Installation

1. Check the Requirements: Java 21+, Paper, Purpur or Folia on 1.21+.
2. Download the latest release from GitHub.
3. Drop the jar into your server's plugins/ folder.
4. Start (or restart) the server. On first run, BusyMining creates plugins/BusyMining/:
   • config.yml: the message prefix, module toggles, database settings and optional menu permission gates.
   • messages.yml: command and help messages.
   • mainmenu.yml: the layout of the /mine menu.
   • items.yml: name, lore and material of the plain custom items.
   • modules/<module>/: each module's own config.yml, plus messages.yml and gui.yml where it has them.
   • busymining.db: the SQLite database (unless you switch to MySQL).
5. Edit whichever files you need (see Configuration).
6. Apply changes without restarting: /mine reload (permission busymining.admin).

Verifying it's working

The console prints one summary block when BusyMining finishes loading:

BusyMining v26.9.0 on Folia
  Storage  SQLite
  Modules  14/14 enabled
  Hooks    Vault, PlaceholderAPI
  Ready in 195ms

Modules adds (off: ...) naming any module that is switched off or failed to load, and Hooks shows which optional plugins were found (none if neither is installed). Then run /mine in-game to open the main menu.

Updating

Replace the jar and restart. BusyMining then brings your files up to date:

• New options are added to your files, with their comments, in the place they have in the default file. This covers config.yml, messages.yml, items.yml, mainmenu.yml and every module file. The console summary gets a Configs row saying how many files and keys changed.
• Everything you wrote is kept as written: values, quotes, comments, indentation and key order. Only the new lines are inserted.
• The previous copy is saved first in plugins/BusyMining/backups/, named after the file and the time of the update.
• Values you already have are never changed. For example, if your modules/oracle/config.yml was generated by an older version, its boss health and summon block stay at the old values until you change them yourself. Reworded default messages don't replace your text either; delete a key to get its current default back on the next restart or /mine reload.
• Lists of your own entries are left alone: menu items, ore amounts and Oracle drops. See Module Configuration.

A file with a YAML error is never touched. BusyMining logs a warning naming the file and keeps using the defaults for whatever it can't read.

Uninstalling

Remove the jar and restart. plugins/BusyMining/ (configs and the SQLite database) stays on disk. Delete it yourself for a clean removal. Custom items that players still hold turn into their plain vanilla material.