A simple, readable story format for Twine 2.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
examples
guide
homepage
scripts
src
test-snapshots/src/author
.babelrc
.eslintrc
.gitignore
LICENSE
README.md
package.json
webpack.config.js
yarn.lock

README.md

Chapbook, a story format for Twine 2

by Chris Klimas

Chapbook is a story format for Twine 2, which means that it plays stories created in Twine in a web browser. To use it, add this URL as a story format:

https://klembot.github.io/chapbook/use/0.0.2/format.js

Chapbook is currently in prerelease state. It produces working stories, but its functionality is not complete and it almost certainly contains bugs.

Chapbook is released under the MIT license. It can be used to create commercial works without royalty payment or other arrangement.

  • Learn about Chapbook

    The guide is a gentle introduction to creating with Chapbook. Start here if you'd like to start creating with Chapbook.

  • Cloak of Darkness, a sample story

    Want a quick look at the output Chapbook produces, or the way you write a code for it? Take a look at the story and its Twee source code. If you've never used Twee before, it's a compact text-only format for Twine stories. The main thing to keep in mind is that each line beginning with :: describes a new passage.

  • Report a bug or suggest a feature

    Currently, bug reports and feature suggestions are limited to Patreon backers. The usual issue tracker will open when Chapbook 1.0 is released.

  • Support Chapbook development

    Become a Patreon backer to gain access to devlogs and other benefits.