Romain BOULLARD
b5c2e4936b
SonarQube step only on push to main Trigger Infer/Clang-Tidy also in PR Reviewed-on: #11 Co-authored-by: Romain BOULLARD <romain.boullard@protonmail.com> Co-committed-by: Romain BOULLARD <romain.boullard@protonmail.com>
Bigfoot
A multiplatform 3D game engine
Goals
The goal is to build a multiplatform, API agnostic, 3D engine. Since this is a learning project, I don't aim to provide a viable option to build actual commercial games with it. This also means that I am providing the project as is, with no support whatsoever.
Building
Requirements
- ConanV2
- Vulkan SDK (If you target Vulkan)
- CMake
- Git
- Python3
Additional requirements for Linux
Note: you can modify the conan profile used to overcome these requirements. But I provide no support for anything else than what's listed here
Additional requirements for Windows
- MSVC
Note: you can modify the conan profile used to overcome these requirements. But I provide no support for anything else than what's listed here
Generating the dependencies for Bigfoot
Use generate_dependencies.sh or generate_dependencies.bat (depending on your platform). These scripts will download/build/install any necessary dependency, using Conan. The recipes used will come from my own conan recipe center
You will need to provide the 'force' or 'missing' parameters to these scripts. I'd recommand for a first run to use 'force' to build all dependencies, and on subsequent runs to use 'missing' to build only missing parameters
./generate_dependencies.sh force
or
./generate_dependencies.sh missing
You can customize these scripts to opt-out of some Bigfoot features
'Just' modify these lines to disable them (I promise to one day modify the script to do it from the command line)
-o bigfoot/*:build_tests=True -o bigfoot/*:tracy=True -o bigfoot/*:build_tools=True -o bigfoot/*:vulkan=True -o bigfoot/*:build_benchmarks=True
- build_tests: Enable/Disable the tests
- tracy: Enable/Disable profiling using Tracy
- build_tools: Enable/Disable the tools (I'd absolutely recommand not disabling this)
- vulkan: Enable/Disable Vulkan renderer (No point disabling it, since for now only Vulkan is available in Bigfoot)
- build_benchmarks: Enable/Disable the benchmarks
Generating Bigfoot
Use generate_bigfoot.sh or generate_bigfoot.bat (depending on your platform) to generate the build files for Bigfoot.
You will then be able to use either Visual Studio (Windows) or Ninja (Linux) to build BigFoot