@patterkit/model

The TypeScript types that describe Patter's data: the shape every other @patterkit package agrees on. Types only, with no behaviour.

Most people won't need to install this directly. To play Patter dialogue in a game or web page, use @patterkit/runtime; to work with Patter projects from a terminal or a build script, use @patterkit/cli.

What's in it

• The source format: scenes and their flow tree (blocks, groups, snippets, beats, and jumps), the project file, locale files, and the authoring file that holds comments, suggestions, and writing status.
• The compiled bundle: the .patterc a game loads, as written by the compiler and read by every runtime.
• Shared helpers for addressing: the game-facing ids (gameIdify, isValidGameId, effectiveGameId).

Conditions and effects are kept as source strings here; the expression language itself is @wildwinter/expr. The format is described in the specification.

npm install @patterkit/model

Part of Patter

Patter is a branching dialogue format with its own editor (Patterpad), command line tool (patter), and runtimes for JavaScript, Unity, Unreal, and Godot. This package is one layer of the JavaScript tooling, and the other @patterkit packages build on it. How it fits together shows where each piece sits, and the source is in the patter repository.

Licence

MIT