Content generated with AI — it may contain mistakes.

ExyliaCapture/GuidesUpdated in v1.3.0

Customise boss bars, holograms and sidebars

Change the boss bar, holograms, sidebars, waypoints and zone outline players see during an event.

Page 10 of 2310 min read
     - "{warning}⚔ {highlight}&l%event_name%"    - " "    - "{letters}Time: {info}%event_time%"    - "{letters}Capturing: {highlight}%koth_capturer%"    - "{letters}Cap. time: {info}%koth_player_time%"    - " "    - "%event_status%"     - ""    - " {highlight}ᴇxʏʟɪᴀ.ɴᴇᴛ"

By the end of this page you have changed what players see during an event: the boss bar at the top, the hologram over the zone and the sidebar. Waypoints and the SurvivalCore HUD need no setup.

Before you start#

  • An event that exists. See Your first event.
  • Access to plugins/ExyliaCapture/lang/<code>/messages.yml and scoreboards.yml, where <code> is your language. Text and colours use ExyliaLib's tags: see Colours and Messages and languages.

Steps#

Turn the boss bar or sidebar on or off for one event

Run /captureadmin, click Configurations, click the event, then Bossbar or Scoreboard. Each click toggles it. Everything below only applies to events where they are on.

Edit the boss bar text

Open lang/<code>/messages.yml, find boss-bars, then your event type's id (koth, conquest, payload...), and change text, colour or overlay.

Edit the hologram lines

In the same file, find hologram-lines and the type's id. Each list entry is one line.

Edit the sidebar

Open lang/<code>/scoreboards.yml, find the type's id under scoreboards, and change its lines.

Reload

Run /captureadmin reload, or click Reload in /captureadmin.

Check that it works#

Start the event with /captureadmin start <id>. You should see the boss bar with your text and colour, the hologram over the zone and the sidebar on the right. A hologram is visible even when the event is not running: its last line then reads inactive or scheduled.

Going further#

Four independent layers, each with its own configuration and its own tokens, plus what a supported client draws on top. Tokens look like %event_name%; they are the plugin's own, not PlaceholderAPI placeholders, and only work in the file they are listed for. For PlaceholderAPI values see Placeholders.

Boss bar#

One per event type, in messages.yml, under boss-bars and that type's id, so it follows the plugin's language:

lang/<code>/messages.yml
yaml
boss-bars:
  koth:
    text: "{highlight}&l%capture_event_name%&r {muted}| {success}⚑ %capture_koth_capturer% {muted}| {info}%capture_koth_player_time% ⌚"
    colour: RED
    overlay: NOTCHED_20

colour takes PINK, BLUE, RED, GREEN, YELLOW, PURPLE or WHITE; overlay takes PROGRESS, NOTCHED_6, NOTCHED_10, NOTCHED_12 or NOTCHED_20.

The fill is the event's own progress, written every second — there is no countdown timer on the bar itself, because it would fight the progress the event is writing.

Default colours: KOTH red, both KOTH Points types blue, KOTH Capture Points purple, Conquest green, Payload yellow, DTC red, Bounty red. Every shipped bar uses NOTCHED_20. Bounty's bar names the target and their health, and empties as the target is worn down.

A single event can turn its bar off with the bossbar-enabled setting.

Holograms#

Also one per event type, and unlike the boss bar it is shown even when the event is not running: the last line, %event_status%, reads inactive, scheduled or running. What it says is in messages.yml, under hologram-lines and the type's id; how it is drawn — enabled, size, offsets, view distance — stays in config.yml, under event-visuals.<type>.hologram.

lang/<code>/messages.yml
yaml
hologram-lines:
  koth:
    - "{warning}⚔ {highlight}&l%event_name%"
    - " "
    - "{letters}Time: {info}%event_time%"
    - "{letters}Capturing: {highlight}%koth_capturer%"
    - "{letters}Cap. time: {info}%koth_player_time%"
    - " "
    - "%event_status%"

