Installation

Table of contents

  1. As a Spigot / Paper plugin
  2. Building from source
  3. Optional dependencies

As a Spigot / Paper plugin

  1. Download the latest EzMine-<version>.jar from the GitHub Releases page or Modrinth.
  2. Place the jar in your server’s plugins/ directory.
  3. Start (or restart) the server. EzMine generates its default configuration files automatically under plugins/EzMine/.
  4. Assign rank permissions to your players (see Ranks).
  5. Reload with /ezmine reload or restart to apply any configuration changes.

Building from source

git clone https://github.com/ez-plugins/EzMine.git
cd EzMine
mvn package -DskipTests

The shaded jar is produced at target/EzMine-<version>.jar.

Optional dependencies

EzMine works standalone. Install any of the following for additional features:

Plugin Purpose
EzSkills Gate ranks by mining skill level; award EzSkills XP per block
mcMMO Gate ranks by mcMMO mining level; award mcMMO XP
Vault Power the pickaxe shop with an economy balance
WorldGuard Restrict EzMine perks to specific regions
LuckPerms Resolve ranks by primary group

None of the optional dependencies are required. EzMine gracefully skips any integration whose plugin is not loaded.