m. c. de marco: To invent new life and new civilizations...

About Scree

Scree is a gamebook template for Scrivener 3. See the previous versions for Scrivener 1 and 2 support.

By default, when compiled in Scrivener (File > Compile), the template will generate a plain text file in “twee” format—a flat-file Markdown-like format for gamebooks—and then automatically post-process it into an HTML gamebook using Twee2 (a command-line Ruby gem) or Tweego. (Automatic post-processing requires the non-sandboxed, non-Mac App Store version of Scrivener 3 and one of Twee2 or Tweego; otherwise you can compile on the command line with any Twine command-line compiler.)

You can import the HTML file into the graphical gamebook editor Twine for further editing, use the twee file as part of a non-GUI workflow like entwine, or use Scree/Scrivener exclusively.

In the other direction, you can import an existing Twine or twee file into Scrivener, following the directions in the template. It will be separated into scenes for you. (If you have an old twee story, the format you probably want to use with it is SugarCube.)

Note that you should write purely in plain text, Markdown (including leaving blank lines in between paragraphs), or SugarCube’s (non-Markdown) plain-text markup when using Scree; any rich text formatting will be ignored. For more help with the Markdown-like dialects of the different story formats, or with gamebook scripting, see the story format documentation in the Twine wiki.

The name of the template within Scrivener is now Scree3 (under the Fiction templates); this is to allow you to run Scrivener 2 (with Scree) and Scrivener 3 (with Scree3) in parallel. For more information about Scree, read the instructions (also included in the template).

You may also be interested in visualizing your story with DotGraph or DotScap, or post-processing it with PrePub.

Versions

The current version is 3.0.3, which supports Scrivener 3 (and requires at least version 3.0.3 of Scrivener). At the time of writing, Scrivener 3 for Windows was not yet out and so has not been tested.

Download the Scree template.

Previous Versions

The previous versions supported Scrivener 2 for Mac and Scrivener 1 and 2 for Windows.

Examples

The template comes pre-populated with a few scenes. Here is how they look after compiling in Scrivener, but before compiling with Twee2 or Tweego:

Here are various versions of the final gamebook, compiled from the Scrivener output above using the Twine 2 story formats supported by Twee2 plus some of my own formats:

Sausage

I shared a few implementation details in the blog and the Twine forum.

If you’re still on Scrivener 2, you might also want to have a look at my blog post about automating Scrivener. For other questions, check out my other Scrivener posts and/or my other hyperfiction posts.