> ## 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 deploy SentryWipe on Paper, Purpur, or Folia with database persistence and licensing.

Welcome to the **SentryWipe** installation guide. SentryWipe provides selective player data resets, automated inventory backups, and multi-plugin integration.

***

## System Prerequisites

Java 17 / 21 TargetFolia CompatiblePaper / Purpur 1.20 - 1.21.4

> [!WARNING]
>
> **Java Runtime:** SentryWipe compiled targets require **Java 17** or **Java 21**. Running on older runtimes will cause an immediate startup crash.

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

> **Economy (Optional)**
>
> Install **Vault** plus an economy provider (EssentialsX, CMI, etc.) to enable balance resets.

> **Permissions (Optional)**
>
> Install **LuckPerms** to enable automated rank and group stripping during full wipes.

> **Storage Engines**
>
> Choose zero-configuration embedded **H2** storage or network-wide **MySQL / MariaDB** connection pooling.

***

## Installation Steps

**1. Download SentryWipe Binary**

Acquire the latest `SentryWipe.jar` from your BuiltByBit purchases or the Sentry Studios Client Portal.

**2. Upload to Plugins Directory**

Transfer `SentryWipe.jar` into your server root's `/plugins` folder:

**plugins**

**SentryWipe.jar**

**Vault.jar (optional)**

**LuckPerms.jar (optional)**

**3. Reboot Server**

Restart your server. Avoid using `/reload` or PlugMan; a clean reboot ensures the event pipeline and Folia region schedulers initialize safely.

**4. Verify In-Game Functionality**

Join the server and type `/wipe` to verify that the interactive player selector or help menu displays without errors:

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

***

## Next Steps

> **[Configuration Guide](https://docs.sentrystudios.org/sentry-wipe/configuration.md)**
>
> Configure your database connection, auto-purge intervals, and Discord webhooks.

> **[Commands & Permissions](https://docs.sentrystudios.org/sentry-wipe/commands.md)**
>
> Master the modular wiping engine, undo/redo sessions, and staff permission nodes.


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