These settings are top-level properties assigned in a menu file. See Create Menu to learn how to create menu files.

​
List of All Settings

​
title
string
required
The title displayed at the top left of the menu inventory. There is no limit to the length of the title. Supports all Placeholders.
​
rows
integer
required
The number of rows in the menu inventory. Must be between 1 and 6.
​
auto-refresh
decimal
default:3
How frequently the menu will be refreshed to get the latest placeholder values, in seconds. Any value lower than 0.1 will disable auto refresh altogether.
​
open-with-commands
list
A list of commands which, when run by a player, will open this menu for them. The player will still need the necessary Permissions to open the menu.
​
open-with-left-click-item
string
An item type that can be left-clicked by a player in their hand to open this menu for them. A list of all valid item types can be found here. The player will still need the necessary Permissions to open the menu.
​
open-with-right-click-item
string
An item type that can be right-clicked by a player in their hand to open this menu for them. A list of all valid item types can be found here. The player will still need the necessary Permissions to open the menu.
​
open-actions
list
Actions automatically run when the menu is opened. Useful for initialization functionality. Supports all Placeholders.
​
no-view-permission-icon
icon
An optional icon that is displayed in any icon slot that the player does not have view permissions for. See Fallback Icons to learn when to use this. See Icon Options for the properties and format of icons.
Unlike normal icons, the x and y properties are not required for this icon
​
background-icon
icon
An optional background icon that is displayed in any icon slot that has no other icons in it. See Icon Options for the properties and format of icons.
Unlike normal icons, the x and y properties are not required for this icon
​
icons
section with icons
A configuration section defining all icons to be displayed in the menu. See Icon Options for the properties and format of icons.

​
Basic Example

The following example is a size changer menu, which allows players to grow or shrink themselves. Copy the below text, add it to a menu file named sizechanger.yml, give yourself the elvenidegui.open.sizechanger.yml permission, reload the plugin with /elvenidegui reload, and then use /sizechanger to test it out!
sizechanger.yml
title: '<dark_green>My Size Changer Menu'
rows: 1
auto-refresh: 6.5
open-with-commands:
  - sizechanger
open-with-left-click-item: emerald
open-with-right-click-item: emerald
open-actions:
  - 'tell: <green>You opened <dark_green>My Size Changer Menu!'
  - 'bossbar: 10 | Thank you for opening My Size Changer Menu!'
icons:
  'grow-icon':
    name: '<green><bold>Change Your Size'
    lore:
      - '<yellow>Left click <gray>to GROW'
      - '<yellow>Right click <gray>to SHRINK'
    material: green_wool
    x: 4
    y: 1
    left-click-actions:
      - 'console: attribute {player} minecraft:scale base set 4'
    right-click-actions:
      - 'console: attribute {player} minecraft:scale base set 0.25'
  'reset-icon':
    name: '<red><bold>Reset'
    material: red_wool
    x: 6
    y: 1
    left-click-actions:
        - 'console: attribute {player} minecraft:scale base reset'

​
More Examples

Shops

Buy and sell items using menus

Kits

Select kits based on permission access in menus

Profiles

Display player profile information in menus

Live Examples

See advanced menus in action on various servers

​
Next Steps

Icon Options

Explore icon properties