Tutorial / Admin panels > Utilities
Chat Filter
Block words and phrases in player chat: star them out or drop the whole message, with optional automatic warnings.
What it does
Chat Filter keeps a list of words and phrases that players may not use in chat. When a message contains one, the word is replaced with stars, or the whole message is blocked.
It can also give an automatic warning every few hits. Toolbox admins are never filtered. Toolbox chat commands and @ admin chat are left alone. Any other message is filtered. A message that starts with ! or / and has a blocked word is blocked instead of censored, so another addon's command (such as /pm) is never posted publicly.
Where to find it
Q menu > KGX's Admin Toolbox > Utilities > Chat Filter.
Toolbox admins can use it. Players can get it through Settings > Player Access with the Chat Filter tick.
The panel
| Option | What it does | Default |
|---|---|---|
| Chat filter on | Turns the filter on or off. Changes apply at once. | Off |
| When a word is found | Replace it with *** (message still sent) or Block the whole message. | Replace |
| Automatic warning every N hits (0 = off) | Gives a warning every N filtered messages (0-20). | 0 |
| Apply warning setting | Saves the slider value. The slider alone does nothing. | |
| Word list | Blocked words and phrases (double-click to remove). | Empty |
| Add a word or phrase and press Enter | Type a word and press Enter to add it. | |
| Add | Adds the word in the box. | |
| Remove all words... | Asks to confirm, then empties the list. | |
| Reset to defaults (off, replace, no warnings) | Turns the filter off, sets Replace and 0 warnings. The word list stays. |
How to use it
Star out bad words
- Open Utilities > Chat Filter.
- Type a word in the box and press Enter. Repeat for each word.
- Pick Replace it with *** (message still sent).
- Tick Chat filter on.
Warn repeat offenders
- Set Automatic warning every N hits (0 = off) to, for example,
3. - Press Apply warning setting.
- Every third filtered message from a player gives them a warning with the reason "Language (chat filter)".
Drop messages completely
- Pick Block the whole message.
- The player's message is not sent. They see "Your message was blocked by the chat filter."
Tips and limits
- Words match anywhere inside a message, ignoring upper and lower case. A short word also matches inside longer words.
- Words are saved in lower case, up to 40 characters each, and at most 500 words.
- One message counts as one hit, however many words it contains.
- The hit count starts over when a player rejoins.
- Automatic warnings count toward Settings > Warning Ladder and
kgxat_warn_kick. - The filter also stars out words in other player text, such as billboards.
- Settings and words are saved in
data/kgx_admin_toolbox/filter.json. Turning the filter on or off and clearing the list are written to the Action Log.