CHANGES:

- Do no longer send teamkill messages to the admin-channel if the punishment plugin is active.

Author: karel26

plugins/mission/info.py

@@ -3,6 +3,8 @@
 from core import report, Side, Player, DataObjectFactory, Member, utils
 from datetime import datetime, timezone
 from psycopg.rows import dict_row
+from plugins.srs.commands import SRS
+from typing import cast
 
 
 class Header(report.EmbedElement):
@@ -182,7 +184,7 @@ async def render(self, player: Player):
             self.add_field(name="Slot", value=player.unit_callsign)
 
             self.add_field(name="Module", value=player.unit_display_name)
-            srs_plugin = self.bot.cogs.get('SRS', None)
+            srs_plugin = cast(SRS, self.bot.cogs.get('SRS'))
             if srs_plugin:
                 srs_users = srs_plugin.eventlistener.srs_users.get(player.server.name, {})
                 if player.name in srs_users:

plugins/mission/listener.py

@@ -803,6 +803,7 @@ async def onGameEvent(self, server: Server, data: dict) -> None:
                 ('player ' + player2.name) if player2 else 'AI',
                 data['arg2'] or 'Cannon/Bomblet')
             )
+
         elif data['eventName'] == 'self_kill':
             player = server.get_player(id=data['arg1']) if data['arg1'] != -1 else None
             side = player.side if player else Side.UNKNOWN
@@ -821,9 +822,16 @@ async def onGameEvent(self, server: Server, data: dict) -> None:
                 data['arg2'] or 'SCENERY', Side(data['arg6']).name,
                 ('player ' + player2.name) if player2 is not None else 'AI',
                 data['arg5'] or 'SCENERY', data['arg7'] or 'Cannon/Bomblet'))
+
             # report teamkills from players to admins (only on public servers)
             if server.is_public() and player1 and player2 and data['arg1'] != data['arg4'] \
                     and data['arg3'] == data['arg6']:
+                # do not report if the punishment plugin is active and teamkills are punished
+                if self.bot.cogs.get('Punishment'):
+                    _config = self.get_config(server, plugin_name='Punishment')
+                    if any(x for x in _config.get('penalties', []) if x.get('event', "") == 'kill'):
+                       return
+
                 name = ('Member ' + player1.member.display_name) \
                     if player1.member else ('Player ' + player1.display_name)
                 message = f"{name} (ucid={player1.ucid}) is killing team members."

plugins/mission/players.py

@@ -12,7 +12,7 @@ async def render(self, server: Server, sides: list[Coalition]):
             Side.RED: {"names": [], "units": [], "SRS": []},
             Side.NEUTRAL: {"names": [], "units": [], "SRS": []}
         }
-        srs_plugin = cast(SRS, self.bot.cogs.get('SRS', None))
+        srs_plugin = cast(SRS, self.bot.cogs.get('SRS'))
         if srs_plugin:
             srs_users = srs_plugin.eventlistener.srs_users.get(server.name, {})
         else:

plugins/punishment/README.md

@@ -1,5 +1,5 @@
 # Plugin Punishment
