Reference

Configuration

Every file the plugin writes, and what lives in each.

Files live in plugins/ExyliaCapture/. All are written on the first boot with their defaults and with comments on every key.

config.yml

Everything global. Per-event settings are not here — they live in the database and are edited from the panel.

scheduler

scheduler:
  timezone: ""

timezonezone idpor defecto empty

Which clock schedules are read against. Empty uses ExyliaLib's own timezone setting, which is where a network should set it once. Takes an IANA id such as America/New_York; an id that does not exist is logged as an error and ExyliaLib's timezone is used instead.

particles

particles:
  enabled: true
  interval-ticks: 40
  particle: WAX_ON
  view-distance: 48.0

The outline drawn around a running event's zones. Covered in Zones.

event-visuals

One block per event type, keyed by the type id — koth, koth_points_exclusive, koth_points_multi, koth_capture_points, conquest, payload, dtc and bounty — each with a boss-bar and a hologram. A type added by an update writes its own entry on the next boot. Covered in On-screen visuals.

leaderboard

leaderboard:
  top-limit: 50
  use-player-heads: true
  rank-materials:
    first: GOLD_BLOCK
    second: IRON_BLOCK
    third: COPPER_BLOCK
    default-player: PLAYER_HEAD
    default-clan: SHIELD
  filter-materials:
    active: LIME_CONCRETE
    inactive: RED_CONCRETE

Covered in Statistics.

Times on the admin screens are typed

Every duration in the event, zone and Destroy The Core screens is asked for as a length of time — 30s, 2m30s, 1h — rather than clicked up one step at a time, and what the plugin writes back reads the same way.

scoreboards.yml

Three sections, the first two keyed by type id: one sidebar per type for a single running event, the compact lines each event contributes when several run, and the shared multi-event sidebar. See On-screen visuals.

messages.yml

Every message, grouped by system:

Section	Contains
`prefix`	What fills `%prefix%` everywhere else.
`events`	Start, end, winner and timeout messages shared by every type.
`koth-capture-points`	Messages specific to that type.
`conquest`	Conquest messages, including the zone line formats.
`payload`	Payload messages.
`dtc`	Destroy The Core messages.
`bounty`	The target being picked, revealed, killed, lost or surviving.
`admin`	Panel and command responses.
`leaderboard`	Leaderboard screens.
`tabs`	The tab strip inside the menus.
`event-list`	The `/capture` list.
`reward-preview`	How rewards are described to players.
`placeholders`	The fallback words: none, unknown, not applicable, dash.
`holograms`	What a hologram shows before an event has a value: starts in, inactive, an empty zone, an idle cart.
`event-types`	Each type's name, three description lines and category tag, keyed by type id.
`rewards`	`claimed`, sent on the join that hands over rewards that were waiting, with `%amount%`.

database.yml

Engine and credentials. See Installation · Choosing an engine.

menus/

Menu layouts as YAML, editable without touching code.

menus/
├── admin/    panel, event list and setup, type selector, conquest zone list and
│             editor, schedules, commands and rewards, and one settings screen
│             per type: koth_settings, koth_points_settings,
│             koth_capture_points_settings, conquest_settings, payload_settings,
│             dtc_settings, bounty_settings
└── user/     event list, player and clan leaderboards, event filter

Icons, slots, titles, lore and sounds can be changed. The action keys on each button are what tie it to what it does: keep them.

Migrations

config.yml is at version 3 and scoreboards.yml at version 2. An older file is migrated on the first boot after updating, and every value you had set is carried across rather than regenerated:

Version 2 to 3 — the per-type blocks move under event-visuals, keyed by type id. koth-capture-points becomes koth_capture_points, and koth-points is split into koth_points_exclusive and koth_points_multi, both starting from what it said.
scoreboards.yml — scoreboards and compact-lines are rekeyed the same way.
Version 1 — the internal section is dropped and the boss bars' color and style are renamed to colour and overlay.

Unknown keys are removed

A key no file declares is deleted on load and reported once as UNKNOWN_KEY. That is what keeps the files clean across updates, and why adding your own keys to them does not work.

Something missing on this page? Tell us on Discord