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

# Quick Start

> Deploy Sentry Studios plugins and configurations on your Minecraft server in under 5 minutes.

Welcome to **Sentry Studios**. Our software is built from the ground up for modern high-performance Minecraft platforms (Paper, Purpur, and Folia). This guide walks you through the initial setup from jar placement to live verification.

***

## Fast Deployment

**1. Verify Java & Platform Runtime**

Confirm that your server environment is running **Java 17** or **Java 21** on **Paper**, **Purpur**, or **Folia** (1.20.x - 1.21.x).

Java 17 / 21Folia CompatiblePaper 1.20 - 1.21.4

> [!WARNING]
>
> Java 8 and Java 11 are strictly incompatible. Compilations utilize modern JVM bytecode features and will crash immediately on startup if launched on outdated runtimes.

**2. Download Licensed Jars**

Obtain your licensed `.jar` binaries directly from the **Sentry Studios Client Portal** or your **BuiltByBit** purchases dashboard.

**3. Drop Into Plugins Directory**

Transfer the jar files into your server root's `/plugins` folder via SFTP or your server management panel:

**server**

**cache**

**config**

**logs**

**plugins**

**SentryWipe.jar**

**SentryLore.jar**

**SentrySettings.jar**

**paper.jar**

**4. Install Core Dependencies**

Install the required and recommended companion plugins for maximum compatibility:

| Plugin | Requirement Level | Purpose |
| :- | :- | :- |
| **Vault (Universal economy provider abstraction for balance wipes)** | Mandatory for Economy | Unlocks balance wipes and financial hooks |
| **LuckPerms (Industry-standard permissions engine for Minecraft)** | Strongly Recommended | Complete permission node enforcement |
| **ProtocolLib (Raw Netty packet manipulation engine for zero-delay PvP)** | Required for SentrySettings | High-speed network packet optimization |
| **PlaceholderAPI (Placeholder expansion system for dynamic GUI lore)** | Recommended | Dynamic live data placeholders in GUIs and tablists |

**5. Boot & Generate Configurations**

Start your server. Each Sentry plugin will validate its environment, create embedded database tables (`H2` / `SQLite`) or connect to `MySQL`, and populate 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]
```

***

## Explore Our Product Ecosystem

Jump directly into the dedicated documentation for your installed resources:

> **[SentryWipe](https://docs.sentrystudios.org/sentry-wipe/installation.md)**
>
> Automated and surgical player data wipes, inventory zip backups, and multi-plugin hooks.

> **[SentryLore](https://docs.sentrystudios.org/sentry-lore/installation.md)**
>
> Dynamic RPG lore engine, 51-painting canvas catalog, live item editor, and NBT dupe protection.

> **[SentrySettings](https://docs.sentrystudios.org/sentry-settings/installation.md)**
>
> Zero-latency `/settings` GUI, crystal and sword PvP packet optimizers, and multi-server sync.

> **[SentryPremades](https://docs.sentrystudios.org/sentry-premades/templates.md)**
>
> Plug-and-play abilities and triggers mapped directly to ItemsAdder, Oraxen, and MythicMobs.

***

## Common Setup Pitfalls

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

> **Database connection timeout with MySQL**
>
> Ensure your MySQL port (default `3306`) is accessible from your server container, and verify credentials inside `config.yml`. If running a single standalone server, switch `database.type: "H2"` for zero-configuration embedded storage.

> **Are Folia servers fully supported?**
>
> Yes. Every Sentry plugin is designed with native region-scheduler threading (`FoliaUtil`) and does not rely on blocked Bukkit scheduling loops.

***

## AI Assistant Integration

Install the SentryStudios skill into your AI coding assistant

npx skills add [https://sentrystudios.org/docs](https://sentrystudios.org/docs)


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