CleanerX

CleanerX is an advanced chat moderation plugin for Spigot and Paper/Folia servers. It filters and censors inappropriate language (partial or full), can block links in chat, and supports automatic punishment commands after configurable swear-count thresholds. You can also manage blacklist/whitelist entries in-game, clear chat with a command, and optionally synchronize banned words from external sources.

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 (including optional remote banned-words synchronization). Check defaults here: Paper config, Spigot config
• ✅ Multi-language support via messages_xx.yml files
• ✅ Native chat-pipeline compatibility with FlectonePulse 1.13+ on Paper and Spigot

⚙️ Technical Information

• 🟢 Supports Minecraft versions 1.20.6, 1.21–1.21.11, 26.1 and 26.1.1/2
• 🟢 Maintains separate modules for Spigot and Paper (Paper build is Folia-compatible)
• 🟢 Written in Kotlin – a modern, expressive, and safer alternative to Java

If you have any questions, you might find answers on our Discord.

🛠️ 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
/crx reset <player>	cleanerx.cmd.crx	Resets the player's curse counter
/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

Build

./gradlew clean buildAll

Wersja CleanerX jest zdefiniowana w głównym build.gradle.kts i dziedziczona przez moduły Paper oraz Spigot. Wszystkie wersje pluginów Gradle i bibliotek znajdują się w gradle/libs.versions.toml; manifesty bibliotek runtime są rozwijane z tych samych wartości. Artefakty mają nazwy CleanerX-Paper-<wersja>.jar i CleanerX-Spigot-<wersja>.jar.

• Always up-to-date stable version available for download on:
  • Modrinth
  • Hangar
• SNAPSHOT and DEV versions available immediately on Github
• You can also build the development version yourself or download the last valid build

🚀 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 Discord 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. 😊

---

Polska wersja README?

CleanerX

CleanerX to zaawansowana wtyczka moderacji czatu dla serwerów Spigot oraz Paper/Folia. Filtruje i cenzuruje nieodpowiedni język (częściowo lub całkowicie), może blokować linki na czacie i obsługuje automatyczne wykonywanie komend kar po przekroczeniu progów liczby wykroczeń. Pozwala też zarządzać blacklistą/whitelistą bez restartu serwera, czyścić czat komendą oraz opcjonalnie synchronizować listę zakazanych słów ze źródeł zewnętrznych.

Pełny spis komend i uprawnień znajdziesz tutaj

Możliwości

• Cenzurowanie częściowe lub całkowite słów w zależności od konfiguracji
• Możliwość blokowania niechcianych linków
• Możliwość dodawania własnych słów do blacklisty za pomoca komendy bez konieczności restartu serwera
• Możliwość dodawania własnych słów do whitelisty za pomoca komendy bez konieczności restartu serwera
• Automatyczne wykonywanie poleceń w zależności od konfiguracji - zalecana współpraca z PunisherX
• Możliwość czyszczenia czatu za pomocą polecenia
• Powiadomienia o aktualizacjach wtyczki z opcją ustawienia automatycznych aktualizacji
• Rozbudowany plik konfiguracyjny do elastycznych ustawień (w tym opcjonalna synchronizacja zakazanych słów ze źródeł zewnętrznych). Domyślne ustawienia: Paper config, Spigot config
• Wsparcie dla wielu języków przez plik messages_xx.yml
• Natywna współpraca z pipeline czatu FlectonePulse 1.13+ na Paper i Spigot

Informacje techniczne

• Obsługiwane wersje Minecraft: 1.20.6, 1.21–1.21.11 oraz 26.1 i 26.1.1/2
• Projekt posiada osobne moduły dla Spigot i Paper (Paper jest kompatybilny z Folią)
• CleanerX 1.5.6+ wymaga minimum Java 25; wersje starsze niż 1.5.6 wymagają Java 21
• Napisany w nowoczesnym języku programowania Kotlin, który jest bardziej ekspresyjny i bezpieczny niż Java.

Jeśli masz jakieś pytania, być może znajdziesz na nie rozwiązanie na naszym discordzie

Pobierz

• Zawsze aktualna wersja stabilna do pobrania na Hangar
• Możesz także samodzielnie zbudować wersję developerską z

Instalacja

• Pobierz najnowszą wersję pluginu z sekcji wydań.
• Umieść plik JAR w folderze plugins na swoim serwerze.
• Uruchom serwer Minecraft.
• Konfiguracja W pliku config.yml znajdziesz opcje konfiguracyjne, takie jak listę zakazanych słów czy tryb pełnej cenzury.

Kontakt

Jeśli masz pytania lub potrzebujesz pomocy, śmiało skontaktuj się z nami na naszym discordzie lub napisz bezpośrednio na PM

Licencja

Ten plugin jest dostępny na licencji MIT. Szczegóły znajdziesz w pliku LICENSE.

Dziękuję za korzystanie z CleanerX! Mam nadzieję, że spełni twoje oczekiwania. 😊