> ## Documentation Index
> Fetch the complete documentation index at: https://perplayerkit.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configure the Kit Room for Your PerPlayerKit Server

> Create and configure the PerPlayerKit virtual kit room — the inventory of items players can pick from when building their personal PvP kits.

The Kit Room is a virtual inventory of admin-curated items that players browse when building their personal PvP kits. Think of it as your server's item catalogue: whatever you place inside a Kit Room page is exactly what players are allowed to equip in their loadouts. Setting it up correctly is the most important first step before opening kit-based PvP to your community.

## Setting Up the Kit Room

You can open the Kit Room editor in two ways: by running the `/kitroom` command directly (requires `perplayerkit.admin`), or by opening the main `/kit` menu and clicking the **Nether Star**. Both methods take you to the same editor where you manage each Kit Room page.

<Steps>
  <Step title="Join the server as an admin">
    Make sure your account has either the `perplayerkit.admin` permission or full operator (OP) status. Without it, the Kit Room editor will not be accessible.
  </Step>

  <Step title="Open the Kit Room editor">
    Run `/kitroom` directly, or run `/kit` (alias `/k`) to open the main menu and then click the **Nether Star**. Both paths open the same Kit Room editor where you can manage each page.
  </Step>

  <Step title="Fill each Kit Room page with items">
    You will see an empty GUI representing a single Kit Room page. Place every item you want players to be able to pick from into the available slots. You can include weapons, armor, potions, food, consumables — anything your server's PvP format calls for.
  </Step>

  <Step title="Save the Kit Room page">
    When the page is ready, hover over the **barrier block** in the corner of the GUI and **shift right-click** it. This saves the current contents as a Kit Room page. You will hear a success sound confirming the save.
  </Step>

  <Step title="Repeat for each additional page">
    Navigate to the next Kit Room page and repeat the process — fill the GUI with items, then shift right-click the barrier block to save. You can configure up to five named pages (see below for how to customize their names and icons).
  </Step>
</Steps>

## Customizing Kit Room Names and Icons

Each Kit Room page has its own display name and icon shown in the selection GUI. Configure these in `config.yml` under the `kitroom.items` block:

```yaml config.yml theme={null}
kitroom:
  items:
    1:
      name: "OG Vanilla"
      material: "DIAMOND_SWORD"
    2:
      name: "Training"
      material: "WOODEN_SWORD"
    3:
      name: "Potions"
      material: "SPLASH_POTION"
    4:
      name: "Armory"
      material: "NETHERITE_SWORD"
    5:
      name: "Axe & UHC"
      material: "SHIELD"
```

The `name` field sets the label shown in the GUI, and `material` sets the icon next to it. Use any valid Bukkit material name in uppercase. After saving the file, reload or restart the plugin for the changes to take effect.

## Kit Room Ideas

Not sure what to put in each page? Here are some popular PvP loadout categories to inspire your setup:

<CardGroup cols={2}>
  <Card title="Crystal PvP" icon="gem">
    End crystals, obsidian, armor, totems of undying, respawn anchors, and glowstone.
  </Card>

  <Card title="Sword PvP" icon="sword">
    Swords, shields, full armor sets, golden apples, and food for sustain.
  </Card>

  <Card title="UHC" icon="apple">
    Golden apples, potions, bows, arrows, crafting materials, and enchanted gear.
  </Card>

  <Card title="Axe Combat" icon="axe">
    Axes of varying enchantments, shields, heavy armor, and gap apples.
  </Card>

  <Card title="Utility" icon="flask-round-potion">
    Splash potions, wind charges, ender pearls, fireworks, and miscellaneous tools.
  </Card>
</CardGroup>

<Note>
  The `only-allow-kitroom-items` anti-exploit setting in `config.yml` controls whether players are restricted to using only items present in a Kit Room page. When set to `true`, any item not found in the Kit Room will be blocked from kit saving and loading — a useful safeguard on competitive servers to prevent item duplication or unapproved gear.

  ```yaml config.yml theme={null}
  anti-exploit:
    only-allow-kitroom-items: true
  ```
</Note>

<Tip>
  You can disable kit commands entirely in non-PvP worlds — such as your spawn or lobby — using the `disabled-command-worlds` config key. Players who run `/kit` in a listed world will see your custom message instead.

  ```yaml config.yml theme={null}
  disabled-command-worlds:
    - "spawn"
    - "lobby"
  disabled-command-message: "<red>Kits are disabled here!</red>"
  ```

  The message supports full **MiniMessage** formatting, so you can style it with colors, bold text, and more.
</Tip>
