Icon Options

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

material

string

required

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

integer

required

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

integer

required

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

left-click-actions

list

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

right-click-actions

list

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

name

string

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

lore

list

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

custom-model-data

string

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.

amount

integer

default:1

The number of items in this icon slot.

enchantments

section with enchantments

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

Basic Enchanting

Unsafe Enchanting

Unsafe enchanting is supported. This allows you to use usually unobtainable levels of an enchantment, or to apply enchantments to items that usually do not support them. This example gives the icon unbreaking 4, which is not obtainable in vanilla.

Use unsafe enchanting with caution. Excessively high enchantment levels could potentially crash your server.

enchantments:
  unbreaking: 4

armor-color

string

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-owner

string

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.

Specific Player

Opening Player

banner-patterns

list

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-open

boolean

default:false

Whether to keep the menu open after clicking the icon.

show-attributes

boolean

default:false

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.

prices

section

Monetary amounts required to click the icon.

to-left-click

decimal

The price that must be paid to left-click the icon. The money will be withdrawn before running the left-click actions. Requires installed economy.

to-right-click

decimal

The price that must be paid to right-click the icon. The money will be withdrawn before running the right-click actions. Requires installed economy.

message

string

default:"You need ${money} to use this."

Message sent to players who don’t have enough money to pay the to-left-click or to-right-click prices. Requires installed economy. Special placeholder {money} will be replaced with the price amount for the player’s click.

The following example tells the player they need $45 if they left-click, and$ 60 if they right-click.

Costs to Click
prices:
  to-left-click: 45
  to-right-click: 60
  message: '&cYou need &e${money} &cto use this.'

required-items

section

Inventory items required to click the icon.

to-left-click

list

The items that the player must have to left-click the icon. The items will be removed before running the left-click actions. The items are provided in the format <item type>, [amount]; the amount is optional and defaults to 1. A list of all valid item types can be found here.

to-right-click

list

The items that the player must have to right-click the icon. The items will be removed before running the right-click actions. The items are provided in the format <item type>, [amount]; the amount is optional and defaults to 1. A list of all valid item types can be found here.

message

string

default:"You must have {amount}x {material} to use this."

Message sent to players who don’t have the required to-left-click or to-right-click items. Special placeholders {amount} and {material} will be replaced with the amount and item type of the first item the player doesn’t have.

If the player has 5 dirt and 3 diamonds, the following example will tell them they need 4 total diamonds.

Costs to Click
required-items:
  to-left-click:
    - 'dirt, 5'
    - 'diamond, 4'
  message: '&cYou must have &e{amount}x {material} &cto use this.'

permissions

section

Permissions required to see or click the icon.

to-left-click

string

The permission required to left-click the icon. You can negate the permission by adding a - at the start.

Normal

Negated

to-right-click

string

The permission required to right-click the icon. You can negate the permission by adding a - at the start.

Normal

Negated

to-view

string

The permission required to see the icon. If you want to display a fallback icon for players lacking this permission, see Fallback Icons. Otherwise, players lacking the permission will see an empty space in the icon’s slot. You can negate the permission by adding a - at the start.

left-click-message

string

Message sent to players who don’t have the permission needed to left-click the icon. Special placeholder {permission} will be replaced with the permission the player is lacking.

right-click-message

string

Message sent to players who don’t have the permission needed to right-click the icon. Special placeholder {permission} will be replaced with the permission the player is lacking.

Next Steps

Actions

Explore actions that can be run when clicking an icon

Get Started

Features

Examples

Other

Adding Icons

List of All Options

Next Steps

Actions

Get Started

Features

Examples

Other

​Adding Icons

​List of All Options

​Next Steps

Actions

Adding Icons

List of All Options

Next Steps