Skip to content

Story Format for Twine cause I can't stop re-inventing the wheel

License

Notifications You must be signed in to change notification settings

washingtonsteven/explorer-format

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Explorer Twine Format

I wanted to make a Twine story format for the idea of a story/game I had so here it is. I'm also learning how to make a Twine story format.

Quick Start

Option 1 (Twine): View the raw format.js file, and copy the URL into Twine > Story Format > Add

Option 2 (CLI compilers like tweego): Download format.js from dist and place them in a proper directory (i.e. storyformats for tweego).

Building the format

yarn build-format

This will:

  1. Build the Typescript used to make up the format code (i.e. /src/index.js).
  2. Inject that js into the HTML source (via handlebars: /src/index.mustache)
  3. Inject that HTML into the source attribute in the format JSON and finally,
  4. Write out that JSON (wrapped in a window.storyFormat JSON-P style call) to dist/format.js

Format dev

yarn serve

Will start a dev server at http://localhost:3000 hosting tests/test-stories/basic.twee, for testing. Will automatically rebuild when any ts, scss, or hbs file is changed. Will not autoreload your browser, sorry, but I can't do everything for you.

About

Story Format for Twine cause I can't stop re-inventing the wheel

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages