Introduction

This document is the specification for writing a textventure story.

Format

A textventure story is written in YAML.

Schema

On a high-level, a textventure story consists of:

• id
• text
• choice

Story without choice:

<id>: !!str <text>

Story with choice:

<id>: !!map
  <text>: !!seq
    - <choice>: !!str <id>

Config

There’s also an optional _config property:

_config:
  start: start
  renderer: text

Example

Given the flowchart:

The textventure would be written as:

start:
  You come to a fork in the road.:
    - Turn left.: left
    - Turn right.: right
left: You turn left.
right: You turn right.

To add choices to the right node:

right:
  You turn right.:
    - Choice A: choice_a
    - Choice B: choice_b
choice_a: Text for A.
choice_b: Text for B.

To rewrite the textventure in Markdown:

_config:
  renderer: markdown
start:
  ? |- # keeps newlines except for the last one
    You come to a fork in the road.
    ![Image of a fork in the road](fork-in-the-road.jpg)
  : # html entities need to be wrapped in quotes
    - '← Turn _left_.': left
    - '→ Turn _right_.': right
left: You turn left.
right: You turn right.