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

> Learn how to install and set up SentryWipe on your Paper server.

Welcome to SentryWipe! This guide will walk you through the installation process for adding SentryWipe to your Paper server.

## Prerequisites

Before installing SentryWipe, ensure your server meets the following requirements:

* **Server Software**: PaperMC (or a fork like Purpur).
* **Minecraft Version**: 1.20 or higher.
* **Java Version**: Java 17 or higher.

### Recommended Plugins (Optional)

SentryWipe integrates seamlessly with several popular plugins. While not strictly required, we highly recommend installing:

* [**Vault**](https://www.spigotmc.org/resources/vault.34315/)
* [**EssentialsX**](https://essentialsx.net/)
* [**LuckPerms**](https://luckperms.net/)
* [**PlaceholderAPI**](https://www.spigotmc.org/resources/placeholderapi.6245/)

## Installation Steps

1. **Download the Plugin** Obtain the latest `SentryWipe.jar` file from your Sentry Studios dashboard or the official resource page.
2. **Upload to Server** Navigate to your server's `plugins` folder and drop the `SentryWipe.jar` file inside.
3. **Restart the Server** Start or restart your server. **Avoid using `/reload` or plugman to load the plugin for the first time**, as this can cause configuration generation issues.
4. **License Configuration** After the first boot, a new folder named `SentryWipe` will be created in your `plugins` directory.
   * Open `plugins/SentryWipe/license.yml`.
   * Enter your `license-key` provided upon purchase.
   * Restart the server one more time to authenticate the plugin.

## Next Steps

Now that SentryWipe is installed, you should configure your database and customize your wipe settings!

<CardGroup cols={2}>
  <Card title="Database Setup" icon="database">
    Configure MySQL, SQLite, or MongoDB for your wipe logs.
  </Card>

  <Card title="Commands & Permissions" icon="user-shield">
    Learn about the available commands and their required permissions.
  </Card>
</CardGroup>