Customise sidebars, boss bars and music
Edit the sidebar of each game, its boss bars, the winner's celebration, nametags and event music.
By the end of this page you can change what players read on screen during a game (sidebar, boss bar, winner's celebration) and what they hear (event music). All of it ships with sensible defaults, so edit only what you want different.
Before you start#
The text files live in plugins/ExyliaEvents/lang/<code>/. They are regenerated per language; see Messages and languages. Run /eventsadmin reload after editing a file.
Steps#
Pick the thing to change
Sidebar: lang/<code>/scoreboards.yml. Boss bars, action bars and titles: the game's own section in lang/<code>/messages.yml. Celebration and music: config.yml.
Edit it
Change the lines, colours or values. Each game provides its own values inside its sidebar lines (round, timer, score, the player's kills).
Reload
Run /eventsadmin reload, then join a game of that type.
Check that it works#
Start a game of the type you edited with /eventsadmin forcestart <id> and join: the sidebar, bar or sound you changed shows up as written. Quiet an arena with Music on its setup screen and confirm no disc plays.
Going further#
The sections below cover each part.
Sidebars#
lang/<code>/scoreboards.yml holds one sidebar per event type, plus a lobby board shown while players wait.
Each is an ExyliaLib sidebar: a title, a list of lines and a refresh interval in ticks.
Example and keys
scoreboards:
lobby: ...
tnttag: ...
spleef: ...
csgo: ...
topkiller_teams: ...Each of the 54 registered types has its own key, team variants included, so a Quake board and a Quake Teams board are edited separately.
The values available inside the lines are the ones that type provides — its round, its timer, its score, the player's own kills — because each event builds its own scoreboard context.
The sidebar is drawn by ExyliaLib either way. What TAB changes is the handover: when TAB is installed, leaving an event restores the player to their normal TAB scoreboard and nametag rather than to nothing.
Boss bars#
messages.yml carries a boss bar per type that has one, in that type's own section, so it is
translated along with the type's messages:
Example and keys
tnttag:
boss-bar:
boss-bar:
text: '{primary}Eliminating in {error}%time% ⌚'
colour: PURPLE
overlay: NOTCHED_20
tagged-action-bar:
action-bar:
text: '...'Types with their own bars, action bars, titles or hologram lines include TNT Tag, Tag Game, Block
Party, Build Battle, Quake, CS:GO, Parkour, Chairs, Slap, Gem Crawler, Pillars of Fortune, LMS, Simon
Says, Survival Games, Mace Roulette and Tournament. The winner's celebration stays in config.yml:
see below.
Mace Roulette's section in messages.yml carries the bar the hunter races against and the title the
chosen player is shown. Its block in config.yml keeps two sounds, written as plain names rather than
effects:
Example and keys
maceroulette:
spin-tick-sound: BLOCK_NOTE_BLOCK_HAT
spin-stop-sound: "ITEM_MACE_SMASH_GROUND|0.7|1.0"spin-tick-sound is the tick as the mace moves from player to player: it is played at a pitch the
spin works out as it slows, and an effect carries only one fixed pitch. spin-stop-sound is written
NAME|volume|pitch.
Tournament's section in messages.yml is three separate effects rather than a bar: a freeze title before a match, the
same countdown on the action bar, and an "you're next" title for whoever fights after.
The winner's celebration#
Whoever wins gets a short sound and a small burst of particles, shown only to them. It is an
ExyliaLib effect under winner-celebration in config.yml, so a title, an action bar or a different
sound can be added the same way:
Example and keys
winner-celebration:
sound:
name: ENTITY_PLAYER_LEVELUP
volume: 0.7
pitch: 1.2
category: PLAYERS
particle:
name: END_ROD
count: 12
spread: 0.5
speed: 0.02Fireworks are off by default, since every nearby player sees them and not only the winner:
winner-fireworks.enabled is false with an empty fireworks volley, and Build Battle's
showcase-fireworks-enabled is false and uses that same volley. Updating turns both off on a
server that still had the volley the plugin used to ship; a volley the owner wrote is left as it is.
Nametags#
Seven types take their players' names off for as long as the game runs, because they are played on not knowing where somebody is and a name is drawn through the wall they hide behind: Hide and Seek, Block Morph Hunt, Murder Mystery, Quake, Quake Teams, CS:GO and CS:GO Teams.
With TAB installed, TAB hides the names and gives them back. Without it, the players are put in a scoreboard team that shows no names, and each one goes back to the team they were in before when they leave or the event ends, so a rank plugin's colour is returned rather than lost.
In the team variants — Quake Teams and CS:GO Teams — teammates still see each other's names, so an ally can be told from an enemy.
Team colours#
In every team event a player's name is drawn in their team's colour: through TAB when it is installed, through the scoreboard team otherwise. It goes back to normal when they leave or the event ends. See Teams, kits and loot.
Visibility#
player-isolation in config.yml, on by default, keeps everybody in an event — players and
spectators — out of sight of the rest of the server, in the world and in the tab list, and shows them
only each other. That is also what stops two events in nearby arenas from showing each other's
players. Turned off, everybody sees everybody.
Inside an event, spectators are hidden from the players in the game.
Music#
Events can play music discs to their participants:
Example and keys
settings:
event-music-enabled: true
event-music-volume: 0.5
event-music-interval: 150
event-music-discs: [MUSIC_DISC_PIGSTEP, MUSIC_DISC_CAT, ...]| Key | Default | What it does |
|---|---|---|
event-music-enabled | true | Whether events play music at all. |
event-music-volume | 0.5 | How loud. |
event-music-interval | 150 | Seconds between discs. |
event-music-discs | 19 discs | The pool it picks from. |
A player who does not want it uses /events music, which is stored per player and remembered.
Each configuration has its own switch too: Music on the setup screen, stored as music-enabled and
on by default, for an arena that should stay quiet while the others play. Chairs is the exception to
all three switches — its music is the game, so it always plays.
event-music-enabled: false silences it for everyone and makes the per-player toggle moot — the
usual choice on a server that already has its own ambience.
Something missing on this page? Tell us on Discord