Conquest draws one hologram per zone, each with that zone's own name and progress. Payload's follows the cart. Bounty has nowhere to put one and draws none, although its block is still written.

Two events with a zone in the same place stack their holograms instead of drawing through each other, and a disabled event shows no hologram.

Hologram tokens#

These are the hologram's own tokens, filled in as the lines are drawn. They are not PlaceholderAPI placeholders and only work in hologram-lines.

All hologram tokens
TokenFamilyWhat it draws
%event_name%Any eventThe event's display name.
%event_time%Any eventTime left in the running event, or a dash.
%event_status%Any eventInactive, the time until it starts, or running.
%koth_capturer%KOTH, KOTH Points, Capture PointsWho holds the zone right now — the clan tag in clan mode.
%koth_player_time%KOTH, KOTH Points, Capture PointsHow much longer the current capture needs to complete.
%koth_leader%KOTH, KOTH Points, Capture PointsThe name in front on points.
%koth_top1_name%KOTH, KOTH Points, Capture PointsFirst on points.
%koth_top1_pts%KOTH, KOTH Points, Capture PointsTheir points.
%koth_top2_name%KOTH, KOTH Points, Capture PointsSecond on points.
%koth_top2_pts%KOTH, KOTH Points, Capture PointsTheir points.
%koth_top3_name%KOTH, KOTH Points, Capture PointsThird on points.
%koth_top3_pts%KOTH, KOTH Points, Capture PointsTheir points.
%conquest_zone_name%ConquestThe name of the zone this hologram belongs to.
%conquest_zone_capturer%ConquestThe clan capturing that zone.
%conquest_zone_progress%ConquestThat zone's capture progress.
%conquest_leader%ConquestThe clan in front across the whole event.
%conquest_top1_clan%ConquestFirst clan on points.
%conquest_top1_pts%ConquestIts points.
%conquest_top2_clan%ConquestSecond clan on points.
%conquest_top2_pts%ConquestIts points.
%payload_progress%PayloadHow far along the track the cart is.
%payload_distance_remaining%PayloadHow far it still has to go.
%payload_capturing_clan%PayloadWho is pushing it.
%payload_state%PayloadThe cart's state.
%dtc_leader%DTCThe name in front on points.
%dtc_top1_name%DTCFirst on points.
%dtc_top1_pts%DTCTheir points.
%dtc_top2_name%DTCSecond on points.
%dtc_top2_pts%DTCTheir points.
%dtc_top3_name%DTCThird on points.
%dtc_top3_pts%DTCTheir points.

scoreboards.yml holds three things:

SectionUsed when
scoreboardsExactly one event is running. One sidebar per type id.
compact-linesThe lines one event contributes to the shared sidebar, two by default, per type id.
multi-eventTwo or more events are running.

Both per-type sections are keyed by the type id, and every type has its own entry — koth_points_multi and koth_capture_points included, which no longer borrow another type's board.

With several events running, each contributes its two compact lines to one shared sidebar, up to four events. The multi-event section decides the title, the separator, the two line templates — where {n} becomes the event's index, 0 to 3 — and the footer.

scoreboards.yml
yaml
multi-event:
  title: "{warning}&l⚡ EVENTS"
  separator: ""
  line1-format: " %e{n}_l1%"
  line2-format: " %e{n}_l2%"
  footer:
    - ""
    - " {highlight}ᴇxʏʟɪᴀ.ɴᴇᴛ"
  update-interval: 2

Single-event sidebars refresh every 2 ticks by default, which is what a live capture timer needs.

Each event type fills its own sidebar tokens. They are the plugin's own, not PlaceholderAPI placeholders, and they only resolve inside scoreboards.yml.

