C++20 game engine (SDL3) and Doppio, its Rust/Iced editor. The engine exposes a
C ABI (libcaffeine-capi) so any frontend can drive it. User-facing documentation
lives in the caffeine-website submodule, not in this tree.
| Path | What it is |
|---|---|
caf-pack/ |
Asset packer — .caf / .cap pipeline |
caffeine-website/ |
Docs site + MCP for agents |
caffeine-launcher/ |
Desktop launcher (Rust) — start studio apps and manage plugins |
doppio-plugins/ |
Official/community Doppio C++ plugins (built with the engine, loaded on demand) |
Initialize everything:
git submodule update --init --recursive
# or
./scripts/submodules.shAgent-oriented layout and policies: AGENTS.md.
Requirements: C++20, CMake 3.20+, SDL3.
git submodule update --init --recursive
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j
cd build && ctest --output-on-failureHelpers: scripts/build.sh, scripts/build.fish, scripts/build.bat.
Doppio is the doppio/ workspace: crates/engine is the libloading bridge to
libcaffeine-capi, and crates/ui holds the components, panels and windows.
Build the C ABI first, then run the editor:
cmake --build build --target caffeine-capi -j
cd doppio
cargo run -p doppio-ui -- ../assets/benchmarks/dense_outdoor.cafChecks used by CI/agents: ./scripts/check-rust-ui.sh (fmt, tests, clippy and the
core/ImGui coupling audit). The old C++ editor is frozen in doppio-archived/;
architecture notes live in doppio/docs/rust-ui.md.
The engine build compiles every plugin from the doppio-plugins submodule and
writes the libraries to build/plugins/. There is no separate plugin build step:
./scripts/submodules.sh
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -jCAFFEINE_BUILD_DOPPIO_PLUGINS=OFF is the only way to skip them, and it is intended
for minimal/headless environments — not for normal builds.
Plugins target the legacy C++/ImGui SDK (include/caffeine/plugin/,
include/caffeine/ui/). The plugin host and Plugin Manager live in the archived
C++ editor (doppio-archived/src/doppio/editor/PluginSystem.cpp); the active Rust
Doppio does not load C++ plugins yet. The engine still builds every plugin so the
runtime/legacy host can use them and so the SDK stays compile-tested.
All user-facing documentation, plans, screenshots and PDFs live in the
caffeine-website submodule (content/, tex/, captures/). Nothing is
duplicated in the engine tree. Pages are HTML-first Markdown: HTML for
metadata, figures, callouts, collapsible reference blocks and rich tables;
Markdown for headings, prose, lists and code.
git submodule update --init caffeine-website
cd caffeine-website
python3 scripts/audit-docs.py --include-engine
python3 scripts/audit-docs-i18n.pyScreenshots and recordings are generated by the headless driver, never by a desktop screenshot:
./scripts/capture-editor-docs.sh
./scripts/capture-editor-tour.shAuthoring standard: caffeine-website/DOCS_STYLE.md.
Editor architecture: doppio/docs/rust-ui.md.