Skip to content

User Manual v1.0.0

Jump to bottom
SzymeX edited this page Jun 11, 2026 · 1 revision

PureFilter Wiki

--- PLAYER COMMANDS ---

There are no player-facing commands. The plugin operates entirely automatically and asynchronously in the background, filtering chat on the fly.

--- ADMIN COMMANDS (Permission: purefilter.admin.X) ---

1. /purefilter

Command: /purefilter (Aliases: /pf)

Description: Displays the help menu and main command usage.

2. /purefilter reload

Command: /purefilter reload

Description: Reloads configuration and all word lists (pl.txt, en.txt, and custom files).

Permission: purefilter.admin.reload

Effect: Rebuilds the fast-lookup word cache immediately without a server restart.

3. /purefilter info

Command: /purefilter info

Description: Displays detailed system information: active mode, active language, and the total number of loaded profanities in the database.

Permission: purefilter.admin.info

4. /purefilter status

Command: /purefilter status

Description: Shows whether the chat filtering engine is currently enabled or disabled.

Permission: purefilter.admin.status

--- SYSTEM FEATURES ---

  • [Fuzzy-Matching Engine]: Advanced text normalization algorithm. Detects and blocks profanities hidden behind leet-speak (0→o, 3→e, 4→a, 5→s, !→i, $+s), spaces, dots, dashes, repeated characters, and identical-looking characters from other alphabets (Unicode homoglyphs).

  • [Filter Modes]: Three operational modes configurable via config.yml:

  • AUTO: Uses only the built-in language databases: Polish (pl.txt) and English (en.txt).

  • MANUAL: Ignores built-in lists and relies entirely on user-defined files in the /words/custom/ directory.

  • AUTO_MANUAL: Combines both sets for maximum server protection.

  • [Punishment System]: Automated punishment system. Upon detecting a profanity, the plugin blocks the message from being sent and instantly executes defined commands from the console (e.g., /tempmute <player> 5m).

  • [Admin Alerts]: In-game chat notifications for staff members holding the purefilter.admin.message permission. Alerts include the offending player's name and a prominent red safety warning if AUTO mode is active.

  • [Color Support]: Full integration with the Adventure API. All system messages fully support traditional legacy color codes (&c, &a) as well as modern HEX (#RRGGBB) styling.

  • [Performance Guard]: Banned words are pre-computed and loaded straight into RAM using a highly optimized HashSet. Message checking completes in a fraction of a millisecond ($O(1)$) on an asynchronous thread, guaranteeing zero lag on the main server thread.

--- PERMISSIONS OVERVIEW ---

  • purefilter.admin – Parent node; grants access to all three subcommands (reload, info, status). Default: OP.

  • purefilter.admin.message – Allows staff to receive in-chat administrative alerts when a player triggers the filter. Default: OP.

  • purefilter.admin.override – Complete filter bypass. Messages sent by players with this node are never processed or blocked. Note: This node is intentionally NOT a child of purefilter.admin and must be explicitly assigned via your permission manager (e.g., LuckPerms). Default: false.

Developed by SzymeX Dev Studio.

Clone this wiki locally