Configuring a Task

A task is the trackable action behind a quest, e.g. "kill 100 chickens". Each task is one config file with a display and one or more XP gain methods that turn in-game triggers into progress. This page builds one from scratch.

Quick start

Open the /plugins/EcoBattlepass/tasks/ folder and copy _example.yml to a new file, e.g. chickens.yml. The file name is the task ID.
Set the display display-name and lore shown in the quest.
Under xp-gain-methods:, set a trigger, a value or multiplier, and optional filters. See the triggers list.
Reference the task ID from a quest, run /ecobattlepass reload, and confirm the action raises the task's progress in game.

Naming and IDs

The file name without .yml is the task ID. You use this ID in your quests.

The structure of a task

Part	What it controls
Display	The name and lore shown for the task in the quest
XP gain methods	The triggers that turn in-game actions into task progress

# === Display: what shows in the quest ===
display:
  display-name: Chickens # Task name
  lore:
    - "&7Kill chickens"
    - "&7%current_task_xp%/%required_task_xp%"

# === XP gain methods: how progress is earned ===
xp-gain-methods:
  - trigger: kill # The libreforge trigger to listen for
    value: 1 # Flat progress per trigger; use "multiplier" to scale the trigger's value
    filters: # Optional; restrict which triggers count
      entities:
        - chicken

Display

The display block is the task's name and lore inside the quest.

display:
  display-name: Chickens # Task name
  lore:
    - "&7Kill chickens"
    - "&7%current_task_xp%/%required_task_xp%"

XP gain methods

Each method takes a trigger, a count, optional conditions, args, and filters. Use value for a flat count per trigger, or multiplier to scale the value the trigger produces.

xp-gain-methods:
  - trigger: kill # See the triggers list for all options
    value: 1 # Use "multiplier" instead to scale the trigger's value
    filters: # Optional; here, only chickens count
      entities:
        - chicken

Internal placeholders

Placeholder	Value	Options
`%current_task_xp%`	The current task XP.	add `_formatted` for commas
`%required_task_xp%`	The required task XP.	add `_formatted` for commas

Where to go next

Use the task: Configuring a quest is where you attach task IDs.
Triggers: the triggers list covers every trigger you can use.
Defaults: the shipped tasks live here.