Plugin Config

The plugin-wide settings live in config.yml in the Boosters data folder (/plugins/Boosters/config.yml). It controls storage, the /boosters GUI layout, and the sounds played on booster events. Edit it, then run /boosters reload to apply changes.

Default config.yml

# Force Boosters to save to local storage even when eco uses a database.
# Disables cross-server sync; leave false for networks.
use-local-storage: false

# Warn players before active boosters expire. Each value is the ticks remaining
# at which to warn (20 ticks = 1 second); a warning fires once as the remaining
# time crosses each threshold. The message lives in lang.yml (expiry-warning)
# and supports %booster% and %time% (HH:MM:SS). Boosters opt out with
# "expiry-warning: false".
expiry-warning-intervals:
  - 1200 # 60 seconds remaining
  - 600 # 30 seconds remaining
  - 200 # 10 seconds remaining

# true = action bar, false = chat
expiry-warning-action-bar: false

gui:
  title: Boosters (%page%/%max_page%) # Title of the /boosters menu. Supports %page% and %max_page% placeholders.
  rows: 3 # Menu height, 1 to 6 rows

  # Sound played when the page turns.
  sound:
    enabled: true
    sound: ui.button.click
    pitch: 1.0
    volume: 1.0

  # Navigation options. Shows the inactive item on the first/last page, or hides
  # the button when no item-inactive is set.
  forwards-arrow:
    item: arrow name:"&fNext Page"
    item-inactive: gray_dye name:"&7Next Page"
    row: 3 # 1 to 6
    column: 6 # 1 to 9
  backwards-arrow:
    item: arrow name:"&fPrevious Page"
    item-inactive: gray_dye name:"&7Previous Page"
    row: 3
    column: 4

  mask: # Background filler items, drawn behind boosters on every page
    items:
      - black_stained_glass_pane # Item used for masked slots
    pattern: # 1 = masked, 0 = open slot a booster can occupy
      - "111111111"
      - "101101101"
      - "111111111"

  custom-slots: [] # Optional extra slots, shown on every page; see https://hub.auxilor.io/wiki/eco/pages

sounds:
  activate: # Played when a booster is activated
    enabled: true
    sound: ENTITY_PLAYER_LEVELUP # Any Bukkit Sound name
    volume: 2
    pitch: 0.9
    category: AMBIENT # Sound category the volume slider obeys
  increment: # Played when an active booster's duration is extended
    enabled: true
    sound: ENTITY_EXPERIENCE_ORB_PICKUP
    volume: 2
    pitch: 0.9
    category: AMBIENT
  expire: # Played when a booster ends
    enabled: true
    sound: ENTITY_ITEM_BREAK
    volume: 2
    pitch: 0.9
    category: AMBIENT
  expiry-warning: # Played alongside each expiry warning
    enabled: true
    sound: BLOCK_NOTE_BLOCK_PLING
    volume: 2
    pitch: 1.0
    category: AMBIENT

Where to go next

  • Build a booster: How to Make a Booster covers the per-booster config files.

  • Commands: Commands and Permissions for the reload and admin commands.