Content generated with AI — it may contain mistakes.

ExyliaMines/GuidesUpdated in v1.8.0

Create and edit mines

Open the editor, create a mine, change its switches, start from a template, clone it or delete it.

Page 4 of 288 min read

Every mine is created and edited from /minesadmin. A change is saved the moment you make it, there is no save button, and it applies at once to the running mine.

Before you start#

ExyliaMines is installed and you have the exyliamines.admin permission (operators have it by default). See Install ExyliaMines. For a first mine from start to finish, follow Your first mine.

Steps#

Open the editor

Run /minesadmin. It lists every mine of this server, sorted by id.

Create a mine

Click Create ▸ Classic mine or Create ▸ Realistic mine, then type an id in chat. Use lowercase letters, digits, - and _, up to 64 characters, and do not start or end with - or _. The mine is created and its setup screen opens.

Walk through the setup screen

Each button opens one section: General, Area, Composition or Regen levels, Resets, Teleports, Rewards, Mining. Every section has a Back ▸ Overview button.

Leave it enabled

The Mine ▸ Status button at the top toggles the mine. A new mine starts enabled.

An id is checked against the whole database, not only this server's mines. On a network that shares one database, an id another server already uses is refused with "A mine with ID … already exists", because creating it would overwrite that server's mine.

A new mine starts with its id as its name, auto-pickup on, lifting of buried players on, and the reset interval and warning from config.yml: 5 minutes and 10 seconds by default (settings.default-reset-interval-seconds: 300, settings.default-reset-warning-seconds: 10). Restrict breaking starts off on a classic mine and on on a realistic one.

The list#

ClickWhat it does
Left-click a mineOpens its setup screen.
Shift-left-click a mineTakes you there, as /minesadmin tp <id> does.
Right-click a mineDeletes it, after a confirmation.
Create ▸ Classic mineAsks for an id and creates an empty classic mine.
Create ▸ Realistic mineThe same, for a realistic mine.
Create ▸ From templateOpens the templates of templates.yml.
Mines ▸ Running boostsLists the boosts running now. See Boosts.
Plugin ▸ SettingsOpens the plugin's settings in game. See Commands.

Each mine shows its type, whether its region is set, whether it is enabled and when it resets next (Per block for a realistic mine).

The setup screen#

SectionClassicRealisticWhat is in it
StatusyesyesEnables or disables the mine.
GeneralyesyesDisplay name, icon, access permission.
AreayesyesRegion, shape, hologram. See Area and shapes and Holograms.
CompositionyesWhat the mine is refilled from. See Classic mines.
ResetsyesInterval, warning, threshold, force reset.
TeleportsyesEntry teleport, safe teleport, lifting buried players.
Regen levelsyesThe blocks that grow back. See Realistic mines.
RewardsyesyesLucky rewards, Fortune, and the boost running on it.
MiningyesyesAuto-pickup, restrict breaking, break effects, mine effects.
CloneyesyesCopies the mine under a new id.
DeleteyesyesDeletes it, after a confirmation.

General#

ButtonClickWhat it does
General ▸ Display nameclickAsks for the name players read in titles, menus, holograms and announcements. Colours are allowed.
General ▸ Iconleft / shiftLeft-click picks the item the mine shows in menus; shift-click resets it. Without one, a classic mine shows a beacon and a realistic one a diamond ore.
General ▸ Access permissionleft / shiftLeft-click asks for a permission node; shift-click clears it.

Make a mine VIP only#

Set General ▸ Access permission to a node such as mines.vip (any text works), then give that node to the rank in your permissions plugin. A mine with no permission is open to everyone. A player who lacks it:

  • is told "You don't have access to this mine." when they walk in, and gets none of the mine's title, boss bars or potion effects. The area itself is not a wall;
  • cannot break anything inside the area, whether it is one of the mine's blocks or not;
  • cannot be sent there with /mine <id> or from the /mines menu, which shows the mine as locked.

exyliamines.admin passes all three.

