Documentação Caffeine
O Caffeine Engine é um motor C++20 sobre SDL3. O Doppio é o seu
editor Rust/Iced. O motor expõe uma C ABI estável para qualquer frontend o conduzir, e
o editor comunica através de libcaffeine-capi.
Novo aqui? Comece em Começar e no Quick start, depois faça a visita visual na galeria de UI.
Mapa da documentação#
| Área | Comece em | Leia também |
|---|---|---|
| Compilar e executar | Começar | Compilar, Guia de build, Contribuir |
| Editor Doppio | Editor de cena | Scene viewport, Workspace e tema, Editor de materiais |
| Testes do editor | Automação de testes | Referência headless, Referência de UI |
| Ferramentas de conteúdo | Material pipeline | Guia de materiais, Nature, Terrain, Water, Texture |
| Core do motor | Tipos do core | Timer, Game loop, Events, Memória, Matemática |
| ECS e cenas | ECS core | Scene manager, Exemplos |
| Renderização | RHI | Materiais PBR, Post-processing, Sombras, Reflexos |
| Física, áudio, animação | Física 3D | Física 2D, Áudio, Animação 2D, Animação esquelética |
| Assets e terreno | Asset manager | Formato CAF, Pipeline de assets, Sistema de terreno |
| Scripting | Visão geral | APIs de runtime, Acesso genérico a componentes, Módulos nativos |
| Plugins | Catálogo de plugins | Escrever um plugin, Plugin Manager, Plugin SDK |
| Referência | Referência da API | Especificações, Índice master, História |
Estado da documentação#
A árvore mistura guias atuais e planos históricos. Cada página começa com um selo de estado:
| Selo | Significado |
|---|---|
| Stable | Verificado contra o código atual; pode seguir. |
| Beta | Implementado, mas ainda a mudar. |
| Reference | Referência de API/módulo; confirme o header ligado. |
| Planned | Apenas design; sem implementação atual. |
| Historical | Mantido por contexto; não é API atual. |
Os planos em plans/ são históricos, salvo indicação em contrário. Documentam
decisões e sessões, não o editor atual.
Editar a documentação#
O padrão de autoria é Markdown HTML-first:
DOCS_STYLE.md.
Cada página precisa de uma faixa doc-meta, figuras para capturas e links relativos
dentro da árvore de docs. Links para código usam URLs absolutos do GitHub.
cd caffeine-website
python3 scripts/audit-docs.py --include-engine
python3 scripts/audit-docs-i18n.py
As capturas são geradas pelo driver headless, nunca por um screenshot do desktop:
./scripts/capture-editor-docs.sh
Referências#
- Engine e Doppio: https://github.com/devscafecommunity/caffeine
- Plugins do editor: https://github.com/devscafecommunity/doppio-plugins
- Launcher: https://github.com/devscafecommunity/caffeine-launcher
- Asset packer: https://github.com/devscafecommunity/caf-pack
- Website e livros: este repositório (
content/,tex/,captures/)