Commands & Permissions

Commands & Permissions

Everything runs under one root command, /mine, with subcommands.

Aliases: /bm, /busymine. Both are equivalent to /mine. If another plugin also claims /mine, /busymining:mine always reaches BusyMining.

Player commands

Every command needs busymining.player, which every player has by default.

Command Description
/mine Open the main menu
/mine help List every subcommand you have access to
/mine menu Open the main menu
/mine shop Open the Mine Shop
/mine stats [player] Open the statistics menu for yourself or any player who has joined before
/mine zeta Show your Zeta balance in chat
/mine journal Open the Journal
/mine artifacts Open the Artifact Identifier
/mine singularity Open the Singularity
/mine upgrades Open the Passive Upgrades menu
/mine oracle Open the Oracle status menu
/mine refinery Open the Mining Tome Refinery menu
/mine vessel Open the Vessel menu for the pickaxe in your hand
/mine minion Open the menu of your nearest minion within 10 blocks
/mine thrallcd Show how long until a Thrall can appear again

Shortcuts

These nine commands are registered on their own and do the same as /mine <name>:

/shop, /artifacts, /upgrades, /singularity, /oracle, /refinery, /journal, /vessel, /minion

Short names like /shop often clash with other plugins. When two plugins register the same name, only one of them gets it. /mine shop (or /busymining:shop) always works.

Admin commands

All of these need busymining.admin (default: op).

Command Description
/mine reload Reload every config, message and menu file and restart all modules
/mine give <item> [player] [amount] Give a custom item. Amount is 1 to 2304. With no player, gives to yourself
/mine addxp <player> <amount> Add mining XP. Works for offline players too
/mine addzeta <player> <amount> Add Zeta. Works for offline players too
/mine cullmobs Remove every Rune Guardian, Wraith, Oracle, Oracle minion, Thrall and Vessel boss BusyMining spawned
/mine addvessel <vessel> [levels] [player] Add Vessel levels to the held pickaxe without a trial
/mine minion give [player] Give a Mining Minion item

Testing tools

These exist to test the late-game loop quickly. Keep them to trusted staff.

Command Description
/mine vesselready [player] Reveal all three Requium Orbs and set anger to 100% on the held pickaxe's trial
/mine resetcooldowns [player] Clear the target's Oracle and Rune Guardian summon cooldowns

/mine shop givezeta <player> <amount> is kept for older scripts. It only works on online players. Use /mine addzeta in new setups.

Vessel names for addvessel are the lowercase ids from the Vessels page, such as valakas_nightfall. Tab completion lists them, along with every item id for /mine give.

Permission nodes

Node Default Grants
busymining.player everyone Every player command and the nine shortcuts. Without it, /mine and the shortcuts are refused
busymining.admin op Every admin command, admin lines in /mine help, and opening other players' minions

Optional menu permissions

Each menu can be locked behind its own permission. The gates are off by default, so everyone can open every menu. Turn one on in config.yml:

yaml
GUIPermissions:
  Shop:
    enabled: true
    Permission: 'busymining.gui.shop'
Gate Default permission Locks
Main busymining.gui.main The main menu
Shop busymining.gui.shop The Mine Shop
Stats busymining.gui.stats The statistics menu
Journal busymining.gui.journal The Journal
Artifacts busymining.gui.artifacts The Artifact Identifier
Vessels busymining.gui.vessels The Vessel menu
Singularity busymining.gui.singularity The Singularity
Upgrades busymining.gui.upgrades Passive Upgrades
Oracle busymining.gui.oracle The Oracle status menu (not summoning)
Refinery busymining.gui.refinery The Mining Tome menu (not the physical Refinery)
Minion busymining.gui.minion Minion menus

The busymining.gui.* nodes are not declared in plugin.yml, so the server gives them to ops only. Grant them to your player groups through your permissions plugin when you turn a gate on. You can also change Permission: to any node you already use.