https://github.com/klembot/twine-utils
Utilities for working with Twine 2 stories, either in JS or from a command line
https://github.com/klembot/twine-utils
twine
Last synced: 4 months ago
JSON representation
Utilities for working with Twine 2 stories, either in JS or from a command line
- Host: GitHub
- URL: https://github.com/klembot/twine-utils
- Owner: klembot
- Created: 2017-08-23T00:52:31.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2023-10-19T11:13:28.000Z (almost 2 years ago)
- Last Synced: 2025-02-28T10:40:23.774Z (8 months ago)
- Topics: twine
- Language: HTML
- Size: 776 KB
- Stars: 23
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# twine-utils
📖 [API documentation](https://klembot.github.io/twine-utils/)
This lets you work with Twee source, Twine 2 stories, and story formats in a
programmatic way: combining them, adding extra JS or CSS, or otherwise modifying
them in JavaScript. This also is able to read Twine 1 stories (TWS) and the HTML
files created by Twine 1, but can't write them.
This library is intended to be used in a Node context, not a browser one, though
everything except the path module should work. They aren't efficient to use in a
browser context because they use Node modules for parsing HTML. In a browser
content, you can have the browser do this for you instead.
Things you can do with this library:
- Assemble a Twine story from disparate sources
- Convert a Twine story to another format, like JSON
- Incorporate Twine into a build process
- Build a tool that works with Twine stories