-The DCSServerBot auto-ban, auto-kick, auto-move-back-to-spectators module, based on the players behaviour and the 
+The DCSServerBot auto-ban, auto-kick, auto-move-back-to-spectators module, based on the player's behavior and the 
 configuration described in here.<br>
 The ideas of this plugin are based on [Slmod](https://github.com/mrSkortch/DCS-SLmod). Thanks to Speed for his awesome solution!
 
@@ -14,7 +14,7 @@ The plugin itself is configured with a file named config/plugins/punishment.yaml
 ```yaml
 DEFAULT:
   penalties:                # These are the penalty points to use.
-  - event: kill             # If you kill a human player, you get 30 points, 18 in case of an AI.
+  - event: kill             # If you team-kill a human player, you get 30 points, 18 in the case of an AI.
     human: 30
     AI: 18
     action: move_to_spec
@@ -35,30 +35,30 @@ DEFAULT:
     default: 30
     reason: Respawning when being shot at
   forgive: 30               # People can forgive others in-between of 30 seconds (default) with the .forgive in-game chat command.
-  punishments:              # list of punishments, based on the users penalty points
+  punishments:              # list of punishments, based on the user's penalty points
   - points: 100             # we temp-ban the player when they reached 100 points.
     action: ban
     days: 3                 # ban-time in days. default: 3
-  - points: 60              # we kick them from the server, when their points reached 60
+  - points: 60              # we kick them from the server when their points reached 60
     action: kick
-  - points: 40              # we move them to spectators, when they have 40 points
+  - points: 40              # we move them to spectators when they have 40 points
     action: move_to_spec
-  - penalty: 10             # we take away credits from them, if they have 10 points
+  - penalty: 10             # we take away credits from them if they have 10 points
     action: credits
-    points: 12              # amount of credits to take
+    points: 12              # number of credits to take
   - points: 1               # we warn them with each penalty point they got
     action: warn
-  flightHoursWeight:        # If you want to treat people that are frequent flyers on your server differently you can do this here
+  flightHoursWeight:        # If you want to treat people that are frequent flyers on your server differently, you can do this here
   - time: 0                 # New joiners will get 1.4x the penalty points as described below
     weight: 1.4
-  - time: 3                 # people that were flying for at least 3 hours on your servers, get the described penalty points 1:1
+  - time: 3                 # people that were flying for at least 3 hours on your servers get the described penalty points 1:1
     weight: 1
   - time: 10                # people that flew longer than 10 hours get only 0.7x the penalty points (70%)
     weight: 0.7
   decay:                    # This describes how points should vanish over time
   - days: 0                 # on the initial day, we do not do anything
     weight: 1
-  - days: 3                 # after 3 day, 75% of the points will still be there (25% will be wiped)
+  - days: 3                 # after 3 days, 75% of the points will still be there (25% will be wiped)
     weight: 0.75
   - days: 30                # after 30 days, an additional 75% of the points will be wiped (25% will still be there)
     weight: 0.25
@@ -74,20 +74,23 @@ DCS.dcs_serverrelease:
       - 'Moderators'          # Do not punish your own moderators (Discord role, not bot role!) on this server
 ```
 ### Penalties
-The number of penalty points that a player "earns", is configured here. Collisions are hits where the players aircraft is being used as a weapon.
-You can add own events that you can use from inside the mission environment (see below), like the example here with "zone-bombing".<br/>
-If you use the inline "action"-element, you can already trigger any action like a "move_to_spec" or "credits" when someone
-FFs or kills a team member.
+The number of penalty points that a player "earns" is configured here. 
+Collisions are hits where the player's aircraft is being used as a weapon.
+You can add your own events that you can use from inside the mission environment (see below), like the example here 
+with "zone-bombing".<br/>
+If you use the inline "action"-element, you can already trigger any action like a "move_to_spec" or "credits" when 
+someone FFs or kills a team member.
 
 > [!NOTE]
-> Multiple events, that happen in-between a minute, are calculated as a single event. This is on purpose, to avoid too 
-> many punishments when a user unintentionally dropped a CBU onto something or strafed multiple targets in one run.
+> Multiple events that happen in-between a minute are calculated as a single event. 
+> This is on purpose, to avoid too many punishments when a user unintentionally dropped a CBU onto something or 
+> strafed multiple targets in one run.
 
 ### Punishments
 Each point level can trigger a specific action. When the user hits this limit by gathering penalties, the specific 
 action is being triggered. Actions are triggered at least every minute. So there might be a slight delay in being a bad 
-pilot and getting punished. That allows victims to -forgive the dedicated act. A ban is temporary and punishment points 
-can decay over time (see below).<br/>
+pilot and getting punished. That allows victims to `-forgive` the dedicated act. 
+A ban is temporary, and punishment points can decay over time (see below).<br/>
 
 In conjunction with the [CreditSystem](../creditsystem/README.md) plugin, you can use "credits" as a punishment and take away credit points 
 from players if they misbehave. A campaign has to be running for this to happen.
@@ -105,16 +108,16 @@ Weight punishment by flight hours. This will be the sum of flight hours over all
 
 ### Decay
 Penalty points will decrease over time. This is configured here.
-Decay can only be configured once, so there is no need for a server specific configuration. All other elements can be configured for every server instance differently.
+Decay can only be configured once, so there is no need for a server-specific configuration. All other elements can be configured for every server instance differently.
 
 > [!WARNING]
 > If you change the decay function, the existing penalties might not decay anymore, depending on how you adjust the 
 > values. This is unfortunately an issue with how I implemented it.
-> You can reset your penalties in your database by using this SQL:
+> You can reset all the penalties in your database by using this SQL:
 > ```sql
 > DELETE FROM pu_events;
 > ```
-> After that, every new punishment will decay according to your new decay function.
+> After that, every new punishment will decay, according to your new decay function.
 
 ## Discord Commands
 | Command      | Parameter | Channel | Role            | Description                                                                                                              |
@@ -129,8 +132,8 @@ Decay can only be configured once, so there is no need for a server specific con
 | -forgive |           | all  | Forgive the last actions that happened to your player. |
 | -penalty |           | all  | Shows your penalty points.                             |
 
-## How to use the penalty system inside of missions
-To use the penalty system inside of missions, you can use this lua-function:
+## How to use the penalty system inside missions
+To use the penalty system inside missions, you can use this lua-function:
 ```lua
 --[[
     eventName, the event according to the penalties table
@@ -141,17 +144,18 @@ dcsbot.punish(eventName, initiator, target)
 ```
 Following the example above, a possible call could be:
 ```lua
-[...]
+-- ...
     if condition then
         player = event.initiator.unit:getPlayerName()
         dcsbot.punish('zone-bombing', player)
     end
-[...]
+-- ...
 ```
 
-### How to disable punishments inside of missions
+### How to disable punishments inside missions
 Sometimes you don't want your mission to punish users at all, but you don't want to configure your server to 
-disable them forever. To do so, you can just disable the punishments from inside your mission:
+disable them forever. 
+To do so, you can disable the punishments from inside your mission:
 ```lua
 if dcsbot then
     dcsbot.disablePunishments()