|
|
||
|---|---|---|
| .vscode | ||
| assets | ||
| docs | ||
| saves/testscene1 | ||
| src | ||
| test | ||
| .gitignore | ||
| .gitmodules | ||
| build.sh | ||
| buildNumber.properties | ||
| CMakeLists.txt | ||
| CMakePresets.json | ||
| DEPENDENCIES.md | ||
| Jenkinsfile | ||
| pom.xml | ||
| README.md | ||
| template.json | ||
| tsconfig.json | ||
Storm Engine
A multiplayer-focused game engine
Building
Cloning
When cloning the repo, make sure to grab all submodules with git clone --recurse-submodules git@git.austinwhoover.com:studiorailgun/Renderer.git
Windows
- Install
- From choco install
- Run build.sh
The build will be in <Project Directory>/build
Alternate Build Profiles
Several build profiles are defined in maven to support different functions
- fast - Only runs the fast unit tests
- integration - Runs the integration tests
- integrationDebug - Runs the integration tests with the memory-debug jar linked
Documentation
Building
The documentation uses Doxygen to build.
On windows, it's recommended to use Doxywizard to build the documentation.
To build
- Open the file
<Project Directory>/docs/Doxyfile - Navigate to the
Runtab - Click
Run doxygen - Click
Show HTML output