Skip to content
A tool to convert a Twine 2 story into a book.
Java TeX XSLT CSS
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows Reformat GitHub Actions gradle.yml file Dec 18, 2019
CommandLine
Core
FrontEnd Clean up code Dec 21, 2019
config/checkstyle
example Add Cucumber tests to OracleTest Dec 21, 2019
gradle/wrapper Update codebase to Java 11 (#64) Dec 18, 2019
.gitattributes
.gitignore
COPYING
CREDITS
README.md
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle
sonar-project.properties

README.md

Spiner

Spiner

Spiner is a set of tools that allows you to easily author you own Choose Your Own Adventure books using Twine 2. This set consists of an application, which transforms your published Twine story into an EPUB ebook.

Build Status

Quality Gate Technical Debt

Features

The following features are currently supported:

Markdown
Simple Markdown syntax can be used to write and format your gamebook (EPUB only).
Passage links
Twine passage links (i.e. [[displayed text|passage title]], [[passage title]]) are automatically converted to <a> links for EPUB.
Story Stylesheet
Your story stylesheet as defined in Twine will be add to every .xhtml file in your EPUB file.
Images
Both local (images on your harddrive) as remote images (images on the internet) can simply be embedded in the EPUB by using standard markdown syntax(e.g. ![alt](url)).
Metadata
Any EPUB metadata can be set from inside a normal Twine passage named 'metadata' using XML.

Usage

Graphical User Interface

By far the easiest way to get started is to let the GUI to do the work for you. Just download the correct version for your operating system and follow the instructions on the screen!

Operating System Download
Windows no download available yet
Mac OS no download available yet
Linux no download available yet
Other no download available yet

Commandline

There is also a separate command-line version that works like this:

usage: java -jar spiner-0.1.2.jar [-f <format>] [-help | -version] [-i <input>] [-o <file>]
 -f,--format <format>   output format, currently only (epub)
 -help                  display this help and exit
 -i,--file <input>      location of input HTML file
 -o,--output <file>     location of output file
 -version               output version information and exit
java -jar spiner-0.1.2.jar -f "epub" -i "My Cool Story.html" -o "My Cool Story.epub"

Examples

Book Link
Kolb and the Dragon Twine to EPUB
Features Twine to EPUB

Roadmap

The following features are currently not implemented but are to be expected somewhere in the indefinite future, in roughly the following order:

Annotation tag
Passages tagged with `annotation` will not be included in the EPUB file.
Unified markup
It would be nice to be able to transform the same Twine story into both an EPUB and LaTeX file without having to fix up tiny details in either of them.
Scripting? and other EPUB3 features
I currently do not own an eReader that supports EPUB3 features. But support for EPUB3 features, especially scripting could prove interesting.

License

See the file COPYING.

You can’t perform that action at this time.