Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 3.37 KB

File metadata and controls

66 lines (48 loc) · 3.37 KB

Kata Framework

A headless, media-first narrative engine for modern web apps.

docs npm license ci

Kata parses .kata scene files, evaluates logic in a sandboxed runtime, and drives any UI framework (React, Vue, vanilla JS) via a predictable typed protocol. You own the look and feel; Kata owns the story.

Get started in 60 seconds

bun create kata-story my-game
cd my-game
bun dev

That's it — you're in a live, branching narrative. From here, read the docs →

Packages

Package Description
@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
kata-vscode VS Code extension — syntax highlighting, LSP, scene graph
create-kata-story bun create kata-story — project scaffolder
create-kata-plugin bun create kata-plugin — plugin scaffolder

Learn more

Contributing

This is a Bun workspace monorepo. Use Bun for everything — npm, pnpm, yarn, node, and vite are not supported.

bun install
bun test            # run all tests
bun run build       # build all packages
bun run changeset   # create a changeset

See CLAUDE.md for the full architecture guide and development conventions.

License

MIT © Purukitto