Config

📘 Config.yml

In the config.yml is a small section for punishments

punishments:
  # If you can remove your own punishment.
  remove-own: false
  # Players that will be exempt when punishing someone
  exempt-players:
    - billy_bob_123
    - Notch_Fan_5

  # When punishing someone the player gets a message saying that they have to provide evidence
  evidence-required: true

  # Blocked commands if you are muted
  blocked-cmds:
    - whisper
    - msg
    - emsg
    - ewhisper
    - pm
    - shout
    - me

The remove-own option determines whether players can unmute, unwarn, or unban themselves. If this option is enabled and the player does not have the easystaff.punishments.bypass.removeown permission, they will not be able to remove their own punishment.

exempt-players

This is a list of player names that cannot be punished under any circumstances. Permissions cannot override this. If you attempt to punish an exempt player, the action will be blocked.

You can manage this list using:

/easystaff exempt add|remove|list

evidence-required

To use this feature, Discord integration must be enabled. When you punish a player, a popup will appear after 1 second, prompting you to provide evidence. Click the link to add the evidence. More information can be found in the documentation.

blocked-cmds

This is a list of commands that muted players will be restricted from using.

❓ Reasons.yml

In the reasons.yml file you can customize a lot.

🔄Placeholders

You can use the following placeholders in your messages or interface screens:

  • %reason% – Displays the reason for the punishment.

  • %time_left% – Shows the remaining time for the punishment (not applicable to kicks or warnings).

  • %id% – Displays the Punishment ID (useful for referencing specific punishments like warnings).

❌ Ban Screen

When a player is banned, they are immediately kicked and shown a customizable screen. You can design this screen to include one line of text or multiple lines. The %time_left% placeholder can be used here. If the ban is permanent, it will display: Expires in: Never

🛑 Warning and Mute Behavior

  • Warnings and mutes do not kick the player.

  • If muted, players will see a message every time they attempt to chat.

  • The %time_left% placeholder can be used to indicate how long the mute will last. If the mute is permanent, it will say: Expires in: Never

Note: You cannot use the %id% placeholder with blocked names, as this is not a traditional punishment. When a player joins, their name will be checked against the blocked names list. If there’s a match, they will not be allowed to join.

💨Kick screen

When you kick someone it will do the same thing as a ban but then you will be able to join back instantly

🚫 Block name screen

You can block a name ingame. That screen is a bit different.

You do not be able to use the %id% placeholder because it is not really a punishment. You add a name to the blocked name list and when a player joins it will check their name and if it matches to one of the blocked names you will not be able to join.

🔔Notifications

When a player is banned (and the punishment is not marked as silent), a notification will be broadcast to all players (unless disabled). You can use the following placeholders in this message:

  • %player% – The name of the punished player.

  • %reason% – The reason for the punishment.

  • %issuer% – The staff member who issued the punishment.

The /punish command allows you to punish a player with a predefined reason. This system may seem complex at first, but here’s a breakdown:

To create a new offense configuration, provide:

  • A reason

  • A set number of offense counts

  • A final action after all counts are used

For each offense, you must specify:

  • Type: WARN, BAN, MUTE, or KICK

  • Duration: Use s, m, h, d, M, or y (seconds, minutes, hours, days, months, years). Note: Use uppercase M for months and lowercase m for minutes.

You may also include a custom reason for specific offenses if desired.

Example 1:

Lets make a example offense. The offense will be named "Cheating". You will have 6 counts and then it will use the final. All the offense counts wil be a ban and none will use a custom reason.

So as you can see I added 6 offenses then the final they are all a BAN and I will slowly work my way up to 1 year.

Example 2:

I want the reason to be "Discrimination". It will have 6 offense counts and then the final. The final offense will have a custom reason.

PreviousEasyStaffNextCustom Punishments

Last updated