Disable a mine#

Click Mine ▸ Status or run /minesadmin disable <id>. A disabled mine leaves the /mines menu, /mine answers "Mine not found", its hologram is taken down, anybody inside has their session closed and it stops resetting. Its area is plain ground again, so breaking there is up to the server and your protection plugins. Every setting is kept, and enabling it again takes up from there.

Mining#

The Mine ▸ Mining section holds:

ButtonDefaultWhat it does
Mining ▸ Auto-pickuponDrops and item loot go straight into the miner's inventory; what does not fit falls on the ground. With it off, players holding exyliamines.autopickup still get it.
Mining ▸ Restrict breakingoff (on for realistic mines)Whether blocks that are not the mine's own may be broken inside its area.
Mining ▸ Break effectsnoneSounds, particles and titles on every block broken here. See Loot and effects.
Mining ▸ Mine effectsnonePotion effects kept on players while they are inside. See Loot and effects.

A mine owns the blocks it is made of (its composition, or its levels and degrade stages) and nothing else. With restrict breaking off, a lamp, a sign or a chest inside the area is left to the server and your other plugins. With it on, breaking any other block inside the area is refused with "This block can't be mined here.", except for admins.

Rewards#

ButtonWhat it does
Rewards ▸ Lucky rewardsOpens the editor of rare prizes any block may give. See Lucky rewards.
Rewards ▸ FortuneOpens the mine's own Fortune settings. See Fortune.
Rewards ▸ BoostShows the boost running on this mine. Boosts start by command or schedule; see Boosts.

Templates#

Create ▸ From template lists the templates of templates.yml in the order the file writes them. Click one, type an id, and you get a mine of that template's type with its name, icon and blocks already set:

  • a classic template becomes a composition, each block with its weight;
  • a realistic template becomes one level per block, each with the template's regen time (weights are ignored).

The area, teleports and everything else are set afterwards, as for any mine. Six templates ship by default: coal, iron, gold, diamond, nether and ores.

To add your own, edit plugins/ExyliaMines/templates.yml and run /minesadmin reload:

plugins/ExyliaMines/templates.yml
yaml
templates:
  coal:
    name: Coal
    icon: COAL_ORE
    type: CLASSIC
    blocks:
      STONE: 70.0
      COAL_ORE: 25.0
      IRON_ORE: 5.0
    regen: 60
  ores:
    name: Natural ores
    icon: DIAMOND_ORE
    type: REALISTIC
    blocks:
      COAL_ORE: 1.0
      IRON_ORE: 1.0
      GOLD_ORE: 1.0
      DIAMOND_ORE: 1.0
    regen: 120

A block name that is not a block, or a weight of zero or less, is skipped.

Clone a mine#

Click Mine ▸ Clone and type a new id. The copy keeps everything the mine is made of and how it behaves: type, name, icon, permission, every switch, the composition or levels with their loot and effects, lucky rewards, mine effects, Fortune settings and reset times.

What belongs to the place the original stands is not copied: the area, the entry and safe teleports and the hologram. The copy's setup screen opens so you can select its region.

Delete a mine#

Click Mine ▸ Delete, or right-click the mine in the list, then confirm. This removes the mine and everything kept about it: its reset cycle, the blocks it was regrowing, its hologram and every player's count of blocks mined there. Players inside lose their session and its potion effects. There is no undo.

Check that it works#

Run /minesadmin: the new mine is in the list with the right type and "enabled". Open /mines as a player: an enabled mine with an entry point appears there.

Technical details

Every edit made after a chat prompt or an editor reads the mine as it is saved at that moment, so one admin's edit never silently undoes another's made in the meantime. Mines can also be edited in the browser with ExyliaLib's web editor, see Web editor; the editor refuses an id that does not match [a-z0-9]([a-z0-9_-]{0,62}[a-z0-9])?. Mines are stored in the mines table; a mine's server column says which server of a network owns it.

Something missing on this page? Tell us on Discord