> ## 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.

# SentrySettings

> Production configuration templates, tabbed font variants, and custom use-case presets for SentrySettings.

Below you will find the complete, copy-ready configuration files for **SentrySettings**. We provide tabbed font variants for visual elements (`menu/gui.yml` and `messages.yml`): our recommended **Small Caps** version for an ultra-clean modern aesthetic, and a **Standard Font** version for native Minecraft typography.

***

## Core Configuration

Controls database persistence, defaults for new players, PvP optimizer intensity profiles, and audio chimes.

```yaml config.yml theme={null}
# ==============================================================================
# SentrySettings - Production Configuration
# Build: v1.0.0 | Folia / Paper / Purpur
# ==============================================================================

version: 1.0.0

# Database Configuration (Used for multi-server synchronization)
database:
  type: "H2" # Options: H2, MYSQL, SQLITE
  mysql:
    host: "127.0.0.1"
    port: 3306
    database: "sentry_settings"
    username: "root"
    password: "your_secure_password"
    useSSL: false

# Automated Update Checks
updates:
  check: true
  notify-console: true
  notify-ingame: false
  version-url: https://github.com/SentryStudio/SettingsVersionChecker/raw/refs/heads/main/version

# Developer & Testing Mode
dev-mode:
  enabled: false
  debug-mode: false

system:
  prefix: ''

# Sound Effects for Interactions
sounds:
  enabled: true
  on-reload: ENTITY_EXPERIENCE_ORB_PICKUP
  on-error: ENTITY_VILLAGER_NO
  on-gui-click: UI_BUTTON_CLICK
  on-gui-open: BLOCK_CHEST_OPEN
  on-category-toggle: BLOCK_LEVER_CLICK

# General Mechanics & Thresholds
general:
  gui-cooldown-ms: 500
  local-chat-range: 100.0
  break-warning-threshold: 0.05 # 5% durability trigger
  lobby-speed-level: 1
  lobby-worlds:
    - lobby
    - hub
    - world

# Default states for players who haven't customized their settings yet
defaults:
  global-chat: true
  private-messages: true
  tpa-requests: true
  player-visibility: true
  scoreboard-visibility: true
  staff-messages: true
  join-quit-messages: true
  mention-sounds: true
  connection-notifications: true
  chat-colors: true
  actionbar-alerts: true
  bossbar-alerts: true
  title-alerts: true
  local-chat-range: false
  compact-chat: false
  flight-particles: true
  lobby-speed-boost: false
  night-vision-goggles: false
  break-warning: true
  ping-spoofer: false
  crystal-pvp-optimizer: false
  sword-pvp-optimizer: false
  anchor-pvp-engine: false
  fps-optimization: false

# Global Availability (Enable or disable toggles across the entire server)
toggles:
  global-chat: true
  private-messages: true
  tpa-requests: true
  player-visibility: true
  scoreboard-visibility: true
  staff-messages: true
  join-quit-messages: true
  mention-sounds: true
  connection-notifications: true
  chat-colors: true
  actionbar-alerts: true
  bossbar-alerts: true
  title-alerts: true
  local-chat-range: true
  compact-chat: true
  flight-particles: true
  lobby-speed-boost: true
  night-vision-goggles: true
  break-warning: true
  ping-spoofer: true
  crystal-pvp-optimizer: true
  sword-pvp-optimizer: true
  anchor-pvp-engine: true
  fps-optimization: true

# ProtocolLib PvP & Network Optimizers Tuning (NORMAL, OPTIMIZED, EXTREME)
optimizer-tuning:
  sword-pvp-optimizer: OPTIMIZED
  crystal-pvp-optimizer: OPTIMIZED
  anchor-pvp-engine: OPTIMIZED
  ping-spoofer: OPTIMIZED
  allow-ultra-low-fps: true

# Discord Logging
discord:
  enabled: false
  webhook-url: "https://discord.com/api/webhooks/your_webhook_url"
  username: "SentrySettings Logs"
  avatar-url: ""
  embed-color: "#F59E0B"
  buttons:
    namemc: true
    docs: true
    discord: true
```

***

## GUI Configuration

