Caffeine

Índice master

Reference Engine Doppio Verificado em:

Um ponto de entrada único para a árvore de documentação. O índice funcional com descrições vive em README.md; esta página mantém o antigo ponto de entrada “master” e resume a arquitetura atual.

Material histórico. HISTORY.md e as páginas em plans/ registam como o projeto chegou aqui. Não são documentação da API atual. Para o editor atual, comece em Editor de cena.

Arquitetura num relance#

CamadaO que éOnde
GPU APIVulkan, D3D12 ou Metal através do SDL3 GPUDrivers da plataforma
Core do motorRuntime, render, RHI, ECS, assets, física, scripting. Sem ImGui, sem estado do editor.src/caffeine/
C ABIFronteira estável para qualquer frontend; versionada em CAFFEINE_CAPI_VERSION.include/caffeine/capi/EngineAPI.h, src/caffeine/capi/
Bridge do motorBindings Rust com libloading; a única crate que toca FFI.doppio/crates/engine/
UI do DoppioWorkspace Iced, painéis, componentes e geradores.doppio/crates/ui/
PluginsFerramentas C++/ImGui opcionais compiladas do submódulo.doppio-plugins/, include/caffeine/plugin/

Pontos de entrada principais#

Necessidade Página
Compilar e executar Começar
Aprender o editor Editor de cena
Visita visual Galeria de UI
Materiais Editor de materiais
Pipeline de render RHI, Materiais PBR
ECS e cenas ECS core, Scene manager
Scripting Visão geral
C ABI e APIs Referência da API
Testes headless Referência do driver
História do projeto História

Mapa do repositório#

Caminho Conteúdo
src/caffeine/ Core do motor
include/caffeine/ Headers públicos (C API, plugins, UI kit, runtime)
apps/ Executáveis caffeine-runtime e caffeine-combined
doppio/ Workspace do editor Rust
doppio-archived/ Snapshot congelado do editor C++ (só referência)
tests/ Suites Catch2
caf-pack/ Submódulo do asset packer
doppio-plugins/ Submódulo de plugins
caffeine-website/ Esta árvore de documentação

Padrões de documentação#

  • Markdown HTML-first: DOCS_STYLE.md.
  • Páginas atuais usam Stable, Beta ou Reference; planos usam Historical.
  • Links para código usam URLs absolutos do GitHub; imagens vivem em images/.
  • Corra as duas auditorias antes de publicar:
bash
cd caffeine-website
python3 scripts/audit-docs.py --include-engine
python3 scripts/audit-docs-i18n.py