Content generated with AI — it may contain mistakes.

ExyliaCapture/ReferenceUpdated in v1.3.0

Configuration

Where ExyliaCapture's files are, what you can change in game, and every key of config.yml with its default.

Page 15 of 237 min read
     

Most of what you need is a button, not a file: run /captureadmin, click Settings and change the language, timezone, zone outline, leaderboard and Discord announcements in game. Open this page when you want a file's location or every key and default.

Where the files are#

The files live in plugins/ExyliaCapture/ and are written on the first boot with their defaults and a comment on every key. config.yml and database.yml sit at the top; everything a player reads (messages, sidebars, menus) lives in a language folder under lang/:

plugins/ExyliaCapture/
├── config.yml
├── database.yml
└── lang/
    └── <code>/
        ├── messages.yml
        ├── scoreboards.yml
        └── menus/

The settings of each event (zones, times, rewards, schedules) are not in a file: they are stored in the database and edited from /captureadmin. See Event types.

After editing a file, run /captureadmin reload. It re-reads the files, the event configurations and the menus, and restarts the scheduler. database.yml is read at startup only, so changing the engine needs a restart. See Commands.

Change it in game#

Run /captureadmin and click Settings. Four pages cover the keys owners touch most:

PageWhat you can change
GeneralLanguage and Timezone.
Zone outlineOutline (on or off) and View range.
LeaderboardRows and Player heads.
DiscordAnnouncements (on or off) and Server name.

A change is written to config.yml. Everything else on this page (outline particle and speed, leaderboard icons, the webhook URL, where events are shared) is only in the file. Times on the event, zone and Destroy The Core screens are typed as a length, such as 30s, 2m30s or 1h.

config.yml#

language#

yaml
language: default

default follows the language set in ExyliaLib's config.yml. en, es, pt, fr, ru or tr set this plugin alone; each is a folder under lang/ you can edit. To translate or reword anything a player reads, edit the files in that folder. See Messages and languages.

A server that already ran the plugin before languages existed starts in custom: the first update moves its old messages.yml, scoreboards.yml and menus/ into lang/custom/ and sets language: custom, so nothing you edited is lost. A fresh install starts in default.

scheduler#

yaml
scheduler:
  timezone: ""

The clock that schedules are read against. Empty uses ExyliaLib's own timezone, which is where a network should set it once. Use an id such as America/New_York to give this plugin its own. An id that does not exist is logged as an error and ExyliaLib's timezone is used instead. See Schedule events.

particles#

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

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

leaderboard#

yaml
leaderboard:
  top-limit: 50
  use-player-heads: true

top-limit is how many rows a leaderboard holds (1 to 500); use-player-heads draws each row as that player's head. The icons of the top three and of the filters are in the same block. See Statistics.

webhooks#

yaml
webhooks:
  enabled: false
  url: ""
  server-name: ""

Event starts and results posted to a Discord channel. The URL is a secret, so it is only editable in the file. See Discord webhooks.

events-scope#

yaml
events-scope: default

Which servers share the event configurations stored in the database. default follows the network group in ExyliaLib's config.yml (identical servers share; no group means one shared table), server gives each server its own, global shares with every server, and any other value is a group name. Read at startup.

event-visuals#

One entry per event type, keyed by its id (koth, koth_points_exclusive, koth_points_multi, koth_capture_points, conquest, payload, dtc, bounty), each with a hologram block: whether it shows, its size, offsets and view distance. What the hologram and the boss bar say is text and lives in messages.yml. A type added by an update writes its own entry on the next boot. See Customise boss bars, holograms and sidebars.

Every key of config.yml
KeyDefaultWhat it does
languagedefaultLanguage of menus, messages and sidebars.
scheduler.timezoneemptyTimezone of schedules; empty follows ExyliaLib.
particles.enabledtrueDraw the zone outline while an event runs.
particles.interval-ticks40Ticks between outline frames (20 = one second).
particles.particleWAX_ONAny Bukkit particle name.
particles.view-distance48.0How far a player can be and still see it (8 to 256 blocks).
event-visuals.<type>.hologramper typeHow each type's hologram is drawn.
leaderboard.top-limit50Rows a leaderboard holds (1 to 500).
leaderboard.use-player-headstrueDraw each row as the player's head.
leaderboard.rank-materials.first / second / thirdGOLD_BLOCK / IRON_BLOCK / COPPER_BLOCKIcons of the top three rows.
leaderboard.rank-materials.default-playerPLAYER_HEADOther player rows when heads are off.
leaderboard.rank-materials.default-clanSHIELDOther clan rows.
leaderboard.filter-materials.active / inactiveLIME_CONCRETE / RED_CONCRETEChosen and unchosen event filter.
webhooks.enabledfalsePost starts and results to Discord.
webhooks.urlemptyThe webhook URL. Keep it private.
webhooks.server-nameemptyFills %server% in the messages, such as the footer.
events-scopedefaultWhich servers share event configurations.

messages.yml#

lang/<code>/messages.yml holds every text the plugin sends, from the event messages to the leaderboard screens, the boss bars and the hologram lines, plus the Discord messages. Colours work as in the rest of Exylia: see Colours. prefix fills %prefix% in every other message.

Sections of messages.yml
SectionContains
prefixWhat fills %prefix% everywhere else.
eventsStart, end, winner and timeout messages shared by every type.
koth-capture-points, conquest, payload, dtc, bountyMessages specific to that type.
adminPanel and command responses.
leaderboardLeaderboard screens.
tabsThe tab strip inside the menus.
event-listThe /capture list.
reward-previewHow rewards are described to players.
placeholdersThe fallback words: none, unknown, not applicable, dash.
hologramsWhat a hologram shows before an event has a value.
event-typesEach type's name, three description lines and category tag.
rewardsclaimed, sent on the join that hands over waiting rewards, with %amount%.
boss-barsEach type's boss bar (text, colour, overlay), keyed by type id.
hologram-linesWhat each type's hologram says, keyed by type id.
setupWhat an operator reads while setting an event up: chat prompts, editor titles, selection steps.
webhooksThe Discord messages.

scoreboards.yml#

lang/<code>/scoreboards.yml has three sections: one sidebar per event type for a single running event, the compact lines each event adds when several run, and the shared multi-event sidebar. See Customise boss bars, holograms and sidebars.

database.yml#

The engine and its credentials. See Installation and Database.

Menus are YAML under lang/<code>/menus/: admin/ for the /captureadmin screens and user/ for the event list, the player and clan leaderboards and the event filter. You can change icons, slots, titles, lore and sounds; the action keys on each button tie it to what it does, so keep them. menus/admin/ is rewritten from the jar on every start, so edit menus/user/ only. See Edit menus.

Migrations#

config.yml is at version 5 and scoreboards.yml at version 2. An older file is migrated on the first boot after updating and every value you set is carried across.

What each version changed
  • Version 4 to 5: each type's boss bar and hologram lines moved from config.yml to messages.yml (boss-bars.<type>, hologram-lines.<type>), keeping your text. How the hologram is drawn stays in event-visuals.
  • Version 3 to 4: language: custom is added, pointing the server at the files it already had.
  • Version 2 to 3: the per-type blocks moved under event-visuals, keyed by type id. koth-capture-points became koth_capture_points, and koth-points was split into koth_points_exclusive and koth_points_multi, both starting from what it said.
  • Version 1: the old internal section is dropped and the boss bar color and style are renamed colour and overlay.
  • scoreboards.yml 1 to 2: scoreboards and compact-lines are rekeyed the same way.
Unknown keys are removed

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

Something missing on this page? Tell us on Discord