Reference

Configuration

config.yml key by key, what templates.yml, boosts.yml and messages.yml hold, the menu files, and where the database is set.

Everything is generated in plugins/ExyliaMines/ on first boot, with comments. Edit the files there, never the copies in the jar, and apply them with /minesadmin reload. Any length of time accepts a bare number of seconds or the written form: 300, 5m, 1h30m.

The mines themselves are not in any file: they live in the database and are edited from /minesadmin.

config.yml

plugins/ExyliaMines/config.yml

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
sounds:
  reset: ENTITY_ENDER_DRAGON_GROWL|0.6|1.4
  enter: BLOCK_BEACON_ACTIVATE|1.0|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: true

Top 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` or `pt` 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, experience orbs, projectiles, minecarts, end crystals and fireworks inside a classic mine when it refills.

The two tick intervals are at least one second. The countdowns players read — boss bars, 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`	`ENTITY_ENDER_DRAGON_GROWL\|0.6\|1.4`	To the players inside a classic mine when it has refilled.
`enter`	`BLOCK_BEACON_ACTIVATE\|1.0\|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 custom loot: `OFF`, `VANILLA`, `LINEAR` or `CHANCE`.
`target`	`ITEMS`	What the mode multiplies: `ITEMS`, `MONEY` or `BOTH`.
`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.
`silk-touch`	`true`	Whether Silk Touch works in mines.

A mine can override mode, max-level and silk-touch for itself. See Fortune.

templates.yml

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

Two sections: boosts, every boost by id with its name, drops, experience, money, duration and mines; and schedule, the entries that start them on their own, each with boost, days, times and min-players. Two boosts and one schedule entry ship by default. See Boosts.

messages.yml

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.

Colours use palette tokens such as {primary}, {error} or {highlight}, so recolouring the server never means editing this file. %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.bossbar gets %next_reset% as a number of seconds — the default ends it with s — while the hologram and the menus get it written out, 4m 12s.
visuals.reset-bossbar counts down with %time%, and visuals.reset-warning-title with %seconds%.

Menus

File	Screen
`lang/<language>/menus/user/mines.yml`	The players' `/mines` list. Yours to restyle. See Players' menu.
`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_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_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.

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 five tables and the library's database page for every key.

Something missing on this page? Tell us on Discord