Começar
De um clone limpo a uma sessão Doppio a correr, com o motor
compilado uma vez e o editor Rust lançado contra libcaffeine-capi.
Caminho recomendado#
1. Clonar com submódulos#
git clone --recurse-submodules git@github.com:devscafecommunity/caffeine.git
cd caffeine
Se o repositório foi clonado sem submódulos, inicialize-os mais tarde:
./scripts/submodules.sh
2. Compilar o motor C++ e a C ABI#
O Doppio é um workspace Rust, mas carrega o motor através de
libcaffeine-capi. Compile primeiro o motor:
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j
A biblioteca fica em build/libcaffeine-capi.so no Linux e
build/libcaffeine-capi.dylib no macOS.
3. Executar o Doppio#
cd doppio
cargo run -p doppio-ui
Sem argumentos, o Doppio abre o gestor de projetos. Para abrir uma cena diretamente:
cargo run -p doppio-ui -- ../assets/benchmarks/dense_outdoor.caf
A biblioteca da C ABI é encontrada junto à árvore de build; defina
CAFFEINE_ENGINE_ROOT quando o editor e o motor estiverem em locais diferentes.
4. Opcional: verificar o workspace#
./scripts/check-rust-ui.sh
Este comando corre cargo fmt --check, os testes Rust, o clippy com warnings como
erros, a auditoria de acoplamento core/ImGui e a suite de flows headless.
Páginas#
| Página | Conteúdo |
|---|---|
| Guia de build | Wrapper scripts/build.sh, helpers de plataforma e comandos de CI |
| Quick start | Primeiro projeto, entidade, gravação de cena e navegação no viewport |
| Compilar | Opções manuais de CMake, workspace Rust e binários de teste |
| Contribuir | Regras de código, documentação e checklist de revisão |
Requisitos#
| Dependência | Versão | Usada por |
|---|---|---|
| CMake | 3.20+ | Motor, C ABI, runtime, plugins |
| Compilador C++ | C++20 — GCC 12+, Clang 15+, MSVC 19.3+ | Motor e plugins |
| SDL3 | 3.x | RHI, runtime, viewport |
| Rust | 1.88+ (edition 2021) | Workspace Doppio |
| Python | 3.10+ | Helpers de build, auditorias de docs, scripts de captura headless |
Nota. O motor descarrega dependências fixadas (ImGui, Bullet3, tinygltf e outras) durante a configuração. A primeira configuração precisa de rede; as seguintes funcionam offline.
Próximos passos#
- Siga o Quick start para criar um projeto e gravar uma cena.
- Leia o driver headless para conduzir o editor sem janela.
- Abra a referência de UI para todos os ids de widgets catalogados.