Skip to content

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

License

Notifications You must be signed in to change notification settings

mangoducksparkles/snowman

 
 

Repository files navigation

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.

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.

About

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

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 87.0%
  • CSS 12.4%
  • EJS 0.6%