About This Template

By default, when compiled (File > Compile), this project will generate a plain text file in “twee” format, a flat-file Markdown-like format for gamebooks that is also used by the graphical gamebook editor Twine. The “twee” file can be compiled into an HTML gamebook using an additional converter program such as Twee2 (; the instructions below include installation of Twee2.

You can also import an existing Twine or twee file into Scrivener (following the Import/Export directions below) and it will be separated into scenes for you.


Install the Scree template: Unzip the Scree archive.  To install the template file, Scree.scrivtemplate, open the Project Templates window, either by just opening Scrivener, or, if it doesn't appear then, by choosing File > New Project from the Scrivener menus.  Click on the category you want to put the template under--e.g., Fiction. In the Options dropdown at the bottom right, click Import Templates...  Then browse to and open the template file in the file dialog.  Then you can create a new project using the Scree template.

Install the Twee compile presets (Windows only): In Scrivener 1 for Windows, compile presets need to be installed separately. So you will need to install at least one of the preset files Twee.ini or Twee2.ini: 

Install Ruby (mostly Windows only): Note that newer versions of MacOS probably are running Ruby 2.0, despite the warning at the Twee2 site.  If  you're running an older MacOSX, see the instructions at the Twee2 site for installing Ruby:  To install on Windows:

To open a cmd window, type cmd into the search box at the bottom of the Windows Start menu.  If you have too much trouble installing Ruby and the gem on Windows (or MacOS), you can use a Tweego binary instead:  Note that Twee2 does not support decompiling on Windows while Tweego does, but Tweego does not support Twine2 story formats, and you will need to download the Twine 1 story formats if you don't have a Twine 1 or Twee install handy.  (Twee2 supports most story formats.)

How To Use This Template

Compiling with Scrivener

Compiling with Twee2

Making Changes

There are various minor changes you can make to the settings to tweak this template and Scrivener itself so that it better suits your needs, as follows:


Scripting and Styling


This template is by M. C. DeMarco,, and is released as-is.  Version: 1.0.2, 7 Oct 2017.

Twee2 is by Dan Q,, and is released under GPL 2.0.

Twine2 is by Chris Klimas and many others and is released under GPL 3.0.