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

> How to set up SentryPremades using the one-click Auto-Installer or manual file deployment.

SentryPremades can be set up in under two minutes using our automated installer utility or via traditional drag-and-drop manual installation.

***

## Server Requirements

Before installing, ensure your server environment meets the following specifications:

| Requirement | Supported Versions | Notes |
| :- | :- | :- |
| **Java Runtime** | Java 21 or higher | Required by modern 1.21+ server software. |
| **Server Software** | Paper, Purpur, or Folia | Minecraft 1.21.x supported. |
| **Memory** | 2 GB+ minimum | Scaled based on server player count. |
| **Optional Integrations** | ItemsAdder, Nexo, MythicMobs | Soft-dependencies; automatically enabled if present. |

***

## Installation Methods

Choose your preferred installation pathway below:

**Auto-Installer (Recommended)**

When you purchase a Sentry premade addon package (such as *Overcharge*), you receive an automated setup utility jar. This utility handles engine downloads and license configuration automatically on server boot.

**1. Place Installer in Plugins**

Drop the downloaded installer `.jar` directly into your server's `plugins/` directory.

**2. Start Your Server**

Boot or restart your server. During startup, the installer performs three automated steps:

* Automatically downloads the latest `SentryPremades.jar` engine into your `plugins/` folder.
* Automatically configures your product license key in `plugins/SentryPremades/config.yml`.
* Generates the default trust list storage configuration.

**3. Review Startup Logs & Clean Up**

Once initialized, the installer logs a confirmation message to your server console:

```log theme={null}
[PremadeInstaller] Installing SentryPremades...
[PremadeInstaller] Configuring SentryPremades...
[PremadeInstaller] Restart your server for changes.
[PremadeInstaller] You can now delete the auto installer located in plugins/OverchargeInstaller.jar.
```

**4. Final Restart**

Safely delete the one-time installer `.jar` from your `plugins/` directory, then restart your server to launch the configured engine.

**Manual Setup**

If your server environment restricts outbound network requests or you prefer full manual control:

**1. Download Jars**

Acquire `SentryPremades.jar` and your premade addon jar (e.g., `Overcharge.jar`).

**2. Deploy to Plugins**

Copy both files into your server's `plugins/` directory.

**3. Generate Configuration**

Start your server once to generate the default configuration directory at `plugins/SentryPremades/`.

**4. Add Your License Key**

Open `plugins/SentryPremades/config.yml` in a text editor and add your product license to the `licenses` list:

```yaml plugins/SentryPremades/config.yml theme={null}
licenses:
  - "overcharge:YOUR_LICENSE_KEY_HERE"

trust-database: yaml:trustlists.yml
```

**5. Restart Server**

Restart your server to activate all premades and verify licensing.

***

## Configuration Reference

The primary configuration file is located at `plugins/SentryPremades/config.yml`:

```yaml plugins/SentryPremades/config.yml theme={null}
# Product license entries for your active premade addons
licenses:
  - "overcharge:YOUR_LICENSE_KEY_HERE"

# Storage backend for player party / trust lists
trust-database: yaml:trustlists.yml
```

**licenses** `list of strings` *required*

The list of active addon licenses formatted as `productId:licenseKey`. If using the Auto-Installer, your license is injected here automatically.

**trust-database** `string` (default: yaml:trustlists.yml)

Defines where player trust lists are persisted. Accepts local flatfile storage (`yaml:trustlists.yml`) or network database connection strings.

***

## Verifying Installation

To verify that SentryPremades and your addons loaded successfully, run the following command in your server console:

```shell theme={null}
premades reload
```

If successful, the console will return:

```log theme={null}
[SentryPremades] [SUCCESS] • Reload done!
```

You are now ready to execute abilities and configure your integrations!


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