Caffeine

Master index

Reference Engine Doppio Last verified:

A single entry point for the documentation tree. The functional index with descriptions lives in README.md; this page keeps the old “master” entry point working and gives the current architecture at a glance.

Historical material. HISTORY.md and the pages under plans/ record how the project arrived here. They are not current API documentation. For the current editor, start with Scene editor.

Architecture at a glance#

LayerWhat it isWhere
GPU APIVulkan, D3D12 or Metal through SDL3 GPUPlatform drivers
Engine coreRuntime, render, RHI, ECS, assets, physics, scripting. No ImGui, no editor state.src/caffeine/
C ABIStable boundary for any frontend; versioned in CAFFEINE_CAPI_VERSION.include/caffeine/capi/EngineAPI.h, src/caffeine/capi/
Engine bridgeRust libloading bindings; the only crate allowed to touch FFI.doppio/crates/engine/
Doppio UIIced workspace, panels, components and generators.doppio/crates/ui/
PluginsOptional C++/ImGui tools compiled from the submodule.doppio-plugins/, include/caffeine/plugin/

Main entry points#

Need Page
Build and run Getting started
Learn the editor Scene editor
Visual tour UI gallery
Materials Material editor
Render pipeline RHI, PBR materials
ECS and scenes ECS core, Scene manager
Scripting Scripting overview
C ABI and APIs API reference
Headless testing Driver reference
Project history History

Repository map#

Path Contents
src/caffeine/ Engine core
include/caffeine/ Public headers (C API, plugins, UI kit, runtime)
apps/ caffeine-runtime and caffeine-combined executables
doppio/ Rust editor workspace
doppio-archived/ Frozen C++ editor snapshot (reference only)
tests/ Catch2 suites
caf-pack/ Asset packer submodule
doppio-plugins/ Plugin submodule
caffeine-website/ This documentation tree

Documentation standards#

  • HTML-first Markdown: DOCS_STYLE.md.
  • Current pages carry Stable, Beta or Reference; plans carry Historical.
  • Source links use absolute GitHub URLs; images live under images/.
  • Run both audits before publishing:
bash
cd caffeine-website
python3 scripts/audit-docs.py --include-engine
python3 scripts/audit-docs-i18n.py