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.

VIEW / DOWNLOAD THE GUIDE!!!!

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

ADVANCE 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

GITHUB REPO | RAISE AN ISSUE | TWINE RESOURCES TWEEGO | TEMPLATES | CSCRIPT 2 SG 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.

VIEW / DOWNLOAD THE GUIDE!!!!

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.

(not so) strangers in the night, by manonamora

The 100% Good ChoiceScript to Sugarcube Guide!

The 100% Good ChoiceScript to Sugarcube Guide is a coding guide meant for ChoiceScript creators looking to use the SugarCube format of Twine. It is meant as a quick start-up and comparison of the different commands and structures between the two formats, including explanations with examples.

The Guide is based on the ChoiceScript Wiki and covers all the necessary commands and informations required to make a ChoiceScript game, and how it translated in SugarCube in terms of formatting, plain code, and macro equivalence. It also includes resources to go further into the formats.

READ & DOWNLOAD THE GUIDE!

The Guide is sectioned into multiple sections:

The Differences between Twine/SugarCube and ChoiceScript

The Command Equivalences (or close substitutes)

The Creation of a New Project, and QoL functionalities (Stats, Saves, Achievements, Settings)

For further details on how the macros/markups/APIs should be used, check out my SugarCube Guide (as it goes into a lot more details). If you are looking for the Tweego Compiler Folder, see this post.

GITHUB REPO | RAISE AN ISSUE | TWINE RESOURCES TWEEGO | TEMPLATES | SUGARCUBE GUIDE

Twine® is an “an open-source tool for telling interactive, non-linear stories” originally created by Chris Klimas maintained in severaldifferentrepositories (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.

Final Content update + Fixes (4.2.0 - beta)

This is the actual final major update for this game. Fixed a bunch of stuff (mainly maze in Chapter 5, NewGame+ error at endings). Made some QoL addendum. And added Achievements (37) and Codexes.

This update breaks the saves (sorry, I forgot to add the Achievement variable last April), so please restart the game completely - or you'll get an error.

If I don't get any bug report during this summer, I'll move the game to Released and Complete. :)

Also, if you want/can, consider sharing the original promo post! and maybe leave a rating/comment? Thanks!

The 100% Good Ready-to-Use Tweego Folder!

The 100% Good Ready-to-Use Tweego Folder is both a coding guide for the Tweego compiler and an easy-install for the program. It is meant to complement the official Tweego documentation, and update the Tweego download folder (formats). The Guide is fairly short and goes over installation of Tweego in Windows and MacOS, the Twee Notation (a.k.a. Passage set-up), and use of Tweego in Windows and MacOS as well as with Twine 1 and Twine 2 formats.

While the Guide was compiled with SugarCube 2.37.3, and the Ready-to-Use Tweego Folder has a base project with SugarCube 2.37.3, Tweego can be used with any Twine 1 and Twine 2 formats. Annotations are also provided to change formats.

READ THE GUIDE & DOWNLOAD THE FOLDER

Note: setting up Tweego is different depending on your device. Check the Guide for full instructions before downloading the Folder (esp. for MacOS).

The Folder includes:

the Ready-to-Use Tweego Guide

Tweego, all official Twine 1 & 2 formats, and relevant scripts

a Base New Project with annotations

GITHUB REPO | RAISE AN ISSUE | TWINE RESOURCES TEMPLATES | SUGARCUBE GUIDE | CSCRIPT 2 SG 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.

Tweego is a free (gratis and libre) command line compiler for Twine/Twee story formats, written in Go, created by TME. The Ready-to-Use folder is based on the one put together by Sjoerd.

READ THE GUIDE & DOWNLOAD THE FOLDER

This was the last step on the Update everything because SugarCube broke everything with the last update tour: the templates. As of today, all the templates are now compatible with SugarCube 2.37.3 (passage code + APIs!).

The changes also include some fixes in the explanations, as well as reformatting the interface (a bit). The whole log of all the edits can be found by clicking on the link below:

The older versions of these templates (2.36 compatible) have been archived on my GitHub. And as of today, any new template created for SugarCube will only be available for 2.37 (too many changes).

If you liked a/some template/s, consider sharing the following posts:

User Interface Template:

Simple Book

One Page (à-la-Chapbook)

Space/Tech Double Whammy

VN-lite RPG

Title Page

Code Template:

Settings

Character creator (+ Guide/Tips)