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

# Commands & Permissions

> A comprehensive guide to SentryWipe's core features, commands, and permissions.

SentryWipe is an advanced player data wipe solution packed with features to make server management safe and effortless.

## Core Features

SentryWipe goes beyond basic commands, offering robust systems to automate and safeguard your data:

> **Preset Wiping Engine**
>
> Wipe specific data points using fully customizable presets (`soft`, `full`, `seasonal`). Control exactly what gets deleted: inventory, XP, advancements, homes, third-party plugin data, and more.

> **Backup & Undo System**
>
> Every wipe automatically creates a backup (stored in FILE or Database). Made a mistake? Easily restore player data using `/wipe undo`.

> **Auto-Purge Inactive Players**
>
> Keep your server optimized. Automatically wipe players who haven't logged in for a configurable amount of days, using your preferred preset.

> **Discord Webhooks**
>
> Keep your staff team informed. Broadcast wipe logs and administrative actions directly to a Discord channel via beautiful embeds.

***

## Commands

All SentryWipe commands are restricted to Server Operators (`op`) by default.

### Management Commands

**/wipe** `Command`

The primary entry point for SentryWipe. Opens the interactive GUI for in-game players or prints help to console.

**Details**

* **Permission:** `sentrywipe.use`
* **Aliases:** `/sw`, `/sentrywipe`

**/wipe \<player> \[preset] \[reason]** `Command`

Executes a wipe sequence targeting a specific player. If no preset is specified, uses the configured default preset.

**Examples:**

* `/wipe Notch` - Opens confirmation prompt or applies default preset.
* `/wipe Notch soft Duplicate Exploit` - Applies the `soft` preset with a logged audit reason.
* `/wipe Notch full confirm` - Bypasses safety prompts and instantly executes a `full` wipe.

**Details**

* **Permission:** `sentrywipe.use`

**/wipe undo|redo \[count]** `Command`

Leverages the Backup Manager to reverse or re-apply recent wipes directly from database logs.

**Examples:**

* `/wipe undo` - Reverses the most recent wipe action.
* `/wipe undo 5` - Undoes the last 5 wipe actions sequentially.

**Details**

* **Permission:** `sentrywipe.use`

**/softwipe \<player> \[reason]** `Command`

Shortcut command to execute a safe reset using the `soft` preset without altering economy balances or ranks.

**Details**

* **Permission:** `sentrywipe.use`

**/wipeall \<confirm>** `Command`

Initiates a global reset across all online players. Requires explicit confirmation.

**Details**

* **Permission:** `sentrywipe.wipeall`
* **Warning:** Clears data for all active players.

### Administrative Utilities

**/wipe reload \[file|all]** `Command`

Hot-reloads configuration files (`config`, `gui`, `messages`, `presets`, `hooks`, or `all`) with sub-millisecond execution timing feedback.

**Details**

* **Permission:** `sentrywipe.use`

**/wipe broadcast** `Command`

Dynamically toggles global wipe announcements on or off without opening `messages.yml`.

**Details**

* **Permission:** `sentrywipe.admin`

**/wipe stats** `Command`

Opens the global statistics GUI showing total wipes, economy reclaimed, and disk storage freed.

**Details**

* **Permission:** `sentrywipe.use`

**/wipe cancel** `Command`

Cancels any active player search query or filter in the player selector GUI.

**Details**

* **Permission:** `sentrywipe.use`

***

## Wipe Presets

When using the `/wipe` command, you can specify a **preset** defined in your `presets.yml`. Presets control exactly what data points are cleared.

> **Full Wipe (Default: full)**
>
> Completely resets the player's progression.
>
> * **Minecraft Data**: Inventory, Ender Chest, XP, Health, Food, Potions, Stats, Advancements, Playerdata file, Bedspawns.
> * **Plugin Hooks**: Essentials (homes, balance), LuckPerms, CMI.

> **Soft Wipe (Default: soft)**
>
> A gentle reset, often used for punishments or specific bug fixes.
>
> * **Cleared**: Inventory, Ender Chest, XP, Health, Food, Potions.
> * **Preserved**: Money/Balance, Homes, Stats, Advancements, Playerdata, Plugin Hooks.

> **Seasonal Wipe (Default: seasonal)**
>
> Designed for season resets where some cosmetics or stats might be kept.
>
> * **Cleared**: Inventory, Ender Chest, XP, Health, Food, Balance, Advancements, Essentials.
> * **Preserved**: Homes, Playerdata (for world generation logic).

***

## Permission Nodes

| Permission Node | Default | Description |
| :- | :- | :- |
| `sentrywipe.use` | `op` | Allows access to primary commands (`/wipe`, `/sw`, `/softwipe`), GUI selector, and reload. |
| `sentrywipe.admin` | `op` | Grants administrative command access, including `/wipe broadcast`. |
| `sentrywipe.wipeall` | `op` | Grants permission to execute a global server wipe via `/wipeall`. |
| `sentrywipe.bypass.purge` | `none` | Players with this permission are protected from the Auto-Purge system. |


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