All sidebar tokens
TokenEvent typesWhat it draws
%capture_event_name%AllThe event's display name.
%capture_event_time%AllTime left in the event.
%capture_zone_x%KOTH, KOTH Points, Capture Points, DTCThe zone centre's X.
%capture_zone_y%KOTH, KOTH Points, Capture Points, DTCThe zone centre's Y.
%capture_zone_z%KOTH, KOTH Points, Capture Points, DTCThe zone centre's Z.
%capture_koth_capturer%KOTH, Capture PointsWho holds the zone right now.
%capture_koth_capturer_clan%KOTHThat capturer's clan.
%capture_koth_player_time%KOTH, Capture PointsHow much longer the current capture needs.
%capture_koth_required%Capture PointsHow long a full capture takes.
%capture_koth_leader%Capture PointsThe name in front on points.
%capture_koth_target%KOTH Points, Capture PointsPoints needed to win.
%capture_koth_player_points%KOTH Points, Capture PointsThe reader's own points.
%capture_koth_top1_name%KOTH Points, Capture PointsFirst on points.
%capture_koth_top1_pts%KOTH Points, Capture PointsTheir points.
%capture_koth_top2_name%KOTH Points, Capture PointsSecond on points.
%capture_koth_top2_pts%KOTH Points, Capture PointsTheir points.
%capture_koth_top3_name%KOTH Points, Capture PointsThird on points.
%capture_koth_top3_pts%KOTH Points, Capture PointsTheir points.
%capture_dtc_target%DTCPoints needed to win.
%capture_dtc_player_points%DTCThe reader's own points.
%capture_dtc_top1_name%DTCFirst on points.
%capture_dtc_top1_pts%DTCTheir points.
%capture_dtc_top2_name%DTCSecond on points.
%capture_dtc_top2_pts%DTCTheir points.
%capture_dtc_top3_name%DTCThird on points.
%capture_dtc_top3_pts%DTCTheir points.
%conquest_target%ConquestPoints needed to win.
%conquest_zone1%ConquestThe first zone's line — two zones at once past four zones.
%conquest_zone2%ConquestThe second zone's line.
%conquest_zone3%ConquestThe third zone's line.
%conquest_zone4%ConquestThe fourth zone's line.
%conquest_top1_clan%ConquestFirst clan on points.
%conquest_top1_pts%ConquestIts points.
%conquest_top2_clan%ConquestSecond clan on points.
%conquest_top2_pts%ConquestIts points.
%conquest_top3_clan%ConquestThird clan on points.
%conquest_top3_pts%ConquestIts points.
%payload_progress%PayloadHow far along the track the cart is.
%payload_distance_remaining%PayloadHow far it still has to go.
%payload_capturing_clan%PayloadWho is pushing it.
%payload_state%PayloadThe cart's state.
%bounty_target%BountyThe target's name.
%bounty_target_health%BountyTheir health in hearts, to one decimal.
%bounty_target_position%BountyWhere they are, as X, Z.
%bounty_reward%BountyThe winner reward, as players read it.

Conquest, Payload and Bounty keep capture_ on the two shared tokens only; their own tokens carry no prefix.

A single event can turn its sidebar off with the scoreboard-enabled setting.

Client waypoints#

If the player's client is Lunar with Apollo, or Feather, the running event's zone is marked on their screen in the event's own colour. The marker is added when the event starts and removed when it ends. Payload's follows the cart; DTC marks the core block; Bounty's follows the target, for every player but them, while track-target is on.

Nothing needs configuring: without a supported client, no waypoint is sent and nothing else changes.

SurvivalCore HUD#

Players on the SurvivalCore client get more, on top of everything above — never instead of it:

ElementWhat it shows
HUD timerThe event's clock: counting down to the end, or up from the start when the event runs until somebody wins.
BeamA pulsing beam at the zone's centre, in the event's colour.
Zone borderThe zone's walls, in the event's colour.
HUD barThe boss bar again, with the same text and progress.
Waypoint iconA crown on KOTH zones, a flag on Conquest zones and the Payload cart, a sword on the DTC core, a skull on the Bounty target.

An event without a zone of its own draws no beam or border. Like the waypoints, nothing needs configuring.

Zone outline#

The particle outline around a running zone is covered in Zones.

Something missing on this page? Tell us on Discord