Tutorials
A tutorials.json beside mod.json adds your own entries to the game's guide, with a photograph of your mode. A new one opens as a small card over the match the first time its moment comes, and stays in the guide afterwards. Tutorials are text and pictures: they never make a mod a gameplay mod.
{"version": 1, "tutorials": {
"my_intro": {
"title": {"en": "My mod", "pt_br": "Meu mod"},
"body": {"en": "What the player needs to know.", "pt_br": "O que o jogador precisa saber."},
"image": "Tutorials/intro.jpg",
"trigger": "run_start"
}
}}
titleandbodyare texts by language; a missing language reads English. Write two or three short sentences: what it is and what the player does.imageis a PNG, JPEG or WebP in your folder. Use a photograph of the game, not a drawing.clip(optional) is a few seconds of the game as an Ogg Theora video (.ogv) in your folder, played looping and muted in the photograph's place. Keep it short, 3 to 10 seconds, without text, at about 960 × 540.- A tower's
tutorialintower_data.jsonmay name one of yours asmod_<name>.
When it opens
trigger | Opens when |
|---|---|
run_start | a run starts |
wave:<N> | wave N starts (wave:12) |
boss | a boss wave starts |
tower_built, tower_built:<Tower> | the player raises a tower, or one of that kind (tower_built:Cannon, your own towers too) |
tower_lost | one of the player's towers falls |
card:<id> | the player takes that card (card:unlock_cockpit) |
worm | the worm bites |
material:<id>, material:<id>:<count> | that material's stock reaches one, or the count (material:oil:10) |
day:<N>, night | day N dawns, or the night falls, under a fast day |
belt_tool, generator, generator_bitten, hangar, swarm, deposit | Torretaz's own moments, for a mod built on its rules |
When several tutorials share a trigger, each moment opens the first one not yet seen. Without a trigger a tutorial waits in the guide, or for your script's api.tutorial("my_intro") (scripts).
The game's own tutorials
"vanilla", beside "tutorials", says which of the game's tutorials still apply under your mod: true all of them, false none, or a list of their keys, such as ["camera", "card_rarity", "rain", "sandstorm"]. A total conversion that says nothing keeps none. Torretaz ships its own, in fifteen languages, and keeps those four.
