Content generated with AI — it may contain mistakes.

ExyliaAimTrainer/GuidesUpdated in v1.2.0

Change the sidebar and screen HUD

The sidebar, the boss bar, the experience bar, hit feedback, sounds and particles: what each shows, where it is configured, and what a player can switch off.

Page 8 of 2512 min read
    - "{primary}&lAIM TRAINER"    - ""    - "{secondary}Drill:"    - " {letters_black}▎ {letters}%exyliaaimtrainer_drill% {muted}· {info}×%exyliaaimtrainer_difficulty%"    - " {letters_black}▎ {letters}Time {letters_black}» {info}%exyliaaimtrainer_time_left%"    - ""    - "{secondary}Live:"    - " {letters_black}▎ {letters}Score {letters_black}» {highlight}%exyliaaimtrainer_score%"    - " {letters_black}▎ {letters}Hits {letters_black}» {success}%exyliaaimtrainer_hits% {muted}· {error}%exyliaaimtrainer_misses%"    - " {letters_black}▎ {letters}Accuracy {letters_black}» {info}%exyliaaimtrainer_accuracy%%"    - " {letters_black}▎ {letters}Streak {letters_black}» {highlight}%exyliaaimtrainer_streak%"    - " {letters_black}▎ {letters}Last {letters_black}» %exyliaaimtrainer_grade%"    - ""    - "{muted}{server-ip}"    - "{primary}&lAIM TRAINER"    - ""    - "{secondary}Duel: {muted}· {letters}%exyliaaimtrainer_format%"    - " {letters_black}▎ {letters}vs {highlight}%exyliaaimtrainer_opponent%"    - " {letters_black}▎ {letters}Round {letters_black}» {info}%exyliaaimtrainer_round%"    - " {letters_black}▎ {letters}Series {letters_black}» {success}%exyliaaimtrainer_series%"    - " {letters_black}▎ {letters}%exyliaaimtrainer_match_state%"    - ""    - "{secondary}Round:"    - " {letters_black}▎ {letters}Time {letters_black}» {info}%exyliaaimtrainer_time_left%"    - " {letters_black}▎ {letters}You {letters_black}» {highlight}%exyliaaimtrainer_score% {muted}· {letters}%exyliaaimtrainer_hits% hits"    - " {letters_black}▎ {letters}Them {letters_black}» {highlight}%exyliaaimtrainer_opponent_score% {muted}· {letters}%exyliaaimtrainer_opponent_hits% hits"    - " {letters_black}▎ {letters}Accuracy {letters_black}» {info}%exyliaaimtrainer_accuracy%%"    - ""    - "{muted}{server-ip}"    

Around every run the plugin draws a sidebar, a boss bar with the time and score, an experience bar countdown, hit feedback and particles. Everything is drawn with packets, so your own scoreboard and inventory are never touched. This page shows how to change each one.

Before you start#

  • Access to the plugin folder on the server.
  • /aimtraineradmin reload re-reads the files without a restart.

Steps#

This edits the sidebar shown during a solo run.

Open the sidebar file

