Getting started

Introduction

What ExyliaMines is, the two kinds of mine it runs, and how this documentation is organised.

ExyliaMines runs the mines of a server: areas players mine for their resources that come back on their own. Everything about a mine — where it is, what it is made of, when it refills, what it pays — is built and edited in game from a menu. There is no mine file to write by hand.

It is free and open source, released under the GPL-3.0 licence and downloaded from the GitHub releases. The mines used to live inside ExyliaSurvivalCore; they are now a plugin of their own, and a server coming from there has its mines, settings, messages and mining history brought over on its own. See Migration.

Two kinds of mine

Kind	How it comes back
Classic	The whole area is refilled at once from a weighted composition of blocks: on a timer, once a share of it has been mined, or when an admin forces it. Players inside are warned first and moved clear of the new blocks.
Realistic	Nothing is refilled. Each block the player breaks grows back on its own after its level's regeneration time, optionally passing through a degrade chain — stone, then cobblestone, then the ore again — that the player mines through.

Both kinds share everything else: a permission, auto-pickup, custom loot per block, break effects, potion effects kept on whoever is inside, lucky rewards, Fortune rules, boosts, a hologram and the players' /mines menu.

What is included

Classic mines

A weighted composition, an interval, a warning, an emptiness threshold, a safe teleport and buried players lifted to free air. Where each mine stands in its cycle survives a restart.

Realistic mines

Levels with their own regeneration time, degrade chains mined stage by stage, and broken blocks that heal after a restart.

Area and shapes

Cuboid, sphere or cylinder, cut out of the box you select. Explosions, pistons, fluids and placed blocks cannot farm a mine.

Loot and effects

Item, money and command loot per block in place of the vanilla drop, sounds and particles per mine or per block, and potion effects inside.

Lucky rewards and boosts

Rare prizes any block may give, and timed multipliers of drops, experience and money started by command or on a weekly schedule.

Statistics

Blocks mined per player and per mine, a top ten per mine, all readable from placeholders.

Requirements

Requirement	Detail
Server	Paper 1.21 or newer, or a fork of it. Folia supported. Spigot is not: the plugin uses Paper's API.
Java	21
Required dependencies	`packetevents`, and `ExyliaLib` 1.230.0 or newer — installed for you if it is missing
Optional dependencies	`ExyliaSurvivalCore`, `PlaceholderAPI`, `Vault`, `Worlds` or `Multiverse-Core`

About ExyliaLib

Typed configuration, the menus, the database, regions and the block selector, holograms, loot tables, effect sequences, schedules, teleports and the update checks all come from ExyliaLib. ExyliaMines is written on top of it and does not run without it, which is why it downloads the library itself on a server that lacks it. See Installation.

How to read this documentation

Getting started

Installation, then a first classic mine and a first realistic mine within minutes.

Configuring

The setup screens, each kind of mine, the area, loot and effects, Fortune, lucky rewards and boosts.

Systems

Holograms, the players' menu, statistics, what other plugins add, and bringing mines over from ExyliaSurvivalCore, CataMines or RealMines.

Reference

Commands, permissions, placeholders, every configuration key, the developer API and the questions that come up most.

Conventions

Values marked as default are what the plugin writes the first time it starts. If the file already exists, your value is kept.
Identifiers between < and > are variables. /mine <id> means /mine coal, not /mine <coal>.
A length of time accepts a bare number of seconds or the written form: 300, 5m and 1h30m all work, in the files and in the prompts.
Colours use ExyliaLib palette tokens ({primary}, {highlight}, {muted}); MiniMessage tags such as <click> and <hover> work too, as the default reset announcement shows.

Something missing on this page? Tell us on Discord