CleanerX

# CleanerX CleanerX is an advanced plugin designed to filter and replace inappropriate language with censored alternatives or remove it entirely, ensuring a clean and respectful gaming environment. It allows you to configure automatic execution of commands, for example, to punish players who repeatedly use offensive language after a specified number of infractions. The plugin also blocks the ability to send links in chat, and if needed, you can clear the chat with a simple command. ## 🔹 Features - ✅ Partial or complete word censorship depending on configuration - ✅ Ability to block unwanted links - ✅ Add custom words to the blacklist via command without needing to restart the server - ✅ Add custom words to the whitelist via command without needing to restart the server - ✅ Automatic execution of commands based on configuration – recommended integration with PunisherX - ✅ Ability to clear chat using a command - ✅ Plugin update notifications with an option to enable automatic updates - ✅ Extensive configuration file for flexible settings. Check the default settings (https://github.com/SyntaxDevTeam/CleanerX/blob/main/src/main/resources/config.yml) - ✅ Multi-language support via `messages_xx.yml` files ## ⚙️ Technical Information - 🟢 **Designed for the latest Minecraft versions 1.20.6–1.21.4+** - 🟢 **Optimized for Paper and its forks (Pufferfish, Purpur, Leaves)** - 🟢 **Requires Java 21 or newer** - 🟢 **Written in Kotlin – a modern, expressive, and safer alternative to Java** If you have any questions, you might find answers on our (https://discord.gg/Q343kjA2YP). ## 🛠️ Commands and Permissions | Command | Permission | Description | |---------------------------------------|--------------------------|----------------------------------------------------| | `/whitelistx <add/remove/list>` | `cleanerx.cmd.whitelist` | Adds, removes or displays words from the whitelist | | `/blacklistx <add/remove/list>` | `cleanerx.cmd.blacklist` | Adds, removes or displays words from the blacklist | | `/cleanx` | `cleanerx.cmd.clean` | Clears the in-game chat | | `/cleanerx reset <player>` or `/crx reset <player>` | `cleanerx.cmd.crx` | Resets swear counter for player | `/cleanerx help` or `/crx help` | `cleanerx.cmd.crx` | Displays a list of available commands | | `/cleanerx reload` or `/crx reload` | `cleanerx.cmd.crx` | Reloads the configuration file. | | `/cleanerx version` or `/crx version` | `cleanerx.cmd.crx` | Shows plugin info | ## 📥 Download - **The latest stable version is available on Hangar:** (https://img.shields.io/hangar/dt/CleanerX)](https://hangar.papermc.io/SyntaxDevTeam/CleanerX) - **You can also build the latest development version from:** (https://img.shields.io/badge/GitHub.com-CleanerX-green)](https://github.com/SyntaxDevTeam/CleanerX) ## 🚀 Installation 1. Download the latest version of the plugin from the release section. 2. Place the JAR file into the `plugins` folder on your server. 3. Start your Minecraft server. 4. **Configuration:** Open the `config.yml` file to customize settings such as the list of banned words or full censorship mode. ## 📞 Contact If you have any questions or need support, feel free to reach out on our (https://discord.gg/Q343kjA2YP) or send us a direct message. ## 📜 License This plugin is available under the **MIT License**. You can find the details in the LICENSE file. --- **Thank you for using CleanerX! I hope it meets your expectations. 😊** ---