tutorial/Nodes

 

Please make sure to read the basic tutorial before proceeding.

 

This page contains a list of possible nodes, that can be used for each icon.

 

Note

Three nodes are strictly required for each item: ID, POSITION-X, POSITION-Y.

ID

The item ID of the icon. You can use both numerical and literal ids, but I recommand using literals for better readability. List of IDs: here (case insensitive, and you can omit the underscore).

Example:

ID: stone


You can optionally use data values BUT you must put the value in single quotes. The amount is optional and is separated by a comma.

Example (10x black wool):

ID: 'wool:15, 10'


POSITION-X and POSITION-Y

There are two of the three required nodes. They set the position of the item inside the menu. You can easily find the coordinates with this table:

Example:

POSITION-X: 5
POSITION-Y: 1


NAME

This node sets the display name of the icon (in the first line, when you hover on it). You can use color codes and symbols.

Example:

NAME: '&6This is a colored name!'


LORE

This node sets the lines that appear below the name. You can use color codes and symbols.

Example:

LORE:
- 'Description of the item'
- 'Some other details'
- '&cImportant note'


ENCHANTMENT

This node sets the enchantments that will appear on an item, mostly used just for the glowing effect. List of enchantments: here.

Example:

ENCHANTMENT: 'fire aspect, 1'


The level is optional. You can use multiple enchantments by separating them with a semicolon:

Example:

ENCHANTMENT: 'sharpness, 5; durability, 10; silk touch'

COLOR

This node sets the color of a leather armor, nothing more. The format of the color is '<red>, <green>, <blue>'. Each color must be between 0 and 255. Color picker here.

Example:

COLOR: '255, 0, 0'


SKULL-OWNER

This node sets the skull owner of an item, only if it's a player's head (skull:3). Useful from 1.8 and above, for displaying different head textues.

Example:

SKULL-OWNER: 'filoghost'


COMMAND

This node sets the command. It supports a variety of commands, that will not be listed here. A normal command (without prefixes) is executed from player who clicked the icon. Commands (that should be called actions in this case) can also more things than just executing commands, look here to learn more.

Example:

COMMAND: 'spawn'


PRICE

This node sets a price for the items. The commands will not be executed if the player who clicked has not enough money for the command. Please look here how to setup the economy environment.

Example:

PRICE: 100.0


LEVELS

This node sets a price in experience levels for the items. The commands will not be executed if the player who clicked has not enough levels for the command. The levels will be removed.

Example:

LEVELS: 5


REQUIRED-ITEM

This node sets a a required item, without it the commands will not be executed. The format is the same of ID.

Example (30x orange stained glass):

REQUIRED-ITEM: 'stained glass:1, 30'


KEEP-OPEN

This node sets if a menu should be closed after clicking on the item (false by default). The value can be either true or false.

Example:

KEEP-OPEN: true


PERMISSION

This node sets if a particular permission is required to click on the item and execute the commands. The permission can be chosen arbitrarily. You can negate it, put a minus - before the permission, to require the user not to have that permission (e.g.: '-my.custom.permission')

Example:

PERMISSION: 'my.custom.permission'


VIEW-PERMISSION

Just like PERMISSION, but a user without this permission will not be able to see the item. Can be negated (e.g.: '-my.custom.permission').

Example:

VIEW-PERMISSION: 'my.custom.permission'


PERMISSION-MESSAGE

This node is linked to permission, it changes the message when the user clicks on an item without permission (the default "no permission" message is configurable in config.yml).

Example:

PERMISSION-MESSAGE: '&cYou must be VIP to use this item!'