Configuring

Area and shapes

Selecting a mine's region, the three shapes, how a break inside a mine is performed, and what cannot farm a mine.

Selecting the region

Area → Mine region hands you ExyliaLib's selection wand, the same one every Exylia plugin uses, so no WorldEdit is needed. Mark the two opposite corners of a box and confirm. Both corners are part of the mine, and it does not matter which one you mark first.

Selecting again later corrects the corners and keeps the shape the mine already had. Backing out of the selection leaves the old region as it was.

A mine whose world is not loaded simply waits: with a world manager such as Worlds or Multiverse-Core loading worlds after the plugins, the mine's area is registered the moment its world loads, and the realistic blocks it was regrowing there are picked up again.

Shapes

Shape cycles through three, each cut out of the box you selected:

Shape	What the mine is
Cuboid	The whole box. The default.
Sphere	The largest sphere that fits in the box, centred in it: as wide as the box's shortest side.
Cylinder	An upright cylinder as wide as the box's narrower horizontal side and as tall as the box.

A block belongs to a rounded mine when its centre is inside the shape. The corners of the box outside it are not part of the mine: a refill leaves them alone, breaking there is not the mine's business, and a player standing there is not inside it.

A sphere wants a cube

The sphere is as wide as the box's shortest side. Select a box that is as tall as it is wide and deep, or the sphere comes out smaller than you expect.

How a break inside a mine works

Inside an enabled mine, the server's own break is always cancelled, for every player, and the mine performs the break itself. That sounds drastic and is exactly what makes a mine coexist with everything else on the server:

Anticheats and other guards decide first. The plugin listens at LOW priority and ignores breaks already cancelled, so a fast-break or nuker check that refuses a break is respected — nothing breaks.
Protection plugins such as WorldGuard decide at NORMAL and see the break already cancelled. There is no flag to set for mines and no fight over who wins: a mine never forces a cancelled break through.
The mine applies its own rules: its permission, its blocks, its loot, its regeneration.

When the mine performs the break it reproduces what the server would have done: drops worked out with the tool in hand (Fortune, Silk Touch and the correct-tool rules included), durability through the server's own path (Unbreaking applies, the tool breaks with its sound), hunger exhaustion, and experience. Experience goes straight to the miner, Mending included, instead of dropping an orb. A player in creative mode gets no drops and spends no durability, as in vanilla.

Block loggers and listeners that skip cancelled events

Because the server's break is cancelled, a plugin that ignores cancelled break events never sees a mine break — a block logger, for instance. Plugins that want to react to mine breaks listen to MineBlockBreakEvent instead. Block-break statistics and advancements are not credited either: they are internal to the server and out of a plugin's reach.

Tools that break several blocks

A 3x3 pickaxe or a vein miner from another plugin should hand each block to the mine through the API. Each one is then treated as a swing of its own: the permission check, the loot and the regeneration all apply, so a 3x3 pickaxe in a mine is nine breaks rather than one break and eight holes the mine never refills.

What cannot farm a mine

A mine pays for and regrows only blocks it put there. Every way to slip one in is closed:

What	What happens
Placing one of the mine's own blocks inside it	Refused with "The mine's own blocks can't be placed inside it." Anything else may be placed. Admins are exempt.
Lava and water meeting inside it	A stone, cobblestone or obsidian that would form is cancelled when it is one of the mine's blocks.
Explosions	Blocks inside a mine are taken out of the explosion; everything around it is still hit.
Pistons	A piston may neither pull a block out of a mine nor push anything into it.

Without these, an ore carried in with Silk Touch would pay the mine's loot again, count towards its reset and, in a realistic mine, make that spot regrow the ore for good.

Overlapping mines

Two mines may overlap, but avoid it: a block in the overlap belongs to whichever enabled mine the region index answers with first, and a player is only ever in one mine's session at a time. Walking out of one of two overlapping mines does keep the session of the one the player is still in.

Something missing on this page? Tell us on Discord