> For the complete documentation index, see [llms.txt](https://kammoun.gitbook.io/adminpanel/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kammoun.gitbook.io/adminpanel/getting-started/readme.md).

# Introduction

**AdminPanel** is a comprehensive staff management plugin for Minecraft servers (Paper, Folia, and Velocity). It provides a fully GUI-driven workflow so your moderation team can manage players, punishments, ranks, inventory snapshots, security, and server performance — all from within the game, without typing long commands.

***

## Key Features

| Category                | What it does                                                           |
| ----------------------- | ---------------------------------------------------------------------- |
| **Moderation**          | Ban, mute, kick, warn players using templates and a history log        |
| **Player Control**      | Freeze suspects, go vanish, change gamemode, heal/feed, teleport       |
| **Inventory Rollback**  | Automatic snapshots on death or quit; restore full/partial backups     |
| **Security**            | Detect alt accounts, scan for illegal items, flag duplication patterns |
| **Ranks & Permissions** | Manage LuckPerms groups and permissions from an in-game GUI            |
| **Staff Tools**         | Staff mode (godmode + fly), staff-only chat, action-bar indicators     |
| **Anti-Cheat**          | Receive and review GrimAC / Vulcan alerts in a dedicated panel         |
| **Performance**         | Monitor TPS, memory, entities, redstone activity, and world stats      |
| **X-Ray Tracker**       | Detect suspicious mining patterns per player and per world             |

***

## Platform & Requirements

| Requirement         | Details                |
| ------------------- | ---------------------- |
| **Server software** | Paper 1.21+, or Folia  |
| **Java**            | 21 or newer            |
| **API version**     | 1.16+                  |
| **Folia support**   | Yes (not fully tested) |

### Optional integrations

AdminPanel auto-detects the following plugins when they are present:

* **LuckPerms** — rank/permission management
* **LiteBans** or **AdvancedBans** — punishment history and action integration
* **GrimAC** or **Vulcan** — anti-cheat alert forwarding
* **ProtocolLib** — required by some advanced GUI features
* **PlaceholderAPI** — placeholder support in messages

***

## Quick Navigation

* New to the plugin? Start with [Installation](/adminpanel/getting-started/installation.md).
* Need to configure the database or integrations? See [Configuration](/adminpanel/getting-started/configuration.md).
* Looking for a specific command? See [Commands](/adminpanel/reference/commands.md).
* Want to restrict what each staff rank can do? See [Permissions](/adminpanel/reference/permissions.md).