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

About Scree

Scree is a gamebook template for Scrivener. 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 that can also be used by the graphical gamebook editor Twine. The “twee” file can be compiled into an HTML gamebook using Twee2 (a command-line Ruby gem) or other twee processors.

You can also import an existing Twine or twee file into Scrivener, following the directions in the template. It will be separated into scenes for you.

Note that you should write purely in plain text or Markdown (including leaving blank lines in between paragraphs) when using the template; 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.

For more information about Scree, see the instructions linked below, or read them in the template itself.

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

Versions

The current version is 1.0.2, which includes tag support (Scrivener tags and statuses are turned into Twine tags) and improved layout auto-generation for Twine 2.

Read the instructions (also included in the template).

Download the Scree template.

Previous Versions

Examples

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

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

Note that PaperThin is still an HTML format; you can save it as text from a browser to get plain text, or just proofread and/or wordcount using the twee source file instead.

If you have an old twee story, the format you probably want to use with it is SugarCube. Otherwise, you may want to avoid SugarCube because it uses non-Markdown markup.

Sausage

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

If you need to compile frequently, 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.