Docs/Getting started

Writer's handbook

This handbook explains how to write interactive fiction on Verhaler. It's short on purpose. Read what you need now and come back when you hit something new.

Who this is for

This handbook is for writers. It shows what a book on Verhaler looks like, what you can build in the editor, and how Readers play through the result. You don't need an account to read it. You don't need to have written interactive fiction before, either. Every page says what a thing is before it uses the name.

It covers everything you'll use as a writer: Chapters, Glossary Items, the seven Dynamic Components, Triggers, Snapshots, Reading Simulation, publishing, and payouts. Each page explains what a feature does, how to set it up, and the mistakes people make with it.

What a Reader does with your book

A Verhaler book reads like any book, on a phone or a laptop: your Reader scrolls down through a Chapter, paragraph by paragraph. The difference is what can happen on the way. In one minute of reading:

  • They read a Chapter. Names of people and places are mentions they can tap to see who or what that Glossary Item is, and read its full entry.
  • They pass a Trigger you placed between two paragraphs. It is invisible to them. It checks what has happened so far and does something.
  • A window opens over the page: a Decision Template with two or three choices, or a die to throw, a conversation, a combat, a shop. They pick, and the window closes.
  • What they picked reveals a Chapter that did not exist for them a moment ago, and they read on into it. The Chapter they did not earn stays hidden, so they never know it existed.

Everything in this handbook is one of those four steps, or the settings behind one. The Story Flow page walks the loop in full.

How the docs are organised

Start here

You don't need to read all of this before you write. If you're new, Story Flow is the page to read first. It takes about ten minutes and the rest of the handbook builds on it. After that, Chapters and Glossary Items cover the two things you'll spend most of your time writing. Dynamic Components can wait until you have Chapters to put them in.

If you already have Chapters written and want to make them interactive, the Dynamic Components overview is the place to start. It has a short guide to which kind fits which moment.

One sample book throughout
The examples in this handbook come from a single book: our interactive version of Moby Dick. Its characters and Facts are what the embedded windows offer you in their pickers, so the same names turn up from page to page.

Where to get help

If the docs don't cover your problem (billing, your account, something broken), email [email protected] and we'll reply. For writing questions, or to share drafts and swap notes with other writers, use the community. For what's allowed on the platform, see the Acceptable Use Policy and the Terms of Service.