Menus

Most of BusyFishing is played through chest menus. /fish (or /fish menu) opens the main menu, which links to every other menu whose module is on.

Opening the main menu

  • /fish or /fish menu
  • Sneak and click while holding a fishing rod. Set in modules/menu/config.yml:
yaml
shift-click:
  enabled: true
  # Permission needed to use it. Empty = everyone.
  permission: ""

# Show the viewer's own skin on the profile button.
profile-skull: true

Changing a menu's layout

Every module keeps its menus in its own gui.yml (for example modules/shop/gui.yml). Each menu has a title, a number of rows, and items, where each item has a material, slots, a name and lore. Text takes MiniMessage or & colour codes. Apply changes with /fish reload.

Drop-in menus (shop, scales, gutting, fish bag) treat their empty slots as the area players put fish into, so leave those slots empty when you add decoration.

Locking menus behind permissions

In the root config.yml, each menu can require a permission. Off by default:

yaml
menu-permissions:
  menu:       { enabled: false, permission: busyfishing.command.fishmenu }
  shop:       { enabled: false, permission: busyfishing.command.fishshop }
  bag:        { enabled: false, permission: busyfishing.command.fishbag }
  deliveries: { enabled: false, permission: busyfishing.command.deliveries }
  scales:     { enabled: false, permission: busyfishing.command.scales }
  gut:        { enabled: false, permission: busyfishing.command.gut }
  skills:     { enabled: false, permission: busyfishing.command.skills }
  bait:       { enabled: false, permission: busyfishing.command.bait }
  codex:      { enabled: false, permission: busyfishing.command.codex }
  augment:    { enabled: false, permission: busyfishing.command.augment }
  augments:   { enabled: false, permission: busyfishing.command.augments }
  stats:      { enabled: false, permission: busyfishing.command.stats }
  totem:      { enabled: false, permission: busyfishing.command.totem }

The check applies both to the command and to the button in the main menu. busyfishing.admin skips it.

Back buttons

Each menu's back button returns to the main menu. You can remove them all, or run your own console commands instead (for example to go back to a server hub menu):

yaml
back-arrows:
  disabled: false
  # Console commands to run instead, per menu. %player% is the player.
  # Example:  shop: ["dm open hub %player%"]
  commands: {}