# Item Options

## Item Configuration

This page outlines all available configuration options for creating custom `ItemStack`s via the config.

### Basic Options

```yaml
Material: DIAMOND_SWORD # The Bukkit material of the item.
Amount: 1               # Stack size.
Name: "&bEpic Sword"    # Item display name.
Lore:                   # List of strings shown as item lore.
  - "&7Sharp and shiny"
  - "&eUse with care"
Glow: true              # Makes item glow (applies a hidden enchant).
Hide-Tooltip: true      # Hides item tooltip.
Max-Stack-Size: 64      # Custom max stack size.
Model-Data: 123456      # Custom model data (for resource packs).
Item-Model: mypack:katana # Custom item model via namespaced key.
Tooltip-Style: custom:glow # Custom tooltip style via namespaced key.
```

{% hint style="info" %}

`Material` values must match those listed in the [Spigot Material enum](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html). They are case-sensitive.
{% endhint %}

{% hint style="info" %}
`Glow: true` adds an `UNBREAKING` enchantment with a high level and hides it using item flags.
{% endhint %}

***

### Custom Data

```yaml
Custom-Data:
  - myplugin:key1:value1
  - myplugin:key2:value2
```

Sets [PersistentDataContainer](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/persistence/PersistentDataContainer.html) values on the item using namespaced keys.

***

### Leather Armor Color

```yaml
Dye-Color: "FF00FF"
```

{% hint style="warning" %}
Only applies to materials starting with `LEATHER_`. Must be a valid hex color string (`RRGGBB`).
{% endhint %}

***

### Player Head Skins

```yaml
Skull-Name: Notch
Skull-URL: "http://textures.minecraft.net/texture/..."
```

{% hint style="warning" %}
Works only for `PLAYER_HEAD`.\
`Skull-URL` will override the skin texture.
{% endhint %}

***

### Potion Data

```yaml
Potion-Data:
  Vanilla: true
  Type: HEAL
  Color: "FF0000"
  Duration: 200
  Amplifier: 2
```

{% hint style="info" %}
`Vanilla: true` uses [PotionType](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionType.html) like `POISON`, `HEAL`, etc.\
When `Vanilla` is false, custom effects are added using [PotionEffectType](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html).
{% endhint %}

***

### Tipped Arrow

```yaml
Arrow-Type: POISON
```

Used for `TIPPED_ARROW` items. Accepts [PotionType](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionType.html).

***

### Enchantments

```yaml
Enchantments:
  - sharpness:5
  - unbreaking:3
```

Each entry must be in the format `enchant_name:level`.

{% hint style="info" %}
Refer to [Enchantment enum](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/enchantments/Enchantment.html) for valid names.
{% endhint %}

***

### Item Flags

```yaml
Flags:
  - HIDE_ATTRIBUTES
  - HIDE_ENCHANTS
```

{% hint style="info" %}
Flags must match the values from the [ItemFlag enum](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/ItemFlag.html).
{% endhint %}

***

### Equippable Options

```yaml
Equippable-Options:
  Slot: HEAD
  Model: custompack:helmet
  Camera-Overlay: mypack:overlay
  Equip-Sound: ITEM_ARMOR_EQUIP_LEATHER
  Allowed-Entities:
    - ZOMBIE
    - PLAYER
  Dispensable: true
  Swappable: true
  Damage-On-Hurt: false
```

Defines [EquippableComponent](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/meta/components/EquippableComponent.html) behavior.

{% hint style="info" %}

`Slot` uses [EquipmentSlot](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/EquipmentSlot.html).\
`Equip-Sound` uses [Sound enum](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html).
{% endhint %}

***

### Food Options

```yaml
Food-Options:
  Can-Always-Eat: true
  Nutrition: 5
  Saturation: 2
```

Modifies the [FoodComponent](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/meta/components/FoodComponent.html).

***

### Tool Options

```yaml
Tool-Options:
  Damage-Per-Block: 1
  Rules:
    - STONE:1.0:true
    - DIRT:0.5:false
  Default-Mining-Speed: 2
```

Customizes the [ToolComponent](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/meta/components/ToolComponent.html).

{% hint style="warning" %}
Each `Rules` entry must be in format: `MATERIAL:speed:correctTool`\
`Material` must match [Material enum](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html)
{% endhint %}

***

### Glider

```yaml
Glider: true
```

Applies Elytra-style gliding behavior to the item (uses [setGlider](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/meta/ItemMeta.html#setGlider\(boolean\))).

***

Let us know if you run into any issues with a specific field!


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://bitbylogic.gitbook.io/bitbylogics-resources/resources/item-actions/item-options.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.