Welcome to the Twine Cookbook!
The Twine Cookbook is a collection of examples organized around common topic areas. For each, contributors have tried to provide examples covering each major built-in story format (Harlowe, SugarCube, and Snowman) where possible and appropriate. For some topics, examples are also provided in SugarCane for Twine 1.4.2.
Each example page includes a short description, a live version, and its Twee code. Both the live version and Twee code can be downloaded directly from each example page.
Reading the Cookbook
Created using GitBook, the Twine Cookbook is best viewed as a compiled webpage. In this format, the left sidebar provides access to the different topic areas as well as to a search bar for more quickly looking through the titles and text of the entries. New updates are published in the website format every few months or as necessary.
The Twine CookBook can also be read without the live versions on GitHub by starting with the summary page. Note, however, that example pages on GitHub are subject change as new changes are made and revisions submitted before and during editing cycles.
Suggesting Examples or Changes
Include as much as possible of the following in an issue:
- A short summary of the example(s) or suggestions(s)
- How (or if) you would like to be recognized for your contribution
Submitting Documentation or Code Updates
- Clone the repository.
- Review the Organization page on the wiki for how folders and files are named and structured.
- Read the recipe formatting page included in the Cookbook and on Github for layout and style guidelines.
- Add your recipe and submit a pull request to request it to be added to the cookbook.
Contributors:
- @videlais (Dan Cox)
- @klembot (Chris Klimas)
- @tmedwards (Thomas Michael Edwards)
- @greyelf (Greyelf)
- @webbedspace (Leon Arnott)
- @shawngraham (Shawn Graham)
- @Akjosch (Akjosch)
License:
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.