Content generated with AI — it may contain mistakes.

ExyliaLib/Customise (all Exylia plugins)Updated in v1.595.0

Edit the menus of your Exylia plugins

Menus are plain files: change a title, an item name, an icon, a slot or a sound, hide a button, and reload.

Page 9 of 545 min read
     - "{letters_black}Setup section"  - ""  - "{primary}{icon:click} Click to manage"    - "minecraft:block.ender_chest.open|1.0|1.4"    - "ffa:select_kit %arena_id% %kit_id% %spawn_id%"

Every menu in an Exylia plugin is a text file you can edit. You will find the file, change a title, an item or a slot, and see the result in game.

All Exylia plugins build their menus the same way, through ExyliaLib, the library every Exylia plugin installs. So this page works for any plugin.

Find the menu file#

Menus live in each plugin's folder, inside the folder of the active language:

plugins/ExyliaFFA/lang/en/menus/
├── user/
│   └── kit_selector.yml
└── admin/
    └── ...

Replace ExyliaFFA with your plugin and en with your language (see Messages and languages). The file names say what the menu is.

Check the top of the file before you edit

Some files, usually the admin menus, start with a box saying "DO NOT EDIT THIS FILE MANUALLY". Those are rewritten on every start and your changes are lost. Edit only files without that box; the player-facing menus normally have none.

Change a menu#

Open the file

Open the menu's .yml file in a text editor that handles YAML. Keep the spaces at the start of lines exactly: they are part of the format.

Change what you want

See the examples below. Change only the values on the right of each colon.

Save and reload

Run the plugin's reload command (for ExyliaFFA, /ffaadmin reload). The next time someone opens the menu it uses your file.

If a part of a menu is wrong, such as an action that does not exist or a misspelled material, that button turns into a dead button and the console prints a line. The rest of the menu still opens.

Common changes#

Change the title or a button's name#

yaml
title: "{primary}&lSELECT KIT {muted}%current_page%/%total_pages%"

title is the text at the top of the window. Item names use the same text format as messages: colour names such as {primary}, & codes, hex and gradients. See Colours. Keep %current_page% and similar words between percent signs; the plugin fills them in.

Change an icon#

yaml
items:
  manage-arenas:
    slot: 11
    material: COMPASS

material is the item shown. Use a Minecraft item name in capitals, such as DIAMOND_SWORD. Some menus write a value between percent signs (%kit_icon%): the plugin picks the item for each row, so leave those alone.

Move a button#

slot is the position in the window, counting from 0 at the top left, left to right. A chest of 27 slots has three rows of nine: slot 0 to 8 is the top row, 9 to 17 the middle, 18 to 26 the bottom. Change slot: 11 to slot: 13 to move a button to the centre of the middle row.

Change the size#

yaml
size: 27

A chest has 9, 18, 27, 36, 45 or 54 slots. If you make it smaller, move every button that sat in a slot beyond the new size, or that button is skipped (the console says which).

Change the text under a name#

yaml
lore:
  - "{letters_black}Setup section"
  - ""
  - "{primary}{icon:click} Click to manage"

lore is the list of lines under the item name. An empty "" is a blank line.

Change the background#

yaml
filler:
  global:
    material: GRAY_STAINED_GLASS_PANE
    hide_tooltip: true

global fills every empty slot. Change material to change the colour of the glass.

Change the sounds#

yaml
open_sounds:
  - "minecraft:block.ender_chest.open|1.0|1.4"

Each line is sound|volume|pitch. Remove the line to silence it.

Hide or show a button by condition#

yaml
condition: "%lfc_state% == none"

The button is only there when the condition is true. A button that is hidden cannot be clicked. Leave existing conditions as they are unless you know the value they read.

Change what a button does#

yaml
actions:
  - "ffa:select_kit %arena_id% %kit_id% %spawn_id%"

Actions are the plugin's own commands. Do not invent new ones: reuse one a plugin already uses in a menu, or remove the actions lines to make a button decorative. You can run a different command only if the plugin documents an action for it.

Check that it works#

Reload, then open the menu in game with the command from the plugin's Commands page. You should see your title, your icon and your button in its new slot. If the menu does not open at all, read the console: it says which line is wrong.

If your edit disappears or does not apply#

  • The file says "do not edit". It is rewritten at every start. Edit a different file, or ask the plugin to expose the setting.
  • You edited another language. Edit the folder of the active language; it is the one in plugins/ExyliaLib/config.yml unless the plugin overrides it.
  • A plugin update changed the file. A default you did not touch is updated. A default that changes where you edited the file waits in /exylialib updates; applying it keeps your old file as <name>.v<old version>.
Technical details

type can be SIMPLE, PAGINATION, MULTI_PAGINATION, ITEM_INPUT or STATIC for chest windows, or a container such as HOPPER or ANVIL, which has its own fixed size. A list menu has a pagination block (slots, item_template, navigation). Clicks can be written by kind, such as left: command and right: command. A menu can set click_cooldown in milliseconds. menu-version at the top lets a plugin replace an untouched file when its layout changes. Full reference: Menus.

Something missing on this page? Tell us on Discord