API reference
This section is generated from TypeScript sources by TypeDoc on every release. If you’re looking for tutorials or guides, start with the Getting Started track instead — the API reference is the deep-dive layer.
Packages
| Package | Purpose |
|---|---|
@kata-framework/core | Headless engine, parser, runtime, plugins, VFS, snapshots |
@kata-framework/react | React 19 bindings — KataProvider, useKata, save manager, tween layer |
@kata-framework/sync | Multiplayer — authority model, transports, KataServer |
@kata-framework/cli | kata build, kata watch, kata graph |
@kata-framework/lsp | Language Server Protocol for .kata files |
@kata-framework/test-utils | createTestEngine, StoryTestRunner, collectFrames |
@kata-framework/devtools | In-browser devtools plugin + React overlay |
Stability
All packages listed above are at v1.0.0 and follow semver. Breaking changes require a major bump. See the changelog for release history.
Finding things
- Looking for a hook? Start in
@kata-framework/react— everything UI-side lives there. - Looking for a plugin? They live in
@kata-framework/core/plugins/*subpaths. The plugins catalog is usually faster than browsing the API tree. - Looking for types like
KSONFrameorKSONAction? They’re re-exported from@kata-framework/core’s root. The KSON protocol page is a friendlier entry point.
Use the search box (/ shortcut) to find a symbol by name across all packages.