extwee
TypeScript icon, indicating that this package has built-in type declarations

2.2.3 • Public • Published

codecov

npm version

License: MIT

NPM Badge

Table of Contents

  1. Story Compilation
  2. Format Support
  3. Node and Web API
    1. Objects
    2. Parsers
    3. Compilers
  4. Documentation
  5. Command-Line Usage
  6. Escaping Meta-Characters
  7. License

Story Compilation

The process of story compilation converts human-readable content, what is generally called a story, into a playable format such as HyperText Markup Language (HTML). The result is then presented as links or other visual, interactive elements for another party to interact with to see its content.

The term compilation is used because different parts of code are put together in a specific arrangement to enable later play. As part of Twine-compatible HTML, this means combining JavaScript code (generally a "story format") with story HTML data.

Extwee is not an authoring tool. It cannot be used to create story content. This data must be created using other tools or processes. Extwee can then compile the content with story format code to produce something playable.

Playable formats are the following and require external story formats1 to enable play:

  • Twine 2 HTML
  • Twine 1 HTML

More human-readable formats include:

  • Twee 32
  • Twine 2 JSON3

From 2009 to 2015, Twine 1 supported a now historical format named TWS. This was a binary format used for archival purposes. Extwee can read this format but does not support creating it because no other tools, including current versions of Twine, accept it as valid input.

Twine 2 supports exporting a collection of stories (known as a library) in the Twine 2 Archive HTML format. Extwee can also read and write this format, creating either a collection of stories from the data or writing a collection of internal objects to a file.

Format Support

Extwee supports multiple historical and current Twine-compatible formats.

Format Input Output
Twine 1 HTML (2006 - 2015) Yes Partial support. Twine 1 HTML can be produced, but the StorySettings optional passage introduced in Twine 1.4.0 requires external libraries like jQuery not included with Extwee.
Twine 1 TWS (2009 - 2015) Yes Extwee does not support TWS (Python pickle) output because no current version of Twine or other story compilation tool produces this historical format.
Twine 2 HTML (2015 - Present) Yes Yes
Twine 2 Archive HTML (2015 - Present) Yes Yes
Twee 3 (2021 - Present) Yes Yes
Twine 2 JSON (2023 - Present) Yes Yes

Note: Round-trip translations can present problems because of required fields and properties per format. Some metadata may be added or removed based on the specification being followed.

(back to top)

Node and Web API

The following objects and methods are available in Node.js or browser contexts.

Note: When used in a browser context, all objects and methods are part of the window.Extwee global.

Objects

An object must be created using either the new keyword in JavaScript or as the result of parsing data.

  • StoryFormat
  • Passage
  • Story

Story and Passage objects can generate multiple output formats: toTwee(), toTwine1HTML(), toTwine2HTML(), and toJSON(). Stories cannot be played in a browser without the corresponding compiler combining it with story format data.

(back to top)

Parsers

Translates output formats such as HTML, Twee, JSON, or JSONP into objects.

Note: Twine 1 story formats exist across multiple files (header.html and optional code.js). They cannot be parsed into a StoryFormat object.

  • parseTwee()
  • parseJSON()
  • parseStoryFormat()
  • parseTwine1HTML()
  • parseTwine2HTML()
  • parseTwine2ArchiveHTML()

(back to top)

Compilers

Compiles story, story formats, or other data into an archive or playable format.

  • compileTwine2HTML()
  • compileTwine1HTML()
  • compileTwine2ArchiveHTML()

Note: In order to create playable Twine 1 HTML, an engine.js file must be supplied.

Support Functionality

Multiple Twine formats support using an IFID to identify one work from another.

As part of its API, the Extwee method generateIFID() can be used to create a new IFID for a Story object or as part of other processes.

(back to top)

Documentation

Extwee has documentation hosted on GitHub Pages.

(back to top)

Command-Line Usage

Extwee supports a command-line interface for four general scenarios:

Compiling Twee 3 + Twine 2 Story Format into Twine 2 HTML

Compile Twee 3 + StoryFormat into Twine 2 HTML:

extwee -c -i <tweeFile> -s <storyFormat> -o <Twine2HTML>

De-compiling Twine 2 HTML into Twee 3

De-compile Twine 2 HTML into Twee 3:

extwee -d -i <twine2HTML> -o <outputTwee>

Compiling Twee 3 into Twine 1 HTML

Enabling Twine 1 mode requires using the -t1 or --twine1 flag.

Because Twine 1 story formats can be split across files, compilation requires the "engine" from Twine 1 named engine.js, the name of the story format, and then its header.html template code and the optional but often included code.js file.

extwee -t1 -c -i <tweeFile> -o <Twine1HTML> -engine <engineJS> -name <storyFormatName> -codejs <CodeJS> -header <header>

De-compiling Twine 1 HTML into Twee 3

Enabling Twine 1 mode requires using the -t1 or --twine1 flag.

extwee -t1 -d -i <twine1HTML> -o <outputTwee>

(back to top)

Roadmap

Each major version has its own GitHub project:

Tree Shaking Support

For advanced tree shaking patterns, most formats are broke into compile.js and parse.js files exporting associated compile() and parse() functions. When using the API, it is possible to only import a single function or object to produce smaller and potentially faster code in projects dependent on Extwee functionality.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

  1. Extwee does not include or publish story formats. These can be found in the Story Format Archive (SFA).

  2. Twee exists in three versions. The first existed between 2006 to 2009 and was part of Twine 1. The move to Twine 2 in 2009 dropped support and the story compilation tools Twee2 and Tweego adopted their own extensions and modifications. Beginning in 2017, work was done to unite the different projects. This resulted in Twee 3 in March 2021.

  3. In October 2023, JavaScript Object Notation (JSON) was added as a supported community format for story compilation tools. Extwee is the first tool to support this format.

Package Sidebar

Install

npm i extwee

Weekly Downloads

24

Version

2.2.3

License

MIT

Unpacked Size

85.9 MB

Total Files

187

Last publish

Collaborators

  • videlais