You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+73-25Lines changed: 73 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -1,31 +1,65 @@
1
-
# Welcome to CleanerX
2
-
CleanerX is a sophisticated plugin designed to filter and replace inappropriate language with censored alternatives or remove it entirely, ensuring a clean and respectful gaming environment.
1
+
# CleanerX
2
+
3
+
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.
4
+
5
+
6
+
## 🔹 Features
7
+
8
+
- ✅ Partial or complete word censorship depending on configuration
9
+
- ✅ Ability to block unwanted links
10
+
- ✅ Add custom words to the blacklist via command without needing to restart the server
11
+
- ✅ Add custom words to the whitelist via command without needing to restart the server
12
+
- ✅ Automatic execution of commands based on configuration – recommended integration with PunisherX
13
+
- ✅ Ability to clear chat using a command
14
+
- ✅ Plugin update notifications with an option to enable automatic updates
15
+
- ✅ Extensive configuration file for flexible settings. Check the default settings [here](https://github.com/SyntaxDevTeam/CleanerX/blob/main/src/main/resources/config.yml)
16
+
- ✅ Multi-language support via `messages_xx.yml` files
17
+
18
+
## ⚙️ Technical Information
19
+
20
+
- 🟢 **Designed for the latest Minecraft versions 1.20.6–1.21.4+**
21
+
- 🟢 **Optimized for Paper and its forks (Pufferfish, Purpur, Leaves)**
22
+
- 🟢 **Requires Java 21 or newer**
23
+
- 🟢 **Written in Kotlin – a modern, expressive, and safer alternative to Java**
24
+
25
+
If you have any questions, you might find answers on our [Discord](https://discord.gg/KNstae3UEV).
|`/whitelist <add/remove/list>`|`cleanerx.cmd.help`| Adds, removes or displays words from the whitelist |
31
+
|`/blacklist <add/remove/list>`|`cleanerx.cmd.help`| Adds, removes or displays words from the blacklist |
32
+
|`/clean`|`cleanerx.cmd.help`| Clears the in-game chat |
33
+
|`/cleanerx help` or `/crx help`|`cleanerx.cmd.help`| Displays a list of available commands |
34
+
|`/cleanerx reload` or `/crx reload`|`cleanerx.cmd.reload`| Reloads the configuration file. |
35
+
|`/cleanerx version` or `/crx version`|`cleanerx.cmd.version`| Shows plugin info |
3
36
4
-
## Information
5
-
*[x] CleanerX was designed specifically for the latest version of Minecraft 1.20.6-1.21+
6
-
*[x] Written and optimized for the Paper engine and its modifications such as Pufferfish and Purpur
7
-
*[x] Requires Java 21 or newer to work correctly
8
-
*[x] Written in the modern programming language Kotlin, which is more expressive and safer than Java.
37
+
## 📥 Download
9
38
10
-
If you have any questions, you might find a solution on our [discord](https://discord.gg/KNstae3UEV)
39
+
-**The latest stable version is available on Hangar:**[](https://hangar.papermc.io/SyntaxDevTeam/CleanerX)
40
+
-**You can also build the latest development version from:**[](https://github.com/SyntaxDevTeam/CleanerX)
11
41
12
-
## Download
13
-
* The always up-to-date stable version is available for download on Hangar [](https://hangar.papermc.io/SyntaxDevTeam/CleanerX)
14
-
* You can also build the development version yourself from [](https://github.com/SyntaxDevTeam/CleanerX)
42
+
## 🚀 Installation
15
43
16
-
## Installation
17
-
* Download the latest version of the plugin from the releases section.
18
-
* Place the JAR file in the plugins folder on your server.
19
-
* Start the Minecraft server.
20
-
* Configuration In the config.yml file, you will find configuration options such as the list of banned words or full censorship mode.
44
+
1. Download the latest version of the plugin from the release section.
45
+
2. Place the JAR file into the `plugins` folder on your server.
46
+
3. Start your Minecraft server.
47
+
4.**Configuration:**
48
+
Open the `config.yml` file to customize settings such as the list of banned words or full censorship mode.
21
49
22
-
## Contact
23
-
If you have questions or need help, feel free to contact us on our [discord](https://discord.gg/KNstae3UEV) or write directly on PM
50
+
## 📞 Contact
24
51
25
-
## License
26
-
This plugin is available under the MIT license. Details can be found in the LICENSE file.
52
+
If you have any questions or need support, feel free to reach out on our [Discord](https://discord.gg/KNstae3UEV) or send us a direct message.
27
53
28
-
Thank you for using CleanerX! I hope it meets your expectations. 😊
54
+
## 📜 License
55
+
56
+
This plugin is available under the **MIT License**. You can find the details in the LICENSE file.
57
+
58
+
---
59
+
60
+
**Thank you for using CleanerX! I hope it meets your expectations. 😊**
@@ -34,11 +68,25 @@ Thank you for using CleanerX! I hope it meets your expectations. 😊
34
68
35
69
# CleanerX
36
70
37
-
CleanerX to zaawansowany plugin zaprojektowany do filtrowania i zamiany niecenzuralnych słów na ocenzurowane odpowiedniki lub ich całkowitego usuwania, zapewniając czyste i szanujące środowisko gry..
71
+
CleanerX to zaawansowana wtyczka zaprojektowana do filtrowania i zastępowania nieodpowiedniego języka ocenzurowanymi alternatywami lub całkowitego usuwania go, zapewniając czyste i pełne szacunku środowisko gry. Pozwala na skonfigurowanie automatycznego wykonywanie poleceń, na przykład, aby ukarać graczy, którzy wielokrotnie używają obraźliwego języka po określonej liczbie przekleństw. Wtyczka blokuje również, możliwość wysyłania na czacie linków do stron, a w razie potrzeby możesz wyczyścić czat za pomocą polecenia.
72
+
73
+
Pełny spis komend i uprawnień znajdziesz [tutaj](https://github.com/SyntaxDevTeam/CleanerX/wiki)
74
+
75
+
## Możliwości
76
+
77
+
* Cenzurowanie częściowe lub całkowite słów w zależności od konfiguracji
78
+
* Możliwość blokowania niechcianych linków
79
+
* Możliwość dodawania własnych słów do blacklisty za pomoca komendy bez konieczności restartu serwera
80
+
* Możliwość dodawania własnych słów do whitelisty za pomoca komendy bez konieczności restartu serwera
81
+
* Automatyczne wykonywanie poleceń w zależności od konfiguracji - zalecana współpraca z PunisherX
82
+
* Możliwość czyszczenia czatu za pomocą polecenia
83
+
* Powiadomienia o aktualizacjach wtyczki z opcją ustawienia automatycznych aktualizacji
0 commit comments