The engine is written C++ and uses cmake as it’s build
system. The engine can be compiled as a static or shared library. This
file contains a guide for all the steps to succesfully build the engine
library, examples and tests in your machine.
Currently the only officially supported platform is Linux. The engine may work on Windows or MacOS but it is not officially supported at the moment. If you want to make sure that it builds succesfully on other platforms, consider CONTRIBUTING.html to this project. This guide will go through the build process on a Linux system.
In order to build the engine, you will need:
A C++23 compiler
cmake >= 3.16
The rest of the dependencies, like assimp and glfw, are present in
the source tree as git submodules under the external/
directory. These will be automatically built by the build system if you
want a static build.
Clone the project from GitHub with --recurse-submodules
to download the dependencies.
git clone --recurse-submodules -j8 https://github.com/San7o/Brenta-Engine.git
cd Brenta-EngineBuilding is done through cmake. To compile the dynamic
library, simply run:
cmake -Bbuild
cmake --build build -j$(nproc)For the static library:
cmake -Bbuild -DBUILD_SHARED_LIBS=off
cmake --build build -j$(nproc)To compile the examples:
cmake -Bbuild -DBRENTA_BUILD_EXAMPLES=on
cmake --build build -j$(nproc) --target <example-name>where example-name is the name of the .cpp
example file without extension.
To build tests:
cmake -Bbuild -DBRENTA_BUILD_TESTS=on
cmake --build build -j$(nproc)
./buid/tests --no-multithreadAdditionally, you can decide to compile with support for ImGUI with
BRENTA_BRENTA_USE_IMGUI and for the ECS library with
BRENTA_BRENTA_USE_ECS.
All binaries will be generated in build/ directory.
You can build the website and doxigen documentation
with:
make htmlThe index will be located in doc.//index.html.
To format the code using clang-format:
make format