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

Welcome to the comprehensive deployment guide for the **Sentry Studios** platform. Whether you are running a single competitive SMP or a multi-region BungeeCord/Velocity network, this guide covers environmental prerequisites, directory structure, licensing, and database configuration.

***

## System Prerequisites

Before installing any Sentry Studios assets, please verify that your server environment meets our baseline technical requirements:

Java 17 / 21 TargetFolia Multi-ThreadedPaper / Purpur 1.20 - 1.21.4

> [!WARNING]
>
> **Java Runtime:** All Sentry plugins strictly require **Java 17** or **Java 21**. Running on older runtimes (Java 8 or 11) will throw an immediate `UnsupportedClassVersionError` and halt startup.

> **Server Platform**
>
> Native support for **PaperMC**, **Purpur**, and **Folia** (1.20.x through 1.21.x).

> **Dependencies**
>
> **Vault** (economy wipes), **ProtocolLib** (SentrySettings packet engine), and **LuckPerms**.

> **Database Engines**
>
> Zero-config embedded **H2** or multi-server connection pooling on **MySQL 8.0+** / **MariaDB**.

***

## Standard Installation

**1. Acquire Licensed Binaries**

Download the latest production `.jar` releases from the Sentry Studios Client Portal or BuiltByBit.

**2. Deploy to Plugins Directory**

Transfer the jars to `/plugins` using SFTP or your server management console (e.g. Pterodactyl, Multicraft).

**3. Install Companion Dependencies**

Ensure necessary companion dependencies are present based on your chosen suite:

| Feature / Resource | Required Companion Plugin | Requirement Level |
| :- | :- | :- |
| SentrySettings PvP Optimizers | **ProtocolLib** (v5.1.0+) | Mandatory |
| SentryWipe Economy Reset | **Vault** + Economy Provider (EssentialsX, CMI) | Mandatory |
| Dynamic UI Menus | **DeluxeMenus** + **PlaceholderAPI** | Recommended |
| Permission Node Enforcement | **LuckPerms** | Recommended |

**4. First Boot & Licensing**

Start your server. Upon first boot, each plugin contacts the Sentry licensing cluster to validate your license key, generates embedded database tables, and produces default configuration trees:

```text Server Console theme={null}
Verifying license key (timeout 3s)...
License verified! Thank you for supporting Sentry Studios.
Dependencies checked: Vault, LuckPerms, PlaceholderAPI
[SentryWipe] Enabled v1.0.0 (HWID: e3b0c44298fc1c14) [Hooks: Vault, PlaceholderAPI]
[SentrySettings] Enabled v1.0.0 (HWID: e3b0c44298fc1c14) [Hooks: ProtocolLib, PlaceholderAPI]
[SentryLore] Enabled v1.0.0 (HWID: e3b0c44298fc1c14) [Hooks: PlaceholderAPI]
```

***

## Recommended Directory Layout

A production-ready server running the Sentry suite will have a clean, modular file structure:

**plugins**

**DeluxeMenus**

**config.yml**

**gui\_menus**

**stats.yml**

**afk\_rewards.yml**

**server\_navigation.yml**

**PlaceholderAPI.jar**

**ProtocolLib.jar**

**SentryLore**

**config.yml**

**messages.yml**

**license.yml**

**menu**

**gui.yml**

**SentrySettings**

**config.yml**

**messages.yml**

**license.yml**

**menu**

**gui.yml**

**SentryWipe**

**backups**

**inventories**

**config.yml**

**gui.yml**

**hooks.yml**

**license.yml**

**messages.yml**

**presets.yml**

**Vault.jar**

***

## Database Architecture: H2 vs MySQL

All Sentry products feature unified storage abstraction. Choose the engine best tailored for your architecture:

**H2 Embedded (Single Server)**

**Zero Configuration Required.** H2 is a high-performance, embedded relational database that runs inside your server process without requiring an external MySQL server. It creates a local `.mv.db` file in the plugin data folder.

```yaml config.yml theme={null}
database:
  type: "H2" # Options: H2, MYSQL, SQLITE
```

* **Pros:** Ultra-fast, zero maintenance, native memory caching, immune to external network drops.
* **Best for:** Factions, Survival, Skyblock, Prison, or standalone competitive servers.

**MySQL / MariaDB (Network Sync)**

**Network-Wide Synchronization.** Synchronizes player settings, lore registries, and wipe audit logs across all servers connected to your BungeeCord or Velocity proxy.

```yaml config.yml theme={null}
database:
  type: "MYSQL"
  mysql:
    host: "127.0.0.1"
    port: 3306
    database: "sentry_network"
    username: "sentry_user"
    password: "your_secure_password"
    useSSL: false
```

* **Pros:** Global real-time synchronization, centralized audit tables, web dashboard compatibility.
* **Best for:** Multi-lobby networks, hub clusters, proxy-connected servers.

***

## Common Setup Pitfalls

> **Plugin fails on startup with UnsupportedClassVersionError**
>
> Your startup script or Docker container is running Java 8 (version 52) or Java 11 (version 55). Update your environment flags or container image to Java 17 (version 61) or Java 21 (version 65).

> **SentrySettings fails with ClassNotFoundException: com.comphenix.protocol...**
>
> SentrySettings requires **ProtocolLib** to operate its client-side packet filters and PvP latency optimizers. Download the latest dev build of ProtocolLib compatible with your server version.

> **Placeholders appearing as raw %sentrywipe\_...% or %sentrysettings\_...%**
>
> Ensure **PlaceholderAPI** is installed and active. Sentry plugins hook into PAPI on startup automatically. Run `/papi ecloud download Server` and `/papi reload` to ensure base expansions are loaded.

***

## Official Community & Support

Need assistance configuring your server or integrating custom hooks? Join our verified Discord community or submit a ticket:

> **[Discord Community](https://discord.com/invite/wN2ExrSkS4)**
>
> Chat with active server owners, access configuration guides, and report issues.

> **[Open a Support Ticket](https://discord.com/invite/wN2ExrSkS4)**
>
> Receive direct 1-on-1 developer support for enterprise setups and licensing questions.


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