Open plugins/ExyliaAimTrainer/lang/en/scoreboards.yml (use the folder of your server's language, for example lang/es/).

Edit the lines

Under training: (solo run) or match: (duel), edit title and lines. A line can use any %exyliaaimtrainer_<name>% placeholder, written without the plugin name, such as %exyliaaimtrainer_score%, and any other placeholder ExyliaLib resolves.

Reload

Run /aimtraineradmin reload. Every player in a drill or duel gets the new sidebar at once.

Check that it works#

Run /aim train. The sidebar shows your new lines while you play, and your lobby board comes back when you leave.

Going further#

Hide the boss bar, or restyle it#

In config.yml, hud.boss-bar.enabled: false shows no boss bar to anybody. colour and overlay change how it looks, and its text is hud.boss-bar in lang/en/messages.yml.

Change the hit sounds and action bars#

Each event of a run (a perfect hit, a miss, a false start) is an entry under feedback in lang/en/messages.yml, with its own action bar, title and sound. Edit or blank the parts you do not want.

Turn off particles or the experience bar#

hud.hit-particle: "" draws no particles. hud.experience-bar: false leaves the player's experience alone.

What players can switch off#

In /aim settings then Screen, each player can hide the Sidebar, Boss bar, Hit feedback, Hit sounds and Hit particles for themselves. See Let players choose target size and colour. A player cannot turn on something you disabled in the config.

Technical details

Everything around a run is drawn with packets: the server's own scoreboard, experience and inventory are never touched. Five channels, configured in three places. What a player reads — the sidebar, the boss bar text and the hit feedback — is translated, so it lives under the plugin's lang/<code>/ folder; what only decides how a channel behaves stays in config.yml.

ChannelConfigured inA player can switch it off
Sidebarscoreboards.ymlYes — Sidebar
Boss barconfig.yml → hud.boss-bar, text in messages.yml → hud.boss-barYes — Boss bar
Experience barconfig.yml → hud.experience-barNo
Titles, action bars and soundsmessages.yml → feedbackAction bar and sounds — Hit feedback and Hit sounds
Hit particlesconfig.yml → hud.hit-particleYes — Hit particles

The hotbar buttons are part of the HUD too; they are a menu file and are described on Menus.

scoreboards.yml defines two sidebars: training, shown during a solo session, and match, shown to a duellist. It is shown when the player enters either, and rebuilt each time a solo run starts. Outside both, the plugin shows nothing, and whatever board a lobby plugin had underneath comes back on its own.

plugins/ExyliaAimTrainer/lang/en/scoreboards.yml
yaml
training:
  enabled: true
  title:
    - "{primary}&lAIM TRAINER"
  lines:
    - ""
    - "{secondary}Drill:"
    - " {letters_black}▎ {letters}%exyliaaimtrainer_drill% {muted}· {info}×%exyliaaimtrainer_difficulty%"
    - " {letters_black}▎ {letters}Time {letters_black}» {info}%exyliaaimtrainer_time_left%"
    - ""
    - "{secondary}Live:"
    - " {letters_black}▎ {letters}Score {letters_black}» {highlight}%exyliaaimtrainer_score%"
    - " {letters_black}▎ {letters}Hits {letters_black}» {success}%exyliaaimtrainer_hits% {muted}· {error}%exyliaaimtrainer_misses%"
    - " {letters_black}▎ {letters}Accuracy {letters_black}» {info}%exyliaaimtrainer_accuracy%%"
    - " {letters_black}▎ {letters}Streak {letters_black}» {highlight}%exyliaaimtrainer_streak%"
    - " {letters_black}▎ {letters}Last {letters_black}» %exyliaaimtrainer_grade%"
    - ""
    - "{muted}{server-ip}"
  update:
    interval: 10
    smart: true
    cache: true
match:
  enabled: true
  title:
    - "{primary}&lAIM TRAINER"
  lines:
    - ""
    - "{secondary}Duel: {muted}· {letters}%exyliaaimtrainer_format%"
    - " {letters_black}▎ {letters}vs {highlight}%exyliaaimtrainer_opponent%"
    - " {letters_black}▎ {letters}Round {letters_black}» {info}%exyliaaimtrainer_round%"
    - " {letters_black}▎ {letters}Series {letters_black}» {success}%exyliaaimtrainer_series%"
    - " {letters_black}▎ {letters}%exyliaaimtrainer_match_state%"
    - ""
    - "{secondary}Round:"
    - " {letters_black}▎ {letters}Time {letters_black}» {info}%exyliaaimtrainer_time_left%"
    - " {letters_black}▎ {letters}You {letters_black}» {highlight}%exyliaaimtrainer_score% {muted}· {letters}%exyliaaimtrainer_hits% hits"
    - " {letters_black}▎ {letters}Them {letters_black}» {highlight}%exyliaaimtrainer_opponent_score% {muted}· {letters}%exyliaaimtrainer_opponent_hits% hits"
    - " {letters_black}▎ {letters}Accuracy {letters_black}» {info}%exyliaaimtrainer_accuracy%%"
    - ""
    - "{muted}{server-ip}"
  update:
    interval: 10
    smart: true
    cache: true
KeyDefaultWhat it does
enabledtruefalse keeps the section written but shows no board for that context.
titleone lineA list. With several entries they animate: each refresh shows the next.
linessee aboveThe lines, top first. At most 15; extra lines are dropped.
update.interval10Ticks between refreshes. 20 ticks is one second.
update.smarttrueSends only the lines that changed instead of the whole board.
update.cachetrueKept for older files: parsed text is cached by ExyliaLib for every plugin at once.

The full key reference is the library's Sidebars section.

What the lines can say

Nothing is pushed into a board. The library renders it on its own interval and asks the placeholders, so a line is any text carrying this plugin's %exyliaaimtrainer_<name>% placeholders, and any other placeholder ExyliaLib resolves works too. This file is read by the plugin itself, so the names go without the plugin name in front; the full list, in the form other plugins read them, is on Placeholders.

Between two runs, some lines read the lifetime numbers

%exyliaaimtrainer_hits%, %exyliaaimtrainer_misses%, %exyliaaimtrainer_shots% and %exyliaaimtrainer_accuracy% mean the running run while one runs and the player's lifetime totals otherwise — and there is no running run during the countdown, while resting after a drill, or between two rounds of a duel. In those moments the default Hits and Accuracy lines show lifetime numbers, while Score and Streak read 0 and Last reads —. Write the lines with that in mind, or use %exyliaaimtrainer_phase% to tell the moments apart.

The player's switch

A player who turns Sidebar off in their settings loses the board at once, and gets it back at once when they turn it on again. The board also stays hidden in every later session until they do.

Boss bar#

Shown when the countdown of a run begins, with the drill's whole duration on it, and redrawn while the run goes. Its progress is the time left. Once the run ends it stays as the run left it until the player leaves or the next run begins.

plugins/ExyliaAimTrainer/config.yml
yaml
hud:
  boss-bar:
    enabled: true
    colour: PURPLE
    overlay: PROGRESS
    refresh-ticks: 5
plugins/ExyliaAimTrainer/lang/en/messages.yml
yaml
hud:
  boss-bar: "{primary}&l%drill% {muted}· {letters}%time% {muted}· {success}%hits% {letters}hits {muted}· {info}%accuracy%% {muted}· {highlight}%score% pts"
KeyDefaultWhat it does
enabledtruefalse shows no boss bar to anybody.
boss-bar in messages.ymlsee aboveThe bar's line. Before languages it was hud.boss-bar.text in config.yml; an older file is moved on its first start.
colourPURPLEPINK, BLUE, RED, GREEN, YELLOW, PURPLE or WHITE.
overlayPROGRESSPROGRESS, NOTCHED_6, NOTCHED_10, NOTCHED_12 or NOTCHED_20.
refresh-ticks5Ticks between two redraws. At least 1.

The text knows its own values, filled in on every redraw; they are not global placeholders.

ValueWhat it is
%drill%The drill's display name
%time%Seconds left, rounded up: 30, 1:30
%hits%Hits so far
%misses%Misses so far
%accuracy%Accuracy with no decimals, without the % sign: 87
%score%The live score
%streak%Hits in a row
%opponent_score%The opponent's live score in a duel; 0 in solo training

Experience bar#

With hud.experience-bar: true (the default), the level shows the seconds left and the bar empties as the run goes. It is one packet a second; the server's real experience is never changed, and it is sent again the moment the player leaves. There is no per-player switch.

For a REACTION drill the time is the drill's cap, since the run ends on its attempts.

Hit feedback#

Every event of a run plays an entry of feedback in messages.yml. Before languages it lived in config.yml; an older file is moved over on its first start, sounds included. Each entry is an ExyliaLib effect with any of a title, an action bar, a boss bar, a sound, a particle and a firework; a section that is left out does nothing. The fields are on the library's Effects page.

plugins/ExyliaAimTrainer/lang/en/messages.yml (excerpt)
yaml
feedback:
  perfect:
    effect:
      action-bar:
        text: "{success}⚡ PERFECT {muted}· {letters}%time%s {muted}· {info}x%streak%"
        duration: 1.5
      sound:
        name: ENTITY_EXPERIENCE_ORB_PICKUP
        volume: 0.7
        pitch: 1.8
    chat: ""
  miss:
    action-bar:
      text: "{error}✘ MISS {muted}· {letters}%accuracy%% accuracy"
      duration: 1.5
    sound:
      name: ENTITY_PLAYER_ATTACK_NODAMAGE
      volume: 1.0
      pitch: 1.0

During a run

These are the ones a player's Hit feedback and Hit sounds switches reach: turning one off plays the same effect with its action bar, or its sound, blanked. A title is never blanked.

EntryWhenDefault
perfectA hit graded PERFECTAction bar ⚡ PERFECT · %time%s · x%streak%, experience-orb sound at pitch 1.8
excellentA hit graded EXCELLENT✦ EXCELLENT, pitch 1.5
goodA hit graded GOOD✔ GOOD, pitch 1.2
okA hit graded OK• OK, pitch 1.0
slowA hit graded SLOW▼ SLOW, pitch 0.7
missA click that hit nothing✘ MISS · %accuracy%% accuracy, ENTITY_PLAYER_ATTACK_NODAMAGE
expiredA FLICK target that ran out of time⌛ EXPIRED · %accuracy%% accuracy, BLOCK_NOTE_BLOCK_SNARE
false-startA REACTION click before the light, or one faster than scoring.min-reaction-millis✘ TOO EARLY · wait for the light, ENTITY_VILLAGER_NO
armedA REACTION target lighting upSound only, BLOCK_NOTE_BLOCK_PLING
rushedA COMBO hit inside the attack cooldown✘ RUSHED · wait for the cooldown, ENTITY_PLAYER_ATTACK_WEAK

The five grade entries have a second field, chat: a chat line sent with the effect, empty by default. It is not affected by the player's switches. How a hit is graded is on Scoring.

The grade entries, miss, expired and rushed know these values:

ValueWhat it is
%grade%The grade in capitals: PERFECT. Empty outside a grade entry.
%time%The graded time in seconds, two decimals: 0.42. 0.00 outside a grade entry.
%hits%Hits so far
%streak%Hits in a row
%combo%The current combo
%accuracy%Accuracy with no decimals, without the % sign

The first hit of a run has no previous hit to be timed against, so it has no grade: it plays only the sound of the good entry, and only if the player has hit sounds on.

Around a run

These play the same for everybody, whatever the player switched off.

EntryWhenDefault
countdownEach second of the countdown; %time% is the seconds left, %time_precise% the same with its unitTitle %time% / Left click the targets, action bar Starting in %time_precise% ⌚, BLOCK_NOTE_BLOCK_HAT
goThe first target is liveTitle GO, BLOCK_NOTE_BLOCK_PLING
session-completeA solo drill ran its courseTitle TIME, UI_TOAST_CHALLENGE_COMPLETE
personal-bestThe run beat the player's best rating; knows %rating%Title NEW BEST / Rating %rating%, ENTITY_PLAYER_LEVELUP
match-foundBoth duellists have arrived in the arenaTitle MATCH FOUND / Teleporting…
round-wonA duel round wonTitle ROUND WON, ENTITY_PLAYER_LEVELUP
round-lostA duel round lostTitle ROUND LOST, BLOCK_NOTE_BLOCK_BASS
round-drawA duel round drawn and replayedTitle DRAW / Same score — replaying, action bar Round replayed
match-wonThe duel wonTitle VICTORY / Match won, UI_TOAST_CHALLENGE_COMPLETE
match-lostThe duel lostTitle DEFEAT / Match lost, ENTITY_WITHER_HURT

Hit particles#

plugins/ExyliaAimTrainer/config.yml
yaml
hud:
  hit-particle: "ELECTRIC_SPARK|8|0.15|0.15|0.15|0.05"

Drawn where a target was hit, to the player who hit it and nobody else. The line is NAME|count|dx|dy|dz|speed; an empty string draws nothing for anybody. A player with Hit particles off sees none.

When a switch takes effect#

SettingSettings keyTakes effect
SidebarsidebarAt once
Boss barboss_barFrom the next run, or the next round of a duel
Hit feedbackaction_barFrom the next run, or the next round
Hit soundshit_soundsFrom the next run, or the next round
Hit particlesparticlesFrom the next run, or the next round

A change made in the middle of a session also sends the settings.applies-next-drill line. The switches are stored on the profile, so they survive restarts. The names shown on the settings screen live in messages.yml under menu.toggles.

Standing still is not a setting

Nobody walks during a run: the plugin drops the client's own movement for as long as the HUD is up, for every player. There is no toggle for it.

Reloading#

/aimtraineradmin reload re-reads the three files and rebuilds the sidebar of every player in a session or a duel. The boss bar picks up a new text at its next redraw; its colour and overlay apply from the next run.

Something missing on this page? Tell us on Discord