Skip to content

Story Quests

Story quests form the main narrative progression of the server. Unlike daily and weekly quests, story quests are played in a fixed order, unlock sequentially through prerequisites, and are completed only once per player.

FeatureStory QuestsDaily / WeeklySide Quests
RepeatableNoYes (rotating pool)No
PrerequisitesYes (quest chain + facts)NoOptional
Auto-startOptionalAssigned by systemNo
NPC turn-inCommonRareOptional
Sequential objectivesOptionalNoNo
Sets facts on completionCommonNoOptional

A quest with "auto_start": true in its options block starts on its own as soon as its prerequisites are met: at login, after another quest was completed, or when a dialog sets a fact that unlocks it. Without prerequisites it starts at the first login. This is typically used for the very first tutorial quest:

{
"id": "tutorial_awakening",
"type": "story",
"options": { "auto_start": true }
}

Story quests use the prerequisites field to define what must be completed before the quest becomes available:

"prerequisites": {
"quests": ["tutorial_awakening"],
"facts": ["chapter_1_completed == true"],
"minLevel": 5
}
TypeFieldDescription
Quest completionquestsList of quest IDs that must be completed
AchievementsachievementsList of achievement IDs that must be unlocked (needs KyuubiSoft Achievements)
FactsfactsList of fact conditions (see Facts System below)
LevelminLevelMinimum player level (needs a leveling plugin)
Skill levelmmoSkillRequired + minMmoSkillLevelMinimum level of a skill (needs the MMO skill plugin)
Permissionconditions: [{ "type": "permission", "value": "<node>" }]The player must have this permission node ("negated": true = must not have it). Checked since 2.0.0

All conditions must be met for the quest to become available. The admin window’s quest editor sets them under Flow → Requirements.

Facts are key-value pairs stored per player that represent story state. They work like flags or variables that track what the player has done or experienced. The system is inspired by The Witcher 3’s quest facts.

  1. A quest or chapter defines setsFact — a fact key that gets set when it is completed
  2. Other quests or chapters use that fact in their unlockCondition or prerequisites.facts
  3. The system checks the player’s fact database to determine availability

Facts support comparison operators:

OperatorExampleMeaning
==tutorial_completed == trueFact equals value
!=has_betrayed != trueFact does not equal value
>=dragons_slain >= 3Fact is greater than or equal to
<=reputation <= 50Fact is less than or equal to
>level > 10Fact is greater than
<corruption < 100Fact is less than
  • A quest with setsFact (and optional setsFactValue) sets the fact when it is completed.
  • A chapter with setsFact sets it when the chapter is completed. Every completed chapter also stores chapter_<id>_completed.
  • A quest trigger with setsFact sets it when the trigger fires.
  • An NPC profile dialog can set one with the action set_fact:name=value.
  • Core NPC dialogs can set one with the dialog action Set fact, and check one with the condition fact. While Quests is loaded, both use the Quests facts.
  • Admins can set, change or delete facts in the Players tool of the admin window.

For example, a quest with "setsFact": "gateway_discovered" sets that fact to true upon completion. Other quests can then require "facts": ["gateway_discovered == true"] in their prerequisites. Auto-start quests that a new fact unlocks start right away.

Story quests can require objectives to be completed in order using "options": { "sequential": true }. When enabled:

  • Only the current objective is active; subsequent objectives are locked
  • Locked objectives display as [Locked] in the Quest Book and HUD
  • Each objective unlocks only after all previous objectives are complete
{
"id": "tutorial_workbench",
"type": "story",
"options": { "sequential": true },
"objectives": [
{ "id": "obj_1", "type": "blocks_chopped", "target": "any", "count": 8 },
{ "id": "obj_2", "type": "items_crafted", "target": "Bench_WorkBench", "count": 1 },
{ "id": "obj_3", "type": "blocks_placed", "target": "Bench_WorkBench", "count": 1 }
]
}

In this example, the player must chop 8 blocks before they can craft the workbench, and must craft it before they can place it.

Many story quests require the player to visit a specific NPC to complete the quest, rather than claiming rewards through the Quest Book. When a quest has an NPC turn-in:

  • The Questbook shows Claim at NPC instead of Claim reward, and the detail panel says where to go
  • The HUD tracker card shows “Turn in: NPC · distance” when all objectives are complete
  • Talking to the NPC opens the completion dialog or the “ready to claim” strip of the quest giver window

A quest with "auto_claim": true in its options completes and pays its rewards as soon as the last objective is done. No claim and no NPC visit is needed:

"options": {
"auto_claim": true
}

This is useful for exploration quests like discovering a zone, where an extra claim step would break immersion. Chapters with autoChain start the next quest of the chain right after (see Chapters).

Story quests appear in the Story tab of the Questbook. It shows a chapter map with finished, current and locked chapters; locked chapters cannot be selected. For the selected chapter, the tab lists its quests in chapter order with their state (new, active, ready, completed or locked with the reason).

Quests with the hidden option set to true are only listed once the player has started or completed them. This allows for secret or surprise quests.

The server ships with a complete story spanning from the tutorial through five biomes. See Chapters for how these quests are organized into chapters.