frontispiece
README.md

Frontispiece

A series of tools to work with ink stories on the web, and connect them to frontend state management systems like React.

Note that these tools are developed very specifically for my projects, and so are fairly opinionated; they tend to assume you use Hookstate as the state management layer (atop React or Preact), and Phaser.JS 3 for handling backgrounds and graphics.

The main 'system agnostic' package is the ink-processor package, which contains vanilla-JS tools to parse the InkJS story, and keep a form of state that works with the immutable nature of frontend rendering frameworks. This processor is used to handle stories used in the other packages.

Usage Example

See the example folder under packages/ink-hookstate for a simple use case of multiple libraries in frontispiece.