Add comprehensive README documenting Mode7 story engine #1

2026-01-22T10:20:23+01:00

Copilot commented

2026-01-22 10:20:23 +01:00

(Migrated from github.com)

Adds complete documentation for the Mode7 teletext-style interactive story engine. Written in British English.

Documentation Coverage

Architecture: Three-module system (teletext renderer, story engine, JSON data format)
Step types: All 18+ step types documented with JSON examples (navigation, layout, text output, timing, input/branching, effects)
Text system: Colour markup tags ([CYAN], [WHITE]), variable substitution ({{name}})
State & branching: State management, conditional content, scene flow patterns
Pressure system: Gradual tension escalation through visual/text corruption
Authoring guide: Best practices, branching patterns, accessibility considerations
Mobile support: Touch-optimised keyboard, responsive behaviour
Development: Project structure, extending the engine, troubleshooting

Example Step Documentation

{
  "type": "branch",
  "var": "trust",
  "cases": {
    "1": "act1_trust_yes",
    "0": "act1_trust_no"
  }
}

Enables developers to understand the existing engine and author new branching narratives.

Original prompt

On /, Please can you generate a RAEDME file in British English, explaining how the story engine works, full guide etc

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Adds complete documentation for the Mode7 teletext-style interactive story engine. Written in British English. ## Documentation Coverage - **Architecture**: Three-module system (teletext renderer, story engine, JSON data format) - **Step types**: All 18+ step types documented with JSON examples (navigation, layout, text output, timing, input/branching, effects) - **Text system**: Colour markup tags (`[CYAN]`, `[WHITE]`), variable substitution (`{{name}}`) - **State & branching**: State management, conditional content, scene flow patterns - **Pressure system**: Gradual tension escalation through visual/text corruption - **Authoring guide**: Best practices, branching patterns, accessibility considerations - **Mobile support**: Touch-optimised keyboard, responsive behaviour - **Development**: Project structure, extending the engine, troubleshooting ## Example Step Documentation ```json { "type": "branch", "var": "trust", "cases": { "1": "act1_trust_yes", "0": "act1_trust_no" } } ``` Enables developers to understand the existing engine and author new branching narratives.   <details> <summary>Original prompt</summary> > On /, Please can you generate a RAEDME file in British English, explaining how the story engine works, full guide etc </details>  --- ✨ Let Copilot coding agent [set things up for you](https://github.com/andydixon/mode7/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo.

andydixon (Migrated from github.com) reviewed

2026-01-22 10:20:23 +01:00

copilot-pull-request-reviewer[bot] (Migrated from github.com) reviewed

2026-01-22 10:22:17 +01:00

copilot-pull-request-reviewer[bot] (Migrated from github.com) left a comment

Copilot wasn't able to review any files in this pull request.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot wasn't able to review any files in this pull request. --- 💡 <a href="/andydixon/mode7/new/master/.github/instructions?filename=*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: andy/mode7#1