**Small Caps (Recommended)**

```yaml menu/gui.yml (Small Caps) theme={null}
gui:
  title: 'B82F6sᴇɴᴛʀʏsᴇᴛᴛɪɴɢs'
  size: 27
  fill: BLACK_STAINED_GLASS_PANE
  pagination:
    previous:
      slot: 18
      material: ARROW
      name: '&#00B4D8ᴘʀᴇᴠɪᴏᴜs ᴘᴀɢᴇ'
      lore:
        - '&8&nɴᴀᴠɪɢᴀᴛɪᴏɴ'
        - ''
        - ' &fView previous page'
        - ' &fof setting toggles.'
        - ''
        - '&#00B4D8&nᴄʟɪᴄᴋ ᴛᴏ ɢᴏ ʙᴀᴄᴋ'
    next:
      slot: 26
      material: ARROW
      name: '&#00B4D8ɴᴇxᴛ ᴘᴀɢᴇ'
      lore:
        - '&8&nɴᴀᴠɪɢᴀᴛɪᴏɴ'
        - ''
        - ' &fView next page'
        - ' &fof setting toggles.'
        - ''
        - '&#00B4D8&nᴄʟɪᴄᴋ ғᴏʀ ɴᴇxᴛ'
  items:
    global-chat:
      material: PAPER
      name: '&#00B4D8ɢʟᴏʙᴀʟ ᴄʜᴀᴛ'
      lore:
        - '&8&nᴛᴏɢɢʟᴇ'
        - ''
        - ' &fToggle visibility of'
        - ' &fpublic server chat.'
        - ''
        - ' %status%'
        - ''
        - '&#00B4D8&nᴄʟɪᴄᴋ ᴛᴏ ᴛᴏɢɢʟᴇ'
    private-messages:
      material: WRITABLE_BOOK
      name: '&#D2A36Bᴘʀɪᴠᴀᴛᴇ ᴍᴇssᴀɢᴇs'
      lore:
        - '&8&nᴛᴏɢɢʟᴇ'
        - ''
        - ' &fToggle receiving direct'
        - ' &fplayer whispers and DMs.'
        - ''
        - ' %status%'
        - ''
        - '&#D2A36B&nᴄʟɪᴄᴋ ᴛᴏ ᴛᴏɢɢʟᴇ'
    player-visibility:
      material: ENDER_EYE
      name: '&#10B985ᴘʟᴀʏᴇʀ ᴠɪsɪʙɪʟɪᴛʏ'
      lore:
        - '&8&nᴛᴏɢɢʟᴇ'
        - ''
        - ' &fHide surrounding players'
        - ' &ffor maximum FPS boost.'
        - ''
        - ' %status%'
        - ''
        - '&#10B985&nᴄʟɪᴄᴋ ᴛᴏ ᴛᴏɢɢʟᴇ'
    night-vision-goggles:
      material: GOLDEN_CARROT
      name: '&#F59E0Bɴɪɢʜᴛ ᴠɪsɪᴏɴ'
      lore:
        - '&8&nᴛᴏɢɢʟᴇ'
        - ''
        - ' &fToggle continuous'
        - ' &ffull-bright vision.'
        - ''
        - ' %status%'
        - ''
        - '&#F59E0B&nᴄʟɪᴄᴋ ᴛᴏ ᴛᴏɢɢʟᴇ'
```

**Standard Font (Vanilla)**

