Vanadium::

V:: stands for Vanadium::

Description

Yet another custom "game engine" no one needed.
Friendly note: You probably shouldn't use it because the logic behind engine architecture is beyond human comprehension.

Requirements

• C++17 capable compiler.
• Cmake to compile the project.

How to clone

git clone --recursive --progress https://github.com/Kepler-Br/Vanadium

If you have already cloned this without submodules, use this:

git submodule update --init --recursive --progress

Compilation

Dependencies

Name	Licence
SDL2	zlib

Dependency installation on Ubuntu/Debian

apt install cmake libsdl2-dev

Dependency installation on MacOS

brew install cmake sdl2

Dependency installation on Windows

• Install MSYS2
• Open mingw64.exe in installed directory
• Install packages: pacman -S mingw-w64-x86_64-clang mingw-w64-x86_64-lld mingw-w64-x86_64-make mingw-w64-x86_64-polly mingw-w64-x86_64-compiler-rt mingw-w64-x86_64-SDL2

Dependencies included as sources or submodules

Name	Maintainer	Licence	Short description
stb	Sean Barrett	MIT/Public Domain	Single-file public domain libraries Only image part is used
glm	G-Truc	Modified MIT	OpenGL Mathematics
bgfx, bimg, bx	Бранимир Караџић	BSD 2-Clause	Cross-platform graphics API wrapper
spdlog	Gabi Melman	MIT	Logging library
imgui	Ocornut	MIT	Immediate mode GUI
fmt	fmt	MIT	String formatting
yaml-cpp	Jesse Beder	MIT	YAML processing
json	Niels Lohmann	MIT	JSON processing
xoshiro-cpp	Ryo Suzuki	MIT	Pseudo random generator
tinyxml2	Lee Thomason	zlib	XML processing
physfs	Icculus	zlib	Virtual file system
earcut.hpp (modified)	Mapbox	ISC	Vertex triangulation

Flags

Flag	Default	Meaning
-DMAKE_LOGS	ON	Make logs
-DBUILD_EXAMPLES	OFF	Build examples

Compilation on Linux/MacOS

mkdir build; cd build; cmake .. -DBUILD_EXAMPLES=ON && make -j

Compilation on Windows

• Launch MSYS2 MinGW through Windows start menu or execute file mingw64.exe manually from installation directory
• Navigate to Vanadium source directory using cd command.
• mkdir build; cd build
• cmake -G "MinGW Makefiles" ..
• mingw32-make -j
  Not tested after migration to bgfx.

Supported systems

System name	Runs
GNU/Linux based systems	Yes
MacOS	Yes
Windows	No
Emscripten	No

Supported render APIs

Pretty much everything that is supported by bgfx.