Getting Started

Squiffy is a tool for creating interactive fiction - that is, multiple choice games that focus on text and story. Players navigate through the game or story by clicking links.

Squiffy is free and open source. It creates HTML and JavaScript, so you can upload it to your own website, or to a site like textadventures.co.uk or itch.io.

A player’s state is automatically saved to their browser’s local storage, so they can always pick up from where they left off just by going back to the same web page.

The Squiffy Editor runs entirely in your browser. All your data is saved locally on your device, automatically.

Using Squiffy

You can find Squiffy at app.squiffystory.com.

Example

This documentation features editable examples. Edit the example on the left, and play it on the right.

Publishing your game

Squiffy creates HTML, CSS and JavaScript files, which you can upload anywhere. You don’t need to distribute your source .squiffy file - everything that is needed for the game to run is contained in the HTML and JavaScript.

The editor’s Download menu offers several export options:

Export HTML and JavaScript - Creates a ZIP file containing index.html, style.css, story.js, and squiffy.runtime.global.js. Upload these files to any web server.
Export HTML (single file) - Creates a single self-contained HTML file with all CSS and JavaScript embedded. This is ideal for easy sharing, uploading to platforms that only accept one file, or offline distribution.
Export JavaScript only - Creates just the story.js file, useful if you want to integrate your story into a custom HTML page.
Download Squiffy script - Downloads your source .squiffy file for backup or editing elsewhere.

You can also use the command-line tool for more control over the build process.

Contributing

Squiffy GitHub repository

If you find a bug, please log an issue.

You can discuss Squiffy on Discord, at GitHub Discussions, or at infiction.org (using the squiffy tag).