```yaml menu/gui.yml (Standard Font) theme={null}
gui:
  title: 'B82F6SentrySettings'
  size: 27
  fill: BLACK_STAINED_GLASS_PANE
  pagination:
    previous:
      slot: 18
      material: ARROW
      name: '&#00B4D8Previous Page'
      lore:
        - '&8&nNavigation'
        - ''
        - ' &fView previous page'
        - ' &fof setting toggles.'
        - ''
        - '&#00B4D8&nClick to Go Back'
    next:
      slot: 26
      material: ARROW
      name: '&#00B4D8Next Page'
      lore:
        - '&8&nNavigation'
        - ''
        - ' &fView next page'
        - ' &fof setting toggles.'
        - ''
        - '&#00B4D8&nClick for Next'
  items:
    global-chat:
      material: PAPER
      name: '&#00B4D8Global Chat'
      lore:
        - '&8&nToggle'
        - ''
        - ' &fToggle visibility of'
        - ' &fpublic server chat.'
        - ''
        - ' %status%'
        - ''
        - '&#00B4D8&nClick to Toggle'
    private-messages:
      material: WRITABLE_BOOK
      name: '&#D2A36BPrivate Messages'
      lore:
        - '&8&nToggle'
        - ''
        - ' &fToggle receiving direct'
        - ' &fplayer whispers and DMs.'
        - ''
        - ' %status%'
        - ''
        - '&#D2A36B&nClick to Toggle'
    player-visibility:
      material: ENDER_EYE
      name: '&#10B985Player Visibility'
      lore:
        - '&8&nToggle'
        - ''
        - ' &fHide surrounding players'
        - ' &ffor maximum FPS boost.'
        - ''
        - ' %status%'
        - ''
        - '&#10B985&nClick to Toggle'
    night-vision-goggles:
      material: GOLDEN_CARROT
      name: '&#F59E0BNight Vision'
      lore:
        - '&8&nToggle'
        - ''
        - ' &fToggle continuous'
        - ' &ffull-bright vision.'
        - ''
        - ' %status%'
        - ''
        - '&#F59E0B&nClick to Toggle'
```

***

## Messages Configuration

**Small Caps (Recommended)**

```yaml messages.yml (Small Caps) theme={null}
success:
  reload: " &l&#10B985sᴜᴄᴄᴇss &#64748B• &fConfiguration reloaded. &#64748B(%time%)"
  wiped-settings: " &l&#10B985sᴜᴄᴄᴇss &#64748B• &fReset settings for &#10B985%player%"

error:
  player-only: " &l&#EF4444ᴇʀʀᴏʀ &#64748B• &fThis command can only be executed by in-game players."
  no-permission: " &l&#EF4444ᴇʀʀᴏʀ &#64748B• &fYou do not have permission (settings.admin)."
  messages-disabled: " &l&#EF4444ᴇʀʀᴏʀ &#64748B• &fThat player has direct messages disabled."
  tpa-disabled: " &l&#EF4444ᴇʀʀᴏʀ &#64748B• &fThat player has teleport requests disabled."
  staff-messages-disabled: " &l&#EF4444ᴇʀʀᴏʀ &#64748B• &fYou have staff broadcasts disabled."
  command-blocked: " &l&#EF4444ᴇʀʀᴏʀ &#64748B• &fThis command is blocked by server security."
  cooldown: " &l&#EF4444ᴇʀʀᴏʀ &#64748B• &fPlease wait before toggling settings again."

system:
  setting-enabled: " &l&#10B985sᴜᴄᴄᴇss &#64748B• &fEnabled: &#10B985%setting%"
  setting-disabled: " &l&#EF4444ᴅɪsᴀʙʟᴇᴅ &#64748B• &fDisabled: &#EF4444%setting%"
  break-warning: " &l&#EF4444ᴀʟᴇʀᴛ &#64748B• &fYour tool is about to break! &#64748B(&#EF4444%percent%%%&#64748B)"
  ping-mention-chat: " &lB82F6ᴍᴇɴᴛɪᴏɴ &#64748B• B82F6%player% &fmentioned you in chat."
```

**Standard Font (Vanilla)**

