currency.yml

Configure the game economy. This file controls the currency name, symbol, starting balances, and event-based rewards/penalties.

Where to find it

Generated after the first server start:

• plugins/Zentrix/currency.yml

What you edit here

• Currency display name and symbol

• Default starting balance for new players

• Player balance command name and aliases (/coins, /bal, etc.)

• Event reward and penalty amounts (positive = reward, negative = penalty)

• Which actions grant or deduct currency

Event rewards are optional. Remove or comment out any event you don't want to use. Spectators never receive currency rewards.

Introduction

currency.yml centralizes all economy-related configuration for matches. Use it to adjust how much players earn for kills, placements, class triggers, and other game events. Values are literal integers and apply immediately when the corresponding in-game event fires.

Rules & behavior for event values

• Positive values add currency.

• Negative values deduct currency (penalty). Balances will not go below 0.

• Commenting out an event (prefix with #) disables that reward/penalty.

• Spectators: events do not grant currency to spectators.

• Atomicity: each event applies independently; multiple events may add up for a single action (e.g., first-blood + player-kill).

File structure

Everything lives under the currency: key.

command: controls the player balance command.

events: lists per-event reward/penalty amounts.

currency:
  display-name: "<string>"
  symbol: "<string>"
  starting-balance: <integer>

  command:
    name: "<string>"
    aliases:
      - "<string>"

  events:
    game-win: <integer>
    player-kill: <integer>
    # ...

Configuration fields

display-name

The name shown in chat and GUI for the currency. Use color codes if desired.

display-name: "&#FFD700Coins"

symbol

A short symbol shown next to amounts (e.g., ⛃ 100).

symbol: "⛃"

starting-balance

The default balance assigned to new players joining for the first time.

starting-balance: 0

command

Controls the player balance command (the command players run to view their own coins).

This does not affect admin economy commands like /zentrix currency set. See: Currency Commands.

command.name

The primary command name.

Default:

• /coins

command:
  name: "coins"

command.aliases

Optional aliases for the same balance command.

Default:

• /bal

• /balance

command:
  aliases:
    - "bal"
    - "balance"

Pick a command that doesn’t conflict with other plugins.

If you change command.name, restart the server so the command re-registers cleanly.

events

A keyed list of in-game events and the integer amount awarded or deducted when they occur.

• Positive number — add currency.

• Negative number — deduct currency (penalty).

• Comment out to disable.

Examples:

events:
  game-win: 100
  player-kill: 25
  game-leave: -10

Event categories (explanation)

Game Lifecycle

• game-win — Award for winning a match.

• game-join — Small reward for joining a lobby.

• game-leave — Penalty for leaving mid-game.

Combat Actions

• player-kill — Reward for eliminating an opponent.

• player-death — Penalty on elimination.

• first-blood — Bonus for the first kill in the match.

Survival & Ranking

• survives-deathmatch — Reward for surviving until Deathmatch starts.

• reaches-top-5 / reaches-top-3 — Placement rewards.

Class Abilities

• class-select — Reward for choosing a class in the lobby.

• warrior-true-damage, archer-bow-buff, etc. — Small rewards tied to ability triggers.

Crafting & Misc

• crafts-custom-recipe — Reward for crafting custom recipes.

• crafts-first-time — Bonus for crafting a particular recipe the first time.

• last-team-member — Reward for being the last surviving member of a team.

Be careful with large positive values on frequent events (like player-kill) — they can inflate your economy quickly. Tune slowly and test in real matches.

Example breakdown: combat & placement

A typical setup:

events:
  player-kill: 25
  player-death: -5
  first-blood: 50
  reaches-top-3: 25

• A player who gets the first kill and later finishes top 3 would receive both first-blood and reaches-top-3 rewards.

• If a player leaves mid-game, game-leave applies and their balance will not drop below 0.

Full configuration

Expand: default currency.yml

# -----------------------------------------------------------------------------
# Zentrix Battle Royale - Currency Configuration
# Developed by Harsh
# -----------------------------------------------------------------------------

# =============================================================================
# ECONOMY SETTINGS
# =============================================================================
# Configure the visual appearance and starting values for the game economy.

currency:
  # The name of the currency displayed in chat/GUI.
  display-name: "&#FFD700Coins"

  # The symbol displayed before amounts (e.g., ⛃ 100).
  symbol: "⛃"

  # Default balance for new players joining for the first time.
  starting-balance: 0

  # ===========================================================================
  # COMMAND CONFIGURATION
  # ===========================================================================
  # Configure the currency balance command.
  
  command:
    # The primary command name (e.g., /balance, /coins, /credits).
    # This will be the main command players use to check their balance.
    name: "coins"
    
    # List of command aliases. Players can use any of these instead of the main command.
    # Example: If name is "balance" and aliases are ["bal", "coins"], players can use:
    #   /balance, /bal, or /coins
    aliases:
      - "bal"
      - "balance"

  # ===========================================================================
  # EVENT REWARDS
  # ===========================================================================
  # Define currency awarded or deducted for specific game actions.
  #
  # RULES:
  #   - Positive (+): Adds currency.
  #   - Negative (-): Deducts currency (Penalty). Balance won't drop below 0.
  #   - Comment (#):  Disables the reward entirely.
  #   - Spectators:   Never receive rewards.

  events:
    # -------------------------------------------------------------------------
    # Game Lifecycle
    # -------------------------------------------------------------------------
    # Each and every event here is optional, you can remove it if you want.
    game-win: 100                   # Player's team wins the game
    game-join: 5                    # Player joins a game lobby
    game-leave: -10                 # Player leaves mid-game (Penalty)

    # -------------------------------------------------------------------------
    # Combat Actions
    # -------------------------------------------------------------------------
    player-kill: 25                 # Killing an opponent
    player-death: -5                # Being eliminated (Penalty)
    first-blood: 50                 # The very first kill of the match

    # -------------------------------------------------------------------------
    # Survival & Ranking
    # -------------------------------------------------------------------------
    survives-deathmatch: 30         # Surviving until the Deathmatch phase starts
    reaches-top-5: 15               # Team reaches Top 5 remaining
    reaches-top-3: 25               # Team reaches Top 3 remaining

    # -------------------------------------------------------------------------
    # Class Abilities
    # -------------------------------------------------------------------------
    class-select: 2                 # Selecting a class in the lobby

    # Specific Ability Triggers
    warrior-true-damage: 3          # Warrior: True damage proc
    archer-bow-buff: 5              # Archer: Buff activation
    looter-chest-bonus: 8           # Looter: Found bonus item
    trapper-fall-reduction: 2       # Trapper: Fall damage prevented
    fisherman-bonus: 3              # Fisherman: Bonus loot caught
    miner-auto-smelt: 5             # Miner: Ore auto-smelted

    # -------------------------------------------------------------------------
    # Crafting & Misc
    # -------------------------------------------------------------------------
    crafts-custom-recipe: 5         # Crafting any custom recipe
    crafts-first-time: 15           # Crafting a specific recipe for the first time
    last-team-member: 10            # Being the last survivor of a team