Configuration
Complete reference for config.yml and the plugin's other files.
Most of what you need is a button, not a file: run /ffaadmin, click Settings and change combat, fair play, arena and kill settings in game. Open this page when you want every key, a file's location or a default.
The files live in plugins/ExyliaFFA/. All of them are generated on the first boot with their
defaults and with comments explaining each key. config.yml, killstreaks.yml and database.yml
sit at the top; everything a player reads — messages, the sidebar and the menus — lives in a language
folder under lang/:
plugins/ExyliaFFA/
├── config.yml
├── killstreaks.yml
├── database.yml
└── lang/
└── <code>/
├── messages.yml
├── scoreboards.yml
└── menus/Editing in game#
Every key of config.yml can also be changed without opening the file: /ffaadmin → Settings
(the comparator in the bottom-left corner) opens ExyliaLib's settings screens, one card per section
of the file. A change is checked, written to config.yml keeping its comments and order, and loaded
as a reload would. The screens need exyliaffa.admin (or ExyliaLib's exylialib.config), and
/exylialib config ExyliaFFA opens the same screens.
Messages, the sidebar and the menus are not on these screens: edit them in lang/<code>/.
config.yml#
language#
language: defaultlanguagestringpor defecto defaultThe language of the plugin's menus, messages and sidebar. default follows the language set in
ExyliaLib's config.yml; en, es, pt, fr, ru or tr set this plugin alone. Each one is a folder
under lang/ you can edit.
custom holds the files a server had before languages existed: the first start after updating moves
the old messages.yml, scoreboards.yml and menus/ into lang/custom/ and sets
language: custom, so nothing an owner edited is lost. A fresh install has neither and starts in
default.
leaderboard#
leaderboard:
max-entries: 50max-entriesintegerpor defecto 50How many players a leaderboard holds, and the highest position a leaderboard placeholder can answer.
combat#
combat:
tag-duration: 20.0
blocked-commands: [spawn, hub, lobby, warp, home, tpa, tpaccept, tpyes, rtp, back]Covered in Combat. The countdown above the hotbar is text a
player reads, so it lives in messages.yml under combat.combat-actionbar.
anti-farmkill#
anti-farmkill:
enabled: true
same-player-enabled: true
same-player-max-kills: 3
same-player-window-seconds: 120
same-ip-enabled: truecommand-whitelist#
command-whitelist:
enabled: true
commands: [msg, message, tell, w, whisper, reply, r, respond, ffa, ffaadmin]anti-freehit#
anti-freehit:
hit-reset-window-seconds: 8The bar a linked player sees is in messages.yml, under anti-freehit.linked-actionbar.
kill-streaks#
kill-streaks:
enabled: true
reset-on-death: true
break-min-streak: 3The break announcement is in messages.yml, under kill-streaks.break-message. The ladder itself is
in killstreaks.yml. See Kill streaks.
respawn#
respawn:
leave-on-death: falseleave-on-deathbooleanpor defecto falsetrue sends whoever dies to the lobby. false leaves them in spectator mode with a menu to respawn
or leave, which is what most servers want.
kill-commands#
kill-commands:
on-kill: []
on-death: []Commands the console runs on each counted kill and on each death. They accept %killer% and
%victim%.
kill-commands:
on-kill:
- "eco give %killer% 25"
on-death:
- "title %victim% actionbar &7Killed by &c%killer%"on-kill runs on every kill, including one the anti-farmkill discarded for statistics. If you
hand out money per kill, two accounts on the same IP can fund themselves by killing each other. To
prevent it, gate the reward inside the command itself or in your economy plugin.
chat#
chat:
isolation: trueisolationbooleanpor defecto trueKeeps an arena's chat inside that arena: whoever is fighting or watching there reads that arena and
nothing else, and the rest of the server reads none of it. Two arenas never share a room either. Set
it to false to leave chat exactly as the server's chat plugin delivers it.
The message is never cancelled or re-sent — its format, hover text and click events are whatever the chat plugin gave it, and only the audience is smaller. The console keeps the full line. A chat plugin that cancels the event and sends each line itself has taken delivery over, and isolation quietly does not apply.
world-border#
world-border:
enabled: trueenabledbooleanpor defecto trueDraws a world border along the edge of each arena's region. Only the arena's own players and
spectators see it, it never deals damage and it never tints the screen red near the edge. It is only
drawn: the arena's bounds are enforced either way. Set it to false to save client FPS in small
arenas.
arenas-scope#
arenas-scopestringpor defecto defaultWhich servers share the arenas and their spawns. default follows the network group set in
ExyliaLib's config.yml (identical servers of a pool share arenas; no group means every server
shares), server gives each server its own, global shares with all, or name a group.
messages.yml#
lang/<code>/messages.yml. Every text the plugin sends, grouped by system:
| Section | Contains |
|---|---|
prefix | The prefix that fills %prefix% in every other message. |
common | Shared errors and responses. |
ffa | Joining, leaving, dying, arena not found, arena full, regeneration notices. |
stats | Names, icons and formatting of the nine counters. |
combat | Entering and leaving combat, blocked command, and the combat countdown bar (combat-actionbar). |
spectator-toggle | Spectator mode messages. |
kit-editor | Saving, cancelling and resetting a layout. |
invite | Invitations between players. |
kill-streaks | Streak notifications and announcements, and the break announcement (break-message). |
anti-freehit | The 1v1 link notice and the bar a linked player sees (linked-actionbar). |
admin | Admin panel responses, plus the setup prompts, refusals, confirmation screens and labels the admin menus use. |
player-settings | Settings menu texts. |
They all begin with %prefix%; delete it from a specific line to send that one without a prefix.
The two action bars fill %time% with the bare number and %time_precise% with the number and its
unit; the defaults use %time_precise% followed by the ⌚ glyph.
scoreboards.yml#
lang/<code>/scoreboards.yml. See Scoreboard.
killstreaks.yml#
See Kill streaks.
database.yml#
menus/#
Menus are editable YAML, in two folders:
lang/<code>/menus/
├── user/ FFA selector, kits, spawns, stats, spectator, settings
└── admin/ panel, arenas, rules (and its combat, kills and survival pages), kits,
PracticeCore kits, spawns, data, player data, confirmationsYou can change titles, sizes, icons, slots, lore and sounds. The action keys on each button are what tie it to what it does: keep them.
menus/admin/ is rewritten from the jar on every start, so nothing an owner is meant to edit lives
there. menus/user/ is yours: a missing file is written again, a new button reaches it on update, and
a changed default waits in /exylialib updates instead of overwriting what you edited.
Migrations#
The plugin versions its files and migrates them on its own, keeping your edits.
| File | Version | What it migrates |
|---|---|---|
config.yml | 5 | Reshapes the two action bars and corrects the countdown token to %time% (3); adds language: custom for a server that already ran the plugin, pointing it at its own files moved into lang/custom/ (4); moves the two action bars and the streak-break line into messages.yml, keeping whatever text you wrote (5). |
messages.yml | 2 | Updates the join, kit-editor and invitation lines you never edited to the new defaults. |
scoreboards.yml | 2 | Points the lines at the renamed occupancy placeholder. |
A key no file declares is removed on load and reported once as UNKNOWN_KEY. That is what keeps the
files clean after an update, and also why adding keys of your own to these files is a bad idea.
Something missing on this page? Tell us on Discord