EzBoost – Configuration Options Reference

Table of Contents
settings.yml
limits.yml
worlds.yml
economy.yml
messages.yml
1. Boost-context tags
gui.yml
1. New: show-effects
boosts.yml

This document provides a complete reference for all configuration files and options available in EzBoost. Use this guide to understand and customize every aspect of the plugin.

settings.yml
limits.yml
worlds.yml
economy.yml
messages.yml
gui.yml
boosts.yml

settings.yml

Controls general plugin behavior.

settings:
  replace-active-boost: false   # Replace active boost if a new one is activated
  refund-on-fail: true         # Refund cost if boost activation fails
  keep-boost-on-death: true    # Keep boost effects after player death
  reapply-on-join: true        # Reapply active boosts when player rejoins
  send-expired-message: true   # Notify player when boost expires
  cooldown-per-boost-type: true # Separate cooldowns for each boost type

The plugin now supports optional per-effect cooldowns. When enabled, each effect (including custom effects) can define its own cooldown duration. To enable per-effect cooldown tracking, set:

settings:
  cooldown-per-effect: false  # When true, cooldowns are tracked per-effect instead of per-boost

Behavior:

cooldown-per-boost-type: true (legacy) keeps the existing per-boost-type cooldown behavior.
cooldown-per-effect: true enables per-effect cooldown checks. Lookups will fall back to the boost-level/global cooldown if no effect-specific cooldown is present.

limits.yml

Defines allowed ranges for boost durations and amplifiers.

limits:
  duration-min: 5      # Minimum allowed duration (seconds)
  duration-max: 3600   # Maximum allowed duration (seconds)
  amplifier-min: 0     # Minimum allowed amplifier (effect strength)
  amplifier-max: 5     # Maximum allowed amplifier (effect strength)

worlds.yml

Controls which worlds allow or deny boost usage.

worlds:
  allow-list: []   # List of world names where boosts are allowed (empty = all worlds allowed)
  deny-list: []    # List of world names where boosts are denied (empty = no worlds denied)

If both lists are empty, boosts are allowed in all worlds.
If a world appears in both lists, deny-list takes priority.

economy.yml

Controls economy integration and Vault support.

economy:
  enabled: true   # Enable/disable economy features
  vault: true     # Use Vault for cost handling

messages.yml

Customize all plugin messages and prefixes. Supports MiniMessage formatting.

prefix: "<gray>[<aqua>EzBoost</aqua>]</gray> "
no-permission: "<red>You don't have permission.</red>"
boost-not-found: "<red>Boost not found.</red>"
boost-disabled: "<red>This boost is currently disabled.</red>"
boost-active: "<yellow>You already have that boost active.</yellow>"
boost-replaced: "<yellow>Your active boost was replaced.</yellow>"
boost-activated: "<green>Boost activated: <white><boost></white>.</green>"
boost-expired: "<gray>Your boost <white><boost></white> has expired.</gray>"
boost-cooldown: "<red>That boost is on cooldown for <white><time></white> seconds.</red>"
boost-effect-cooldown: "<red>The effect <white><effect></white> is on cooldown for <white><time></white> seconds.</red>"
insufficient-funds: "<red>You need <white><cost_compact></white> to activate this boost.</red>"
economy-unavailable: "<red>Economy is unavailable. Please contact an admin.</red>"
cost-charged: "<gray>Charged <white><cost_compact></white> for <white><boost></white>.</gray>"
reload: "<green>EzBoost reloaded.</green>"
only-players: "<red>Only players can use this command.</red>"
invalid-target: "<red>Player not found.</red>"
token-given: "<green>Gave <white><amount>x</white> <white><boost></white> boost token(s) to <white><player></white>.</green>"
token-used: "<green>Activated <white><boost></white> from a boost token.</green>"
world-blocked: "<red>You can't use boosts in this world.</red>"
actionbar:
  enabled: false
  format: "<gray>Boost:</gray> <white><boost></white> <gray>(<time>s)</gray>"

Boost-context tags

The following tags are automatically injected for messages that are sent in the context of a specific boost. No PlaceholderAPI is required for these.

Tag	Value	Available in
`<boost>`	Display name	All boost-context messages
`<boost_display>`	Display name (explicit alias)	All boost-context messages
`<boost_key>`	Internal config key	All boost-context messages
`<boost_cost>`	Fully formatted cost (e.g. `50,000`)	All boost-context messages
`<boost_cost_compact>`	Compact cost (e.g. `50K`)	All boost-context messages
`<boost_cost_raw>`	Raw numeric cost (e.g. `50000`)	All boost-context messages
`<boost_duration>`	Duration in seconds	All boost-context messages
`<boost_cooldown>`	Cooldown in seconds	All boost-context messages
`<cost>`	Alias for `<boost_cost>` (backward compat)	All boost-context messages
`<cost_compact>`	Alias for `<boost_cost_compact>` (backward compat)	All boost-context messages
`<time>`	Remaining cooldown in seconds	`boost-cooldown`, `boost-effect-cooldown`
`<effect>`	Effect name	`boost-effect-cooldown`

Boost-context messages (those that receive boost tags automatically): boost-activated, boost-expired, boost-cooldown, boost-effect-cooldown, insufficient-funds, cost-charged, token-used

Messages without boost context (no-permission, boost-active, boost-replaced, boost-not-found, etc.) do not have a single boost in scope and only support the generic tags listed in their own comments.

Other placeholders:

Tag	Available in
`<amount>`	`token-given`
`<player>`	`token-given`
`<boost>` (display name)	`actionbar.format`
`<time>` (seconds remaining)	`actionbar.format`

gui.yml

Controls the in-game boost selection menu. See also docs/gui.md for advanced details.

gui:
  enabled: true
  title: "<gradient:#00d2ff:#3a47d5>EzBoost</gradient>"
  size: 45
  close-on-click: true
  filler:
    material: BLACK_STAINED_GLASS_PANE
    name: "<gray> </gray>"
    lore: []
  lore:
    - "<gray>Duration:</gray> <white><duration>s</white>"
    - "<gray>Cooldown:</gray> <white><cooldown>s</white>"
    - "<gray>Cost:</gray> <white><cost></white>"
    - "<gray>Status:</gray> <status>"
  status:
    available: "<green>Available</green>"
    locked: "<red>Locked</red>"
    cooldown: "<gold>Cooldown</gold>"
    active: "<aqua>Active</aqua>"
  slots:
    speed: 10
    jump: 11
    haste: 12
    strength: 13
    regen: 14
    nightvision: 15
    resistance: 16
    fireresist: 17

Placeholders: <duration>, <cooldown>, <cost>, <status>

New: `show-effects`

You can control whether the GUI automatically displays the potion/effect lines for each boost.

gui:
  show-effects: false  # When false (default), effect information is hidden from the item lore

Default: false (effect lines hidden)
Set to true to display per-effect lines (including per-effect cooldowns when applicable).

boosts.yml

Defines all available boosts. See docs/boosts.md for a full reference and customization guide.

speed:
  display-name: "<aqua>Speed Boost</aqua>"
  icon: SUGAR
  effects:
    - type: SPEED
      amplifier: 1
  commands:
    enable: []
    disable: []
    toggle: []
  duration: 300
  cooldown: 600
  cost: 0.0
  permission: "ezboost.boost.speed"
  enabled: true

For more details, see the full EzBoost documentation on GitHub.