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

# Getting Started

> Comprehensive guide to deploying Sentry Studios resources, initial configuration, and setting up your environment.

<h2 id="prerequisites">
  System Prerequisites
</h2>

Before installing any Sentry Studios assets, please verify your server environment meets our minimum requirements to ensure optimal performance.

<Warning>
  **Java Requirement:** All compiled plugins strictly require **Java 17** or **Java 21**. Running on outdated Java runtimes (such as Java 8 or 11) will result in immediate startup failures.
</Warning>

<CardGroup cols={2}>
  <Card title="Recommended Software" icon="server" iconType="duotone">
    We highly recommend high-performance forks like [PaperMC](https://papermc.io), [Purpur](https://purpurmc.org), or Folia.
  </Card>

  <Card title="Required Dependencies" icon="puzzle-piece" iconType="duotone">
    Ensure you have [Vault](https://www.spigotmc.org/resources/vault.34315/) and a compatible permissions plugin (e.g., LuckPerms) installed.
  </Card>
</CardGroup>

***

<h2 id="installation-steps">
  Standard Installation
</h2>

<Steps>
  <Step title="Download Your Assets">
    Log in to your [BuiltByBit](https://builtbybit.com) account or the Sentry Studios client portal. Navigate to your purchases and download the latest `.jar` or `.zip` files.
  </Step>

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

  <Step title="Install External Dependencies (If Applicable)">
    If you are utilizing our custom GUIs, ensure you also install external dependencies:

    * [DeluxeMenus](https://www.spigotmc.org/resources/deluxemenus.11734/) for UI rendering
    * [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) for dynamic data injection
  </Step>

  <Step title="Restart & Verify">
    Restart your server. Check the console to verify that the plugins have successfully enabled and generated their default configuration folders.
  </Step>
</Steps>

***

<h2 id="directory-setup">
  Recommended Directory Setup
</h2>

For a fully integrated server utilizing our GUI configurations and plugins, your `/plugins` directory should resemble (**<u>NOT EXACT</u>**) the structure below:

<Tree>
  <Tree.Folder name="Vault (or any dependency)" />

  <Tree.Folder name="SentryWipe (example)" defaultOpen>
    <Tree.File name="config.yml" />

    <Tree.File name="licence.yml" />
  </Tree.Folder>
</Tree>

<h2 id="first-time-configuration">
  First-Time Configuration
</h2>

After your first startup, all configuration files will be generated in their respective plugin folders. Sentry Studios plugins are designed to be highly customizable.

<Tip>
  We utilize YAML (`.yml`) format for all configurations. Ensure you use strict spaces (not tabs) when modifying values. Use [YAML Checker](https://yamlchecker.com/) if you experience parsing errors.
</Tip>

To apply changes, you rarely need to restart your server. Use the designated reload commands (e.g., `/sentrywipe reload` or `/deluxemenus reload`) to apply UI and message changes instantly.

***

<h2 id="database-setup">
  Database Setup
</h2>

By default, all Sentry Studios resources utilize local **SQLite** storage for immediate, zero-configuration deployment.

For networks or large servers, we recommend migrating to **MySQL**:

1. Open the plugin's `config.yml`.
2. Locate the `database` section and change the type from `SQLITE` to `MYSQL`.
3. Input your host, port, username, password, and database name.
4. Restart the server. Data schemas will automatically be generated in your MySQL database.

***

<h2 id="troubleshooting">
  Troubleshooting
</h2>

<AccordionGroup>
  <Accordion title="Plugin fails to load on startup" icon="triangle-exclamation">
    The most common cause is an outdated Java version. Verify your server is running **Java 17** or **Java 21**. Use `java -version` in your console to confirm.
  </Accordion>

  <Accordion title="GUI menus aren't opening" icon="window-restore">
    Ensure **DeluxeMenus** is installed and that the menu files are properly registered in `DeluxeMenus/config.yml`. Check the console for any YAML parsing errors in the menu files.
  </Accordion>

  <Accordion title="Placeholders show up as %player_name% or %text%" icon="percent">
    This means the required **PlaceholderAPI** expansion isn't installed or PAPI hasn't been reloaded. Run `/papi ecloud download <ExpansionName>` followed by `/papi reload`.
  </Accordion>
</AccordionGroup>

***

<h2 id="getting-support">
  Getting Support
</h2>

If you encounter an issue that isn't covered in the documentation, our support team is ready to help.

<CardGroup cols={2}>
  <Card title="Discord Community" icon="discord" iconType="solid" href="https://discord.com/invite/wN2ExrSkS4">
    Join our Discord for community support, sneak peeks, and direct assistance.
  </Card>

  <Card title="Open a Ticket" icon="ticket" iconType="duotone" href="https://discord.com/invite/wN2ExrSkS4">
    For billing inquiries or complex technical issues, open a support ticket on our website.
  </Card>
</CardGroup>