Bukkit

Kits Configuration

Kits Configuration

All your kits are saved and loaded from /SuperKits/kits.yml. Each kit has several fields and option that may be tweaked and adjusted to customize the kit to suit your needs.

Below is a sample kit, with almost every option defined. Remember, every option has a default value. Omitting the option entirely will simply set it to its default value.

SampleKit:
  items:
    - Leather_Helmet:1
    - Iron_Chestplate:1 Protection:1
    - Leather_Leggings:1
    - Leather_Boots:1
    - Iron_Sword:1 Sharpness:1
    - Bow:1
    - Arrow:128
  effects:
    - Strength:1:60
  permissions:
    - samplekit.user
  clearInventory: false
  infiniteEffects: true
  timeout:
    duration: 60
    global: false
  inheritance:
    parent: none
    requireParentPerms: false
    inheritParentPerms: true
  economy:
    cost: 0.0
    cash: 0.0
  movement:
    walkSpeed: 1.0
    flySpeed: 1.0
  showInList: true

Now lets look through the fields together:

items: This is the field where you define all the items in your kit. All items are parsed as [item]:[data]:[amount], so a stack of birch wood planks would be represented as Wood:1:64. Omitting the data will default it to 0. To add enchantments to the item, leave a space between the item and any enchantments. All enchantments are parsed as [enchantment]:[level], so Sharpness II would be represented as Sharpness:2.

effects: This is the field where you define all potion effects that will be applied with your kit. All effects are parsed as [effect]:[level]:[duration], so Strength II for 2 minutes would ge represented as Strength:2:120. Omitting the duration will default it to 60 seconds.

permissions: This is a list of all permission nodes that will be granted to any players using this kit. Permissions are automatically revoked when the player loses the kit, or logs out.

clearInventory: This field indicates whether the kit should clear the player's inventory and effects before being applied. If omitted, it will default to true.

infiniteEffects: This field indicates whether the kit's effects should be infinitely renewed (until death or another inventory clearing kit is selected). If omitted, it will default to false.

timeout.duration: This field defines the duration of the kit's timeout, or the delay in seconds before it may be taken again by the same person. If omitted, it will default to 0.

timeout.global: This field indicates whether the kit's timeout should be universally applied to all players. If omitted, it will default to false.

inheritance.parent: This field defines the external kit that this kit will consider its parent. When this kit is given, all items, effects, and options belonging to its parent will be automatically applied before its own. If omitted, it will default to none.

inheritance.requireParentPerms: This field indicates whether this kit should additionally require the permissions of its parent kit for a player to take it. If omitted, it will default to false.

inheritance.inheritParentPerms: This field indicates whether this kit should consider its parent's permissions to be its own. If omitted, it will default to true.

economy.cost: This is the amount of currency that is required to take this kit. If omitted, it will default to none.

economy.cash: This is the amount of currency that will be granted when a player takes this kit. BE CAREFUL TO SET A COOLDOWN OR PERMISSIONS IF YOU USE THIS OPTION! If omitted, it will default to none.

movement.walkSpeed: This is a multiplier for the player's walking speed. It will function similarly to a speed or slowness potion, but is much more flexible. Values above or below a certain amount may not be permitted by CraftBukkit. If omitted, it will default to 1.0.

movement.flySpeed: This is a multiplier for the player's fly speed. Values above or below a certain amount may not be permitted by CraftBukkit. If omitted, it will default to 1.0.

showInList: This field indicates whether the kit should be shown when the command /kitlist is used. If omitted, it will default to true.