Spirit

A 3D game engine targeting Linux and Windows. This is a hobby project evolving as I learn, build, and break things along the way.

Requirements

Git (Submodules)
CMake 3.22
C++ 20 compliant compiler _{(GCC 13 | CLANG 14 | MSVC 16.10)}

Setup

1. Clone repository with submodules.
   git clone https://github.com/MStachowicz/Spirit.git --recursive
2. Generate In terminal use:
   cmake -B Build OR Open in an editor supporting CMakePresets.json
3. Open Spirit.exe inside the build directory

Dependencies

A list of the submodules used:
GLFW - GL/GLES/Vulkan API for creating windows, contexts, reading input, handling events.
GLAD - GL/GLES/EGL/GLX/WGL Loader/Generator.
GLM - Math library.
ImGui - Immediate mode data-centric UI to display the editing interface in debug builds.
STB - Image file loading utility.
ASSIMP - Model file loading utility.

The single root CMakeLists.txt is responsible for building all the dependencies.