Quest Structure

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

For default engine

Quest structure for default engine

id: "daily_break_blocks"
name: "<#55aaff>Break Blocks"
icon-material: "OAK_LOG"
description:
  - "<#cccccc>Daily task from the guild."
  - "<#cccccc>Complete: Break Blocks."
  - "<#cccccc>Check the objective below."
rewards-description:
  - "<#a7ff99>+150 coins"
  - "<#ffe08a>+70 XP"
objective:
  type: "break-blocks"
  amount: 16
  target-materials:
    - OAK_LOG
rewards:
  money: 150
  xp: 70
quest-effects:
  activate: "objective_block_break"
  complete: "quest_complete_success"

For chain engine

Quest structure for chain engine

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

objective

The goal: type + parameters (see Objective configuration section)

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.

Last updated