Home

Syntax Guide

For the full effect list, their options and examples, go to Effects Documentation. To Do

Creating Standalone Stories

All stories have to follow the same structure:

story
├── data (optional)
│   ├── audio files
│   ├── images
│   └── other non-text content
├── story.txt
└── description.txt (optional)

In the future there may be possibility of splitting story into chapters.

The data directory is optional, it is used to store the media files used within the story, most often images and sounds. The files will be loaded with the same names, so if the background music file would be called bgm.mp3 it will be possible to use it with effects by typing {{ cd_bgm: bgm.mp3 }}.

The description.txt is optional, contains plain-text description and if present will be used in story browser.

The story.txt contains the main story, it is possible to use the effect formatting within.