Configuration
Where ExyliaSurvivalCore keeps its files, what you change most (language, modules, teleports), what an edit survives, and how to reload.
Everything lives in plugins/ExyliaSurvivalCore/. config.yml holds the module switches, the language and
the teleport rules. Each module has its own folder, modules/<id>/, and the messages and menus are under
lang/<code>/. After editing, run /survivalcoreadmin reload (needs survivalcore.admin.reload);
see Reloading. Module switches are the one thing a reload does not apply: they take a restart.
Modules that moved to other plugins have no files here any more. Colours and message syntax are shared with every Exylia plugin: see Colours and Messages and languages.
Kinds of file
| Kind | Behaviour | Which files |
|---|---|---|
| Schema-backed | Fixed keys, generated with comments. A key the schema does not know is reported once as UNKNOWN_KEY and removed | config.yml and each modules/<id>/config.yml that has settings |
| Free-form | Written once with a header, never rewritten. Nothing is pruned, nothing you delete comes back | modules/reclaim/config.yml, modules/scheduled-commands/config.yml, modules/enchantments/rules.yml |
| Lifted out | A list that cannot live inside a schema record, kept in a sibling file. Written from the jar on a first install, never rewritten after | farming/categories.yml, join-leave/groups.yml, missions/missions.yml, projects/projects.yml, rankup/ranks.yml, repair/groups.yml, rtp/worlds.yml, seasons/seasons.yml, stats/stats.yml |
| Translated | Messages and menus, one copy per language under lang/<code>/ | lang/<code>/messages.yml, lang/<code>/modules/<id>/messages.yml, the menus below them |
A lifted-out file that already exists is treated as already moved, so a file you deliberately emptied
stays empty rather than having the shipped defaults written back over it. All of them except
repair/groups.yml are translated per language as well: the ranks, categories, missions, seasons, stats
and the rest are written in the language the plugin runs in.
Languages#
config.yml carries language. default follows ExyliaLib's language; en, es, fr, pt, ru or
tr set this plugin alone.
- Messages are
lang/<code>/messages.ymlfor the core andlang/<code>/modules/<id>/messages.ymlfor each module. Nothing player-facing is hardcoded. - Menus are
lang/<code>/menus/andlang/<code>/modules/<id>/menus/. The admin menus arelang/<code>/menus/admin/*and are regenerated from the jar on start; the player menus are yours to restyle. - A server that ran the plugin before languages existed keeps its files in
lang/custom/.
A line may open with an effect tag such as [sound:ENTITY_VILLAGER_NO|1.0|1.0], which is an instruction
and never reaches the screen. %prefix% is substituted from the plugin's prefix.
What an edit survives#
The shipped files are refreshed on every start. For each YAML file the plugin compares three things: your
file, the shipped file, and the defaults you last reviewed, which are kept in .defaults/files/ inside
the plugin folder.
- A missing file is written — unless it was installed before and you deleted it. A deleted menu stays deleted, and the console names the menu it could not register.
- A key the new version adds is written into your file at once, comments included.
- A default that changed or was removed, on a key still at the value you last reviewed, is left as it
is and listed in
/exylialib updates, where you apply or keep it. - Anything you changed or deleted is never touched.
- A file whose shipped
menu-version(ordefaults-version) is higher than yours is replaced whole; your previous file is kept next to it as<name>.v<old version>.
A file that does not parse is left untouched and reported.
config.yml#
| Key | Default | What it does |
|---|---|---|
language | default | See Languages |
debug | false | Extra console output |
defer-to-exylia-lobby | true | When ExyliaLobby is enabled, jumpads, join-leave and portals stay off and ExyliaLobby does those jobs. Spawn is unaffected. Needs a restart |
modules | all true | One switch per module — see below |
teleport | See teleport | |
combat-blocks-teleports | true | Refuses /spawn, /home, /warp, /rtp, /back, /tpa and portal teleports during combat. A warmup-skipping permission does not skip this |
idle-after-seconds | 300 | Idle time (0-86400) before time-played rewards stop counting the player. 0 turns it off |
modules#
One switch per module, all true by default. Set one to false and restart to turn that module off: it
registers no commands, listeners or tables, and its own files are left alone. The module guides under
Guides say what each one does.
All thirty switches and when a module stays off anyway
The switches: spawn, tpa, homes, join-leave, rtp,
scheduled-commands, rankup, player-utils, back, farming, reclaim, stats, portals,
jumpads, kits, item-spawners, warps, near, repair, death, enchantments,
player-settings, missions, boosters, seasons, optimization, item-updater, reputation,
projects and mobs.
mobs is a legacy switch that does nothing: custom mobs moved to ExyliaMobs and no module registers it.
It stays in the file so old configs keep loading.
A module also stays off, whatever its switch says, when another plugin does its job:
| Module | Stays off while |
|---|---|
farming | ExyliaJobs is installed |
item-spawners | ExyliaSpawners is installed |
jumpads, join-leave, portals | ExyliaLobby is enabled and defer-to-exylia-lobby is true |
A changed switch takes a restart; /survivalcoreadmin reload names the modules that are waiting for one.
teleport#
These are ExyliaLib's teleport settings. The plugin hands them to ExyliaLib's teleport module, which
applies them to every move the plugin makes. The ones owners change most are warmup-seconds (standing
still before the move, 0.0 by default) and cancel-on-move / cancel-on-damage (both true).
Every teleport key
| Key | Default | Range | What it does |
|---|---|---|---|
warmup-seconds | 0.0 | Standing still before the move | |
cancel-on-move | true | Moving cancels the warmup | |
cancel-on-damage | true | Taking damage cancels the warmup | |
safe-search-radius | 5 | 0-32 | How far to look for safe ground |
safe-max-attempts | 32 | 1-256 | Attempts to find safe ground |
cross-server-ttl-seconds | 300 | 30-3600 | How long a move to another server stays valid |
cross-server-settle-seconds | 0.5 | 0.05-5 | Pause after arriving on another server |
back-history-size | 3 | 1-16 | Locations /back remembers |
back-history-minutes | 30 | 1-1440 | How long they are remembered |
tpa-expiry-seconds | 60 | 5-3600 | See below |
tpa-max-pending | 8 | 1-64 | Requests waiting per player |
random-max-attempts | 16 | 1-64 | Attempts for a random location |
The plugin itself reads only back-history-minutes (for /back). A TPA request actually expires after
settings.request-expire-seconds in modules/tpa/config.yml (60 by default), not after
tpa-expiry-seconds.
There is no database section in config.yml: the database is configured once for every plugin in
ExyliaLib's database.yml (see Database).
Shared shapes#
Title, action bar and boss bar keys
Several modules draw the same three things, and they take the same keys everywhere.
| Shape | Keys |
|---|---|
| Title | text, subtitle, fade-in, stay, fade-out, time-style |
| Action bar | text, duration, time-style |
| Boss bar | text, colour, overlay, count-up, progress, time-style |
colour takes PINK, BLUE, RED, GREEN, YELLOW, PURPLE or WHITE. overlay takes
PROGRESS, NOTCHED_6, NOTCHED_10, NOTCHED_12 or NOTCHED_20. time-style takes auto,
seconds, tenths, hundredths, clock or full. A stay or duration of 0 means "until
something stops it".
Sounds are always SOUND_NAME|VOLUME|PITCH, and a blank string disables one.
Per-module files#
Module ids use dashes: join-leave, item-spawners, player-utils, scheduled-commands. A module's
files are in modules/<id>/.
Which files each module has
| Module | Files |
|---|---|
spawn, tpa, homes, back, warps | config.yml — the warmup, the bypass node, blacklisted worlds, the sounds and the effects |
rtp | config.yml plus worlds.yml |
join-leave | config.yml plus groups.yml |
rankup | config.yml plus ranks.yml |
farming | config.yml plus categories.yml |
stats | config.yml plus stats.yml |
missions | config.yml plus missions.yml |
seasons | config.yml plus seasons.yml |
repair | config.yml plus groups.yml |
enchantments | config.yml plus rules.yml |
reclaim, scheduled-commands | config.yml only, free-form |
player-utils, near, jumpads, kits, item-spawners, death, boosters, portals, optimization, reputation | config.yml only |
projects | projects.yml only |
player-settings, item-updater | No configuration file at all |
What each key does is on that module's own page: Movement, Progression, Missions and seasons, Kits and crates, Zones, Restrictions, Quality of life, Optimization and Reputation and projects.
Reloading#
/survivalcoreadmin reload, from the console or in game, runs three steps in order:
- configs —
config.ymlincludingdebugandteleport, and every schema-backed module file. - modules — each module that is on declares its files again and re-reads what it keeps: ladders,
rules,
missions.yml,seasons.ymland the rest. - menus — the menus are refreshed as described above and every menu is compiled again. This step
also runs on
/exylialib reload.
A step that fails is reported by name and the ones after it still run. The reload does not apply a module switch; when one no longer matches what is running, it ends by naming the modules that need a restart.
Something missing on this page? Tell us on Discord