How to Make a Reward

A reward is what a player earns for tiering up the battlepass. Each reward is a reusable config file with a display (what shows on the tier button) and effects (what actually happens when it's claimed). Thanks to libreforge, a reward can be an item, currency, a potion effect, a stat multiplier, or anything else you can express as an effect. This page builds one from scratch.

Quick start

1. Open the /plugins/EcoBattlepass/rewards/ folder and copy _example.yml to a new file, e.g. diamond_block.yml. The file name is the reward ID.

2. Set the display name and reward-lore that show on the tier button.

3. Add the effects that fire when the reward is claimed, using the Item Lookup System for any item arguments.

4. Reference the reward ID from a tier in your battlepass config.

5. Run /ecobattlepass reload, open the pass, claim the tier, and confirm the player receives the reward.

Naming and IDs

The file name without .yml is the reward ID. You use this ID in your battlepass configs and effect filters.

The structure of a reward

# === Display: what the player sees on the tier ===
display:
  name: "&6x&b1 &fDiamond Block" # Reward name in the GUI
  reward-lore: # Lines under the name; use [] for no lore
    - "&7This is a diamond block"
    - "&7It is very valuable"

# === Effects: what the player gets on claim ===
effects:
  - id: give_item # libreforge effect
    args:
      item: DIAMOND_BLOCK 1 # Item Lookup System syntax

Display

The display block is the reward's name and lore on the tier button.

display:
  name: "&6x&b1 &fDiamond Block" # Shown on the tier
  reward-lore: # Use [] to show no lore at all
    - "&7This is a diamond block"
    - "&7It is very valuable"

Effects

The effects block is the core of the reward: it runs when the player claims the tier.

effects:
  - id: give_item
    args:
      item: DIAMOND_BLOCK 1 # Item Lookup System syntax

Gives the player a diamond block when they claim the tier.

Where to go next

• Use the reward: How to make a battlepass is where you attach reward IDs to tiers.

• Effects deep-dive: Configuring an Effect is the full libreforge reference.

• Item syntax: the Item Lookup System covers item arguments.

• Defaults: the shipped rewards live here.