/snowman

A minimal Twine 2 story format designed for people who already know JavaScript and CSS

Primary LanguageJavaScriptMIT LicenseMIT

Node.js CI codecov

Snowman 2.0.3

Snowman is a minimal Twine 2 story format designed for people who already know JavaScript and CSS originally created by Chris Klimas. It is currently maintained by Dan Cox.

About this fork

This fork adds support for footnotes in the Passage class of Snowman. Footnotes are part of Markdown Extra, but not widely supported.

What does Snowman offer?

Snowman does not use macros like Harlowe, SugarCube, and other story formats. Instead, it has two global objects, window.story and window.passage, that expose functionality for working with the overall story and the current passage, respectively.

It also includes the JavaScript libraries jQuery and Underscore.

Additional styling options are supplied through the inclusion of the Marked library.

Want to learn more?

The official Snowman documentation has more details about Snowman including multiple examples of how to do various tasks.

Building

Run npm install to install dependencies.

npm run build will create a Twine 2-ready story format under dist/.

To check for style errors, run npm run lint. To run unit tests, run npm run test.