100% Good Twine Sugarcube Guide

NOTE: the Guide is in its complete form, and won't receive further substantial update.

The 100% Good Twine SugarCube Guide!

---

The 100% Good Twine SugarCube Guide is a coding guide for the SugarCube format of Twine. It is meant as an alternative to the SugarCube documentation, with further explanations, interactive examples, and organised by difficulty. The goal of this guide is to make the learning curve for new SugarCube user less steep, and provide a comprehensive and wide look over the format.

As of this release (v2.0.0), it is up to date with the version 2.37.3. If you are looking for the guide covering SugarCube 2.36.1, you can find it on my GitHub.

The Guide is compartmentalised in (currently) four categories:

• The Basics
  • or the absolute basics to start with SugarCube
  • No need for extra knowledge. Just the base needed to make something.
• The Basics+
  • adding interactivity, and creating a fully rounded IF game
  • May require a bit of CSS knowledge (formatting rules)
• Intermediate Mode
  • adding more customisation and complex code
  • Will probably require some CSS knowledge, and maybe some JavaScript
• Advanced Use
  • the most complex macros and APIs
  • Will surely require some JavaScript/jQuery knowledge

Note: The Advanced Use includes all the APIs, macros, and methods not covered by the previous categories. This includes code requiring very advance knowledge of JavaScript/jQuery to be used properly.

Each category explains many aspects of the format, tailored to a specific level of the user. More simpler explanations and examples are available in earlier chapters, compared to the later ones.

If something is unclear, you found a mistake, you would like more examples in the guide, or would like a feature covered, let me know!

The Guide currently covers all macros (as of SugarCube v.2.37.3), all functions and methods, and APIs. It touches upon the use of HTML, CSS, JavaScript and jQuery, when relevant. It also discusses aspects of accessibility.

The Guides also provides a list of further resources, for the different coding languages.

The Guide is available in a downloadable form for offline view:

• HTML file that can be opened in Twine
• .tw file that can be opened in Twine
• source code, separating the chapters, .js and .css files

Roadmap (not fixes)

Below are elements that may, one day, be added in the Guide.
An announcement will be made when they will be included.

• Adding the answers of the Coding Support posts
• More Demos?

---

GITHUB REPO | RAISE AN ISSUE
TWINE RESOURCES
| BLOG | TUMBLR POST |  TEMPLATES |
CSCRIPT 2 SG GUIDE | TWEEGO GUIDE

Twine® is an “an open-source tool for telling interactive, non-linear stories” originally created by Chris Klimas maintained in several different repositories (Twinery.org). Twine is also a registered trademark of the Interactive Fiction Technology Foundation.

SugarCube is a free (gratis and libre) coding format for Twine/Twee created and maintained by TME.