Main Configuration

plugins/BusyFishing/config.yml holds the settings shared by every module and the switches that turn modules on and off. Apply changes with /fish reload unless noted.

General

yaml
# Put in front of most chat messages.
prefix: "Fishing » "

# Shown in front of money amounts.
currency-symbol: "$"

# Extra names for the /fish command, on top of the built-in ones. Needs a restart.
command-aliases: []

Modules

yaml
modules:
  fish: true          # custom fish and the catch itself; everything else builds on it
  leveling: true      # fishing XP, levels and skill points
  entropy: true       # the entropy currency and entropy crystals
  shop: true          # /fish shop
  scales: true        # /fish scales
  gutting: true       # /fish gut
  fishbag: true       # /fish bag
  codex: true         # /fish codex
  stats: true         # /fish stats
  skills: true        # /fish skills
  augments: true      # rod augments
  bait: true          # bait and the bait shop
  boosters: true      # lures and entropy boosters
  party: true         # bonus for fishing near other players
  mobs: true          # crabs, and fish from killing fish mobs
  totems: true        # fishing totems
  deliveries: true    # /fish deliveries
  tournaments: true   # fishing tournaments
  events: true        # the seasonal event
  menu: true          # /fish menu
  # The one-way importer for servers moving from PyroFishingPro.
  pyro-import: true
  bosses: true        # fishing bosses
  crafting: true      # /fish craft recipe menu
  fishbags: true      # fish bags as tradeable items
  parties: true       # invitation-based fishing parties

A module that is off removes its commands, menu buttons, listeners, placeholders and timers. The rest keeps working. A few depend on others: almost everything needs fish, and gutting needs entropy. Each module's own settings are covered in Module Configuration.

pyro-compat

yaml
pyro-compat: auto

For servers moving from PyroFishingPro. While on, BusyFishing also accepts Pyro's permission nodes (pyrofishingpro.*), its placeholders (%pyrofishingpro_*%), the /pyrofish command, the tags on items Pyro created, and fires Pyro's events for Pyro addons.

Value Meaning
auto (default) On only when plugins/PyroFishingPro/ exists or its data was already moved over. Off on a server that never used Pyro.
true / false Force it.

Needs a restart. See the Migration Guide.

Menus

menu-permissions and back-arrows are covered on the Menus page.

Storage

yaml
storage:
  # How often changed player data is written to disk or the database.
  autosave-minutes: 5

# Player data is kept in plugins/BusyFishing/playerdata/ unless this is enabled.
database:
  enabled: false
  type: mysql        # mysql or mariadb
  host: localhost
  port: 3306
  database: busyfishing
  username: root
  password: ""
  pool-size: 10
  connection-timeout: 5000

See Database Setup.