RUCHMAIR
Ruchmair / Documentation
Developer resources

Documentation

A clean home for installation guides, Storyteller 3 workflows, Game Bridge runtime integration, localization, AI tools, scripting references and future Ruchmair products.

Getting Started

This first website release includes the documentation structure, but not the full manual yet. That is intentional: the marketing site can go live without delaying publication while the detailed product documentation is added section by section.

Website note: replace these starter sections with your final Storyteller 3 installation and workflow instructions before linking individual documentation pages from the Unity Asset Store.

Recommended documentation flow

  1. Installation and package requirements
  2. Creating a Storyteller 3 Story project
  3. Creating scenes and nodes
  4. Characters and environments
  5. Routes, conditions and nonlinear structures
  6. Localization and translation
  7. Audio, storyboards and media
  8. Game Bridge runtime setup
  9. Saving, history and advanced runtime systems

Storyteller 3

Storyteller 3 is the authoring side of the ecosystem. This section can grow into a full manual with screenshots and small focused pages instead of one enormous document.

Documentation / Storyteller 3
├── Installation
├── Project Manager
├── Story Canvas
├── Node Types
├── Characters
├── Environments
├── Routes & Loops
├── Localization
├── AI Tools
├── Audio & Storyboards
└── Exporting / Game Bridge

Game Bridge

Game Bridge is included with Storyteller 3. Its documentation focuses on the runtime side: scene data, interactions, UI presentation, conditions, history, saving and connecting authored data to gameplay.

Localization

Document how languages are added, how the default language is used, how localized dialogue and route titles are stored, and how translation tools interact with the project.

AI Tools

Keep AI documentation separate from core authoring so users who do not use AI can still follow the standard workflow. Include API-key setup, supported actions, expected formats and cost/privacy considerations.

Scripting

As the API stabilizes, add copyable examples for common runtime tasks. A dedicated reference section can eventually document public classes, methods and extension points.

Adding future products

The documentation navigation is intentionally product-agnostic. A future Unity asset can receive its own documentation tree without changing the top-level Ruchmair site.