Getting started

Talewright stories are folders of plain-text files. You can try everything in your browser. The extra tools are optional.

1. Play the sample

   Open the web player and pick The Lost Relic. Nothing to install.

2. Write a story

   Use any editor that saves plain text. Start with two files in a folder: story.talewright.yaml for the title, starting scene, characters and rules, and story.tale for scenes and choices. Your first story gives you the complete starting text.

   On Linux x64, the Talewright extension for VS Code adds highlighting, suggestions and live checks.

3. Check and play it

   Zip the story folder, open the web player and choose Open a story file. The player reports any mistakes with file and line number. After making changes, create a fresh ZIP and open it again.

4. Share it

   Send the same ZIP to friends to play in their browser. To build a website or desktop game, see Sharing your story.

For editor setup, optional command-line tools and platform details, read the full getting started guide.