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

# Installation

> Ultra-optimized personal preferences and server management tools.

Welcome to the **SentrySettings** documentation.

SentrySettings is an all-in-one personal preference menu and server optimization engine. It unifies essential features (like player visibility, night vision, and lobby speeds) into a single, lightning-fast GUI backed by database synchronization.

## System Prerequisites

<Warning>
  **Java Requirement:** SentrySettings requires **Java 17** or **Java 21**. Running on outdated Java runtimes (such as Java 8 or 11) will result in startup failures.
</Warning>

<CardGroup cols={2}>
  <Card title="Supported Platforms" icon="server" iconType="duotone">
    Fully supports Spigot, PaperMC, Purpur, and Folia (1.16 - 1.21).
  </Card>

  <Card title="ProtocolLib (Required)" icon="puzzle-piece" iconType="duotone">
    SentrySettings **requires** ProtocolLib to intercept and optimize network packets.
  </Card>
</CardGroup>

***

## Installation Steps

<Steps>
  <Step title="Download the Plugins">
    Navigate to your Sentry Studios client portal and download `SentrySettings.jar`. You must also download the latest version of [ProtocolLib](https://github.com/dmulloy2/ProtocolLib/releases).
  </Step>

  <Step title="Upload to Plugins Folder">
    Transfer both `.jar` files into your server's `/plugins` directory using SFTP or your server panel's file manager.

    <Tree />
  </Step>

  <Step title="Restart Your Server">
    Restart your server. We highly recommend doing a full server reboot rather than using `/reload` or PlugMan to ensure the packet optimizers hook safely into the server's network pipeline.
  </Step>

  <Step title="Verify Installation">
    Check the console to verify that the plugin has successfully enabled and generated its default `config.yml`. Once the server is online, log in and type `/settings` to see the GUI in action!
  </Step>
</Steps>

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="Plugin fails to load on startup" icon="triangle-exclamation" iconType="duotone">
    The most common cause is either an outdated Java version or a missing ProtocolLib dependency. Verify your server is running **Java 17+** and that `ProtocolLib.jar` is present in your plugins folder, or your license is incorrect.
  </Accordion>

  <Accordion title="Player Visibility toggle isn't working" icon="eye-slash" iconType="duotone">
    If players are still visible after toggling this setting, ensure that your server isn't running another plugin (like a Vanish or staff-mode plugin) that aggressively forces player visibility states and overrides SentrySettings.
  </Accordion>
</AccordionGroup>