Start / orientation

Getting started¶

Tokimu is in early development. The repository is currently most useful to engine contributors, architecture readers, and people evaluating its corpus evidence. It is not yet a packaged end-user engine distribution.

Choose an entry point¶

For current implementation work, build the Rust workspace and run focused corpus entries from the source repository.

Current workspace¶

The public facade and engine services are organized around semantic ownership:

tokimu-core       engine-neutral world concepts
tokimu-runtime    lifecycle, scheduling, and execution
tokimu-render     provider-neutral rendering contracts
tokimu-platform   native and browser mechanisms
tokimu-assets     asset identity and loading
tokimu-input      normalized input state
tokimu-wasm       bounded browser entry surface
tokimu            public facade

The corpus/ tree contains architecture-driving executable evidence, including focused proofs, external data corpora, shared incubating support, and application-shaped consumers.

The separate frontends/ workspace contains the early TypeScript authoring packages. Those packages describe authored intent and lower toward language-neutral Rust models; core engine crates do not depend on npm or a JavaScript runtime.

Build the workspace¶

Install stable Rust, clone the repository, then run:

cargo test --workspace

Individual corpus entries can be launched by package name. Their README or DESIGN.md files identify the claim being tested, dependencies, expected diagnostics, and known limitations.