Menus
The twenty-one menu files, which ones survive an update, what each screen does, and every aimtrainer action a file can bind.
Twenty-one files ship under plugins/ExyliaAimTrainer/lang/<code>/menus/, one set per language (en, es,
pt, fr, ru, tr; custom for a server that had menus before languages existed). See
Configuration · language. They are updated in two
different ways.
| Files | Count | On every start and every reload |
|---|---|---|
menus/*.yml (the player screens and hotbar.yml) | 16 | Kept up to date without undoing your edits. Yours. |
menus/admin/*.yml | 5 | The folder is replaced with the one in the jar. |
The player screens and the hotbar go through ExyliaLib's bundled-file update:
- a missing file is written, unless it was installed before and you deleted it;
- a key new in a release is added to your file at once, comments included;
- a default that changed on a key you never touched is not applied, but listed in
/exylialib updates, where you apply or keep it; - anything you changed or deleted is never touched.
menus/admin/ is replaced wholesale on every start and every reload. Edits to it are lost without a
warning.
A file that fails to parse is reported in the console with its path and the reason, and that one screen does not open until it is fixed. A broken hotbar is reported the same way, and the drill runs without it.
The format is ExyliaLib's declarative menu YAML; see the library's menus page.
The player screens#
| File | Opened by | What it shows |
|---|---|---|
main.yml | /aim | (Under the SCREEN menu style, a native screen from screens/main.html with tabs for home, drills, duels, profile, boards and settings; result.yml has screens/result.html.) The hub: Drills, Duel, Settings, your profile, Leaderboards and History. A Leave button appears only while you are in a drill or a duel. |
drills.yml | /aim drills, Drills | One row per drill, in config.yml order, with its duration and your best rating, which arrives once the database answers. A click starts it; from inside a drill it changes the drill instead. The settings button returns here. |
settings.yml | /aim settings, Settings in the hub, the drill list, the hotbar and the summary screen | The settings hub: the difficulty your settings add up to and two cards, Targets and Screen. Back returns to the screen it was opened from. |
settings_targets.yml | Targets in the settings hub | Size and distance (left click up, right click down, shift click to type an exact value), colour and style (left next, right previous). Back returns to the hub. |
settings_screen.yml | Screen in the settings hub | The five switches: sidebar, boss bar, action bar, hit sounds and particles. Back returns to the hub. |
opponents.yml | /aim duel, Duel | Every online player you can see, those free to duel first. Refreshed every second while open. A busy player shows why and cannot be clicked. |
duel.yml | A free player in the picker | Their record, one format button (left click next, right click previous) and the drill list. The format you pick is remembered on your profile. A drill click sends the request. |
profile.yml | /aim profile, the hub | Lifetime numbers, duel record, duel streak, and buttons to Records, Sessions, Duel history and Leaderboards. The rating, accuracy, hits and shots are those of the edition the player is on. |
records.yml | Records in a profile | Your best result per drill on the edition you are on, in config.yml order. Always your own, even from another player's profile. |
sessions.yml | /aim sessions, History in the hub, the profile | Your recent drills, newest first. A personal best is drawn as a star. |
history.yml | /aim history, the sessions screen, the profile | Your recent duels, newest first, as a victory or a defeat. |
leaderboard_drills.yml | /aim leaderboard, Leaderboards | The overall board, then one board per drill. |
leaderboard.yml | A board in the picker, /aim leaderboard <drill> | The top leaderboard.entries players of the viewer's own edition. The Sort by button (slot 46; left click next category, right click previous) re-sorts the open board in place; the Edition button (slot 47) swaps it to the Java or Bedrock board, keeping the category. The overall board has only Rating and Accuracy. |
drill_result.yml | A drill ending | Rating, score, difficulty, accuracy, speed, and your previous best with the change. A Personal best item appears when you beat it. Play again, Change drill, Settings and Leave. |
result.yml | Coming back from a duel that ended less than a minute ago | Winner, runner-up, the series score and a Rematch button, greyed out when the opponent has left. |
The hotbar#
hotbar.yml is drawn over the hotbar during a drill and during a duel. Its items are packets, not real
items: nothing can be dropped or moved. Slots 0 to 4 are left to the real inventory, because slot 0 holds
the drill's weapon.
| Slot | Button | Right click runs |
|---|---|---|
| 5 | Change drill | aimtrainer:open drills |
| 6 | Settings | aimtrainer:open settings |
| 7 | Play again | aimtrainer:replay |
| 8 | Leave | aimtrainer:leave |
In a duel Play again does nothing: there is no drill of your own to replay. Change drill still opens the list there, but a pick is refused as busy.
The admin screens#
Reached through /aimtraineradmin. Everything destructive asks first through ExyliaLib's confirmation dialog; either answer reopens the screen the click came from.
| File | What it does |
|---|---|
admin/main.yml | Counts of arenas, ready arenas, running duels, running drills and players in a drill or duel, and buttons to Settings, to Arenas, Running duels, Players and Reload. |
admin/arenas.yml | Every arena, sorted by id. One that is enabled and has a spawn is a grass block; anything else is a coarse dirt block marked [NO SPAWN]. Create arena asks for an id. |
admin/arena.yml | One arena: rename it (up to 64 characters, colours allowed), set its spawn, enable or disable it, delete it. |
admin/settings.yml, admin/settings_training.yml, admin/settings_duels.yml, admin/settings_practice.yml, admin/settings_records.yml | The settings hub and its four pages, reached from the Settings card of the admin hub; see Arenas. |
admin/duels.yml | The duels running now. A click asks to cancel one; both players are sent back and nothing is stored. |
admin/players.yml | Online players with their rating, accuracy, sessions and duel record. Free players: click to reset their statistics. Busy players: left click stops their session, right click resets. |
- [NO SPAWN] also marks a disabled arena that has a spawn, although its lore says to set one.
- Status (to disabled) and Delete stop every drill and cancel every duel in the arena first. Disabling asks for no confirmation; deleting does.
- Stop the session has no confirmation and only stops a drill. On a player in a duel it does nothing; cancel the duel from Running duels instead.
- Reset statistics opens ExyliaLib's player reset for this plugin; see Stats.
Actions#
Every click a menu file, the hotbar or another plugin's file can name lives under the aimtrainer
namespace. Actions that read a row only work from the screen that supplies that row.
Player actions#
| Action | Arguments | What it does |
|---|---|---|
aimtrainer:open | [screen] | Opens a screen: main, drills, settings [origin], settings_targets [origin], settings_screen [origin], opponents, profile (your own), records, history, sessions, leaderboard_drills, or leaderboard <drill> [category]. No argument or anything else opens main. origin is the screen Back returns to. |
aimtrainer:train | <drill> | Closes the menu and starts that drill. Inside a drill session it changes the session to that drill instead, in the same arena. |
aimtrainer:replay | — | Closes the menu and runs your current drill again from its countdown, with your current settings. |
aimtrainer:leave | — | Closes the menu, if any, and leaves your drill or forfeits your duel. |
aimtrainer:setting | <size|distance|colour|style> [step] | Moves a setting by a signed number of clicks, 1 by default. Also size_value <number> and distance_value <number> for an exact multiplier, brought inside the range. The open settings screen redraws in place. |
aimtrainer:setting_input | <size|distance> | Closes the menu and asks for an exact multiplier inside the configured range, then reopens the settings. |
aimtrainer:toggle | <sidebar|boss_bar|action_bar|hit_sounds|particles> | Flips one switch. |
aimtrainer:format | [step] | Moves the open duel screen's format by a signed number of steps, 1 by default, and remembers it. |
aimtrainer:select_format | <bestOf> | Picks a format on the open duel screen and remembers it. Kept for menu files written before the single format button. |
aimtrainer:duel_open | — | Row action in opponents.yml: opens the duel screen for that player. |
aimtrainer:duel_send | <drill> | On the duel screen: sends the request with the selected format. |
aimtrainer:leaderboard_drill | [drill] | Opens that board by rating: the drill named, or the row's drill in leaderboard_drills.yml. |
aimtrainer:leaderboard_sort | [step] | On leaderboard.yml: re-sorts the open board by the next category (-1 the previous). The overall board cycles only Rating and Accuracy. |
aimtrainer:leaderboard_category | — | Row action in the categories of leaderboard.yml: re-sorts the open board. |
aimtrainer:leaderboard_edition | — | On leaderboard.yml: swaps the open board between Java and Bedrock, keeping its category. |
aimtrainer:rematch | — | Sends a request with the same drill and format, and a fresh seed, to the opponent of your last duel. result.yml passes %match_id%, which the action ignores. |
A setting changed while you are in a drill is saved and applies from the next one. train, replay and
a drill change from inside a session share a two-second wait: a click inside it does nothing.
Every action checks the node of the command it stands for, and open the node of the screen it opens;
see Permissions.
Admin actions#
| Action | Arguments | What it does |
|---|---|---|
aimtrainer:admin_open | [main|arenas|arena <id>|duels|players] | Opens a staff screen; main by default. |
aimtrainer:admin_reload | — | Runs the reload and reopens the admin menu. |
aimtrainer:admin_arena_create | — | Asks for an id; the arena is stored lowercased, named after what was typed, and its screen opens. |
aimtrainer:admin_arena_rename | <id> | Asks for a display name. |
aimtrainer:admin_arena_spawn | <id> | Starts the setup wizard: stand where the spawn goes, facing where the targets should appear. |
aimtrainer:admin_arena_toggle | <id> | Enables or disables the arena; disabling stops everything running in it. |
aimtrainer:admin_arena_delete | <id> | Asks for confirmation, then stops everything in the arena and deletes it. |
aimtrainer:admin_duel_cancel | <match uuid> | Asks for confirmation, then cancels the duel. |
aimtrainer:admin_session_stop | <player uuid> | Stops that player's drill, without confirmation. |
aimtrainer:admin_player_reset | <player uuid> | Opens ExyliaLib's player reset for this plugin. |
Every one checks exyliaaimtrainer.admin; a click without it does nothing. See
Permissions.
What a drill row knows#
Every screen that lists drills — drills.yml, duel.yml and leaderboard_drills.yml — builds the row the
same way, so these values work in any of their templates:
| Placeholder | Value |
|---|---|
%drill_id% | The key in drills. |
%drill_name% | display-name. |
%drill_icon% | icon. |
%drill_description% | description. |
%drill_kind% | The kind's name from menu.kinds. |
%drill_duration% | duration, written out. |
%drill_targets% | targets. |
%drill_size% | size. |
%drill_distance% | distance.min-distance.max. |
%drill_weight% | weight. |
drills.yml adds %size%, %distance%, %difficulty%, %best_rating%, %best_score%,
%best_accuracy% and %sessions% for the viewer; duel.yml adds %format% and %rounds_to_win%.
Any screen can also use the plugin's own %exyliaaimtrainer_*% placeholders, as main.yml does; see
Placeholders.
Something missing on this page? Tell us on Discord