Installation
Place the Jar in Your Server:
- Copy the generated jar (e.g., ChatFilter.jar) into your server’s plugins folder.
- Restart the Server:
Start or restart your server. The plugin will generate a default configuration file if one does not already exist.
Configuration
After installing and starting the server, a configuration file named config.yml will be created in the plugins/ChatFilter folder. Open this file in a text editor to update the list of banned words. An example configuration might look like this:
Code (Text):
# List of words to filter from signs.
banned-words:
- badword1
- badword2
- inappropriate
- banned-words:
Any word included in this list (regardless of case) will be removed from signs and chat when they are changed.
How It Works
Sign Filtering
- Event Trigger:
When a player changes a sign (using /sign or by placing a sign), the plugin checks every line on the sign.
- Processing:
For each line, it iterates through the banned words list. If a banned word is found (using a case-insensitive search), it is removed from that line.
- Feedback:
If any banned word is removed, the player is warned via a chat message:
"Warning: Your sign contained inappropriate language which has been removed."
Chat Formatting
- Event Trigger:
When a player sends a chat message (provided it is not a command), the plugin processes the message.
- Processing:
If the message starts with a lowercase letter, the plugin automatically capitalizes the first character.
- Result:
This results in cleaner, more professional chat messages.