🛠️Creating Custom Items

Creating Custom Items via Configuration

The KItem system allows you to define complex ItemStack objects directly in your YAML configuration files. This guide covers all available options, key formats, and special item types supported by the loader.

---

1️⃣ Basic Structure

Every item section must contain a material key. All other keys are optional.

simple-item:
  material: DIAMOND_SWORD
  name: "&cGod Sword"
  lore:
    - "&7A simple example"

---

2️⃣ Universal Configuration Keys

These keys apply to almost every item type.

Key	Type	Description
material	String	Required. The Bukkit Material name (e.g., STONE, DIAMOND_SWORD).
name / displayName	String	Display name of the item. Supports color codes (&).
lore	List	A list of strings for the item description. Supports color codes.
amount	Integer	Stack size (default: 1).
damage	Integer	Sets the durability damage of the item.
custom-model-data	Integer	Used for resource packs to assign custom textures.
unbreakable	Boolean	If true, the item will not lose durability.
glow	Boolean	If true, adds a glow effect (enchantment) and hides the enchantment lore.
flags	List	Hides specific item attributes (e.g., HIDE_ATTRIBUTES, HIDE_ENCHANTS).
enchantments	List	Format: ENCHANT_NAME:LEVEL. Example: DAMAGE_ALL:5.

---

3️⃣ Interaction & Menu Settings

Useful if the item is used inside a GUI or Shop.

Key	Type	Description
slot	Integer	Inventory slot number.
price	Double	Cost of the item.
permission	String	Permission node required to see or interact with the item.
commands	List	Commands executed when clicked.
CommandType	String	Who runs the commands: PLAYER, CONSOLE, or BUNGEE.

---

4️⃣ Special Item Types

Potions

Applicable for: POTION, SPLASH_POTION, LINGERING_POTION

Key	Description
potion-color	Defines the visual color of the liquid (Format: Red,Green,Blue 0–255).
potion-effects	Adds custom potion effects (Format: EFFECT_NAME:DURATION_IN_SECONDS:AMPLIFIER). Note: Duration in config is multiplied by 20 internally (converted to ticks).

Example:

super-brew:
  material: SPLASH_POTION
  potion-color: "0,255,0" # Green
  potion-effects:
    - "SPEED:60:1"  # Speed II for 60 seconds
    - "JUMP:30:2"   # Jump Boost III for 30 seconds

---

Leather Armor

Applicable for: LEATHER_HELMET, LEATHER_CHESTPLATE, LEATHER_LEGGINGS, LEATHER_BOOTS

Key	Description
color	Dyes the armor (Format: Red,Green,Blue 0–255).

Example:

cultist-robe:
  material: LEATHER_CHESTPLATE
  color: "255,0,0" # Red

---

Player Heads

Applicable for: PLAYER_HEAD

You can specify a head using one of the following keys:

Key	Description
skull-owner	Minecraft player name (e.g., "Notch").
texture	Base64 encoded texture string (from sites like minecraft-heads.com).

Example:

admin-head:
  material: PLAYER_HEAD
  skull-owner: "EagleStudios"
  # OR
  # texture: "eyJ0ZXh0dXJlcy..."

---

5️⃣ NBT Data (Advanced)

Add custom NBT tags to items under the nbt section. Values must follow the syntax: key: "TYPE:VALUE"

Supported Type	Description
string	Text value
int / integer	Integer number
double	Decimal number
bool / boolean	True/False
long	Long integer

Example:

legendary-gem:
  material: EMERALD
  name: "&aGem of Power"
  nbt:
    internal_id: "string:gem_001"
    power_level: "int:9000"
    is_quest_item: "bool:true"
    drop_chance: "double:0.05"