# ServerShield \u2014 Automatic moderation plugin for Minecraft 1.21+<\/p>\n
## Short description
\nServerShield is a focused, low-latency moderation plugin that prevents slurs and severe profanity from appearing in chat \u2014 blocking them before they are sent. Plug-and-play behavior with sensible defaults, fine-tunable thresholds, and built-in admin stats.<\/p>\n
### Tagline
\nAutomated slur removal & safe chat enforcement for Paper\/Spigot (Minecraft 1.21+)<\/p>\n
—<\/p>\n
## Long description
\nServerShield blocks slurs and severe profanity in real-time by sending chat content to a trusted moderation API. When offensive content is detected, the message is prevented from broadcasting and the sender’s chat is cleared so the content never appears to other players \u2014 or themselves.<\/p>\n
ServerShield focuses on doing one job well: stop slurs and minimize harmful content in your server chat without manual keyword lists or local slur storage. It integrates with Paper and Spigot (Minecraft 1.21+) and is designed for minimal admin setup.<\/p>\n
—<\/p>\n
## Key features
\n– Instant slur removal \u2014 messages flagged as slurs are cancelled before they reach players.
\n– Configurable threshold \u2014 adjust how aggressive the moderation should be using the `threshold` setting.
\n– Two action modes: `delete` (default) and `hashtag` \u2014 `delete` simply blocks, `hashtag` replaces content with `########` when you prefer a visible placeholder.
\n– Works on Paper 1.21 & Spigot \u2014 detects and handles `AsyncChatEvent` or `AsyncPlayerChatEvent` as needed.
\n– Stats: `\/servershield stats` \u2014 admins can view how many messages were blocked and a player breakdown.
\n– No local slur list \u2014 the plugin relies on an external profanity API for detection.
\n– Optional obfuscated release build via `yguard` profile (for plugin authors who distribute a protected jar).<\/p>\n
—<\/p>\n
## Quick install
\n1. Place `ServerShield.jar` into your server `plugins\/` folder.
\n2. Restart or reload the server.
\n3. Edit `plugins\/ServerShield\/config.yml` to tune settings (see config recipe below).<\/p>\n
> Note: Standalone, no external configuration required unless you want to tweak detection sensitivity or stats.<\/p>\n
—<\/p>\n
## Configuration (config.yml quick reference)
\n– action: `delete` # `delete` or `hashtag`
\n– threshold: `0.9` # higher is stricter; values between 0.0 and 1.0
\n– broadcast_for_all: `true` # broadcast hashtag replacements to everybody if set
\n– clear_chat_lines: `100` # number of blank lines to remove the sender’s message from view
\n– debug: `false` # turn on for tuning and troubleshooting
\n– persist_stats: `true` # whether to save stats to `plugins\/ServerShield\/stats.yml`<\/p>\n
Tuning: enable `debug: true` to see API responses and scores in server console. That helps you find the ideal `threshold` for your community.<\/p>\n
—<\/p>\n
## Commands & Permissions
\n– `\/servershield stats` \u2014 Show total blocked messages and top blocked players.
\n – Permission: `servershield.stats` (default: `op`) \u2014 view in-game stats.
\n– Permission: `servershield.admin` for admin-only access to plugin commands (default: `op`).<\/p>\n
—<\/p>\n
## Privacy & Data
\n– ServerShield sends chat messages to the Profanity API (https:\/\/vector.profanity.dev) for moderation decisions. If you do not want to send chat to an external service, do not run the plugin.
\n– The plugin does NOT store raw messages in `stats.yml` \u2014 it only stores counts and aggregated per-player blocked totals when `persist_stats` is enabled.
\n– You can disable persistence by setting `persist_stats: false` in `config.yml`.<\/p>\n
—<\/p>\n
## Roadmap (planned)
\n– Advanced ban system & rules (all-in-one moderation console)
\n– Essentials-like feature set (optional replacement for standard tools)
\n—<\/p>\n
## Changelog (short)
\n– 0.01 BETA \u2014 Initial public beta with slur detection and basic stats.<\/p>\n
—<\/p>\n
## FAQ
\nQ: What happens when the API is down?
\nA: ServerShield handles API failures gracefully: if the API cannot be reached, messages will be treated as safe (no local blocking), so uptime of the external API may impact blocking. Turn on `debug` to monitor API errors.<\/p>\n
Q: Does ServerShield use any local slur database?
\nA: No \u2014 per my choice, the plugin uses the external profanity service only. This avoids maintaining a local list.<\/p>\n
Q: Is the plugin compatible with Paper 1.21?
\nA: Yes \u2014 ServerShield handles `AsyncChatEvent` on Paper and falls back to `AsyncPlayerChatEvent` for Spigot.<\/p>\n
—<\/p>\n
## Support & contact<\/p>\n
– We are working on this.<\/p>\n
—<\/p>\n
## License
\n– See Modrinth for license details.<\/p>\n
—<\/p>\n","protected":false},"excerpt":{"rendered":"
ServerShield is an all in one automated moderation plugin for minecraft servers!<\/p>\n","protected":false},"featured_media":137642,"template":"","meta":{"_minecraft_slug":"servershield","_minecraft_project_id":"ur8Z078c","_minecraft_author":"Catspindev01","_minecraft_license":"LicenseRef-All-Rights-Reserved","_minecraft_downloads":28,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"servershield.zip","_minecraft_size_bytes":264247,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-15T22:12:04.473753Z","_minecraft_date_created":"2025-11-18T01:08:29.687376Z","_minecraft_date_modified":"2025-11-16T20:53:47.282915Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/servershield","_minecraft_icon_attachment_id":137642,"_minecraft_imported_at":"2026-06-08T03:21:29+00:00","_minecraft_import_hash":"97bf438284fad3d706c6759d19c7fad5","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[126,127,123,92],"mod_loader":[132],"minecraft_version":[62,37,40,73,74,38,78,79,80,81,82],"class_list":["post-137641","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-management","mod_category-paper","mod_category-technology","mod_category-utility","mod_loader-paper","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n