XPlayerKits

Requirements

1. Spigot Compatibility
   You can use Spigot, Paper, or any of their forks from version 1.8 up to 1.21.5.

2. PlaceholderAPI (Required)
   This plugin requires PlaceholderAPI to work. Make sure to download and install it from: PlaceholderAPI on SpigotMC

Installation

1. Download the XPlayerKits plugin .jar file.
2. Place the .jar inside the /plugins folder of your server.
3. Start or reload the server.
4. The plugin will create a /kits folder where you can manage your kits.

Creating or Editing Kits

To create or modify a kit:

1. Use the command: /xkits editor
2. This will open a graphical editor menu.
3. You will see options to:
   • Edit an existing kit
   • Create a new kit
4. Click any of the options to open the property editor for that kit.

Commands

Here you’ll find information about all available commands in the plugin.

💬 You can suggest additional commands on our Discord Server

Normal Commands

Command	Description
/kits	Optional legacy command. Enable it only if necessary to avoid conflicts.
/xkits	Main command of the plugin.
/xkits kits	Opens the kits menu.
/xkits reload	Reloads the plugin configuration.
/xkits editor	Opens the graphical kit editor.
/xkits slots	Opens the slot editor for the built-in menu.
/xkits give <kitId> <player>	Gives a kit to a player, skipping requirement checks.
/xkits claim <kitId> <player>	Claims a kit for a player, verifying all requirements.
/xkits delete <kitId>	Deletes a kit directly in-game.
/xkits reset <kitId> <player>	Resets a specific kit for a player.
/xkits resetall <player>	Resets all kits for a player.

Migration Commands

Command	Description
/xkits migrate playerkits2_yml	Migrates player data from PlayerKits2 stored in YML.
/xkits migrate playerkits2_mysql	Migrates player data from PlayerKits2 stored in MySQL.
/xkits migratekits playerkits2	Migrates all kit data from the PlayerKits2 plugin.

Permissions

Here you’ll find the list of permissions used by the plugin.

💬 You can suggest additional permissions on our Discord server.

Permission List

Permission	Description
xkits.admin	Grants full access to all commands: create, edit, and delete kits.
xkits.allow.<kitId>	Permission to claim a specific kit. Kits default to "none" (no permission required).

Creating Kit

Requirements

This section explains how to define conditions that must be met in order for a player to claim a kit.

How Requirements Work

Requirements are simple conditional expressions based on placeholders. If the condition evaluates as true, the player can claim the kit.

Format

%placeholder% (comparator) value

Ejemplo

%vault_eco_balance% >= 100

This means the player must have at least 100 coins to claim the kit.

List of Comparators

Comparator	Description
>	Checks if the placeholder value is greater than the given value.
<	Checks if the placeholder value is less than the given value.
=	Checks if the placeholder value is equal to the given value.
!=	Checks if the placeholder value is not equal to the given value.
>=	Checks if the placeholder value is greater than or equal to the value.
<=	Checks if the placeholder value is less than or equal to the value.

Actions on Claim

These actions are executed after a player successfully claims a kit.

Type	Execution Description	Example
console	Executes a command from the console.	console:say test
command	Executes a command as the player.	command:dm open main
sound	Plays a sound to the player.	sound:ENTITY_ENDERMAN_TELEPORT;1.0f;1.0f
message	Sends a message to the player.	message:You claimed the kit correctly.

Actions on Deny

These actions are executed when a player does not meet the requirements to claim a kit.

Type	Execution Description	Example
console	Executes a command from the console.	console:say test
command	Executes a command as the player.	command:dm open main
sound	Plays a sound to the player.	sound:ENTITY_ENDERMAN_TELEPORT;1.0f;1.0f
message	Sends a message to the player.	message:You can’t claim this kit.

Menu Slots

To change the item type in the menu, simply rename the item using an anvil or a command like /ie rename from the ItemEdit plugin.

The following item names trigger special slot actions:

Name	Action Description
{LAST_SLOT}	Goes to the previous page (only shown if not on the first page).
{NEXT_SLOT}	Goes to the next page (only shown if more kits exist on the next page).
{CLOSE}	Closes the kit menu.

Placeholders

Below are the available placeholders provided by the plugin:

Placeholder	Description
%xplayerkits_cooldown_<kitId>%	Shows the cooldown message defined in countdown.noCountdown or the remaining cooldown time.
%xplayerkits_claimed_onetime_<kitId>%	Returns yes or no depending on whether the kit has already been claimed (one-time kits).
%xplayerkits_claimed_cooldown_<kitId>%	Returns yes or no depending on whether the kit is currently on cooldown.

💡 You can suggest additional placeholders in our Discord.