Documentation - ChatFilter Plugin
Setup & Configuration
1️⃣ Installation
- Download the latest version of the plugin .jar file.
- Place the .jar file into your plugins folder.
- Restart your server to generate the default config.yml.
- Edit config.yml to customize the blacklist and Discord webhook.
- Run /reload or restart your server for changes to take effect.
2️⃣ Configuration (config.yml)
This plugin generates a config.yml file in the plugins/ChatFilter/ directory.
blacklisted-words:
- "badword1"
- "badword2"
discord-webhook: "
https://discord.com/api/webhooks/YOUR_WEBHOOK_URL"
- blacklisted-words – Add words that should be blocked.
- discord-webhook – Set your Discord webhook URL to log blocked messages.
3️⃣ How It Works
- When a player sends a message, the plugin checks it against the blacklist.
- If the message contains a blacklisted word, the message won't be sent, and the player will receive:
&c&lThe word you were trying to say is a Blacklisted word so it got censored.
- The blocked message is then logged to Discord via the webhook.
4️⃣ Permissions
This plugin works
automatically without any required permissions.
5️⃣ Commands
Currently, there are
no commands. Configuration is done via config.yml.
6️⃣ Support
If you need help or have feature requests, feel free to
open an issue or
join our Discord server.