Mods are a feature of the full game, not the demo. They open when the full game launches, and details may change before then.

Quests

Make a request that villagers hand out: defeat creatures, collect items, find a place, talk to someone, and earn gold, experience and items for it.

What this lets you make#

A quest has a title, a description, one to four objectives and a reward. You can only use the kinds of objective the game already tracks (defeat, collect, find a place, talk, raise a relationship). You cannot invent new kinds. A quest can be offered automatically by villagers of a certain job or by named villagers, or you can hand it out from your own dialogue.

In the editor#

Open the Quests tab under Story in the left column (if it is not there, add it from Add new content at the bottom) and press Add. One entry is one quest. A new quest is to defeat three wolves, given by the innkeeper, with 50 gold and 100 experience as the reward.

This kind has its own form. From top to bottom:

  • Category (Personal, Village or Rumor, which only decides where it sits in the quest journal), Quest name and Description.
  • Objectives: up to 4, and all must be done. The kinds are Defeat creatures, Collect items, Find a place, Raise a relationship and Talk to someone. Press Add an objective for more.
  • Rewards: Gold, Experience, Item rewards and Relationship rewards, all optional.
  • Time limit: in game hours, 1 to 240. Unset means no limit.
  • Who gives this quest: the roles or villagers you pick will offer it on their own. If you pick nobody, use Offer a quest in a dialogue.
  • Offer lines: Villager says, Accept answer and Decline answer, plus the optional Villager replies after accepting and When it is offered.
  • Hand-in lines: optional, added with Add hand-in lines. Without them the usual hand-in button is used. A named villager needs them.

The right column is the Quest journal preview, drawn as the card a player sees in the journal. Below it, Dialogues that offer this quest lists which dialogues hand it out. When nothing does, it tells you to add an Offer a quest effect in a dialogue or to choose a giver here.

Advanced: writing the JSON by hand#

This is the same content as it is written in the file. The editor saves exactly this format. You can also press Open folder at the top of the editor and edit the file in an outside text editor; when you save, the editor picks up the change. Fields the form does not have are kept as they are. Where the file goes and how it is listed: Mod folder and mod.json.

The file is data/quests.json, and mod.json points to it with "quests": "data/quests.json" under content.

A minimal working example#

The innkeeper asks the player to defeat five Ember Wolves, tell the hunter Lu Qi about it, and come back for the reward:

data/quests.json
[
  {
    "id": "wolf_pack",
    "category": "village",
    "title": "The wolf pack",
    "titles": { "zh-TW": "狼群" },
    "description": "Defeat five ember wolves, tell Lu Qi about it, then see the innkeeper for your reward.",
    "descriptions": { "zh-TW": "打倒五隻餘燼狼,再去和路奇說一聲,最後回旅店找老闆領賞。" },
    "objectives": [ { "type": "kill", "species": "ember_wolf", "count": 5 }, { "type": "talk", "npc": "luqi" } ],
    "rewards": { "gold": 60, "xp": 150, "items": [ { "item": "wolf_pelt", "count": 1 } ] },
    "giver": { "roles": ["INNKEEPER"] },
    "offer": {
      "text": "Wolves keep circling outside the village lately. Could you drive them off?",
      "accept": "Leave it to me.",
      "decline": "Not right now."
    },
    "turnIn": {
      "text": "Well? Is the wolf pack dealt with?",
      "handIn": "It is all taken care of.",
      "notYet": "Still working on it.",
      "thanks": "Wonderful. Here is your reward."
    }
  }
]

title and description work like text in other tables: write the main language directly and add other languages in titles and descriptions (en, zh-TW, zh-CN).

Fields#

FieldRange and meaning
id (required)Your own name for it, same rules as other tables
categorypersonal (default), village or rumor
title, titles (required)Title, up to 60 characters
description, descriptions (required)Description, up to 400 characters
objectives (required)1 to 4 objectives, see "Objectives". All must be done to hand the quest in
rewardsRewards, see "Rewards"
dueHoursTime limit, a whole number of in-game hours from 1 to 240. Leave out for no limit
giverWho offers the quest: { "roles": [jobs...] }, { "npcs": [villagers...] }, both together, or "all". The lists of jobs and villagers are on the Dialogue page
offerThe dialogue for taking the quest. Required whenever there is a giver
turnInThe dialogue for handing it in. Required when giver names a specific villager

Objectives#

