V-Gears/doc/BUILD.md

V-Gears Building Guide

Install dependencies

If you are runind Debian (or derivates), you can install the required dependencies by running as root

apt install g++ cmake libqt5widgets5 qtbase5-dev zlib1g-dev libogre-1.12-dev libois-dev libvorbis-dev libboost-dev libboost-program-options-dev libboost-test-dev libboost-filesystem-dev libboost-thread-dev lua5.2 liblua5.2-dev libluabind-dev luajit libopenal-dev libtinyxml-dev

Deterministic fallbacks

The CMake scripts include an option USE_DETERMINISTIC_FALLBACKS (default ON).

• When ON, CMake will attempt pragmatic fallbacks to find libraries when find_package/pkg-config do not succeed (SONAME find_library passes, appending common /usr/lib paths, or injecting generic -lboost_* flags).
• When OFF, CMake will not perform these fallbacks; instead require proper dev packages or explicit hints (recommended for CI and packaging).

Disable fallbacks example:

cmake .. -DUSE_DETERMINISTIC_FALLBACKS=OFF -DCMAKE_BUILD_TYPE=Release

If you see warnings about missing Boost or OgreBites, prefer installing the appropriate -dev packages listed above, or point CMake at your OGRE/Boost installation with -DOGRE_ROOT=... and -DBoost_DIR=.../-DBoost_LIBRARY_DIRS.

Build using CMake

From the project directory, run these commands:

mkdir build;
cd build;
cmake ../;
make;

If you want to speed it up a bit (it can take several minutes, depending on your system), you can add the parameter -j to make to use multiple threads. For instance, make -j3 will use three cores for the compilation.

Once the build process finishes, you u sholh have the following files (from the project directory):

• build/bin/v-gears, the engine executable.
• build/bin/v-gears-launcher, the data installer.

Both the engine and the installer are a little pesky about from where they are launched, so before trying to run them, keep reading.

Next steps

• Install V-Gears
• Install data
• Run V-Gears