recital / packages / twine-format / README.md
README.md
Raw

Recital Twine Format

A modification of Entweedle that converts a Twine 2 story into a Recital stage script, which can then be parsed into other forms.

Building

$ node build

All files end up in the dist folder.

Usage

Twine 2 doesn't allow you to install formats locally. Therefore, the format must be hosted on a remote server, and then the URL for the format.js file pasted into Twine 2.

To do this, host the dist folder as a static site somewhere, and take the URL of format.js and paste it into Twine. (I use Netlify for this.)