twee-ts

twee-ts compiler configuration file

Type object
File match twee-ts.config.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/twee-ts/latest.json
Source https://raw.githubusercontent.com/SchemaStore/schemastore/master/src/schemas/json/twee-ts.config.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Configuration file for twee-ts, a TypeScript Twee-to-HTML compiler.

Properties

$schema string

JSON Schema reference for editor support.

sources string[]

Files or directories to compile.

output string

Output file path.

outputMode string

Output mode.

Default: "html"
Values: "html" "twee3" "twee1" "twine2-archive" "twine1-archive" "json"
formatId string

Story format directory ID (e.g. 'sugarcube-2').

startPassage string

Name of the starting passage.

Default: "Start"
formatPaths string[]

Extra directories to search for story formats.

formatIndices string[]

URLs to SFA-compatible index.json files for remote format lookup.

formatUrls string[]

Direct URLs to format.js files.

useTweegoPath boolean

Also search TWEEGO_PATH env for formats.

Default: true
modules string[]

Module files to inject into .

headFile string

Raw HTML file to append to .

trim boolean

Trim passage whitespace.

Default: true
twee2Compat boolean

Twee2 compatibility mode.

Default: false
testMode boolean

Enable debug/test mode option.

Default: false
noRemote boolean

Disable remote format fetching.

Default: false
tagAliases Record<string, string>

Map alias tags to canonical special tags (e.g. { "library": "script" }).

sourceInfo boolean

Emit source file and line as data- attributes on passage elements.

Default: false
wordCountMethod string

Word counting method. 'tweego': NFKD normalize, divide chars by 5 (matches Tweego). 'whitespace': split on whitespace after stripping comments and markup.

Default: "tweego"
Values: "tweego" "whitespace"