Customise the /mines menu
See what players get from /mines and /mine, how they go to a mine, and how to restyle the menu.
Players reach the mines through two commands, both granted to everybody by default. The list can also be drawn as a native screen (ExyliaLib's SCREEN menu style, screens/mines.html): two columns of mines, each with its fill, reset time, boost and your mined count, and a click to go there; a locked mine or one with no entry point is shown disabled. A broken screen file falls back to the chest menu.
| Command | Permission | What it does |
|---|---|---|
/mines | exyliamines.menu | Opens the list of mines. |
/mine <id> | exyliamines.teleport | Sends the player to that mine's entry point. Tab completion offers every enabled mine. |
Steps#
Open the list
A player runs /mines. Every enabled mine of the server is listed with its icon, name and state.
Go to a mine
Clicking a mine, or running /mine <id>, sends the player to its entry point.
Restyle it (optional)
Edit the words in lang/<language>/screens/mines.yml, or the layout in screens/mines.html. The chest-menu fallback is lang/<language>/menus/user/mines.yml. See "Restyling it" below.
Check that it works#
Run /mines as a player with no admin rights. You see the list, locked mines are marked, and clicking an open one teleports you. If a click says "This mine has no entry point.", set the mine's teleport in Teleports.
The list#
/mines shows every enabled mine of the server, sorted by id, each with its icon and name and:
| Line | What it says |
|---|---|
| Type | Classic or Realistic. |
| Access | Open, or Locked for a mine whose permission the player lacks. |
| Remaining | The share still standing. |
| Next reset | Time until the next refill; "Per block" for a realistic mine. |
| Boost | The drop multiplier and time left of a running boost, or None. |
| Mined by you | How many blocks this player has mined there. |
A pickaxe at the bottom adds up the player's blocks across every mine. Clicking a mine sends them there.
Locked mines are listed too, so players see what they can work towards; clicking one says they have no access.
Going to a mine#
/mine <id> and a click in the menu run the same checks, in this order:
- The mine exists and is enabled — otherwise "Mine not found."
- The player has
exyliamines.teleportand the mine's own permission, if it has one — otherwise "You don't have access to this mine." - The mine has an entry point — otherwise "This mine has no entry point."
- The player is not in combat — otherwise they are told how long is left. A mine is not a way out of a fight. Combat is read from ExyliaLib's combat module, which follows DeluxeCombat or PvPManager when one is installed.
The teleport itself goes through ExyliaLib's teleports, and the teleported line confirms it.
Only classic mines have a Teleports section, so a realistic mine built in the editor has no entry point and answers "This mine has no entry point." See Realistic mines.
Restyling it#
The menu is lang/<language>/menus/user/mines.yml, and it is yours: a release only adds what is missing
from it and never overwrites your edits. It is an ExyliaLib pagination menu — see the
library's menus page for every key.
Each mine's entry is the item_template, and can use:
| Value | What it is |
|---|---|
%mine_id%, %mine_name%, %mine_icon% | Id, display name, icon material. |
%mine_type%, %remaining%, %next_reset%, %total_blocks%, %boost% | As on the hologram. |
%access% | access-open or access-locked from messages.yml. |
%player_blocks% | Blocks the viewer mined in this mine. |
%player_blocks_total% is available to every other item of the menu. The button action that sends a
player to a mine is exyliamines:teleport <id>. It is the one action of the plugin that does not need
exyliamines.admin, so it can go on any item of this menu — a featured mine, say — and it still runs every
check above.
Something missing on this page? Tell us on Discord