Kits

Kits are groups of items and effects that can be given to players in various ways. There are many types of kits, and they can be packaged together in any combination.

Kits can be given an id attribute, which is used to refer to them in other places. Kits can contain other kits directly, and can also inherit items from other kits through the parents="" attribute.

Some types of kits are removable, meaning that the kit can be automatically taken from the player as well as given. When used in certain contexts, these kits will be automatically removed from the player at an appropriate time. This will be noted in the documentation where applicable.

ElementDescription
A kit node, containing specific kit types and/or other kit nodes.
Kit Attributes
AttributeDescriptionValueDefault
Unique identifier used to reference this kit from other places in the XML.String
PropertyFilter when this kit is used.Filter
The kit's parent or a comma separated list of parent kits.String
Force apply the kit.true/false
Enable or disable potion particles.
Potion particles are disabled for all players by default.
true/falsefalse
Reset any ender pearls the player might have thrown before the kit was applied.true/falsefalse

The effect of the force attribute depends on the type of kit it is used with: conflicting items or armor will be replaced instead of smartly merged & repaired, health & hunger will be set instead of only increased, and potion effects can be replaced with the same effect at a lower level or shorter duration.

<kits>
<kit id="spawn" force="true">
<item slot="0" material ="iron sword"/>
<item slot="8" amount="32" material="bread"/>
<effect duration="5" amplifier="1">instant_health</effect>
</kit>
<kit id="red" parents="spawn">
<helmet color="cd0000" material="leather helmet"/>
</kit>
<kit id="blue" parents="spawn">
<helmet color="0066cc" material="leather helmet"/>
</kit>
</kits>

In the example above players from blue team will get a blue helmet, players from red team will get a red helmet; both teams will get the items from the spawn kit. The spawn kit contains a 5 second healing potion to help prevent spawn killing.

Item & Armor Kits

Kits can place items in specific slots of a player's inventory, and equip them with armor. See Items & Armor for details.

Item kits will replace any items in the player's inventory in slots present in the kit, but they will not alter any other slots. If you want to guarantee that a slot is empty, put an item called "air" in that slot. You can also clear the player's entire inventory before applying the kit by using one of the elements below.

Inventory Clear Elements
ElementDescription
Clear the all of the player's inventory including armor slots.
Clear only the player's item slots.
<kit id="ender" reset-ender-pearls="true">
<item slot="0" amount="1" material="ender pearl"/>
<clear/>
</kit>

Game-mode Kit

A player's gamemode can be changed when they spawn or enter a region, etc. by using this kit.

ElementDescriptionValue
The gamemode to change the player to.
Game Mode String
<game-mode>adventure</game-mode>

Health & Hunger Kits

A player's health and hunger can be modified with kits, this can be useful on maps with the naturalRegeneration gamerule set to false.

By default health or hunger values are only increased, not decreased. For example, a player with 5 hearts (10 points) will not get a 5 health point kit applied, however a 20 point kit will be applied. This can be overwritten with a kits force="true" attribute.

Health & Hunger Elements
ElementDescriptionValue
Health value in 1/2 heart increments.1 - 20
Food saturation, always equal to or less than the player's food level.Decimal
Food level in 1/2 drumstick increments.0 - 20
<kit id="health" force="true">
<health>10</health>
</kit>
<kit id="hunger">
<saturation>20</saturation>
<foodlevel>20</foodlevel>
</kit>

Potion Effect Kits (removable)

Potion effects can be applied and removed with a kit. See Potion Effects for details about the <effect> element.

<kit>
<effect duration="10" amplifier="4">resistance</effect>
</kit>

Attribute Modifier Kits (removable)

Attribute modifiers can be applied directly to players through a kit. Modifying attributes in this way, instead of through an item, is a simple way to ensure that the player cannot avoid the effect of the modifier.

The only way to remove an attribute modifier is by removing the kit that applied it. A kit cannot affect a modifier applied by a different kit.

Attribute Operations

  • add Add amount
  • base Multiply amount by base value and add it
  • multiply Multiply by amount
Attribute Kit Elements
ElementDescription
Attribute name
Attribute Kit Attributes
AttributeDescriptionValueDefault
Numeric parameterDecimal
Modifier operationadd / base / multiply
<kit>
<attribute operation="add" amount="0.5">generic.movementSpeed</attribute>
</kit>

Walk Speed Kit (removable)

Increase or decrease a player's walking speed. The value is a multiplier of the normal walking speed.

ElementDescriptionValue
Increase or decrease a player's walking speed.0 - 5.0
<kit id="rabbit">
<!-- 1.8 times faster than a normal player -->
<walk-speed>1.8</walk-speed>
</kit>
<kit id="tortoise">
<!-- half as fast as a normal player -->
<walk-speed>0.5</walk-speed>
</kit>

Knockback Reduction Kit (removable)

Reduce (or increase) the knockback players receive when they have this kit applied. The normal input range is 0 - 1.0. If the value is greater than one the knockback will be increased, and anything lower than zero pushes the player to the attacker instead of away from them.

ElementDescriptionValue
Knockback reduction amountNumber
<kit>
<knockback-reduction>0.5</knockback-reduction>
</kit>

Shield Kit (removable)

The shield kit gives the player a shield consisting of absorption hearts that recharge after a set period of time. Recharging of the shield is based on when damage was taken last, every time a player is damaged it resets the recharge timer.

ElementDescription
Give the player a recharging shield of absorption hearts.
Shield Kit Attributes
AttributeDescriptionValueDefault
Amount of extra absorption hearts to give to the player.Decimal4
Time to wait after a player is last damaged to recharge the shield.Time Period4s
<kit>
<shield health="4" delay="8s"/>
</kit>

Double Jump Kit (removable)

Give players with this kit the ability to double-jump. This element's enabled attribute can be used to disable double-jump inside regions, etc.

ElementDescription
Give player the double-jump ability.
Double-Jump Attributes
AttributeDescriptionValueDefault
Enable or disable double-jump.true/falsetrue
Power of the double jump (a normal player jump is about 1)Number3
Recharge time till the player can double jump again.Time Period2.5s
Player starts recharging before they land from their previous jump.true/falsefalse
<kit>
<double-jump recharge-before-landing="true"/>
</kit>

Fly Kit (removable)

The fly kit gives players which it is applied to the ability to fly. It also allows modification of the speed at which they fly. If no attributes are specified can-fly defaults to true.

ElementDescription
Control the player's flying ability
Fly Kit Attributes
AttributeDescriptionValueDefault
Set if the player can fly.true/falsetrue
Set if the player is currently flying.
To enable flyingcan not be set to false.
true/false
Set the fly speed multiplier.0 - 101
<kit id="fly">
<fly/> <!-- Allow player to fly -->
<fly can-fly="false"/> <!-- Don't allow player to fly -->
<fly flying="true"/> <!-- Make the player fly right away -->
<fly flying="false"/> <!-- Make the player stop flying right away -->
</kit>