Quest format
Each quest is one YAML file in plugins/QuestForge/quests/. The file name does not matter; the id inside it does. Run /quest reload after editing.
If a file uses a key QuestForge does not know, the console says so on reload (Unknown key 'requires' in quest file ...) instead of ignoring it quietly.
Top-level keys
| Key | Required | Description |
|---|---|---|
id |
yes | Unique id. Used by prerequisites, commands and NPCs |
name |
no | Display name, MiniMessage allowed. Defaults to the id |
description |
no | Text shown in the quest preview |
prerequisites |
no | List of quest ids the player must have completed first |
objectives |
yes | Ordered list of objectives. The player does them one after another |
rewards |
no | What the player gets on completion. See Rewards |
repeatable |
no | none (default), daily, weekly, always, or a cooldown such as 6h or 1h30m |
Full example
id: welcome
name: "<gold>Welcome to the Server"
description: "Gather wood, craft a pickaxe, slay a zombie."
prerequisites: []
objectives:
- type: COLLECT
material: OAK_LOG
amount: 8
- type: CRAFT
material: WOODEN_PICKAXE
amount: 1
- type: KILL
entity: ZOMBIE
amount: 1
rewards:
money: 100.0
xp: 30
items:
- material: BREAD
amount: 8
commands:
- "broadcast %player% finished the welcome quest!"
The objective types and their keys are on Objective Types.
Repeatable quests
id: daily_logger
name: "<green>Daily Logger"
repeatable: daily
objectives:
- type: COLLECT
material: OAK_LOG
amount: 32
rewards:
money: 50.0
A daily quest can be done again 24 hours after it was finished, a weekly one after 7 days. The action bar shows how long is left.
Any other cooldown is written as a duration: 30m, 6h, 1h30m, 3d, 2w. always lets the player take it again as soon as it is done. A value QuestForge cannot read (a typo like dialy) is reported in the console at load, and the quest is treated as a one-off until it is fixed.
repeatable: |
Can be taken again |
|---|---|
none (default) |
never |
daily |
24 hours after finishing |
weekly |
7 days after finishing |
6h, 1h30m, 3d… |
after that long |
always |
straight away |
The pack that ships with QuestForge already has 22 repeatable quests (15 daily, 7 weekly) to start from.