Flows
A flow is a run of full-screen steps that the app plays: part slideshow, part questionnaire. Some steps show a title, a few lines, a long text or a video. Others ask a question and keep the answer. Steps can branch on a choice. Craft uses flows in two places, with the same format in both:
- The prelude, the world's cold open. It plays when a player enters a new game, before they pick a game start and a character.
- A creation flow on a character type. It is the guided way a player makes their own character: their answers go to the AI, which writes the character sheet.
How it is used
The prelude. A project has at most one, kept in the project settings' Prelude tab.
- It plays when a player opens a game that has no player character yet, before the lobby. The player can close it from its first step, and the lobby has a button to play it again. Once it has played or been closed, it doesn't play again in that browser tab.
- A game copies the prelude when it is created, from the world's latest published version if it has one, or else from the world as it is. So a change reaches new games once you publish, and never reaches games already running. Syncing a game with its world never moves the prelude either way.
- Answers given in a prelude are thrown away. A question there only sets a mood or picks which text comes next.
- Anything that must happen in the story (where play starts, the first scene, setup) belongs in a game start, not the prelude.
A creation flow. It is kept on a file type with the character designation, in the Creation flow card on the Flow tab of the character type's settings. Only character types use one.
- When a player chooses to create their own character, the creation flow replaces the field-by-field form.
- At the end, the AI gets each answer on the path the player took, with the question's text, the picked option's label, and the AI instructions of the step and of each picked option. It also gets the character type's schema and its generation instructions. It writes the whole sheet: it names the character, fills every field the answers leave open, and can make a portrait. The player can look over and edit the sheet before they start.
- The AI sees only an option's label and AI instruction, never the file an option links to. Put what the AI must know in the AI instruction.
- Rules that apply to every generated character (stat ranges, naming)
belong in the type's own generation instructions, which are set in the
app, in the type's settings. A flow's
settings.generationInstructionsis used only when the type has none.
How a flow runs. Play starts at the start step and follows the
edges. A step with no edge out is an ending: the flow finishes when the
player moves on from it. A question step waits for an answer unless it is
optional. Other steps wait for the player unless their advance says to
move on after a few seconds or when their video ends.
Changing a flow
The steps are listed in the step reference and the format in the manifest reference.
In the project settings, open the Prelude tab and choose Build Prelude. For a creation flow, open the character type's settings, go to its Flow tab and choose Add a creation flow. Both open the same editor: a canvas of steps in play order. Add screen adds a step, dragging from a step's dot connects it to the next, and each option of a choice has its own dot for branching. Preview plays the whole flow as a player sees it, and Done (prelude) or Save (creation flow) saves. Removing a prelude can't be undone.
Doing it well
- A prelude is short. Four to eight steps: a title with art, two or three beats in the world's voice, and at most one choice for tone. Time the title to move on by itself and let the player read the rest.
- Hand off to the game start. The prelude and the game start's opening play back to back. Read the game start first, end where it begins, and don't repeat its opening or give away its secrets.
- Ask only what the AI can't guess. A creation flow of three to six steps works well: a background or role, one or two questions with flavor, and the stats. Each question's text should read as a question in the world's voice.
- Link choices to the world's files. Offer real classes, factions or origins as options linked to their files, so players can open them, and write what each one means in its AI instruction.
- Match the stats to the rules and the cast. The stat step's names, ranges and costs must fit the character type's fields and the world's ready-made characters. If the stats are narrative, use a choice or text step whose AI instruction states the ranges.
- Make flavor optional. Let players skip questions that only add color.
- Keep the art Craft-hosted. A picture must be a URL Craft hosts: to get one, pick or upload one in the screen's Background section. Without one, use a background fill.
- Trace every path. Before you save, follow each branch from the start along the edges to an ending, and read it as a player would.
- One idea per step. Short steps read better than one long one, and a long text belongs in a reading step.
Mistakes
- A step nothing leads to. A step no edge reaches from the start never plays. An edge that points at a missing step is refused.
- A question without
field, or a display step with one. A question needsfieldto keep its answer; without one the player can't move on. A display step must not have one. - A misspelled
type. It saves, and the step then shows an error in place of the screen. - Branches on the wrong step. Only a choice where one option is picked can branch. Branch edges anywhere else match no answer, and the player can get stuck there.
- An option with no edge. If the other options go to different steps, picking it blocks the player. If every branch meets at one step, it goes there.
- A plain edge beside branch edges. It is followed only for options that have no edge of their own. Two plain edges out of one step: only the first is followed.
- A video step without
advance. It waits for the player when the clip ends. Give it{ "mode": "media" }to move on by itself. - Point-buy costs as a map.
costsis a list of{ score, cost }, never{ "8": 0, … }. - An invented URL. A picture, video or track URL must exist. A made-up one shows nothing.
- Reading
nodesas the play order. The edges set the order. Walk them to see what a player sees. - Expecting a prelude change in running games, or prelude answers in the game. Neither happens.
Reference
- The flow manifest: The JSON a flow is saved as: steps, edges, branching, pacing, music and fonts, with a whole prelude and a whole creation flow.
- Flow steps: Every kind of step a flow can show or ask, with its data fields and an example.