> For the complete documentation index, see [llms.txt](https://vulkan-technologies.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vulkan-technologies.gitbook.io/documentation/vulkan-menu/configuration/item.md).

# Item

Learn how to create an item.

### Syntax

```yaml
items:
  my-item:
    slot: 2
    item:
      material: "diamond_sword"
      name: "My sword"
      lore:
        - "This is my sword"
        - "This is my sword"
    actions:
      - "[message] Hello"
```

{% hint style="warning" %}
Each item has a name, `my-item` in this example, it must be unique!
{% endhint %}

### Material

#### Default

Usually, you'll use Minecraft default materials that you can find here: [Material list](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html)

No prefix needed, and must be in lowercase

```yaml
material: "note_block"
```

#### HeadDatabase

You can get a head from [HeadDatabase](https://www.spigotmc.org/resources/head-database.14280/)

```yaml
material: "hdb-headId"
```

#### ItemsAdder

You can use an item defined in ItemsAdder with the `ia-` prefix

```yaml
material: "ia-namespace:name"
```

#### Oraxen

You can use an item defined in Oraxen with `oraxen-` prefix

```yaml
material: "oraxen-itemId"
```

#### Nexo

You can use an item in Nexo with `nexo-` prefix

<pre class="language-yaml"><code class="lang-yaml"><strong>material: "nexo-itemId"
</strong></code></pre>

#### Internal placeholders `Coming soon`&#x20;

You also can use the following placeholders as materials:

* Item in main hand - `main_hand`&#x20;
* Item in off hand - `off_hand`&#x20;
* Items in armor slots - `armor_helmet`, `armor_chestplate`, `armor_leggings` and `armor_boots`&#x20;

### Display name

Sets the item's display name.&#x20;

```yaml
name: "<rainbow>My item"
```

{% hint style="info" %}
You can use placeholders & MiniMessage format.
{% endhint %}

### Lore

Sets the item's lore (the text shown under the item's name).

```yaml
lore:
  - "<newline>"
  - "<gray>Right click to <green>enable"
```

{% hint style="info" %}
You can use placeholders & MiniMessage format.
{% endhint %}

### Priority

Sets the item priority. It's used if you want different items in the same slot (by using the [view requirement ](/documentation/vulkan-menu/configuration/requirement.md)option). The item that has the highest priority will be checked first if the player has the required view requirement. It will display the item if they have the requirements and if not, it will check the next item and so on.

```yaml
priority: 10
```

### Amount

Sets the item's amount in the menu.

```yaml
amount: 1
```

### Slot

Sets in which slot the item should be inside the menu.

#### Single

```yaml
slot: 10
```

#### Multiple

```yaml
slot:
  - 10
  - 11
  - 12
```

#### Placeholders / variables

```yaml
slot: "%my_placeholder%"
slot: "<variable-myItemSlot>"
```

{% hint style="info" %}
Slots starts at 0&#x20;
{% endhint %}

{% hint style="warning" %}
Slot must be between 0 and the menu's size value. (unless you use the players inventory as well `Requires packetvents`
{% endhint %}

### Custom model data

Sets the item's custom model data

```yaml
custom-model-data: 10
```

### Item flags

Allows you to set item flags.

```yaml
item-flags:
  - "HIDE_ARMOR_TRIM"
  - "HIDE_ATTRIBUTES"
```

{% hint style="info" %}
You can find all available ItemFlags [HERE](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/ItemFlag.html).
{% endhint %}

### Enchantments

Enchants the item with the specified enchantments.

```yaml
enchantments:
  1:
    enchantment: "AQUA_AFFINITY"
    level: 1
  2:
    enchantment: "EFFICIENCY"
    level: 4
```

{% hint style="info" %}
You can find all available enchantments [HERE](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/enchantments/Enchantment.html).
{% endhint %}

### Click actions

Sets the [actions](/documentation/vulkan-menu/configuration/actions.md) that should be executed once the player clicks the item.

You can use the followings:

* `left-click-actions`&#x20;
* `right-click-actions`&#x20;
* `middle-click-actions`&#x20;
* `shift-left-click-actions`&#x20;
* `shift-right-click-actions`&#x20;
* `actions`

```yaml
actions:
  - "[message] You clicked on the item!"
left-click-actions:
  - "[message] You clicked on the item with left click!"
right-click-actions:
  - "[message] You clicked on the item with right click!"
middle-click-actions:
  - "[message] You clicked on the item with middle click!"
shift-left-click-actions:
  - "[message] You clicked on the item with shift left click!"
shift-right-click-actions:
  - "[message] You clicked on the item with shift right click!"
```

### Click requirements

Sets the [requirements](/documentation/vulkan-menu/configuration/requirement.md) the player should have to click the item.

Deny actions are the [actions](/documentation/vulkan-menu/configuration/actions.md) that are going to be executed if the player doesn't have the required requirements.

```yaml
click-requirements:
  permission:
    requirement: "[permission] myplugin.command.hello"
    deny-actions:
      - "[message] You don't have permission to use this item"
```

### View requirements

Sets the [requirement](/documentation/vulkan-menu/configuration/requirement.md) the player should have to view the item.

```yaml
view-requirements:
  - "[permission] myplugin.command.hello"
```