Install ExyliaSurvivalCore
Install ExyliaSurvivalCore and ExyliaLib, see what each optional plugin enables, what the first boot generates, where the database is set, and what a reload reloads.
You will have ExyliaSurvivalCore running on Paper 1.21.1 or newer (or Folia), with its files generated and the optional plugins you want connected.
Before you start#
You need Paper 1.21.1 or newer (or Folia) and ExyliaLib, the one plugin ExyliaSurvivalCore cannot run
without. ExyliaLib provides the configuration, menus, database, placeholders, teleports, scheduler, wizards,
chat inputs and the readers of other plugins' economies. The plugin names no minimum ExyliaLib version: the
loader installs the library and the library's own updater keeps it current. See
Install ExyliaLib.
packetevents is optional: without it the plugin runs and only its packet-drawn extras stay off.
Optional plugins#
Each one is declared under softdepend and switches on something specific:
| Plugin | What it enables |
|---|---|
ExyliaEconomy | The currencies the plugin charges and pays in, and the Vault slot. It is a soft dependency so this plugin enables after it. |
Vault | Prices and payouts in whatever economy Vault serves, when ExyliaEconomy is not the one. |
ExyliaLobby | With it enabled, jumpads, join-leave and portals stay off and the lobby provides them. See Modules. |
PlaceholderAPI | The plugin's placeholders outside it; placeholder requirements in ranks.yml; stats of type PAPI, such as the shipped playtime. |
WorldGuard | Region scopes in the enchantment rules. |
Apollo (Apollo-Bukkit, Apollo-Folia), FeatherServerAPI | Spawn and homes shown as client waypoints. |
Worlds | World handling on Folia. |
packetevents | The packet-drawn extras, such as the glow of item spawners. |
ExyliaJobs is not in plugin.yml, but it matters: the farming module stays off while it is installed,
because the jobs pay for the same effort.
Without any economy registered, prices and payouts are skipped and the console says so at boot:
No economy is installed: prices and payouts are skipped. Install
ExyliaEconomy or any Vault economy.
Install the plugin#
Drop in the jars
Copy ExyliaSurvivalCore.jar and ExyliaLib.jar into plugins/, plus any optional plugin from the
table above.
Start the server
The first boot writes config.yml, the language files under lang/, one folder per module under
modules/ and the tables of every module that is on.
Turn off what you do not want
Every module switch ships as true. Set the rest to false and restart — see
Modules.
Set the spawn and grant the nodes
/spawn set, then grant your groups the nodes they need. See
First steps.
Check that it works#
The console shows ExyliaSurvivalCore enabling without errors, and plugins/ExyliaSurvivalCore/ holds
config.yml, lang/ and modules/. Run /survivalcoreadmin in game: the admin hub opens.
Warnings worth recognising in the console at boot:
No economy is installed: prices and payouts are skipped.— no currency is registered at all.Missions are on but stats are off: …andSeasons rank stat counters, and the stats module is off: nothing will be ranked.— both read the stat counters, which only thestatsmodule keeps.- A warning about a leftover
modules/blocked-items/rules.yml, which belongs to ExyliaWarzone now.
Generated files#
All of them live in plugins/ExyliaSurvivalCore/. The part that matters: config.yml and the ladder files are yours, and menus/admin/ is not.
Every generated file
| Path | Contents |
|---|---|
config.yml | language, debug, the module switches, the three server-wide settings and the teleport section. |
lang/<code>/messages.yml, lang/<code>/modules/<id>/messages.yml | Every line the plugin sends, in the language config.yml selects. |
modules/<id>/config.yml | One per module that has settings. |
modules/<id>/<data>.yml | The ladders: ranks, categories, groups, worlds, stats, missions, rules. |
lang/<code>/modules/<id>/menus/, lang/<code>/menus/currency_select.yml | The menus outside menus/admin/. Yours to edit; new keys are added, your values are kept. |
lang/<code>/menus/admin/ | The admin screens. Rewritten from the jar on every start and every reload. |
.defaults/files/ | The shipped defaults you last reviewed, which is how an update tells your edits from its own. |
database.yml | Database engine and Redis, written by ExyliaLib. |
The language comes from the language key of config.yml. default follows the server language set in
ExyliaLib's own config.yml; any other value (en, es, pt, fr, ru, tr) sets this plugin alone.
A server that ran the plugin before languages existed keeps its own files, moved to lang/custom/. How
each kind of file is written and updated is on Configuration, and
the language and message system is in ExyliaLib messages and languages.
That directory is replaced from the jar every time the plugin enables and every time you run
/survivalcoreadmin reload. Edits there are lost, without a warning.
Database#
By default the plugin uses H2: a file inside the plugin folder, with no server and no maintenance. To share homes, warps, kits, ranks and statistics across servers, point every server at the same database:
database:
type: mysql
mysql:
host: 127.0.0.1
port: 3306
database: minecraft
username: root
password: ""Supported engines: h2, mysql, mariadb, postgresql and mongodb. The file is ExyliaLib's; its
full reference, including the redis block, is in the library's database page.
The tables are listed on the Database page. A module that is off never creates its own.
Reloading#
/survivalcoreadmin reloadAlias /survivalcore; it needs survivalcore.admin.reload and runs from the console too. It reloads the
configuration files, each module's own files and the menus. A step that fails is reported by name and the steps after it still run.
| Reloaded | Not reloaded |
|---|---|
config.yml, including debug, language and teleport | The module switches — a module turned on or off needs a restart |
Every modules/<id>/ file of a module that is on | The database connection |
The messages and the menus — which also replaces menus/admin/ from the jar | Anything stored in the database, which is read when it changes |
When a switch in config.yml no longer matches what is running, the reload ends with
"Restart to apply module changes » …" and the ids of those modules.
Updating#
Replace the jar and restart. menus/admin/ is refreshed from the jar. Everything in the database is
untouched. Everything else keeps your edits:
config.ymland each module'sconfig.ymlkeep your values.- The ladder files —
ranks.yml,categories.yml,missions.ymland the rest — are never rewritten. - The other menus and
seasons.ymlreceive keys a new version adds; a default that changed waits in/exylialib updatesinstead of overwriting yours. A file whose shippedmenu-versionis higher than yours is replaced, and yours is kept next to it as<name>.v<old version>.
Something missing on this page? Tell us on Discord