Main Configuration

Main Configuration

plugins/BusyMining/config.yml holds four things: the message prefix, which modules load, the database connection, and the optional menu permission gates. Everything else lives in per-module files. See Module Configuration.

Prefix

yaml
prefix: "[Mining] "

Put in front of most player messages. See Message Customization.

Module toggles

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

This block is the only on/off switch for a module. Enabled keys inside some module files (modules/minion/config.yml, modules/journal/config.yml, modules/refinery/config.yml) are not read.

Module Covers
core Mining XP, levels, Zeta, player data, Mysterious Dust drops, Zeta Tears. Most other modules need it
gem Gemstones
economy The Mine Shop and Zeta Shop
flux Fluxes
artifact Artifacts, fossils and Requium Orbs
passive Passive Upgrades
rune Rune Guardians and runes
singularity The Singularity
refinery The Refinery and Mining Tome menu
oracle Oracles and Oracleite
enchantment Mining Enchantments
journal The Journal
vessel Vessels and Thralls
minion Minions

Some features span modules. Vessels need artifact for fossils and Requium Orbs; the Singularity in RUNES mode needs rune; Mining Tomes need enchantment. Turning off a module hides its main menu button and its items can't be given with /mine give.

Database settings

yaml
database:
  enabled: true
  type: sqlite
  host: localhost
  port: 3306
  database: busymining
  username: root
  password: ""
  pool-size: 10
  connection-timeout: 5000

Full breakdown: Database Setup.

Menu permission gates

yaml
GUIPermissions:
  Main:
    enabled: false
    Permission: 'busymining.gui.main'
  # Shop, Stats, Journal, Artifacts, Vessels, Singularity, Upgrades, Oracle, Refinery, Minion

Each gate locks one menu behind a permission when enabled: true. See Commands & Permissions.

Applying changes

/mine reload (busymining.admin) re-reads config.yml, messages.yml, items.yml, mainmenu.yml and every module file, and restarts all modules, including any you just turned on or off. Two things need a full restart: database settings and the prefix.