These options are properties assigned to an icon in a menu's icons section. See Menu Settings to learn where to put the icons section.

Adding Icons

Icons are added to a menu's icons section. Here is an example of an icon added to a menu:

title: 'My Menu'
rows: 5
icons:
  'go-to-spawn':
    material: 'red_bed'
    x: 5
    y: 3
    left-click-actions:
      - 'spawn'
    name: '&cTeleport to Spawn'

An icon is added to the section with an ID, followed by various icon options. In the above example, the icon's ID is go-to-spawn.

In a single menu YML file, every icon must have a unique ID; icons with duplicate IDs will not load properly

The ID can be anything you want to make using letters, numbers, dashes, and underscores; avoid using other symbols.

List of All Options

materialstringrequired

The item type of the icon. A list of all valid item types can be found here.

xintegerrequired

The x coordinate of the position of the icon within the menu, from 1 to 9.

yintegerrequired

The y coordinate of the position of the icon within the menu, from 1 to the number of rows in your menu.

left-click-actionslist

Actions run when left-clicking this icon. Supports all Placeholders.

right-click-actionslist

Actions run when right-clicking this icon. Supports all Placeholders.

namestring

The name of the icon, displayed in the tooltip when hovering over the icon item. Supports all Placeholders.

lorelist

The lore of the icon, displayed under the name in the tooltip when hovering over the icon item. Supports all Placeholders.

custom-model-datastring

Adds a custom model data component with the given value to the icon item, allowing you to customize the icon's texture using a resource pack.

amountintegerdefault: 1

The number of items in this icon slot.

enchantmentssection with enchantments

A configuration section defining the enchantments to add to the icon.

armor-colorstring

Sets the color of leather armor, in the RGB format <red>, <green>, <blue>. If the icon material is not leather armor, this option is ignored. Google has a built-in RGB color picker.

skull-ownerstring

A player username whose skin will be used as the texture for a player head. If the icon material is not a player head, this option is ignored. Supports all Placeholders.

banner-patternslist

Adds patterns to a banner in order, in the format <pattern type>:<dye color>. If the icon material is not a banner, this option is ignored. A list of all valid pattern types can be found here. A list of all valid dye colors can be found here.

keep-openboolean

Whether to keep the menu open after clicking the icon.

show-attributesboolean

Whether to show item attributes in the icon tooltip, such as tool damage, tool speed, enchantment names, banner pattern names, etc. By default, ElvenideGUI hides all item attributes in icon tooltips to keep the GUI looking clean.

pricessection

Monetary amounts required to click the icon.

required-itemssection

Inventory items required to click the icon.

permissionssection

Permissions required to see or click the icon.

Next Steps

Actions

Explore actions that can be run when clicking an icon