Caffeine documentation
The Caffeine Engine is a C++20 engine on SDL3. Doppio is its
Rust/Iced editor. The engine exposes a stable C ABI so any frontend can drive it, and
the editor talks to it through libcaffeine-capi.
New here? Start with Getting started and the Quick start, then take the visual tour in the UI gallery.
Documentation map#
| Area | Start with | Also read |
|---|---|---|
| Build and run | Getting started | Building, Build guide, Contributing |
| Doppio editor | Scene editor | Scene viewport, Workspace and theme, Material editor |
| Editor testing | Test automation | Headless driver reference, UI reference |
| Content tools | Material pipeline | Materials guide, Nature, Terrain, Water, Texture |
| Engine core | Core types | Timer, Game loop, Events, Memory, Math |
| ECS and scenes | ECS core | Scene manager, Examples |
| Rendering | RHI | PBR materials, Post-processing, Shadows, Reflections |
| Physics, audio, animation | Physics 3D | Physics 2D, Audio, Animation 2D, Skeletal animation |
| Assets and terrain | Asset manager | CAF format, Asset pipeline, Terrain system |
| Scripting | Scripting overview | Runtime APIs, Generic component access, Native modules |
| Plugins | Plugin catalog | Writing a plugin, Plugin Manager, Plugin SDK |
| Reference | API reference | Architecture specs, Master index, History |
Status of this documentation#
The tree mixes current guides and historical plans. Every page starts with a status badge:
| Badge | Meaning |
|---|---|
| Stable | Verified against the current source and safe to follow. |
| Beta | Implemented but still changing. |
| Reference | API or module reference; check the linked header. |
| Planned | Design only; no current implementation. |
| Historical | Kept for context; not current API. |
Plans under plans/ are historical unless the page says otherwise. They document
decisions and sessions, not the current editor.
Editing the docs#
The authoring standard is HTML-first Markdown:
DOCS_STYLE.md.
Every page needs a doc-meta strip, figures for screenshots and relative links that
stay inside the docs tree. Source links use absolute GitHub URLs.
cd caffeine-website
python3 scripts/audit-docs.py --include-engine
python3 scripts/audit-docs-i18n.py
Screenshots are generated by the headless driver, never by a desktop screenshot:
./scripts/capture-editor-docs.sh
References#
- Engine and Doppio: https://github.com/devscafecommunity/caffeine
- Editor plugins: https://github.com/devscafecommunity/doppio-plugins
- Launcher: https://github.com/devscafecommunity/caffeine-launcher
- Asset packer: https://github.com/devscafecommunity/caf-pack
- Website and books: this repository (
content/,tex/,captures/)