API reference
The generated rustdoc is the exhaustive reference for every public crate in the workspace. The book covers concepts and curated maps; the rustdoc covers every type, trait, function, and method.
The published reference is built from main on every release and lives at
eraflo.github.io/KhoraEngine/api.
Public SDK
khora-sdk is the only crate game developers should depend on. Everything else
is implementation detail. See the SDK surface page for a curated map.
| Entry | rustdoc |
|---|---|
| Crate root | khora_sdk |
| Prelude | khora_sdk::prelude |
| Engine type | EngineCore |
| ECS facade | GameWorld |
| App lifecycle trait | EngineApp |
| Agent registration trait | AgentProvider |
| Custom phase trait | PhaseProvider |
| Spawn builder | Vessel |
| Bootstrap entry | run_winit |
| Window settings | WindowConfig |
Internal crates
Visible for engine contributors. Game code should not depend on these directly —
their surface is re-exported through khora-sdk where game code needs it. See the
crate map for the dependency layering.
| Crate | rustdoc |
|---|---|
khora_core | Trait floor — math, GORNA types, traits, runtime containers |
khora_data | CRPECS ECS, component storage, Flows, scene strategies |
khora_io | VFS, asset service, serialization service, pack builder |
khora_lanes | Render, physics, audio, asset, scene, UI lanes |
khora_agents | The strategist agents + PhysicsQueryService |
khora_control | DCC, scheduler, GORNA arbitration, plugin |
khora_infra | Default backends — wgpu, Rapier, CPAL, Taffy, winit |
khora_telemetry | Telemetry service, metrics, monitors |
khora_macros | #[derive(Component)] proc macro |
khora_plugins | Plugin loading and registration |
khora_editor | Editor application |
Generating locally
To build the same rustdoc on your machine:
cargo doc --workspace --no-deps --open
The output lands under target/doc/. The combined documentation site (this book
plus rustdoc mounted under /api) is assembled by .github/workflows/docs.yml
on every push to main; there is no single local command that mirrors the full
combined site.
The API reference is the contract. The book is the rationale — start with Concepts.