> ## 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 & Use Cases

> A deep dive into the powerful features of SentryWipe, automated inventory backups, and real-world administrative use cases.

SentryWipe is much more than a simple command to delete player data. It is an enterprise administration suite designed to handle everything from surgical economy rollbacks to network-wide seasonal resets with instant automated rollback safety.

***

## Modular Wiping Engine

Unlike legacy wiping scripts that act as a blunt hammer by deleting entire `.dat` files, SentryWipe operates with surgical precision. Server administrators can wipe 18 distinct components individually or bundle them into reusable presets.

> **Preset Wipes**
>
> Pre-define modular wipe templates in `presets.yml` (e.g. `soft`, `full`, `seasonal`, `combat_reset`) to standardize administration across your staff team.

> **Interactive GUI Wipes**
>
> Open the in-game GUI (`/wipe <player>`) to selectively toggle individual data categories on or off with instant visual feedback before confirming.

![SentryWipe Main GUI](https://mintcdn.com/sentrystudios/FMIaJt_G0MJ4Ro6T/images/wipe_menu.png?fit=max\&auto=format\&n=FMIaJt_G0MJ4Ro6T\&q=85\&s=832797bbe2016c9ee2084c03f3b06dae)

### Granular Wipe Components

When executing a custom or preset wipe, SentryWipe can target any combination of the following components:

| Category | Type | Targeted In-Game Data |
| :- | :- | :- |
| `inventory` | Destructive | Clears all 36 player inventory slots, armor slots, and off-hand. |
| `ender_chest` | Destructive | Clears the 27-slot player ender chest storage. |
| `economy` / `balance` | Economy | Wipes player balance to `$0` or default start balance via Vault. |
| `xp` | Progress | Resets player XP level and progress bar back to `0`. |
| `health` / `food` | State | Restores health to 20.0, food level to 20, and saturation to 20.0. |
| `potions` | Combat | Clears all active potion effects (positive and negative). |
| `cooldowns` | Combat | Resets material cooldowns (`ENDER_PEARL`, `CHORUS_FRUIT`, `SHIELD`, `WIND_CHARGE`, `MACE`). |
| `ender_pearls` | Combat | Removes any currently in-flight thrown pearls belonging to the player. |
| `bedspawn` | World | Clears personal bed respawn coordinates, redirecting to world spawn. |
| `vehicles` | World | Ejects player from mounts or minecarts and removes the entity. |
| `velocity` / `fire` | State | Extinguishes active fire ticks and resets velocity vectors to zero. |
| `stats` | Data | Clears untyped statistics in `stats/<uuid>.json`. |
| `advancements` | Data | Clears advancement achievements in `advancements/<uuid>.json`. |

***

## Automated Inventory Backups & Instant Restore

Every destructive action in SentryWipe is protected by an automated backup layer. Before any player data is modified or purged, SentryWipe captures a complete snapshot of the target player's inventory, armor, and ender chest.

```mermaid theme={null}
sequenceDiagram
    autonumber
    actor Admin as Staff / Server Admin
    participant Core as SentryWipe Engine
    participant Backup as Backup Manager
    participant Disk as Storage (YAML / DB)
    participant Target as Target Player State
    participant Discord as Discord Webhook

    Admin->>Core: /wipe <player> soft
    Core->>Backup: Request Pre-Wipe Snapshot
    Backup->>Disk: Write <uuid>_<timestamp>.yml
    Disk-->>Backup: Snapshot Verified
    Core->>Target: Execute Surgical Component Purge
    Core->>Discord: Send Embed Notification (Audit Log)
    Core-->>Admin: Success Toast & Undo Token Active
    opt Accidental Wipe Reversal
        Admin->>Core: /wipe undo
        Core->>Backup: Load Last Snapshot
        Backup->>Target: Restore Inventory & Ender Chest
        Core-->>Admin: Player Restored Successfully
    end
```

![SentryWipe Saved Backups GUI](https://mintcdn.com/sentrystudios/FMIaJt_G0MJ4Ro6T/images/wipe_backups.png?fit=max\&auto=format\&n=FMIaJt_G0MJ4Ro6T\&q=85\&s=169922aea5005a85b90b1a81f1c03bf3)

### How Backup Safety Works

**1. Pre-Wipe Snapshot**

Before executing `/wipe`, a timestamped YAML backup is written to `plugins/SentryWipe/backups/inventories/<uuid>_<timestamp>.yml`.

**2. In-Game Browser**

Staff can click the **Saved Backups** ender chest (Slot 16 in `/wipe`) to view all historical snapshots taken for that player.

**3. One-Click Restore**

Clicking a backup file instantly restores the player's items into their inventory. If the player is offline, a persistent restore marker is queued and applied automatically when they next connect.

**4. Instant Command Rollback**

If a staff member makes an accidental wipe, simply run `/wipe undo` to reverse the most recent operation in seconds.

![SentryWipe Undo Notification](https://mintcdn.com/sentrystudios/FMIaJt_G0MJ4Ro6T/images/wipe_undo.png?fit=max\&auto=format\&n=FMIaJt_G0MJ4Ro6T\&q=85\&s=3bb10de02363944f0939705282610cfc)

***

## Real-World Use Cases

### Use Case A: Duplication Exploit Containment (Soft Wipe)

A duplication glitch was discovered in an economy plugin. Rather than punishing legitimate builders by wiping whole worlds, run a targeted `economy_reset` preset that strips only `inventory`, `ender_chest`, and `balance` while leaving player ranks, homes, and statistics intact.

![SentryWipe Presets GUI](https://mintcdn.com/sentrystudios/FMIaJt_G0MJ4Ro6T/images/wipe_presets.png?fit=max\&auto=format\&n=FMIaJt_G0MJ4Ro6T\&q=85\&s=ac780cf3f9c84dc2e746d7daa2cf26ae)

### Use Case B: Banned Exploiter Purge (Nuclear Wipe)

A malicious player has been permanently banned for severe hacking. Running `/wipe <player> full` completely clears their inventory, wipes their Vault balance, resets their Essentials homes, removes their LuckPerms user groups, and purges their offline `.dat` files from disk.

![SentryWipe Confirmation GUI](https://mintcdn.com/sentrystudios/FMIaJt_G0MJ4Ro6T/images/wipe_confirm.png?fit=max\&auto=format\&n=FMIaJt_G0MJ4Ro6T\&q=85\&s=993dd3b9c439600c9b3fc15ea9f48282)

### Use Case C: Seasonal Network Reset (`/wipeall`)

When launching a new season or wipe cycle, execute:

```bash theme={null}
/wipeall confirm Season_4_Launch
```

SentryWipe will take an automated snapshot of all online players, purge the selected seasonal components asynchronously using `FoliaUtil`, and broadcast a customized announcement to the server and your Discord log channel.

![SentryWipe Chat Broadcast](https://mintcdn.com/sentrystudios/FMIaJt_G0MJ4Ro6T/images/wipe_chat.png?fit=max\&auto=format\&n=FMIaJt_G0MJ4Ro6T\&q=85\&s=e349175749f8b94703c6e5d8ded1ab94)


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