FilterGuard Guide
This page introduces FilterGuard as a public staff guide. It focuses on what the tool does, how authorized staff get started, and which commands are useful.
What It Does
Section titled “What It Does”FilterGuard extends server chat-filter style checks to other player-written text surfaces: signs, wall signs, hanging signs, wall hanging signs, books, anvils, item names, and server nicknames.
How Staff Use It
Section titled “How Staff Use It”Start with /filterguard. The sections below explain what FilterGuard is for, which commands authorized staff can use, and what its output means.
Available features include:
- Reads CMI Settings/ChatFilter.yml deny rules.
- Checks sign text, wall sign text, hanging sign text, wall hanging sign text, book edits, anvil rename text, item-name rename text, and CMI nickname changes.
- Supports per-surface enabled toggles.
- Supports per-surface actions: log, alert, cancel, and cancel-and-alert.
- Sends live alerts to staff with onembcmi.filterguard.alert.
- Keeps bounded recent detections for the current runtime.
- Provides a safe /filterguard test <surface> <text> command before enabling cancellation.
Quick Start
Section titled “Quick Start”- Start with
/filterguardto open or view FilterGuard. - Use
/filterguard statusto check your current progress, settings, or state. - Try
/filterguard recentwhen you are ready to use one of the feature actions.
Commands
Section titled “Commands”| Command | What it does | Example |
|---|---|---|
/filterguard | Opens or shows the main FilterGuard player view. | /filterguard |
/filterguard status | Shows your current FilterGuard status. | /filterguard status |
/filterguard recent [page] | Runs the FilterGuard recent action. | /filterguard recent |
/filterguard rules [page] | Runs the FilterGuard rules action. | /filterguard rules |
Aliases
Section titled “Aliases”/chatfilterguard/cfguard
Examples
Section titled “Examples”/filterguard/filterguard status/filterguard recent/filterguard recent 2/filterguard rules
Good To Know
Section titled “Good To Know”- This is a permission-gated staff or server-management feature, not a normal player feature.
- Review the full reference before changing settings or using any command that can write data.
Full Reference
Section titled “Full Reference”The full synced FilterGuard reference is available for exact technical details.