> ## Documentation Index
> Fetch the complete documentation index at: https://perplayerkit.com/llms.txt
> Use this file to discover all available pages before exploring further.
# PerPlayerKit Quickstart: From Install to First Kit
> Install PerPlayerKit, set up your Kit Room, assign permissions, and have players creating custom PvP kits on your server in under 10 minutes.
This guide walks you through the entire process of going from a fresh server to a fully functional PerPlayerKit setup. By the end you will have the plugin installed, a Virtual Kit Room stocked with items, permissions assigned to your groups, and a working kit system that your players can start using immediately. The whole process takes under ten minutes.
## Setup Steps
Stop your server, then copy the `PerPlayerKit-x.x.x.jar` file into your `plugins/` folder. Start the server to let PerPlayerKit generate its configuration files, then stop the server again before making any edits.
```bash theme={null}
# Your plugins folder structure after first start
plugins/
├── PerPlayerKit-x.x.x.jar
└── PerPlayerKit/
├── config.yml
└── ...
```
Open `plugins/PerPlayerKit/config.yml` and set the storage type. For a single server, SQLite requires no external database and is the simplest option:
```yaml theme={null}
storage:
type: "sqlite"
```
Save the file. If you need MySQL or PostgreSQL for a multi-server network, see the full [Installation guide](/installation) for connection details.
Start the server and join with an account that has operator status or the `perplayerkit.admin` permission. Once in-game, run `/kit` to open the main plugin GUI, then click the **Nether Star** item to enter the Kit Room editor.
Inside the Kit Room editor, place every item you want players to be able to pick from — armor, weapons, potions, food, tools, and anything else that belongs in your PvP meta. When you're satisfied with the contents, **shift-right-click the Barrier block** in the corner to save the Kit Room.
You can create multiple themed Kit Rooms (for example, Crystal PvP, Sword PvP, and UHC). Each Kit Room page is configured separately. Players browse all available pages when building their loadout.
Some Kit Room ideas to get you started:
| Theme | Example Items |
| ----------- | ----------------------------------------------- |
| Crystal PvP | End crystals, obsidian, totems, netherite armor |
| Sword PvP | Swords, shields, golden apples, netherite armor |
| Axe Combat | Axes, shields, crossbows, specialized gear |
| Utility | Potions, wind charges, ender pearls, food |
Add the following permissions to your groups using a permissions plugin such as LuckPerms:
| Group | Permissions to Grant | What They Grant |
| ------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------- |
| Players | `perplayerkit.use` | Kit creation, loading, sharing, enderchest kits, regear, heal, and repair |
| Staff | `perplayerkit.use` + `perplayerkit.staff` | All player features plus `/inspectkit` and `/inspectec` for moderation |
| Admins | `perplayerkit.use` + `perplayerkit.staff` + `perplayerkit.admin` | Everything above plus Kit Room editing and public kit management |
`perplayerkit.staff` and `perplayerkit.admin` are additive — they grant only their own specific commands and do not automatically include player-facing features. Always pair them with `perplayerkit.use` for staff and admin groups.
```bash theme={null}
# Example LuckPerms commands
/lp group default permission set perplayerkit.use true
/lp group staff permission set perplayerkit.use true
/lp group staff permission set perplayerkit.staff true
/lp group admin permission set perplayerkit.use true
/lp group admin permission set perplayerkit.staff true
/lp group admin permission set perplayerkit.admin true
```
Switch to a non-admin account (or use a test player) and run `/kit` to open the main kit menu. Select **Create New Kit**, browse the Kit Room you just filled, choose items, arrange them in your inventory, and save the kit with a name. Then run `/k1` to load it instantly.
If the menu opens and items from your Kit Room appear correctly, your setup is complete.
`/kit` (alias `/k`) always opens the full GUI where players manage all their kits. The shortcut commands `/k1` through `/k9` skip the menu entirely and load the corresponding kit slot directly into the player's inventory — great for quick reskitting between fights.
## Recommended Config Tweaks
Once the basics are working, consider enabling these popular features in `config.yml`:
```yaml theme={null}
feature:
# Restore health and hunger when a player loads a kit
set-health-on-kit-load: true
set-hunger-on-kit-load: true
# Re-apply the player's last kit automatically on respawn
rekit-on-respawn: true
rekit-on-respawn-delay: 0 # delay in ticks; increase if another plugin gives items on spawn
```
## Where to Go Next
Explore every available configuration option: storage settings, anti-exploit rules, disabled worlds, regear modes, and more.
See the complete list of player, staff, and admin commands, their aliases, and the exact permissions each one requires.