Plugin Punishment

The DCSServerBot auto-ban, auto-kick, auto-move-back-to-spectators module, based on the player’s behavior and the configuration described in here.
Some ideas of this plugin are based on Slmod. Thanks to Speed for his awesome solution!

Configuration

As Punishment is an optional plugin, you need to activate it in main.yaml first like so:

opt_plugins:
  - punishment

The plugin itself is configured with a file named config/plugins/punishment.yaml. You’ll find a sample in ./samples:

DEFAULT:
  reslot_window: 60           # If you reslot or reconnect in-between this time in seconds (default: 60) after being shot at, a reslot event will be triggered.
  survival_window: 300        # If you survived this time in seconds (default: 300) after being shot at, the opponent will not get a kill.
  channel: 1122334455667788   # Optional: Channel where to post who was punished for what (default: admin channel, disable: -1).
  penalties:                  # These are the penalty points to use.
  - 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
    reason: Killing a team member
  - event: collision_kill   # If you collide and kill another player, you get 20 points, if it was an AI, you get 12.
    human: 20
    AI: 12
    reason: Killing a team member during a collision
  - event: friendly_fire    # If you fire on a friendly player, you get 12 penalty points, 8 for an AI.
    human: 12
    AI: 8
    reason: Friendly fire on a team member
  - event: collision_hit    # If you hit another team member, you get 5 points, 1 if it was an AI.
    human: 5
    AI: 1
    reason: Colliding with a team member
  - event: reslot           # If you re-slotted when being shot at, you get 30 points (you stole a kill)
    default: 30
    reason: Respawning when being shot at
  - event: taxiway_takeoff
    default: 10
    action: kick
    reason: Illegal taxiway takeoff
  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 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
    action: kick
  - 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
    action: credits
    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
  - 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
    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 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
  - days: 60                # after 60 days, the penalty points get wiped completely                
    weight: 0
DCS.dcs_serverrelease:
  exemptions:
    ucid:
      - 'aabbccddee'          # Do not punish the users with these UCIDs
      - 'eeggffjjjs'
    discord: 
      - '@everyone'           # Do not punish members of your Discord (that are linked) on this server
      - 'Moderators'          # Do not punish your own moderators (Discord role, not bot role!) on this server

Penalties

Here, the configuration for the penalty points assigned to a player is set. Collisions refer to instances where a player’s aircraft is used as a weapon against others. Inside the mission environment, you can create custom events, such as “zone-bombing” in the example provided.

If you incorporate the inline “action”-element, you can immediately initiate actions like “move_to_spec” or “credits” when friendly fire occurs or a team member is killed.

[!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 dropped a CBU 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).

In conjunction with the CreditSystem 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.

Exemptions

User that should not be punished. Can be either ucids or Discord roles.

Forgive

To prevent actions to be executed against an initiator, victims can use the .forgive command inside the in-game chat. This will delete the punishments to this user that are not executed already and delete the events from this specific occasion.

Weight per Flight-Hours

Weight punishment by flight hours. This will be the sum of flight hours over all servers handled by this bot.

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.

[!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 all the penalties in your database by using this SQL:
DELETE FROM pu_events;
After that, every new punishment will decay, according to your new decay function.

Crash / Ejection Handling

A common issue of DCS World PvP is that players do not get kills if others crash or eject after being shot at. DCSServerBot fixes this. If you got shot at and crash or eject in reslot_window seconds afterwards, the opponent will get the kill. If you got hit and crash or eject in-between survival_window seconds, the opponent will get the kill also.

Reslot / Disconnect Handling

When a player reslots or disconnects in the middle of an engagement (they got shot at or even hit), the plugin will treat these incidents according to the probability of kill.
The current implementation is like so:

If you reslot in-between reslot_window seconds after being shot at or hit, you get punished with a reslot event. The kill will be given to the opponent.
If you reslot in-between survival_window seconds after being hit, you will not get punished but the opponent will get the kill.
If you disconnect in-between reslot_window seconds after being shot at or in-between survival_window seconds after being hit, the opponent will get the kill.
If you then re-connect again in-between reslot_window seconds after diconnecting, you get also punished with a reslot event.

Condition	Decision
Player got shot at and disconnects in-between the MAX_MISSILE_TIME.	The plugin will send a message to the admin channel, informing about the incident only, as the player could have a bad internet connection.
Player got shot at and reslots in-between the MAX_MISSILE_TIME.	The player will be punished with a “reslot” event. The opponent will be rewarded with the kill.
Player got hit and either reslots or disconnects in-between the MAX_MISSILE_TIME.	The player will be punished with a “reslot” event. The opponent will be rewarded with the kill.
Player crashed in-between the MAX_MISSILE_TIME after being hit.	The opponent will be rewarded with the kill.

[!NOTE] MAX_MISSILE_TIME is hard-coded to 60 seconds for now.

Discord Commands

In-Game Chat Commands

| Command | Parameter | Role | Description | |———-|———–|——|——————————————————–| | -forgive | | all | Forgive the last actions that happened to your player. | | -penalty | | all | Shows your penalty points. |

How to use the penalty system inside missions

To use the penalty system inside missions, you can use this lua-function:

--[[
    eventName, the event according to the penalties table
    initiator, the player name to be punished
    target, the victim name (might be nil or -1 for AI)
]]--
dcsbot.punish(eventName, initiator, target)

Following the example above, a possible call could be:

-- ...
    if condition then
        player = event.initiator.unit:getPlayerName()
        dcsbot.punish('zone-bombing', player)
    end
-- ...

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 disable the punishments from inside your mission:

if dcsbot then
    dcsbot.disablePunishments()    
end 

Tables

pu_events