Commands
The two player commands and the staff command with its subcommands, and what reload does.
Three roots. /mines and /mine are the players'; /minesadmin is staff's and opens the editor every mine
is built in.
Player commands#
| Command | What it does | Permission |
|---|---|---|
/mines | Open the list of enabled mines. | exyliamines.menu |
/mine <id> | Go to a mine's entry point. | exyliamines.teleport |
/mine checks that the mine exists and is enabled, that the player may enter it, that it has an entry
point and that the player is not in combat, in that order. See
Players' menu.
Staff commands#
Everything below needs exyliamines.admin.
| Command | What it does | Permission |
|---|---|---|
/minesadmin | Open the editor: the list of mines, where you create, edit and delete them. | exyliamines.admin |
/minesadmin edit <id> | Open one mine's setup screen straight away. | exyliamines.admin |
/minesadmin tp <id> | Go to a mine even when it is disabled or has no entry point yet. | exyliamines.admin |
/minesadmin reset <id|all> | Refill a classic mine now, or every enabled classic mine with `all`. | exyliamines.admin |
/minesadmin enable <id> | Turn a mine on. | exyliamines.admin |
/minesadmin disable <id> | Turn a mine off. | exyliamines.admin |
/minesadmin reload | Reload config.yml, templates.yml, boosts.yml, messages.yml and the menus. | exyliamines.admin |
/minesadmin import <catamines|realmines> | Import the mines of CataMines or RealMines. | exyliamines.admin |
Boost commands#
| Command | What it does | Permission |
|---|---|---|
/minesadmin boost start <id> | Start a boost from boosts.yml; one already running starts over. | exyliamines.admin |
/minesadmin boost custom <multiplier> <duration> [mines] | Start a boost with typed numbers, for example `1.2 30m gold iron`. No mines means every mine. | exyliamines.admin |
/minesadmin boost give <player> <id> | Give one online player a boost from boosts.yml; it multiplies only what they break. | exyliamines.admin |
/minesadmin boost give-custom <player> <multiplier> <duration> [mines] | Like boost custom, for one online player. | exyliamines.admin |
/minesadmin boost stop <id|all> [player] | End one running boost, or all of them. Name the player to end the boost given to them. | exyliamines.admin |
/minesadmin boost list | Open the running boosts menu; from the console it lists them in chat. | exyliamines.admin |
Everything but the bare /minesadmin, edit and tp also runs from the console. Tab completion offers
every mine on the server, enabled or not, to edit, tp, enable and disable; the classic mines and
all to reset; the boosts of boosts.yml to start and give; the running ones and all to stop;
and the enabled mines to custom and give-custom. See Boosts.
What reload does#
/minesadmin reload runs six named steps and reports how many ran and in how many milliseconds:
| Step | What it does |
|---|---|
configs | Reads config.yml, templates.yml, boosts.yml and messages.yml again, then the prefix and the debug switch. A changed language applies here. |
timers | Restarts the mine clocks, so a changed classic-tick-interval-seconds or realistic-tick-interval-seconds applies. |
areas | Registers every mine's area again and re-sorts who is inside, so a changed presence margin applies. |
boosts | Applies the schedule of boosts.yml again. |
holograms | Redraws every hologram with the lines as they are now. |
menus | Compiles every menu again. |
The menus step also runs when ExyliaLib itself is reloaded, so a recoloured palette reaches the menus.
Reload does not touch the mines. They live in the database and are edited from /minesadmin, where a
change applies the moment it is made.
Web editor#
/exylialib editor ExyliaMines opens the plugin in the browser: config.yml, templates.yml,
boosts.yml and the mines themselves, which can be created, edited and deleted there as in /minesadmin.
Each needs exyliamines.admin. Applying settings applies them as reload's timers and areas steps do;
applying boosts reschedules them. Changes to loot, lucky rewards or effects ask for confirm, since they
can run console commands. See the library's web editor page.
Settings in game#
Settings, the comparator at the bottom centre of the /minesadmin list, opens a hub with three cards:
New mines (default reset interval, reset warning and realistic regeneration time, cleaning entities on
reset, the presence margin), Announcements (reset, radius, lucky rewards, boosts) and Fortune (mode,
target, share per level, lucky share per level, highest level, Silk Touch). Each page explains the value, shows
the current one and its default; click to edit, shift-right-click resets. It needs exyliamines.admin, and
Back returns to the previous screen. A change is written to config.yml, comments kept, and applied as
/minesadmin reload would. Templates and boosts are edited in the web editor (or with
/exylialib config ExyliaMines, for anyone with exylialib.config); messages.yml and the menus are file-only.
Resetting data#
ExyliaMines has no wipe or reset command of its own: ExyliaLib's /exylialib wipe and
/exylialib resetplayer cover its tables, each classified by what it holds:
| Table | Kind |
|---|---|
mines | setup |
mines_state | cache |
mines_broken_blocks | world |
mines_boosts | world |
mines_stats | progress |
/exylialib resetplayer <player> ExyliaMines deletes that player's mining counts and the boosts given to
them; a server running the plugin also forgets them in memory, so they leave the top tens at once. See the
library's commands page.
There is no command to create or delete a mine, or to change its area, composition, levels or reset
times. All of that is a button in /minesadmin; the subcommands above are shortcuts for what staff do
every day. See Mines.
Something missing on this page? Tell us on Discord