Installation und Kompilierung
Bereite CMake und einen C++20-Compiler vor, erstelle die ausführbare Datei und starte sie aus dem richtigen Verzeichnis.
Auf dieser Seite
Voraussetzungen des Projekts
| Werkzeug | Verifizierte Voraussetzung |
|---|---|
| C++-Compiler | Unterstützung für C++20 und die verwendete Standardbibliothek, einschließlich std::format. |
| CMake | Version 3.28 oder neuer. |
| Git | Zum Klonen des Projekts und Herunterladen von SFML über FetchContent erforderlich. |
| Ninja | Erforderlich, wenn du den Generator aus den Befehlen dieses Leitfadens wählst. |
| Internetverbindung | Die erste Konfiguration lädt Abhängigkeiten herunter. |
Die in .vscode eingerichtete Umgebung verwendet Windows, MinGW GCC, Ninja und GDB. Die folgenden Befehle leiten sich aus CMakeLists.txt und dieser Konfiguration ab; sie stellen keine zertifizierte Build-Matrix dar.
Den Code abrufen
In einem Terminal, in dem die Werkzeuge über PATH erreichbar sind:
git clone https://github.com/Arukado01/AwesomeEngine.git
cd AwesomeEngineUm genau den hier beschriebenen Code anzusehen, kannst du in einer neuen Kopie die geprüfte Revision auswählen:
git checkout 5a6dfacd86414c4cdfaa7157b533330f173a3126Dieser letzte Befehl setzt die Kopie auf einen bestimmten Commit. Wenn du Änderungen entwickeln möchtest, erstelle vor Beginn einen eigenen Branch. Die Dokumentation verlinkt jede Quelle ebenfalls auf diese Revision, damit du sie mit späteren Aktualisierungen vergleichen kannst.
Konfigurieren und kompilieren
cmake -S . -B Build -G Ninja -DCMAKE_BUILD_TYPE=Debug
cmake --build Build --parallelCMake fasst die .cpp-Dateien aus Engine/Source und Games/Source zu einer ausführbaren Datei namens AwesomeEngine zusammen. Die Abhängigkeiten werden mit FetchContent bezogen:
- SFML 3.1.0.
- nlohmann/json 3.12.0.
- spdlog 1.16.0.
- TGUI 1.13.0.
- magic_enum 0.9.8.
Für einen getrennten Release-Build:
cmake -S . -B BuildRelease -G Ninja -DCMAKE_BUILD_TYPE=Release
cmake --build BuildRelease --parallelDas Projekt sieht auch Optionen für den MSVC-Compiler vor, die obigen Schritte verwenden jedoch Ninja und den Compiler deiner Umgebung. Mische keine Generatoren oder Compiler im selben Build-Verzeichnis.
Unter Windows ausführen
Lass das Terminal im Stammverzeichnis des Repositorys, neben Content:
.\Build\AwesomeEngine.exeDie dokumentierte Revision fordert Tetris als Startszene an. In dieser Revision ist keine funktionsfähige Spielauswahl registriert: Die Startszene wird in Engine.cpp festgelegt.
Das Arbeitsverzeichnis ist wichtig. Konfiguration, Shader, Schrift und andere Ressourcen werden über relative Pfade wie Content/Config.json geladen. Ein Start aus Build kann verhindern, dass die Engine sie findet.
Mit VS Code arbeiten
Das Repository enthält Build-Aufgaben und eine Debugging-Konfiguration für GDB. Die ausführbare Datei liegt unter Build/AwesomeEngine.exe; das Arbeitsverzeichnis bleibt das Stammverzeichnis.
Einige Editoroptionen enthalten absolute Pfade vom Rechner des Autors. Passe die Pfade zu Compiler und Werkzeugen an deine Installation an; übernimm sie nicht als allgemeine Voraussetzungen.
Wenn Build oder Start fehlschlagen
Sieh unter Fehlerbehebung nach: Dort werden Werkzeugprobleme, fehlgeschlagene Downloads, Ressourcenprobleme und bekannte Einschränkungen des Codes unterschieden. Dieser Leitfaden veröffentlicht weder einen Installer noch eine plattformübergreifende Binärdatei.