@goldfire/storyscript

Description

StoryScript is a fork of the standard screenplay format to be used with interactive games, originally designed for use in the game Arctic Awakening.

Installation

• Install with npm: npm install @goldfire/storyscript
• Install with Yarn: yarn add @goldfire/storyscript

Usage

To use as a CLI:

> node StoryScript /absolute/path/to/script.txt

To use in a Node.js project:

const {parseScript} = require('@goldfire/storyscript');

const scriptFile = fs.readFileSync('/path/to/script.txt', 'utf8');
const ast = parseScript(scriptFile);

console.log(JSON.stringify(ast, null, 2));

StoryScript Syntax

TODO

License

Copyright (c) 2021 James Simpson and GoldFire Studios, Inc.

Released under the MIT License.