Quick Start

Get BusyMining running with its default setup in about five minutes.

1. Install

Drop the jar in plugins/ and start your server. See Installation for the full walkthrough.

2. Check which modules are on

Open plugins/BusyMining/config.yml. The modules: block controls which of the fourteen modules load. All of them ship enabled:

yaml
modules:
  core: true
  gem: true
  economy: true
  flux: true
  artifact: true
  passive: true
  rune: true
  singularity: true
  refinery: true
  oracle: true
  enchantment: true
  journal: true
  vessel: true
  minion: true

Set any of them to false to switch that system off. See Main Configuration for what each module covers.

3. Go mining

Grab a pickaxe (without Silk Touch) and mine ores in survival. Each configured ore gives mining XP and Zeta, and has a chance to drop gemstones, fluxes, sealed artifacts and Mysterious Dust. Creative mode and Silk Touch pickaxes earn nothing.

4. Open the menu

/bmine              # the main menu: shop, stats, journal, singularity, artifacts, ...
/bmine help         # every subcommand you have access to
/bmine stats        # your mining statistics
/bmine zeta         # your Zeta balance

Every command starts with /bmine; there are no aliases or shortcuts. Full list: Commands & Permissions.

5. Hook up your economy

The Mine Shop pays players when they sell gemstones, fluxes and artifacts. With Vault and an economy plugin installed it pays through Vault. Without them it runs the console commands in modules/economy/config.yml instead. Check that one of the two is set up before players start selling.

6. Pick the worlds BusyMining runs in

BusyMining runs in every world by default. To keep it to your mining worlds, list them under Settings.EnabledWorlds in modules/core/config.yml; spawn, lobby and every other world are then left alone. Or leave that list empty and name the worlds to turn off under Settings.DisabledWorlds. Settings.DisableCustomMobWorlds keeps only Rune Guardians, Oracles and Thralls out of a world. See Worlds.

7. Reload after editing configs

Apply YAML changes with /bmine reload (permission busymining.admin) instead of restarting. Database settings are the exception and need a restart.

Where to go next