# V-Gears V-Gears Building Guide ## Install dependencies If you are running Debian (or derivates), you can install the required dependencies by running as root ```bash 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](#optional-programs)). ```bash apt install ffmpeg timidity ``` ## Build using CMake From the project directory, run these commands: ```bash 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](RUN.md "Run V-Gears") for details. ## Run the tests (optional) 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: ```bash 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. ## Make packages (optional) 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. ### Build the packages Use a separate Release build, so it doesn't interfere with your development build. From the project directory: ```bash 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](#build-using-cmake). When `cpack` finishes, `build-release/` contains: - `v-gears__amd64.deb`, the Debian package. - `v-gears--Linux-x86_64.tar.gz`, the archive. - A `.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`. ### What's in the packages 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: ```bash sudo apt install ./v-gears__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. ### Which systems can use them 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. ### Packaging options These can be set when running `cmake` (`-D