```yaml messages.yml (Standard Font) theme={null}
success:
  reload: " &l&#10B985SUCCESS &#64748B• &fConfiguration reloaded. &#64748B(%time%)"
  wiped-settings: " &l&#10B985SUCCESS &#64748B• &fReset settings for &#10B985%player%"

error:
  player-only: " &l&#EF4444ERROR &#64748B• &fThis command can only be executed by in-game players."
  no-permission: " &l&#EF4444ERROR &#64748B• &fYou do not have permission (settings.admin)."
  messages-disabled: " &l&#EF4444ERROR &#64748B• &fThat player has direct messages disabled."
  tpa-disabled: " &l&#EF4444ERROR &#64748B• &fThat player has teleport requests disabled."
  staff-messages-disabled: " &l&#EF4444ERROR &#64748B• &fYou have staff broadcasts disabled."
  command-blocked: " &l&#EF4444ERROR &#64748B• &fThis command is blocked by server security."
  cooldown: " &l&#EF4444ERROR &#64748B• &fPlease wait before toggling settings again."

system:
  setting-enabled: " &l&#10B985SUCCESS &#64748B• &fEnabled: &#10B985%setting%"
  setting-disabled: " &l&#EF4444DISABLED &#64748B• &fDisabled: &#EF4444%setting%"
  break-warning: " &l&#EF4444ALERT &#64748B• &fYour tool is about to break! &#64748B(&#EF4444%percent%%%&#64748B)"
  ping-mention-chat: " &lB82F6MENTION &#64748B• B82F6%player% &fmentioned you in chat."
```

***

## Production Presets

**1. Competitive Practice / Crystal PvP Preset**

Maximizes packet throughput, activates extreme zero-delay crystal explosions, and enables sword combo hit-reg:

```yaml config.yml (Competitive PvP Tuning) theme={null}
optimizer-tuning:
  sword-pvp-optimizer: EXTREME
  crystal-pvp-optimizer: EXTREME
  anchor-pvp-engine: EXTREME
  ping-spoofer: OPTIMIZED
  allow-ultra-low-fps: true

defaults:
  player-visibility: true
  sword-pvp-optimizer: true
  crystal-pvp-optimizer: true
  fps-optimization: false
```

**2. Hub & SMP Social Focus Preset**

Optimized for multi-server lobbies, casual survival networks, and event broadcasts:

```yaml config.yml (Hub & SMP Preset) theme={null}
general:
  gui-cooldown-ms: 300
  lobby-speed-level: 2
  lobby-worlds:
    - hub
    - lobby
    - spawn

defaults:
  player-visibility: true
  lobby-speed-boost: true
  night-vision-goggles: true
  mention-sounds: true
  chat-colors: true
  break-warning: true
  sword-pvp-optimizer: false
  crystal-pvp-optimizer: false
```

**3. Lifesteal SMP High-Stakes Combat Preset**

Configured for high-stakes Lifesteal PvP where tool preservation, weapon hit registration, and ping compensation are critical:

```yaml config.yml (Lifesteal PvP Tuning) theme={null}
optimizer-tuning:
  sword-pvp-optimizer: EXTREME
  crystal-pvp-optimizer: BALANCED
  anchor-pvp-engine: BALANCED
  ping-spoofer: OPTIMIZED
  allow-ultra-low-fps: true

defaults:
  player-visibility: true
  sword-pvp-optimizer: true
  crystal-pvp-optimizer: false
  break-warning: true # Essential to prevent losing valuable maxed Netherite swords
  mention-sounds: true
  chat-colors: true
```

**4. OP Prison Maximum Mining FPS Preset**

Eliminates client-side stutter from explosive pickaxe enchantments, massive block break packets, and multiplier spam:

```yaml config.yml (OP Prison Performance Tuning) theme={null}
optimizer-tuning:
  sword-pvp-optimizer: OFF
  crystal-pvp-optimizer: OFF
  anchor-pvp-engine: OFF
  allow-ultra-low-fps: true # Enables aggressive entity and particle culling for explosive enchants

defaults:
  player-visibility: false # Hides other miners in crowded mine areas
  fps-optimization: true
  break-warning: false
  mention-sounds: false
  chat-colors: true
```

**5. Anarchy Uncapped Crystal Combat Preset**

Tuned for pure Anarchy servers where crystal placement speed, zero-delay anchor explosions, and maximum packet throughput dictate survival:

```yaml config.yml (Anarchy Combat Tuning) theme={null}
optimizer-tuning:
  sword-pvp-optimizer: EXTREME
  crystal-pvp-optimizer: EXTREME
  anchor-pvp-engine: EXTREME
  ping-spoofer: OFF
  allow-ultra-low-fps: true

defaults:
  player-visibility: true
  sword-pvp-optimizer: true
  crystal-pvp-optimizer: true
  fps-optimization: false
  break-warning: true
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.