Configuration
Where ExyliaMines keeps its files, how to reload them, what to change first, and every config.yml, templates.yml, boosts.yml and messages.yml key.
ExyliaMines keeps a few small files; most of what you change daily is done in game. This page says where each file is, what owners touch most, and lists every key.
Where the files are#
Everything is generated in plugins/ExyliaMines/ on first boot, with comments. Edit the files there, never
the copies in the jar, then apply them with /minesadmin reload. Any length of time accepts a bare number
of seconds or the written form: 300, 5m, 1h30m.
| File | What it holds |
|---|---|
config.yml | Reset defaults, sounds, announcements and Fortune. |
templates.yml | The starting points of Create > From template. |
boosts.yml | The boosts and when they start on their own. |
lang/<language>/messages.yml | Every chat line, title and boss bar. |
lang/<language>/menus/ | The menu screens. |
database.yml | The database, shared with the rest of Exylia. |
The mines themselves are not in any file: they live in the database and are edited from /minesadmin.
What owners change most#
Defaults for new mines#
Each mine has its own reset interval, warning and regrowth time. config.yml only decides what a new
mine starts with: a reset every 300 seconds, a warning 10 seconds before, and 60 seconds for a level of
a realistic mine to grow back. Changing it does not touch mines you already made.
Who hears about resets, lucky rewards and boosts#
Under announcements, each of reset, lucky and boosts is OFF, NEARBY or SERVER. By default a reset
and a lucky reward reach only players within radius (64 blocks), and a boost reaches the whole server.
Set reset: OFF to stop the chat line on every refill.
Fortune#
fortune.mode decides how a Fortune pickaxe changes a mine's drops, and fortune.max-level caps it (-1
counts any level, 0 turns Fortune off). Each mine can override its own. The step-by-step is in
Fortune.
Settings without opening a file#
Settings at the bottom of the /minesadmin list opens reset defaults, announcements and Fortune in
game, and needs exyliamines.admin. A change there is saved to config.yml and applied at once. Templates
and boosts go through the web editor or /exylialib config ExyliaMines. messages.yml and the menus stay
file-only. See Commands.
Messages, colours and language#
Chat lines live in lang/<language>/messages.yml and use palette tokens such as {primary} or {error}, so
recolouring the server never means editing this file. See Colours and
Messages and languages. To restyle a menu, see
Edit menus and Players' menu.
Some lines show on the player's HUD instead of in chat, through the [hud:group] tag, and fall back to chat for players who cannot see it: teleported (hud:teleport), lucky.announcement (hud:lucky) and boosts.started and boosts.ended (hud:boost). New in v1.9.0
config.yml: every key
language: default
debug: false
settings:
default-reset-interval-seconds: 300
default-reset-warning-seconds: 10
classic-tick-interval-seconds: 1
realistic-tick-interval-seconds: 1
default-realistic-regen-seconds: 60
clean-entities-on-reset: true
presence-margin: 5
sounds:
reset: BLOCK_NOTE_BLOCK_CHIME|0.7|1.2
enter: BLOCK_NOTE_BLOCK_PLING|0.6|1.4
block-mined: ''
announcements:
reset: NEARBY
radius: 64
lucky: NEARBY
boosts: SERVER
fortune:
mode: VANILLA
target: ITEMS
per-level: 0.25
lucky-per-level: 0.0
max-level: -1
silk-touch: trueTop level
| Key | Default | What it does |
|---|---|---|
language | default | The language of the menus and messages. 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. |
debug | false | Explains in the console what the plugin is doing, such as who a loot command runs as. |
settings
| Key | Default | What it does |
|---|---|---|
default-reset-interval-seconds | 300 | The reset interval a new classic mine starts with. Each mine then has its own. |
default-reset-warning-seconds | 10 | The warning a new classic mine starts with. |
classic-tick-interval-seconds | 1 | How often classic mines are checked for a refill that is due or a threshold reached. |
realistic-tick-interval-seconds | 1 | How often realistic mines are checked for blocks to grow back. |
default-realistic-regen-seconds | 60 | The regen time a new level of a realistic mine starts with. |
clean-entities-on-reset | true | Removes dropped items and projectiles inside a classic mine when it refills. |
presence-margin | 5 | Blocks around a mine's area that still count as inside it: the entry title, the boss bars and the potion effects start this far out, and mining from the edge no longer walks the player out of the mine and back in on every step. What can be mined is still the area alone. 0 to 32 from the settings screen. |
The two tick intervals are at least one second. The countdowns players read, such as boss bars and holograms, are redrawn every second whatever they say.
sounds
Each one is written NAME|volume|pitch. An empty value plays nothing.
| Key | Default | Played |
|---|---|---|
reset | BLOCK_NOTE_BLOCK_CHIME|0.7|1.2 | To the players inside a classic mine when it has refilled. |
enter | BLOCK_NOTE_BLOCK_PLING|0.6|1.4 | When a player walks into a classic mine. |
block-mined | '' | To whoever breaks a block of a realistic mine. |
announcements
| Key | Default | What it does |
|---|---|---|
reset | NEARBY | Who is told in chat that a classic mine refilled: OFF, NEARBY or SERVER. |
radius | 64 | How far from the mine a player hears it with NEARBY, in blocks. |
lucky | NEARBY | Who is told that somebody found a lucky reward. Measured from the block. |
boosts | SERVER | Who is told that a boost started or ended. Measured from every mine it covers. |
fortune
| Key | Default | What it does |
|---|---|---|
mode | VANILLA | How Fortune changes the mine's drops, vanilla ones included under OFF and LINEAR: OFF, VANILLA, LINEAR or CHANCE. |
target | ITEMS | What the mode multiplies: ITEMS (vanilla drops included), MONEY or BOTH. Commands are never multiplied. |
per-level | 0.25 | What each level adds with LINEAR and CHANCE. |
lucky-per-level | 0.0 | What each level adds to the chance of lucky rewards. |
max-level | -1 | The highest Fortune level counted in mines. -1 any, 0 none. exyliamines.fortune.<n> raises it for a rank. |
silk-touch | true | Whether Silk Touch works in mines. |
A mine can override mode, max-level, per-level and silk-touch for itself. See
Fortune.
templates.yml and boosts.yml
templates.yml holds the starting points offered by Create > From template, keyed by id:
| Key | What it is |
|---|---|
name | What the menu calls the template, and the name the new mine gets. |
icon | The material the menu shows, and the new mine's icon. |
type | CLASSIC or REALISTIC. |
blocks | Material to weight. A classic template becomes this composition; a realistic one makes a level of each material and ignores the weights. |
regen | The regen time of each level of a realistic template. |
Six ship by default: coal, iron, gold, diamond, nether and ores. See
Mines.
boosts.yml has two sections: boosts, every boost by id with its name, drops, experience, money,
duration and mines (empty means every mine); and schedule, the entries that start them on their own,
each with boost, days (MONDAY to SUNDAY, empty means every day), times (24h HH:mm, in ExyliaLib's
timezone) and min-players. Two boosts (gold_rush, happy_hour) and one schedule entry (weekend_rush,
weekends at 20:00 with at least 5 players) ship by default. See Boosts.
messages.yml: sections and values
lang/<language>/messages.yml holds every line the plugin sends. The top-level keys are the chat lines and
the menu labels; then come the sections:
| Section | What it holds |
|---|---|
lucky | The announcement, the finder's title, what a command prize is called, the editor's title. |
boosts | Started, ended, stopped, the list lines, the custom boost's name, the menu labels and the boss bar inside a boosted mine. |
potions | The title of the potion effect editor. |
fortune | How each Fortune setting reads in a mine's menu. |
holograms | The lines over a classic and over a realistic mine. See Holograms. |
visuals | The reset warning title, the reset countdown boss bar, the entry title and the "next reset" boss bar. |
%prefix% is replaced by the prefix value at the top. A line may open with an effect tag that never
reaches the screen: [sound:NAME|volume|pitch] plays a sound to whoever receives it. An empty line sends
nothing, which is how one is turned off; a title or a boss bar with an empty text is not shown.
The values each line may use are written in the comment above it. Two worth knowing:
visuals.bossbartakes%mine_name%and%next_reset%, written out as time (for example4m 12s).visuals.reset-bossbarcounts down with%time%, andvisuals.reset-warning-titlewith%time%or%seconds%.
Menu files
| File | Screen |
|---|---|
lang/<language>/menus/user/mines.yml | The players' /mines list. Yours to restyle. |
lang/<language>/menus/admin/mine_list.yml | The list of mines in /minesadmin. |
lang/<language>/menus/admin/mine_templates.yml | The templates. |
lang/<language>/menus/admin/mine_boosts.yml | The running boosts. |
lang/<language>/menus/admin/mine_setup_classic.yml | The overview of a classic mine. |
lang/<language>/menus/admin/mine_setup_realistic.yml | The overview of a realistic mine. |
lang/<language>/menus/admin/mine_setup_general.yml | Name, icon, permission. |
lang/<language>/menus/admin/mine_setup_area.yml | Region, shape, hologram. |
lang/<language>/menus/admin/mine_setup_resets.yml | Interval, warning, threshold, force reset. |
lang/<language>/menus/admin/mine_setup_teleports.yml | Entry and safe teleports, lifting buried players. |
lang/<language>/menus/admin/mine_setup_rewards.yml | Lucky rewards, Fortune, boost. |
lang/<language>/menus/admin/mine_setup_fortune.yml | A mine's Fortune: mode, highest level, share per level, Silk Touch. |
lang/<language>/menus/admin/mine_setup_mining.yml | Auto-pickup, restrict breaking, break and potion effects. |
lang/<language>/menus/admin/mine_composition.yml | A classic mine's composition. |
lang/<language>/menus/admin/mine_levels.yml | A realistic mine's levels. |
lang/<language>/menus/admin/mine_level_detail.yml | One level. |
lang/<language>/menus/admin/mine_level_chain.yml | One level's degrade chain. |
lang/<language>/menus/admin/settings.yml, settings_mines.yml, settings_announcements.yml, settings_fortune.yml | The in-game Settings hub and its three pages. |
The admin/ screens are rewritten from the jar on every start; edits there are lost.
Database#
database.yml is ExyliaLib's: H2 by default, or mysql, mariadb, postgresql and mongodb. See
Installation for the tables and the
library's database page for every key.
Something missing on this page? Tell us on Discord