> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sentrystudios.org/llms.txt
> Use this file to discover all available pages before exploring further.
# Features & Use Cases
> Explore the zero-latency /settings GUI, ProtocolLib packet optimizers, and cross-server synchronization in SentrySettings.
**SentrySettings** consolidates dozens of fragmented utility plugins into a unified, high-performance interface. Backed by ProtocolLib packet interception, asynchronous H2/MySQL persistence, and fine-grained toggle permissions, SentrySettings delivers an unmatched quality-of-life experience for players and network administrators alike.
***
## Unified Player Preferences GUI (`/settings`)
Players access their personal preferences via a sleek, interactive chest GUI. Toggling any setting applies changes instantly with audible feedback and chat toasts.
> **Player Visibility Engine**
>
> Allows players to hide other players in crowded hub lobbies or combat warps, boosting client-side framerates by up to 200%.
> **Infinite Night Vision**
>
> Gives miners and builders clean, toggleable Night Vision without requiring command spam or potion consumption.
> **Lobby Speed Boosts**
>
> Automatically grants dynamic Speed potion effects to players while standing in designated lobby and hub worlds.
> **Cross-Server MySQL Sync**
>
> Player settings persist globally across all BungeeCord and Velocity nodes. A setting toggled in Lobby 1 remains saved when entering Factions.
***
## ProtocolLib PvP & Network Optimizers
SentrySettings features an enterprise-grade packet optimization engine designed for high-intensity competitive servers (Crystal PvP, Sword PvP, Anchor PvP).
```mermaid theme={null}
flowchart LR
Client[Player Client] -->|USE_ENTITY Packet| Netty[ProtocolLib Netty Worker]
Netty -->|Zero-Tick Intercept| Optimizer{SentrySettings Pipeline}
Optimizer -->|Crystal PvP| Detonation[Instant Crystal Burst]
Optimizer -->|Sword PvP| HitReg[Sub-Millisecond Hit Sync]
Optimizer -->|Normal Packets| Bukkit[Standard Server Tick]
```
### Optimizer Modules & Tuning Profiles
Administrators can configure the intensity profile for each module in `config.yml` (`NORMAL`, `OPTIMIZED`, or `EXTREME`):
| Module | Interception Level | Profile | Description |
| :- | :- | :- | :- |
| `crystal-pvp-optimizer` | Inbound `USE_ENTITY` | EXTREME | Intercepts packet attack vectors on Ender Crystals to trigger zero-delay server explosions. |
| `sword-pvp-optimizer` | Inbound `USE_ENTITY` | OPTIMIZED | Eliminates client-server hit-registration delay on living entities during rapid combo exchanges. |
| `anchor-pvp-engine` | Inbound `USE_ITEM` | EXTREME | Accelerates Respawn Anchor Glowstone charging and instant detonation in non-Nether dimensions. |
| `fps-optimization` | Outbound `ENTITY_METADATA` | NORMAL | Aggressive ultra-low FPS mode that hides ambient particles, ground item metadata, and extraneous entities. |
| `ping-spoofer` | Outbound `KEEP_ALIVE` | NORMAL | Regulates connection timing to mitigate packet drop spikes on jittery wireless connections. |
> **Zero-Latency Netty Pipeline**
>
> Unlike traditional Bukkit event listeners that run synchronously on server tick boundaries (delaying hit checks until the next game tick), SentrySettings processes combat packets on raw Netty worker threads via ProtocolLib. This guarantees true client-to-server zero-tick response times.
***
## Integrated Security & Command Blocker
Protect your server infrastructure against reconnaissance attacks without installing bloated anti-exploit plugins:
* **Command Interception:** Natively intercepts and blocks reconnaissance commands like `/plugins`, `/pl`, `/version`, `/ver`, and `/about`.
* **Social Message Protection:** If a player disables `private-messages` or `tpa-requests`, inbound `/msg`, `/tell`, `/w`, `/r`, `/tpa`, and `/tpahere` attempts are caught at the lowest Bukkit event priority before hitting external chat plugins.
* **Low Durability Break Warnings:** Monitors `PlayerItemDamageEvent` and triggers an urgent warning chime when a tool or armor piece drops below the configurable threshold (default `5%`).
***
## Complete Toggle Master Catalog
Every toggle can be individually enabled/disabled globally in `config.yml`, assigned default states for new players, and customized in `menu/gui.yml`:
> **Chat & Social Preferences**
>
> * `global-chat`: View or mute global public chat.
> * `private-messages`: Allow or block direct player whispers.
> * `staff-messages`: View or hide server-wide staff broadcasts.
> * `mention-sounds`: Play an alert sound when `@YourName` is typed in chat.
> * `chat-colors`: Render hex and color formatting in public chat.
> * `local-chat-range`: Restrict visible chat to players within 100 blocks.
> * `compact-chat`: Condense repetitive spam lines into multipliers `(x2)`.
> **Visual & Notification Alerts**
>
> * `actionbar-alerts`: Display notification text above the hotbar.
> * `bossbar-alerts`: Show or hide on-screen bossbar health bars.
> * `title-alerts`: Display large on-screen title text popups.
> * `join-quit-messages`: Hide login/logout spam from chat.
> * `connection-notifications`: Pop up toast alerts for friends joining.
> * `break-warning`: Chime when armor or tool durability drops under 5%.
> **Client Optimization & Movement**
>
> * `player-visibility`: Toggle visibility of surrounding players for FPS boost.
> * `scoreboard-visibility`: Hide or show the sidebar scoreboard.
> * `flight-particles`: Hide potion and trail particles from flying players.
> * `lobby-speed-boost`: Automatically apply Speed I/II in hub worlds.
> * `night-vision-goggles`: Toggle continuous full-bright night vision.
> * `tpa-requests`: Block unwanted teleport requests.
> **Combat & Network Optimizers**
>
> * `fps-optimization`: Ultra-Low FPS mode for low-end graphics cards.
> * `sword-pvp-optimizer`: Sub-millisecond hit-registration pipeline.
> * `crystal-pvp-optimizer`: Zero-delay End Crystal placement and detonation.
> * `anchor-pvp-engine`: High-speed Respawn Anchor combat engine.
> * `ping-spoofer`: Connection packet pacing filter.
***
## PlaceholderAPI Integration
SentrySettings automatically registers its internal expansion with [PlaceholderAPI](https://github.com/PlaceholderAPI/PlaceholderAPI), allowing scoreboards, tablists, and custom menus to reflect real-time player toggle states:
| Placeholder | Output Format | Description |
| :- | :- | :- |
| `%sentrysettings_%` | String (e.g. `[ᴇɴᴀʙʟᴇᴅ]` / `[ᴅɪsᴀʙʟᴇᴅ]`) | Returns the localized, color-formatted status string from `menu/gui.yml`. |
| `%sentrysettings__raw%` | Boolean (`true` / `false`) | Returns the raw boolean value, ideal for DeluxeMenus `click_requirement` logic. |
> [!TIP]
>
> Replace `` with any key from the toggle catalog (e.g. `%sentrysettings_night-vision-goggles%` or `%sentrysettings_player-visibility_raw%`).
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.