Director events
Add a new thing for the village storyteller to make happen: a fair, a raid, an omen. You decide when it is likely and which village numbers it changes.
What this lets you make#
Every village has an unseen storyteller (the "director") that picks one thing to happen each day: a caravan arrives, a night raid, a strange sign in the sky. You can add new events to its list of candidates, described as data: what kind of event it is, how many days it lasts, when it is likely to be picked, which village numbers change when it starts and ends, and what villagers say about it.
When an event starts, the player sees the announcement you wrote. While it lasts, villagers say your line, and prices and small-talk warmth can change too.
In the editor#
Open the World events tab under World in the left column and press Add. In the editor this kind has no form: it shows a text box where you edit the entry directly, in the same format as in the advanced section below. A new entry starts nearly empty, and the check bar at the bottom tells you what is still missing. If the text has a format mistake, the editor shows Format error, not applied yet and does not save that change.
The top-bar Test reloads the game with your mod and drops you in a flat test field, which is a quick way to confirm it loads without problems. The test field has no villages, water or farm plots, so to see this in action, turn the mod on under My Mods and play in a world.
Advanced: writing the JSON by hand#
In the editor this kind is a text box, and what you type there uses exactly the format shown below. 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. Where the file goes and how it is listed: Mod folder and mod.json.
The file goes under data/ (any name, for example data/director.json), and mod.json points to it with "directorEvents": "data/director.json" under content.
A minimal working example#
A "frost fair": more likely in winter, only opens in villages with decent security, and raises morale by 5 when it opens.
[
{
"id": "frost_fair",
"kind": "opportunity",
"tension": -4,
"days": 2,
"cooldownDays": 14,
"minChapter": 1,
"priceMult": 0.9,
"season": { "winter": 2 },
"weight": {
"base": 4,
"require": [ { "village": "security", "atLeast": 30 } ],
"bonus": [ { "if": { "village": "prosperity", "atLeast": 60 }, "add": 3 } ]
},
"onStart": [ { "village": "morale", "change": 5 } ],
"announce": "The frost fair is open, with winter goods on sale.",
"announces": { "zh-TW": "霜原集市開張了,商人們帶來了冬天的貨。" },
"line": "They say the prices at the fair are very fair."
}
]Fields#
| Field | Range and meaning |
|---|---|
id (required) | Your own name for it, same rules as other tables |
kind (required) | threat, opportunity, social or omen |
tension (required) | -20 to 25. Positive makes the world more tense, negative calms it |
days | How many days it lasts, whole number 1 to 5, default 2 |
cooldownDays | How many days before the same event can happen again, 3 to 60, default 10 |
minChapter | The earliest story chapter it can happen in, 0 to 8 |
priceMult | Shop price multiplier while it lasts, 0.7 to 1.4 |
chatMult | Multiplier on the warmth gained from small talk while it lasts, 1 to 3 |
season | Chance multiplier per season, 0.2 to 3. Keys are spring, summer, autumn, winter, for example { "winter": 1.5 } |
weight (required) | How likely it is to be picked, see "Chance" below |
onStart | Effects when the event starts (up to 8) |
onEnd | Effects when the event ends (up to 8) |
onEndResolved, onEndFailed | threat events only: effects for when the player handled it, and when they did not |
announce, announces (required) | The announcement when it starts, up to 160 characters. announce is the main text and announces adds other languages (en, zh-TW, zh-CN) |
line, lines | What villagers say while it lasts, up to 300 characters, written the same way. Leave out for no line |
Chance: weight#
Each day the storyteller scores every candidate event and draws one. weight is how your event is scored:
base(required, 0 to 20): the starting score.require: up to 8 conditions. All of them must hold or the score is 0.bonus: up to 8 entries{ "if": condition, "add": -20 to 20 }. When the condition holds, the score goes up (or down).
The score never goes below 0. The numbers only mean something next to the other events, so do not agonise over them.
Conditions#
Used in require and bonus. Each condition is an object:
| Form | Meaning |
|---|---|
{ "village": axis, "atLeast": n } or "below": n | One of this village's numbers (0 to 100) is at least / below n. You may write both atLeast and below |
{ "world": axis, "atLeast": n } or "below": n | One of the world's axes (-100 to 100) is at least / below n |
{ "crisis": "tag" } | The village currently has this crisis mark |
{ "calm": true } | The village has no crisis right now |
{ "tensionAtLeast": n }, { "tensionBelow": n } | The world's tension (0 to 100) is at least / below n |
{ "tendency": n } | This village's leaning is exactly n (a whole number from -2 to 2) |
{ "chapterAtLeast": n } | The story has reached at least chapter n (0 to 8) |
| Village number (`village`) | Name in the game |
|---|---|
security | Security |
prosperity | Prosperity |
foodSupply | Food |
morale | Morale |
outsiderTrust | Trust in outsiders |
corruption | Corruption |
| World axis (`world`) | Name in the game |
|---|---|
stability | Stability |
autonomy | Autonomy |
memory | Memory |
voidAcceptance | Void acceptance |
extraction | Extraction |
sharedAuthority | Shared authority |
Effects#
| Form | Meaning |
|---|---|
{ "village": axis, "change": n } | Raise or lower that village number by n, where n is -30 to 30 |
{ "crisis": "tag", "on": true } | Switch a crisis mark on (true, the default) or off (false) |
The crisis mark raid_watch puts the village on night-raid alert and starts a raid wave. You can also invent your own (lowercase letters, digits, underscores) and let another of your events pick it up with { "crisis": "your_tag" }. It gets your mod id added automatically, so it never clashes with someone else's.
A threat event#
A threat can react differently to "the player dealt with it" and "the player did not". This one puts the village on raid alert, then raises security if it was handled and lowers it if it was not:
[
{
"id": "wolf_night",
"kind": "threat",
"tension": 8,
"days": 2,
"cooldownDays": 12,
"minChapter": 1,
"weight": {
"base": 3,
"require": [ { "village": "security", "below": 70 } ],
"bonus": [ { "if": { "tensionBelow": 30 }, "add": 2 } ]
},
"onStart": [ { "crisis": "raid_watch", "on": true } ],
"onEndResolved": [ { "village": "security", "change": 6 } ],
"onEndFailed": [ { "village": "security", "change": -8 } ],
"announce": "Wolves prowl outside the village at night. The guards are on alert.",
"announces": { "zh-TW": "夜裡有狼群在村外徘徊,守衛提高了警戒。" },
"line": "Do not leave the village after dark. I heard howling."
}
]Common mistakes#
- Leaving out
announce. Every event needs an announcement. - Leaving out
weight, or leaving out itsbase. - Using
onEndResolvedoronEndFailedon anopportunity,socialoromenevent. Onlythreatcan. - Writing a village number range of -100 to 100. Village numbers run 0 to 100. Only world axes run -100 to 100.
- Writing
daysorcooldownDaysas decimals. They must be whole numbers. - Thinking
tensionis the chance. It is the effect on the world's tension after the event happens. The chance lives inweight.
Related pages#
- Dialogue: use the
evt_<event id>flag to make villagers say something extra during an event. - Quests
- Folder and mod.json
- The mod editor: build this kind of content with forms and test it in the game.