kinetik-embed 0.1.0-alpha.0

Rust-native scripting language runtime and CLI for game engines.
Documentation

Kinetik

Kinetik is a Rust-implemented scripting language for game engines.

It aims to be small, embeddable, game-focused, beginner-friendly, JSON-native for data, explicit about programmable tables, and optimized for embedding and LLM-assisted development.

Current Status

Production-oriented implementation foundation. The language contract is in SPEC.md; implementation slices are in docs/BACKLOG.md.

Install

The alpha CLI package is kinetik-lang and installs a kinetik-lang binary. See docs/INSTALL.md for the full install guide, exit codes, and first-script walkthrough.

cargo install kinetik-lang

From a source checkout:

cargo install --path crates/kinetik-cli
kinetik-lang check examples/hello.kn
kinetik-lang run examples/hello.kn

Baseline Checks

cargo fmt --check
cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace
cargo doc --workspace --no-deps

Read First

  • AGENTS.md - instructions for coding agents.
  • SPEC.md - language specification.
  • docs/constitution.md - project laws and non-negotiable decisions.
  • docs/PRD.md - product intent.
  • docs/ARCHITECTURE.md - implementation architecture.
  • docs/ROADMAP.md - milestone order.
  • docs/BACKLOG.md - end-to-end implementation slices.
  • CHANGELOG.md and docs/VERSIONING.md - release notes and alpha compatibility policy.

License

Kinetik is licensed under the MIT License.

See LICENSE for the full license text.