Content generated with AI — it may contain mistakes.

ExyliaSandBox/ReferenceguideUpdated in v1.2.0

Edit the menus

Which of the twenty ExyliaSandBox menus you can edit safely, what opens each one, and how to reuse its actions in your own menus.

Page 15 of 244 min read

ExyliaSandBox ships twenty menu files per language under lang/<language>/menus/. Six are for players and are yours to edit; fourteen are admin screens that the plugin rewrites. This page tells you which is which and what opens each.

Before you start#

The general way to edit a menu (items, titles, sounds, placeholders) is in Edit menus. This page covers only what is specific to ExyliaSandBox.

Steps#

Edit only the player folder

Change files in menus/user/. A missing file is written back and a new key is added; a changed default waits in /exylialib updates, and anything you edited is left alone.

Leave the admin folder alone

Everything in menus/admin/ is rewritten from the jar on every start, and each file says so at the top. Edits there are lost at the next restart.

Reload

Click Reload in /sandboxadmin (see The admin panel). Menus recompile at once.

Check that it works#

Change the title of menus/user/world_selector.yml, reload, and run /rtp: the new title shows. If you changed a file in menus/admin/, expect it to be back to normal after a restart.

Going further#

The player screens#

FileOpened byWhat it shows
user/world_selector.yml/rtp, /rtpqueueEvery configured world. Each row's stack size is the players inside, and it glows only when the world is ready; clicking a world that is not ready does nothing
user/kit_selector.yml/rtp, the queues, /back, /tpaThe player's kits that have contents, sorted by slot. One file for all five flows; the flow that opened it decides what a click does
user/kit_creator.yml/kitcreatorThe player's slots, title <used>/<max>. Create Kit takes the first free slot, Predefined kits opens the templates, a saved kit opens its options
user/kit_options.ymlA saved kitEdit, Favorite, Rename, Icon, Delete and a preview of the kit
user/predefined_kits.yml/predefinedkitsThe admin templates that have contents; clicking one opens the copy screen
user/predefined_kit_copy.ymlA templateOne row per slot the player may use. Empty slots are green; taken slots are amber, glow, show the kit already there and warn it will be overwritten

The admin screens#

FileWhat it is
admin/admin.ymlThe hub; see The admin panel
admin/world_list.yml, world_config.yml, world_settings.yml, world_players.ymlThe world list, one world's draft, its gamerules and difficulty, and its players; see Worlds
admin/tp_region_list.yml, tp_region_editor.ymlThe teleport pads; see Teleport pads
admin/predefined_kit_list.yml, predefined_kit_editor.yml, predefined_practice_kits.ymlThe kit templates and linking a PracticeCore kit; see Kits
admin/settings.yml, settings_teleports.yml, settings_rules.ymlThe settings hub and its two pages; see The admin panel
admin/confirm.ymlThe shared confirmation screen: resetting worlds, deleting a world, a template, a pad or a saved kit

The SCREEN menu style#

Under ExyliaLib's SCREEN menu style, the world selector and the kit screens open as one on-screen page instead of chest windows: screens/sandbox.html, with a side bar of Worlds, Your kits and Kit library and a body that wears the kit under the cursor. It reads its rows and values from the six user/ files above. Its words live in lang/<language>/screens/sandbox.yml and its look in screens/theme.css; put your own rules in a custom.css beside it and the shipped files keep updating. The kit room and the kit editor stay chest windows. A file that cannot be read keeps the chest menus and logs why.

Reuse actions in your own menus#

Some actions work in menus, hotbar items or NPCs you build yourself (ExyliaLib actions, prefixed sandbox:):

ActionWhat it does
sandbox:open_world_selectorOpens the world list in RTP mode. Needs exyliasandbox.command.rtp
sandbox:open_kit_creatorOpens the kit creator
sandbox:open_kitroomOpens the kit room. Needs the kit room permission
sandbox:join_no_kit <world>Joins that world's queue with no kit chosen. The player still needs one saved, and exyliasandbox.command.rtpqueue plus exyliasandbox.join.nokit
sandbox:leave_queueLeaves the queue
Technical details
  • The shipped admin hub uses sandbox:open_kitroom, and the SCREEN page uses sandbox:open_world_selector and sandbox:open_kit_creator; join_no_kit and leave_queue are used by no shipped screen.
  • Twenty files: 6 in user/ and 14 in admin/. Languages shipped: en, es, fr, pt, ru, tr.
  • The confirmation screen is used for five things: resetting the worlds to defaults, deleting a world, deleting a predefined kit, deleting a teleport pad and deleting a saved kit.
  • Menu titles are drawn from the language folder chosen by language in config.yml.

Something missing on this page? Tell us on Discord