`type`Other fieldsMeaning
killspecies, count (1 to 50)Defeat this many of a creature. Built-in, from your own species table, or @othermod/id
collectitem, count (1 to 999)Hold this many of an item (built-in or modded). Checked when handing the quest in
discoversiteFind a place, from the list below. When the quest is accepted, the villager first gives a rumour of where it is
relationshipnpc, field, value (-100 to 100)Reach a number in your relationship with a named villager. field is affinity, trust, respect, fear, debt or intimacy
talknpc or role, pick oneTalk to a named villager, or to any villager with a given job. Starting the conversation counts

The site of a discover objective must be a place the game already has:

`site`Place
forbidden_mine_entranceForbidden Mine Entrance
collapsed_watchtowerCollapsed Watchtower
drowned_shrineDrowned Shrine
hollow_beneath_the_millHollow Beneath the Mill
saltbone_campSaltbone Camp
old_toll_stoneOld Toll Stone
weeping_groveWeeping Grove
smugglers_cellarSmuggler's Cellar
ashfall_kilnAshfall Kiln
thousand_step_stairThousand-Step Stair
cracked_wellheadCracked Wellhead
lantern_keepers_hutLantern-Keeper's Hut

Rewards#

FieldRange
goldGold, a whole number from 0 to 3000
xpExperience, a whole number from 0 to 3000
itemsUp to 5 kinds: { "item": item, "count": 1 to 99 }
relationUp to 4 entries: { "field": relationship field, "delta": -20 to 20 }, adds to or subtracts from that relationship

How the player gets the quest#

There are two ways:

  • Write a giver: the game adds the offer dialogue to those villagers for you (they say offer.text, and the player picks accept or decline). A villager who has already given the quest will not offer it again. You must write offer. If giver names specific villagers, you must also write turnIn, and the game adds the hand-in dialogue to those villagers.
  • Leave out giver: hand it out yourself from the Dialogue table with an answer whose effect is { "type": "offer_quest", "quest": "quest id" }. That gives you full control over who offers it and under what conditions.
`offer` fieldMeaning
text (required)What the villager says, up to 600 characters
accept (required)The accepting answer, up to 200 characters
decline (required)The declining answer, up to 200 characters
replyOne more line from the villager after the player accepts
conditionsExtra conditions (same as Dialogue conditions), up to 12
priority1 to 200, default 45
`turnIn` fieldMeaning
text (required)What the villager says when the player comes back with the quest
handIn (required)The answer for handing the quest in
notYet (required)The answer for when it is not finished yet (choosing it offers the quest again, so someone who abandoned it can take it up again)
thanksOne more line from the villager after handing in

To hand the quest out from your own dialogue, leave out giver and add an answer like this to a dialogue entry:

json
{ "id": "take_it", "text": "I will handle it.", "effects": [ { "type": "offer_quest", "quest": "old_watchtower" } ] }

An example without a giver#

A rumour quest: find the collapsed watchtower and bring back three pieces of iron ore. With no giver, you hand it out from your dialogue table with offer_quest.

data/quests.json
[
  {
    "id": "old_watchtower",
    "category": "rumor",
    "title": "The collapsed watchtower",
    "titles": { "zh-TW": "塌陷的哨塔" },
    "description": "They say the northern watchtower has collapsed, with old iron ore inside. Go and look, then bring back three pieces of iron ore.",
    "descriptions": { "zh-TW": "有人說北邊的哨塔塌了,裡面還有舊時的鐵礦。去看看,帶三塊鐵礦回來。" },
    "objectives": [
      { "type": "discover", "site": "collapsed_watchtower" },
      { "type": "collect", "item": "iron_ore", "count": 3 }
    ],
    "rewards": { "gold": 40, "xp": 100, "relation": [ { "field": "respect", "delta": 3 } ] },
    "dueHours": 72
  }
]

Common mistakes#

  • Writing a giver without an offer, or naming a specific villager without a turnIn.
  • More than 4 objectives, or none at all.
  • Writing both npc and role in a talk objective. Pick one.
  • Making up a name for a discover site. Only the places in the list above work.
  • A kill count over 50, or a collect count over 999.
  • Using offer_quest in dialogue for a quest you never defined. The load check names it.
  • Rewards over the limit. Gold and experience max out at 3000 each, and items at 5 kinds.
  • Dialogue: the lists of jobs and named villagers, plus offer_quest and turn_in_quest.
  • Species: make a new creature to hunt.
  • Spawns: make it show up in the wild.
  • Blueprints: hide a quest objective inside a building.
  • The mod editor: build this kind of content with forms and test it in the game.