Custom items

See also: Categorizable

A custom item within the sense of Caliburn is a template for an item stack. Thus, custom items do not have an amount.

It is recommended to use ItemsXL's /ixl registerItem command to read the traits from an item stack automatically.

Alternatively, Items can also be configured using a file.

Caliburn stores custom items under plugin/Caliburn/custom/items. The file name (without the .yml extension) is the ID of the item.

idType: LORE # See https://github.com/DRE2N/CaliburnAPI/wiki/identifier-types
material: GOLDEN_SWORD
meta: # Meta uses Bukkit's internal serialization system.
  ==: ItemMeta
  meta-type: UNSPECIFIC

# These OPTIONAL settings should specify a class
# that provides custom handlers implemented through a custom Java plugin.
# They do not need to be included in most cases.
damageHandler: "de.erethon.mycustomitemplugin.MySwordDamageHandler"
dropHandler: "de.erethon.mycustomitemplugin.MySwordDropHandler"
hitHandler: "de.erethon.mycustomitemplugin.MySwordHitHandler"
rightClickHandler: "de.erethon.mycustomitemplugin.MySwordRightClickHandler"

# Custom skull settings override meta.
# They do not need to be included in most cases either.
skullOwner: "b4f61444-f5fa-4668-91f0-9e00408d6298"
textureValue: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvM2VkZDIwYmU5MzUyMDk0OWU2Y2U3ODlkYzRmNDNlZmFlYjI4YzcxN2VlNmJmY2JiZTAyNzgwMTQyZjcxNiJ9fX0="

nbt: ... # NBT tags to modify the item

API

Registration

Damage modifiers

ActionHandlers

To do