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.

Note: it is recommended to use VSCode with this Folder.

---

What is included in the Ready-to-Use Tweego Folder?

Guide:

• The Ready-to-Use Tweego Guide, with extensive explanation to "install" and to use Tweego for both MacOS and Windows, examples and recommendations.
  • Playable on this page
    
  • Source Code is available on GitHub

Tweego:

• Tweego (v2.1.1-Twee3) for MacOS or Windows incl. licenses
  • unavailable in Ready-to-Use Folder (MacOS sans Tweego) version
• Twine formats:
  • Twine 2 main formats: Chapbook, Harlowe, Snowman and SugarCube (see available versions below)
  • Twine 1 main formats: Jonah, Responsive, SugarCane
• Editable Tweego scripts:
  • Windows: build.bat, debug.bat, decompile.bat
  • MacOS: build.sh, debug.sh, decompile.sh
  • with a Cheat-Sheet with basic instructions
  • with required folders: source, export, decomp

Base New Project:

• A Ready-to-Code Project (SugarCube 2.37.3 - source folder):
  • The Minimal Base required to compile
    • includes annotations on how to change the code to make it compatible with other Twine formats
  • A JavaScript file for script code (empty)
  • A CSS file for the StyleSheet (empty)
• Compiled examples (SugarCube 2.37.3 - export folder)
  • Playable HTML file
  • Playable HTML file in Debug/Test Mode

Available Twine Formats and Versions:

• SugarCube: 1.0.35, 2.36.1, 2.37.3 (most recent)
• Harlowe: 1.2.4, 2.1.0, 3.3.9 (most recent)
• Chapbook: 1.2.3, 2.2.0 (most recent)
• Snowman: 1.4.0, 2.0.2 (most recent)
• Twine 1: Jonah, Responsive, SugarCane

---

GITHUB REPO | RAISE AN ISSUE
TWINE RESOURCES
| BLOG | TUMBLR POST |  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.

See the Credits page for the formats.