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

# Features & Commands

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

<CardGroup cols={2}>
  <Card title="Preset Wiping Engine" icon="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.
  </Card>

  <Card title="Backup & Undo System" icon="rotate-left">
    Every wipe automatically creates a backup (stored in FILE or Database). Made a mistake? Easily restore player data using `/wipe undo`.
  </Card>

  <Card title="Auto-Purge Inactive Players" icon="broom">
    Keep your server optimized. Automatically wipe players who haven't logged in for a configurable amount of days, using your preferred preset.
  </Card>

  <Card title="Discord Webhooks" icon="discord">
    Keep your staff team informed. Broadcast wipe logs and administrative actions directly to a Discord channel via beautiful embeds.
  </Card>
</CardGroup>

***

## Commands

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

### General Commands

<ResponseField name="/sw" type="Command">
  The main command for SentryWipe. Displays the help menu or opens the interactive GUI to manage player wipes visually.

  <Expandable title="Details">
    * **Permission:** `sentrywipe.use`
    * **Aliases:** `/sentrywipe`
  </Expandable>
</ResponseField>

### Wiping Commands

<ResponseField name="/wipe <player> [preset|confirm]" type="Command">
  The primary management command to reset a player's data.

  **Examples:**

  * `/wipe Notch` - Opens a prompt or uses the default wipe.
  * `/wipe Notch soft` - Wipes Notch using the `soft` preset.
  * `/wipe Notch full confirm` - Bypasses safety prompts and instantly executes a `full` wipe.

  <Expandable title="Details">
    - **Permission:** `sentrywipe.use`
  </Expandable>
</ResponseField>

<ResponseField name="/wipe undo|redo [count]" type="Command">
  Leverages the Backup Manager to reverse recent wipes.

  **Examples:**

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

  <Expandable title="Details">
    - **Permission:** `sentrywipe.use`
  </Expandable>
</ResponseField>

<ResponseField name="/softwipe <player>" type="Command">
  A shortcut command to execute a safe, quick reset on a player without triggering a full wipe. This automatically uses the `soft` preset.

  <Expandable title="Details">
    * **Permission:** `sentrywipe.use`
  </Expandable>
</ResponseField>

<ResponseField name="/wipeall <host>" type="Command">
  Initiates a global reset for all online players. **Requires confirmation** to prevent accidental data loss.

  <Expandable title="Details">
    * **Permission:** `sentrywipe.wipeall`
    * **Warning:** Use with extreme caution. This will iterate through all players and apply the configured default wipe.
  </Expandable>
</ResponseField>

***

## Wipe Presets (What Gets Wiped?)

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

<AccordionGroup>
  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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).
  </Accordion>
</AccordionGroup>

***

## Permissions List

| Permission Node           | Default | Description                                                                             |
| ------------------------- | ------- | --------------------------------------------------------------------------------------- |
| `sentrywipe.use`          | `op`    | Allows access to primary SentryWipe features, including `/sw`, `/wipe`, and GUI access. |
| `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.                  |