Discord

In the config.yml you can add a few options for Discord.

discord:
  enabled: false
  webhooks:
    punishments: ""
    reports: ""
    linking: ""

  ping-issuer: true
  
  messages:
    link-required: "&c[Discord] &fYou need to link your Discord account to use this feature. Use &b/staff-link&f to link your account."
    link-success: "&a[Discord] &fYour Discord account has been successfully linked!"
    unlink-success: "&a[Discord] &fYour Discord account has been unlinked."

To enable Discord integration, start by setting the Discord integration boolean to true in your configuration.

Once enabled, you can configure webhook URLs for the following features:

• Punishments

• Reports

• Linking

These webhooks are intended for staff use and will send relevant messages to designated Discord channels.

📝How to create a webhook?

To create a webhook:

1. Open your Discord server and go to the channel you want to use.

2. Click Edit Channel, then navigate to the Integrations tab.

3. Under Webhooks, click "New Webhook".

4. Give the webhook a name (optional), then click "Copy Webhook URL".

Paste this webhook URL into the appropriate section in your EasyStaff config. For example, paste it under the punishments webhook option to link punishment actions to that channel.

You can (and should) create separate channels and webhooks for punishments, reports, and linking.

⚠️ Important: If you have Discord integration enabled, a linking webhook is required for proper functionality.

discord:
  enabled: true
  webhooks:
    punishments: "your_webhook_url"

🔨Punishments

When a punishment is issued and the ping-issuer option is enabled:

• A Discord message will be sent in the configured punishment channel.

• The message will ping the issuer, as long as the punished player has linked their Minecraft and Discord accounts.

• If the player has not linked their account, the issuer will not be pinged.

punishments:
  remove-own: false
  exempt-players:
    - billy_bob_123
    - Notch_Fan_5
    
  evidence-required: true
  
  blocked-cmds:
    - whisper
    - msg
    - emsg
    - ewhisper
    - pm
    - shout
    - me

In the punishment configuration, you can enable the evidence-required option.

When enabled:

• After issuing a punishment, an in-game message will prompt you to provide evidence.

• If the punished player has not linked their account to Discord, an error message will be shown instead.

• Clicking on the in-game prompt allows you to provide a link as evidence.

• The original Discord message will then be edited to include the evidence link.