Configuration
Where ExyliaClasses keeps its files, how to reload them, and every key in config.yml and messages.yml.
Most of what owners change is a button, not a file: run /classesadmin settings to edit the energy bar and the mark bar in game. Open this page when you want a file's location, a key or a default.
The files live in plugins/ExyliaClasses/. They are generated on the first start with comments explaining each key:
plugins/ExyliaClasses/
├── config.yml
└── lang/
└── <code>/
├── messages.yml
├── classes/
└── menus/config.yml holds the language, the debug flag and the two boss bars. Everything a player reads (messages, class names, ability names, menu texts) lives in lang/<code>/. The classes themselves are in lang/<code>/classes/: see Classes.
Reload after editing#
Run /classesadmin reload (permission exyliaclasses.admin.reload). It reloads, in order: the config files, the message prefix, the debug flag, the settings menus, the class files and every online player's class. A file with a mistake is reported instead of half-loaded. Class files added to the folder after the server started are loaded by the reload, but only appear in the web editor after a restart.
Change the language#
Set language in config.yml. default follows the language in ExyliaLib's own config.yml, so one line there switches every Exylia plugin; en, es, pt, fr, ru or tr set this plugin alone. Each language is a folder under lang/ that you can edit. A changed language takes effect on /classesadmin reload. For colour tokens, %prefix% and the language system in general, see Colours and Messages and languages.
On the first start of 1.1.0 the existing messages.yml is adopted as lang/custom/ and config.yml is pointed at it with language: custom, so nothing a server edited is lost. The two bar titles that used to be energy-bar.text and mark-bar.text move into that messages.yml as boss-bars.energy and boss-bars.mark. Set language to default or a code to switch to the shipped translations.
Change the bars#
The energy bar and the mark bar each have three keys in config.yml: enabled, colour and overlay. The same cards are in /classesadmin settings, which also edit the file. Their titles are text, so they live in messages.yml under boss-bars; what each title can show is on Energy.
energy-bar:
enabled: true
colour: "YELLOW"
overlay: "NOTCHED_20"Change a message#
Edit lang/<code>/messages.yml. Every message accepts the Exylia palette tokens, colour tags, & codes and placeholders. A message that starts with [sound:NAME|VOLUME|PITCH] plays that sound as it is sent; remove the prefix and it goes out silently. Menus are edited as described in Edit menus.
config.yml: every key
language: default
debug: false
energy-bar:
enabled: true
colour: "YELLOW"
overlay: "NOTCHED_20"
mark-bar:
enabled: true
colour: "RED"
overlay: "PROGRESS"| Key | Default | What it does |
|---|---|---|
language | default | Which folder under lang/ the messages, classes and menus are read from. |
debug | false | Prints integration status and load detail to the console. Turn it on when something behaves oddly. |
energy-bar.enabled | true | Show the energy bar. |
energy-bar.colour | YELLOW | PINK, BLUE, RED, GREEN, YELLOW, PURPLE or WHITE. |
energy-bar.overlay | NOTCHED_20 | PROGRESS, NOTCHED_6, NOTCHED_10, NOTCHED_12 or NOTCHED_20. |
mark-bar.enabled | true | Show the mark bar. |
mark-bar.colour | RED | Same colours as the energy bar. |
mark-bar.overlay | PROGRESS | Same segmentations as the energy bar. |
messages.yml: every message and its placeholders
Every message lives in lang/<code>/messages.yml. Beyond the ones listed, any placeholder works, resolved for whoever receives the message.
| Message | Sent to | Accepts |
|---|---|---|
prefix | Used as %prefix% in the other messages | none |
no-permission | The player, on wearing a gated class's armour | %class% |
warmup.timer | The player, once a second during the warmup | %class%, %time% (whole seconds), %duration% (formatted, 5s) |
warmup.ready | The player, when the class activates | %class% |
warmup.canceled | The player, when the warmup is interrupted | none |
class-section.removed | The player, when the class ends | %class% |
abilities.cooldown | The caster | %ability%, %time%, %duration% (formatted with tenths, 4.3s) |
abilities.used | The caster, on success | %ability% |
abilities.clan | Each clan target other than the caster | %player%, %ability% |
abilities.enemy | Each enemy target | %player%, %ability% |
abilities.no-energy | The caster | %needed%, %current% |
weapons.mark.applied | The shooter | %target%, %damage% |
weapons.mark.received | The marked player | %attacker%, %damage% |
weapons.mark.expired | The marked player, when the bar empties | none |
weapons.mark.same-class | The shooter | none |
weapons.backstab.success | The attacker | none |
weapons.backstab.victim | The target | %attacker% |
weapons.backstab.no-cooldown | The attacker | %current%, %needed% (both percentages) |
weapons.backstab.cant-dead | The attacker | none |
command.reload | Whoever ran the reload | none |
command.no-permission | Whoever ran a command without permission | none |
boss-bars.energy | The energy bar's title | Energy |
boss-bars.mark | The mark bar's title | Energy |
%class% and %ability% are inserted as formatted text, so the <#c8c8c8><bold>ARCHER</bold> written in a class file renders as colour instead of printing the tags.
Something missing on this page? Tell us on Discord