Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
.gitignore
FileReader.js
HTMLParser.js
HTMLWriter.js
LICENSE
Passage.js
README.md
Story.js
StoryFormat.js
StoryFormatParser.js
TweeParser.js
TweeWriter.js
index.js
package-lock.json
package.json

README.md

ExTwee 1.0

ExTwee is a Twee compiler supporting Twine 2-style formats using the Twee3 specification.

It will read both Twee2 (Twee2) and Twee3 formatted files, but does not understand or currently support Twee1 (Twine 1.4.2) or Twee2 special passages for Twine 1.X formatting.

Extwee does not support Twine 1.X story formats.

Story Formats

Because of potentially conflicting licenses, Extwee does not come with any Twine 2-style story formats.

Compatibility With Other Tools

  • Does not parse StorySettings
  • Does not parse @includes
  • Does not parse StoryIncludes
  • Does not handle [haml]; will not parse HAML
  • Does not handle [twee2] special passages

Compiling

extwee -i source.twee -o output.html -f path/format.js

Decompiling

extwee -d file.html -o source.twee

File Formats

Extwee decides how to parse a file based on its extentsion. It understands Twee2 files to have either .tw2 or .twee2 extentsions. Files created for Twee3 parsers should have the .tw3 or .twee3 file extentsion.

Escaping Metacharacters

Extwee will attempt to escape and unescape the metacharacters of {, }, [, and ] when moving to and from Twee notation. However, even with this support, it highly recommended to avoid these characters in passage name and tags to avoid confusion and potential issues.

TODO

  • Adding support for directory handling. Instead acting on a single file, a directory could be supplied that found found and included the CSS and JS files organized within it.
You can’t perform that action at this time.