Menus
The two editable menu files, what each button is wired to, the full action vocabulary and the placeholders a menu can read.
Rename, move, recolour or rewire the buttons in /bot and its Fine tuning screen. Both screens are
YAML files you own, and /botadmin reload applies your edits without a restart.
Before you start#
Menus use ExyliaLib's declarative YAML, so read Edit menus once for the item keys, the filler block and sounds. Colours are in Colours.
Steps#
Open the file
Open plugins/ExyliaPracticeBotV3/lang/<code>/menus/user/main.yml (the /bot hub) or advanced.yml
(Fine tuning), where <code> is the language set in config.yml.
Edit the item
Find the button in the tables below, then change its name, lore, material or slot. Its
actions list says what a click does.
Reload
Run /botadmin reload. Menus are re-read along with config.yml and messages.yml.
Check that it works#
Run /bot again: the button shows your wording or position, and a click still changes the same setting.
If a click does nothing, the action name is wrong; see the field lists.
The two files#
/bot opens one screen and that screen opens one more:
| File | Screen |
|---|---|
plugins/ExyliaPracticeBotV3/lang/<code>/menus/user/main.yml | The hub /bot opens: mode, difficulty, armour, hands, potions and the spawn buttons. |
plugins/ExyliaPracticeBotV3/lang/<code>/menus/user/advanced.yml | Fine tuning: the numeric sliders and the sandbox toggles. |
<code> is the language set in config.yml. A missing file is written again and a new button reaches
it on update, but what you edited is never overwritten: a changed default waits in
/exylialib updates for you to review. /botadmin reload re-reads both, along with config.yml and
messages.yml. The format is ExyliaLib's declarative menu YAML — see the
library's menus page for the item keys, the filler block and
sounds.
Screen menu style#
On a server whose ExyliaLib menu style is SCREEN, /bot and the Fine tuning screen draw as full
screens instead of chests: the bot stands in the round in the gear it is wearing, with every piece of
gear, mode, difficulty and the switches a click away (left-click for the next value, right-click for the
previous one or the second setting). The screens are screens/bot.html (which routes user/main) and
screens/bot_tuning.html, their words come from lang/<code>/screens/bot.yml and bot_tuning.yml, and
they run the same actions as the chest menus, so a click changes the same setting. Put your own style
rules in custom.css next to theme.css. A screen file that cannot be read keeps the chest menu and
logs why; /exylialib screens check lists what is wrong.
Menu ids are the path under menus/ without the extension, which is why both files live in user/.
It is the layout every Exylia plugin uses. Moving a file out of user/ changes its id and the plugin
will not find it. The staff settings hub lives in an admin/ folder (admin/settings,
admin/settings_bot, admin/settings_spawning, admin/settings_fighting); those files are rewritten
from the jar on every start, so do not edit them.
main.yml#
size: 54, type: SIMPLE, a grey glass filler, and refresh ON_CLICK so a button shows its new value
the moment you click it.
| Item | Slot | Left-click | Right-click |
|---|---|---|---|
mode | 3 | cycle mode | cycle mode back |
difficulty | 4 | cycle difficulty | cycle difficulty back |
advanced | 5 | open_advanced_settings | |
helmet | 10 | cycle helmet | cycle helmet_enchant |
chestplate | 19 | cycle chestplate | cycle chestplate_enchant |
leggings | 28 | cycle leggings | cycle leggings_enchant |
boots | 37 | cycle boots | cycle boots_enchant |
main-hand | 16 | cycle main_hand | cycle knockback |
off-hand | 25 | cycle off_hand | |
potions | 34 | cycle strength | cycle speed |
teleport | 43 | tp_to_bot | tp_bot_to_me |
toggle-shield | 13 | toggle shield_up | |
toggle-attack | 22 | toggle attack | |
toggle-follow | 31 | toggle follow | |
spawn | 48 | spawn | |
reset | 49 | reset_settings | |
remove | 50 | remove |
advanced.yml#
The same shell, plus parent: "user/main" — which is what makes the Back button at slot 49 work.
| Item | Slot | Left-click | Right-click |
|---|---|---|---|
attack-damage | 10 | adjust attack_damage 0.5 | adjust attack_damage -0.5 |
toggle-anti-knockback | 13 | toggle anti_knockback | |
follow-distance | 16 | adjust follow_distance 0.5 | adjust follow_distance -0.5 |
attack-reach | 19 | adjust attack_reach 0.1 | adjust attack_reach -0.1 |
toggle-slow-falling | 22 | toggle slow_falling | |
max-health | 25 | adjust max_health 2 | adjust max_health -2 |
attack-speed | 28 | adjust attack_speed 0.1 | adjust attack_speed -0.1 |
toggle-fire-resistance | 31 | toggle fire_resistance | |
shield-disable | 34 | adjust shield_disable 0.5 | adjust shield_disable -0.5 |
movement-speed | 37 | adjust movement_speed 0.1 | adjust movement_speed -0.1 |
totems | 40 | adjust totems 1 | adjust totems -1 |
toggle-instant-totems | 41 | toggle instant_totems | |
toggle-invincible | 43 | toggle invincible | |
back | 49 | back |
back is ExyliaLib's own action, not this plugin's; it needs the parent key above it and nothing
else.
Writing an action#
Actions go in an item's actions list, optionally prefixed with the click that fires them:
actions:
- "left: cycle helmet"
- "right: cycle helmet_enchant"An entry with no prefix fires on any click. Actions are written unprefixed and resolve in this
plugin's practicebot namespace, so cycle mode and practicebot:cycle mode are the same thing.
The full vocabulary#
| Action | What it does |
|---|---|
spawn | Spawns the player's bot where they stand. Needs exyliapracticebot.spawn; refuses in a world outside worlds, and refuses if they already have one. |
remove | Sends the bot away. Never needs a node. |
tp_to_bot | Teleports the player to their bot. Needs exyliapracticebot.teleport. |
tp_bot_to_me | Teleports the bot to the player. Needs exyliapracticebot.teleport. |
open_advanced_settings | Opens user/advanced. Needs exyliapracticebot.advanced. |
open_main | Opens user/main. No shipped file uses it; it is there for your own buttons. |
reset_settings | Asks for confirmation, then puts every setting back to the server default, kit included, and reopens the main menu. |
set_mode <mode> | Sets the mode outright. Unrecognised names fall back to NONE. Needs exyliapracticebot.mode.<mode>, except for NONE. |
set_difficulty <difficulty> | Sets the difficulty outright. Unrecognised names fall back to NORMAL. Needs exyliapracticebot.difficulty.<difficulty>. |
toggle <field> | Flips one boolean. The five Fine tuning toggles need exyliapracticebot.advanced. |
cycle <field> [back] | Steps one setting to its next value, or its previous with back. mode and difficulty skip the values the player has no node for. |
adjust <field> <delta> | Adds delta to one number, clamped and rounded. Needs exyliapracticebot.advanced. |
A click the player has no node for answers with bot.no-permission and changes nothing. See
Permissions.
set_mode and set_difficulty are there for a menu that wants one button per mode instead of one
cycling button. See Modes and
Difficulty for the names they accept.
toggle, cycle and adjust each accept exactly the fields below. A name that is not on its list
fails the action — the click does nothing and the setting is untouched. There is no way to add a field
from YAML.
Field lists for toggle, cycle and adjust
toggle <field>#
| Field | Setting |
|---|---|
attack | Whether the bot fights back at all. |
follow | Whether it follows its owner. |
shield_up | Stun-slam practice: the bot never swings and keeps a shield raised at you. See Behaviour. |
invincible | Never dies. |
instant_totems | A popped totem is back in hand on the next tick. |
anti_knockback | Ignores knockback entirely. |
slow_falling | Permanent Slow Falling. |
fire_resistance | Permanent Fire Resistance. |
cycle <field> [back]#
| Field | Steps through |
|---|---|
helmet, chestplate, leggings, boots | NONE → DIAMOND → NETHERITE |
helmet_enchant, chestplate_enchant, leggings_enchant, boots_enchant | NONE → PROTECTION → BLAST_PROTECTION |
main_hand | SWORD → AXE → MACE → TOTEM |
off_hand | NONE → TOTEM → SHIELD |
knockback | NONE → KNOCKBACK_1 → KNOCKBACK_2 |
strength | NONE → STRENGTH_1 → STRENGTH_2 |
speed | NONE → SPEED_1 → SPEED_2 |
mode | The seven combat modes |
difficulty | The five difficulties |
Every list wraps around at the end. back only means anything for mode and difficulty — everything
else is short enough that forward is the only direction anybody needs, and the argument is ignored
there.
adjust <field> <delta>#
| Field | Setting |
|---|---|
attack_damage | Damage of a fully charged, non-critical hit. |
attack_reach | Blocks it can hit from. |
attack_speed | Multiplier on the cadence the mode chose. |
movement_speed | Multiplier on walk and sprint speed. |
follow_distance | How close it stays when it is not fighting. |
max_health | Maximum health, in half-hearts. |
totems | Spare totems per life. |
shield_disable | Seconds an axe hit keeps its shield down. |
delta may be negative, and that is how the shipped files write their decrease buttons. Every result
is clamped to the matching pair in the limits block of config.yml and then rounded to one decimal,
so a button with a delta finer than 0.1 will appear to do nothing. totems is rounded to a whole
number after the clamp. See Limits.
Placeholders#
A menu file can read the player's current settings through these names. %name% is the label to
print, %name_material% is the icon to draw — which is how the armour column shows the actual piece
the bot is wearing and changes under the cursor.
All menu placeholders
| Placeholder | Holds |
|---|---|
%bot_active% | Whether the player has a bot out, as ON or OFF. |
%mode% | The mode's label. |
%mode_material% | The item the mode is drawn with. |
%mode_summary% | The one line explaining what the mode fights with. |
%difficulty% | The difficulty's label. |
%difficulty_material% | The item the difficulty is drawn with. |
%difficulty_summary% | The one line explaining what the difficulty changes. |
%attack_mode% | Whether the bot fights back, as ON or OFF. |
%follow_owner% | Whether it follows its owner, as ON or OFF. |
%shield_up% | Whether Shield up is on, as ON or OFF. |
%instant_totems% | Whether Instant totems is on, as ON or OFF. |
%invincible% | Whether it can die, as ON or OFF. |
%anti_knockback% | Whether it ignores knockback, as ON or OFF. |
%slow_falling% | Whether it has permanent Slow Falling, as ON or OFF. |
%fire_resistance% | Whether it has permanent Fire Resistance, as ON or OFF. |
%helmet% | The helmet's label. |
%helmet_material% | The helmet the bot is actually wearing, as an item. |
%helmet_enchant% | The helmet enchantment's label. |
%helmet_enchant_material% | That enchantment's icon. |
%chestplate% | The chestplate's label. |
%chestplate_material% | The chestplate the bot is actually wearing, as an item. |
%chestplate_enchant% | The chestplate enchantment's label. |
%chestplate_enchant_material% | That enchantment's icon. |
%leggings% | The leggings' label. |
%leggings_material% | The leggings the bot is actually wearing, as an item. |
%leggings_enchant% | The leggings enchantment's label. |
%leggings_enchant_material% | That enchantment's icon. |
%boots% | The boots' label. |
%boots_material% | The boots the bot is actually wearing, as an item. |
%boots_enchant% | The boots enchantment's label. |
%boots_enchant_material% | That enchantment's icon. |
%main_hand% | The weapon's label. |
%main_hand_material% | The weapon as an item. |
%off_hand% | The off hand's label. |
%off_hand_material% | The off hand as an item. A barrier when it is empty. |
%knockback% | The weapon's Knockback level, as a label. |
%strength% | The Strength level, as a label. |
%speed% | The Speed level, as a label. |
%attack_damage% | Damage of a fully charged hit, to one decimal. |
%attack_reach% | Attack reach in blocks, to one decimal. |
%attack_speed% | The attack speed multiplier, to one decimal. |
%movement_speed% | The movement speed multiplier, to one decimal. |
%follow_distance% | Follow distance in blocks, to one decimal. |
%max_health% | Maximum health in half-hearts, to one decimal. |
%shield_disable% | Seconds an axe hit keeps a shield down, to one decimal. |
%totems% | The totem reserve, or the unlimited label when it is below zero. |
Every label comes from the placeholders block of messages.yml, so renaming Diamond or recolouring
Strength II is that file's job and never this one's. %bot_active% is not used by either shipped
file; it is there for an owner who wants Spawn and Remove to say what state they are in.
The plugin registers no PlaceholderAPI expansion. Every name above is resolved by the menu that is
being drawn and exists nowhere else — not on a scoreboard, not in a hologram, not in another plugin's
message. There is no %practicebot_...% to put anywhere.
Something missing on this page? Tell us on Discord