# How to Start

## Requirements

\
**1) Spigot**

{% hint style="warning" %}
You need Spigot or Paper for the plugin to work. Don't use Craftbukkit.
{% endhint %}

**2) PlaceholderAPI**

{% hint style="info" %}
This dependency is optional. It will allow you to set variables on kit item names and lore, also to add extra requirements to claim kits.\
<https://www.spigotmc.org/resources/placeholderapi.6245/>
{% endhint %}

**3) Vault + Economy Plugin**

{% hint style="info" %}
These dependencies are optional. They will allow you to set a price to the kit.

<https://www.spigotmc.org/resources/vault.34315/>
{% endhint %}

## Installation

To install the plugin on your server just place the PlayerKits2.jar file inside your plugins folder. Remember to use a Spigot/Paper server. Example kits will be generated in the `kits` folder. I suggest you keep them while you learn how to use the plugin.

## How to create a Kit

To create a new kit you just need to have some items on your inventory and then execute the `/kit create <name>` command. Note that armor and offhand items will also be saved into the kit.

{% hint style="warning" %}
By default, kit items are saved grabbing all of their ORIGINAL DATA, an exact copy of the original item. This prevents some complex items from other plugins to broke when giving them again to the player. Click [**HERE**](/playerkits-2/commands-and-permissions.md#kit-creation-with-original-parameter) to know more. This can also be achieved using the `/kit create <name> original` command.

If you want to be able to modify kit items on the configuration file, you must use the `/kit create <kit> configurable` command instead. This however will not save all item data.
{% endhint %}

### Edit a kit through the game

You can use `/kit edit <kit>` to open an inventory and edit the properties of the created kit. All options are self explanatory. Here you can change almost all aspects of the kit, like the display items, the cooldown, permission, position on the GUI, and more.

In the bottom of the inventory you will find the **Kit Display Items**. These items will appear in the main GUI and show to players depending on the kit status. The **Default Display Item** will show when the player is able to claim the kit. If the player doesn't have permissions to claim a kit, then the **No Permissions Display Item** will be set. There are 5 display items in total.

<figure><img src="/files/CyoFUlnjSnEnr7qYBhdA" alt=""><figcaption></figcaption></figure>

To edit display items you just need to place an already created item between the two heads (in the empty slot). I suggest you to use another plugin to create these display items like [**ItemEdit**](https://www.spigotmc.org/resources/itemedit-1-8-x-1-20-x.40993/). Or, if you are good with configuration files, you can edit the item properties directly from the kit config.

<figure><img src="/files/Kph54vYPyCCCbm2f2lyq" alt=""><figcaption></figcaption></figure>

### Edit a kit through the config

When you create a kit a new `<kit>.yml` file is generated inside the `kits` folder. There you can edit the properties of the kit if you don't want to do it directly from the game. In the next section you can find all properties and how to use them.

{% hint style="warning" %}
Make sure you are not inside the `/kit edit <kit>` inventory while modifying the kit config.
{% endhint %}

## Claiming a kit

To claim the kit you have two options:

* Using `/kit claim <kit>` command or `/kit <kit>` (when `claim_kit_short_command` option is enabled on the config)
* Using `/kit` to enter the GUI mode and clicking on a kit item.

{% hint style="danger" %}
OP players and players with all permissions will IGNORE cooldown and one time. So make sure you /deop yourself first before testing kits.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ajneb97.gitbook.io/playerkits-2/how-to-start.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.