AWESOME ENGINE / GUIA TÉCNICO

Instalação e compilação

Prepare o CMake e um compilador C++20, compile o executável e execute-o a partir do diretório correto.

Nesta página

Requisitos do projeto

Ferramenta Requisito verificado
Compilador C++ Compatibilidade com C++20 e com a biblioteca padrão utilizada, incluindo std::format.
CMake Versão 3.28 ou posterior.
Git Necessário para clonar o projeto e baixar o SFML por meio de FetchContent.
Ninja Necessário se você escolher o gerador dos comandos deste guia.
Conexão com a Internet A configuração inicial baixa as dependências.

O ambiente configurado em .vscode usa Windows, MinGW GCC, Ninja e GDB. Os comandos abaixo derivam do CMakeLists.txt e dessa configuração; não representam uma matriz de compilações certificada.

Obter o código

Em um terminal com as ferramentas disponíveis no PATH:

git clone https://github.com/Arukado01/AwesomeEngine.git
cd AwesomeEngine

Para consultar exatamente o código descrito nesta documentação, você pode selecionar a revisão auditada em uma cópia nova:

git checkout 5a6dfacd86414c4cdfaa7157b533330f173a3126

Esse último comando deixa a cópia em um commit específico. Se você pretende desenvolver alterações, crie sua própria branch antes de trabalhar. A documentação também vincula cada fonte a essa revisão para permitir comparações com futuras atualizações.

Configurar e compilar

cmake -S . -B Build -G Ninja -DCMAKE_BUILD_TYPE=Debug
cmake --build Build --parallel

O CMake reúne os arquivos .cpp de Engine/Source e Games/Source em um único executável chamado AwesomeEngine. As dependências são obtidas por meio de FetchContent:

  • SFML 3.1.0.
  • nlohmann/json 3.12.0.
  • spdlog 1.16.0.
  • TGUI 1.13.0.
  • magic_enum 0.9.8.

Para uma compilação Release separada:

cmake -S . -B BuildRelease -G Ninja -DCMAKE_BUILD_TYPE=Release
cmake --build BuildRelease --parallel

O projeto também inclui opções do compilador MSVC, mas os passos acima usam Ninja e o compilador disponível no seu ambiente. Não misture geradores nem compiladores no mesmo diretório de compilação.

Executar no Windows

Mantenha o terminal na raiz do repositório, ao lado de Content:

.\Build\AwesomeEngine.exe

A revisão documentada solicita Tetris como cena inicial. Não existe um seletor de jogos funcional registrado nessa revisão: a cena inicial é definida em Engine.cpp.

O diretório de trabalho importa. A configuração, os shaders, a fonte e os demais recursos são carregados por caminhos relativos, como Content/Config.json. Executar a partir de Build pode impedir que o motor os encontre.

Trabalhar com o VS Code

O repositório contém tarefas de compilação e uma configuração de depuração com GDB. O caminho do executável é Build/AwesomeEngine.exe, e o diretório de trabalho permanece na raiz.

Algumas opções do editor contêm caminhos absolutos do computador do autor. Adapte os caminhos do compilador e das ferramentas à sua instalação; não os copie como requisitos universais.

Se a compilação ou a inicialização falhar

Consulte Solução de problemas: ela separa problemas de ferramentas, download de dependências, recursos e limitações conhecidas do código. Nenhum instalador ou binário multiplataforma é publicado como parte deste guia.

Fontes

Baseado em código-fonte verificado.Encontrou um problema? →