Pier 17 / Documentation

The Twine Customizer is a graphic interface to customize Twine style and scripts without having to mess around with JavaScript or CSS.

Index

Getting Started

Just go to the Customizer, change whatever you like in the right side panel, then hit the Download button in the bottom right.

Once it has been downloaded, you can import it in the Twine website by clicking on Library, then import and selecting the HTML file (you might have to extract the zip file first).

⚠️ Important!You should not reuse the same template file to start more than one story. Each Twine story must have a unique identifier (IFID) but if you use the same template file multiple times all the stories that you start from it will have the same IFID as the template, which can lead to problems with save data. Each time you download a template it will have a different identifier, so if you want to start a new story you should download a new copy of the template before importing it, to make sure it has a fresh IFID or replace it manually in the StoryData passage with a new one you from a generator .

Learning Twine

The customizer can help you set things up, but you still need to know the basic Twine syntax to write stories. If it's your first time making a Twine story, I recommend checking out the Twine cookbook for a good introduction to the basics. Early on the cookbook introduces something called Story Formats — the templates generated with this tool use SugarCube 2 , so you should look at the examples for that one.

Customization

Most of the options are pretty straightforward, and you will see their effects immediatly as the preview updates automatically to reflect any changes you make. This section only covers the less obvious stuff like some alternative export options.

Styling

The options in this section are used to do some basic customization of the look and feel of Twine, if you know CSS you can customize it further by editing the Story StyleSheet after you import the file in Twine.

Themes

There's a bunch of presets in the Theme gallery to get you started, but you can further customize them however you want in the customizer or with CSS.

SugarCube options

The settings in this section are passed to the SugarCube configuration. Not all the options available in SugarCube are in the UI yet.

You can change all the settings — including those missing in the UI — by editing the Story JavaScript after you have imported the file in Twine. Go to the SugarCube documentation for the full list of options.

Add-ons

Add-ons extend the functionality of the base SugarCube by adding new macros or JavaScript functions.

There are many, many add-ons developed by the community and freely available. Some of the more popular ones are ready to add in the customizer with a single click, you can check the list in the Add-ons directory (and you can click on the thumbnails there to try an interactive demo).

Templates

There will be a Templates section with a bunch of example projects to learn from, but I don't have any finished yet... If you want to contribute a sample project or tutorial or know any good ones let me know.

Macros

Did you use a macro but you don't remember where it came from, or can't find it's documentation? Check the Macro index, which has the complete list of macros from SugarCube and all the Add-ons available in the customizer, with links to their documentation.

Export options

Compressed zip

Export as a zip file containing the HTML and a folder for images, if there are any. Note that you can't import a zip file directly into Twine, you'll have to extract the contents and import only the HTML file inside.

Single HTML

Export a single HTML file with all styling images embedded in the CSS. Only recommended if you don't plan to modify the story CSS as it will be bloated with the image data and incovenient to edit. The advantage is that if your story contains only text you you can just distribute a single HTML file, instead of having a zip with the game and a background image.

Archive only

Doesn't include SugarCube source code. The resulting HTML file is much smaller, but can't be opened in a browser and doesn't have use instructions. Useful to import directly into Twine.

VSCode project

Export as a zip file containing a Visual Studio Code project. The project structure is based on ChapelR's Tweego Setup (v3) and comes with scripts to build the project using Tweego and NodeJS. It also integrates with the Twee 3 Language Tools extension, so you'll get additional contextual documentation for many of the scripts available in the customizer.

Twee source files

Export as a zip file containing all Twee, JavaScript and CSS source files. Use this if you want to use a Twee compiler such as Tweego but don't want all the boilerplate included in the VSCode project.

Sandbox

The SugarCube sandbox (beta) allows you to try out macros and other features without having to download a template. It's also a good place to test your own widgets and make sure they work before you add them to your story. There's a limit of 2,500 characters.

You can download a template with the code, bookmark the page or share the link.

Support and feedback

Please note that this is an early prototype and it is expected to have bugs and errors. If you encounter any issues or have any questions you can contact zen774#0868 in the official Twine Discord server .

Changelog

Update — 0.5

Update — 0.4

Update — 0.3

Update — 0.2

Update — 0.1