Muzzle

# Muzzle by Minedream Team Muzzle is an advanced regex-based chat filtering and moderation plugin for Minecraft servers. It normalizes leet-speak evasions, blocks unwanted URLs and domain advertisements, tracks player offenses, and executes configurable punishment pipelines automatically. ## Key Features * **Leet-Speak Normalization** — Automatically detects and decodes leet-speak character substitutions (e.g. `f1lt3r` -> `filter`) to stop filter bypasses. * **Regex Pattern Filtering** — Powerful regular expression engine supporting customizable filter lists and action triggers. * **URL & Domain Protection** — Blocks unauthorized links and IP addresses with whitelist support for official network domains. * **Automated Escalating Punishments** — Warns players, blocks messages, or automatically mutes repeat offenders based on configurable offense thresholds. * **In-Game Testing Tool** — Administrators can test messages in real-time using `/muzzle test ` to debug regex rules before deployment. ## Commands | Command | Description | Permission | |---------|-------------|------------| | `/muzzle status` | Display active filter engine status and pattern counts. | `muzzle.admin` | | `/muzzle list` | List all registered filter lists and configured actions. | `muzzle.admin` | | `/muzzle test ` | Test a chat message against all active regex patterns. | `muzzle.admin` | | `/muzzle mute [duration]` | Manually mute a player from chat. | `muzzle.mute` | | `/muzzle unmute ` | Unmute a player. | `muzzle.mute` | | `/muzzle offenses ` | View filter violation count for a player. | `muzzle.history` | | `/muzzle clear ` | Clear saved offenses for a player. | `muzzle.admin` | | `/muzzle reload` | Reload filter lists and configuration from disk. | `muzzle.admin` | ## Permissions | Permission Node | Description | Default | |----------------|-------------|---------| | `muzzle.use` | Allow executing basic Muzzle status commands. | All players | | `muzzle.bypass` | Bypass chat filtering and URL checks. | OP | | `muzzle.admin` | Full administrative access to manage filters and settings. | OP | | `muzzle.mute` | Allow muting and unmuting players manually. | OP | | `muzzle.history` | Allow viewing player filter violation history. | OP | ## Configuration ### `config.yml` Configure leet-speak normalization, URL blocking, and punishment thresholds: ```yaml # Muzzle Configuration # Enable leet-speak decoding before filtering leet-normalization: true # URL & IP Domain Blocker url-filter: enabled: true action: BLOCK # Options: BLOCK, WARN, MUTE whitelist: - "mine-dream.org" - "discord.gg/minedream" # Automatic punishment thresholds offenses: max-warnings: 3 auto-mute-duration: 300 # seconds ```