V-Gears Building GuideIf you are running Debian (or derivates), you can install the required dependencies by running as root
apt install g++ cmake libqt5widgets5 qtbase5-dev zlib1g-dev libarchive-dev libogre-1.12-dev libois-dev libvorbis-dev libboost-dev libboost-program-options-dev libboost-test-dev libboost-filesystem-dev libboost-thread-dev libopenal-dev libtinyxml-dev libluajit-5.1-dev
The data installer also needs FFmpeg and TiMidity (see Optional programs).
apt install ffmpeg timidity
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. The build uses a lot of memory, so on machines with little RAM, use a low number (-j2).
Once the build process finishes, you should have the following files (from the project directory):
build/bin/v-gears, the engine executable.build/bin/v-gears-installer, the data installer.If you build with -DCMAKE_BUILD_TYPE=Debug, they are in build/bin_debug/ instead.
The engine can be launched from anywhere: it finds its data directory (~/.v-gears/ by default) and fills it from the data/ folder of the repository the first time. See the run guide for details.
The tests are not built by default. To build and run the tests of the installer logic (the option rules, the installation layout, the verifier, the log, the tool finder and the movie camera data) and of the data directory and Ogre plugin lookup, which don't need the rest of the engine:
mkdir build-tests;
cd build-tests;
cmake ../ -DBUILD_TESTS=ON;
make v-gears-installer-tests;
./bin/v-gears-installer-tests
The engine tests (for example the movie state and camera frames) are in the v-gears-tests target, built the same way.
V-Gears can be packaged for Linux as a .deb package and as a .tar.gz archive. None of them includes data from the original game: the player still needs the data installer and their own copy of the game.
Use a separate Release build, so it doesn't interfere with your development build. From the project directory:
mkdir build-release;
cd build-release;
cmake ../ -DCMAKE_BUILD_TYPE=Release;
make -j4 v-gears v-gears-installer;
cpack;
The first build takes a while. Adjust -j as explained in Build using CMake.
When cpack finishes, build-release/ contains:
v-gears_<version>_amd64.deb, the Debian package.v-gears-<version>-Linux-x86_64.tar.gz, the archive..sha256 checksum file for each of them. Publish them along with the packages.The version is the one in the project() line of the main CMakeLists.txt. To make only one of the packages, use cpack -G DEB or cpack -G TGZ.
Both have the same files:
bin/v-gears and bin/v-gears-installer, the engine and the data installer.share/v-gears/, the V-Gears data files (configuration, scripts, screens, fonts...). The engine copies them to the user's data directory (~/.v-gears/) the first time it runs, and the data installer adds the game data there.share/doc/v-gears/, the documentation and the license.share/applications/ and share/icons/, the desktop files and the icons.The .deb installs them under /usr, so both programs show in the applications menu. Install it with apt, so it installs the dependencies too:
sudo apt install ./v-gears_<version>_amd64.deb
The .tar.gz has the same layout in a single folder. It can be extracted anywhere and run from there (bin/v-gears, bin/v-gears-installer), without root. It doesn't add anything to the applications menu.
The Ogre plugins (RenderSystem_GL, Codec_STBI) are not in the packages: the engine loads the ones of the system's Ogre.
The packages don't include any library: they use the ones installed in the system. The dependencies of the .deb are taken from the libraries the programs were built with, so it can only be installed in systems that have the same versions (the same Ogre and Boost versions, especially). In practice, the packages work in the same distribution and version where they were built.
To make packages for a given distribution, build them in that distribution, for example in a container or a virtual machine. The .tar.gz has the same limits, but it gives no warning: if a library is missing, the programs don't start.
These can be set when running cmake (-D<option>=<value>):
|Option|Default|Description|
|--|--|--|
|CMAKE_BUILD_TYPE|Release|Use Release for packages. With Debug, the programs are slower and the archive name ends in -debug.|
|VGEARS_OGRE_PLUGIN_DIR|Found at build time|Directory of the system's Ogre plugins. The engine looks for the plugins there after its data directory and its own directory. Set it if the plugins of the target system are in another place.|
|VGEARS_PACKAGE_MAINTAINER|The project maintainer|Name and email of the maintainer in the .deb.|
To install V-Gears directly in the system, with the same files and layout as the packages, run this from the build directory:
sudo cmake --install . --prefix /usr/local
You don't need this for a normal build. It only matters if CMake can't find a library that is installed.
The CMake scripts include an option USE_DETERMINISTIC_FALLBACKS (default ON).
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).OFF, CMake will not perform these fallbacks; instead require proper
dev packages or explicit hints.Leave it ON for now, also for packages. On Linux, the regular library detection in src/CMakeLists.txt is skipped because of a known bug in the script, so with the fallbacks OFF the build fails to link Boost and OgreBites.
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.
To convert the sound effects, the music and the videos, the installer uses FFmpeg and TiMidity. They are not needed to build V-Gears, only to install the data. In Debian (or derivates):
apt install ffmpeg timidity
See the data installation guide.