Quest Structure

Quest structure (Questborn/quests/type_name/quest_name.yml)

For Default / Rotation engine

Quest structure for individual quests (like daily/weekly tasks).

id: "weekly_architect_lines"
name: "<#38bdf8>🏗 Architect's Lines"
icon-material: "STONE_BRICKS"
icon-custom-model-data: 105

rotation-pool: "rare" # Required if type uses ROTATION engine
required-permission: "questborn.quest.architect" # Optional

description:
- "<#cccccc>The architect is drafting a new district."
- "<#cccccc>Place lots of stone, add some light,"
- ""
- "<#93c5fd>⭐ <#cccccc>Rarity: <#bfdbfe>Rare"
rewards-description:
- "<#a7ff99>+1500 coins"
- "<#ffe08a>+520 XP"

quest-path:
  stage-1:
    objective:
      type: BLOCK_PLACE
      amount: 256
      target-materials:
      - STONE_BRICKS
      - COBBLESTONE

rewards:
  money:
    amount: 1500
  xp:
    points: 520

quest-effects:
  activate: "quest_activate_start"
  complete: "quest_complete_success"

For Chain engine

Structure using multiple stages inside a single quest.

id: iron_smelting
name: "<#34eb6b>Iron Smelting"
icon-material: IRON_INGOT
slot: 21
page: 1
require-quests:
- "copper_smelting"
description:
- "<#cccccc>Mine some iron ore."
- "<#cccccc>Smelt the ore into iron ingots."
rewards-description:
- "<#a7ff99>+170 coins"
- "<#ffe08a>+80 XP"

quest-path:
  stage-1:
    objective:
      type: BLOCK_BREAK
      amount: 24
      target-materials:
      - "IRON_ORE"
      - "DEEPSLATE_IRON_ORE"
  stage-2:
    objective:
      type: ITEM_SMELT
      amount: 24
      target-materials:
      - "IRON_INGOT"
  stage-3:
    required-materials:
      - "IRON_INGOT:12"

rewards:
  money:
    amount: 170
  xp:
    points: 80

quest-effects:
  activate: "quest_activate_start"
  stage-change: "quest_stage_change"
  complete: "quest_complete_success"

Explanation of keys and what they are responsible for

Key	What it does
id	Unique quest id. Tip: keep it aligned with filename (e.g. daily_…)
name	Quest title in the GUI
icon-material	Item that will be the quest icon in the list in the GUI
slot	The slot where the quest will be located in the GUI
page	The page where the quest will be located. Tip: If you have one page, you can omit page: 1
require-quests	Quests are required to access the current one. Tip: You don't need to use this in the first quest in the chain.
description	What the player should do and why (story). Keep it readable
rewards-description	Text shown in GUI. This does not execute anything by itself
quest-path	The path of the quest stages, in it you can use objective & required-materials
objective	The goal: type + parameters (see Objective configuration section)
required-materials	Items needed to complete the quest. (These items must be handed in to the quest)
rewards	Actual rewards (money/xp/items/atributes/commands depending on your build. See Rewards configuration section)
quest-effects	Quest effects after receiving and completing

Tip: Minimum required keys: id, name, description, objective or required-materials