Guides
The guides are step-by-step walkthroughs. Each one takes a job, such as adding an item or building a window, and walks you through it from an empty project to a working mod. They are for when you have made your first mod and want to do something bigger.
If you have not made a mod yet, start with Getting started. It gets a log line on screen in about five minutes, and every guide here builds on the project it makes.
The guides
Read them in any order. Each page tells you what to set up first.
- Content: add items, recipes, icons, furniture, loot, shop stock and mail.
- Content models: give an item or a piece of furniture a 3D model.
- Gameplay and economy: read and change the player, survival, the world, money and jobs.
- UI and HTML views: make Mods menu pages, windows and HTML panels.
- Using the framework alongside other mods: what happens when two mods use the same call, and how to avoid clashes.
Short recipes
The cookbook has small, one-job recipes you can copy, such as giving the player an item or paying them money.
Newer features
These areas do not have a walkthrough yet. Each one has an API page that explains it:
- Player shops: furniture managers the player runs as shops.
- Doors and level changers: the positions of doors and level changers.
- Mod NPC routines: weekly routines and orders for NPCs that your mod adds.
- Furniture blueprints and flatpacks: crafting blueprints, and the packed form of furniture from mods.
- Custom skills: skills of your own in the character panel.
- Dialogue and quest authoring: write conversations and quests in code.
- Debug: the master trace switch and the self-checks.
Where to go next
Start with Content if you want to add things to the game, or Gameplay and economy if you want to change how it plays.