Skip to content

Welcome to the Twine Cookbook#

This Cookbook contains documentation, tips, and examples for using the non-linear story creation tool Twine.

Reading the Cookbook Online#

Starting with version 2.0, the Twine Cookbook is created using mkdocs with the Material theme and plugin set.

It can be found at https://twinery.org/cookbook/.

A print edition of the Cookbook is available! It's available in many major booksellers like Amazon and Barnes & Noble, but you can purchase it via IngramSpark at a discount. The print version contains the same content as the web version, but is of course useful in classrooms, or when internet access is difficult or inconvenient.

An EPUB version of the print edition is also available at no cost, which can be read on many devices.

Building the Cookbook using MkDocs#

The Cookbook can be built using Python. Run pip install -r requirements.txt to install the requirements.

  • mkdocs build creates HTML and CSS files based on the markdown files.
  • mkdocs serve builds and hosts a local server version.

Note: Depending on how Python is installed in Windows, users may need to use pip install --user -r requirements.txt to install and then use python -m before any MkDocs commands.

Want to suggest a change or new example?#

Start with the Code of Conduct and then review the steps in the Contributing guide.

Contributors#

License#

License

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Version 2.1 (April 2021)#