How to build VCMI (Linux)

From VCMI Project Wiki
Revision as of 06:09, 17 August 2023 by Runlevel5 (talk | contribs) (Update instructions how to build RPM)
Jump to: navigation, search

Compiling VCMI

  • Current baseline requirement for building is Ubuntu 20.04
  • Supported C++ compilers for UNIX-like systems are GCC 5.5+ and Clang 13+

Older distributions and compilers might work, but they aren't tested by Travis CI

Installing dependencies


To compile, the following packages (and their development counterparts) are needed to build:

  • CMake 3.10 or newer
  • SDL2 with devel packages: mixer, image, ttf
  • zlib and zlib-devel
  • Recommended, if you want to build launcher or map editor: Qt 5, widget and network modules
  • Recommended, FFmpeg libraries, if you want to watch in-game videos: libavformat and libswscale. Their name could be libavformat-devel and libswscale-devel, or ffmpeg-libs-devel or similar names.
  • Boost C++ libraries v1.48+: program-options, filesystem, system, thread, locale
  • Optional, if you want to build scripting modules: LuaJIT

On Debian-based systems (e.g. Ubuntu)

For Ubuntu 22.04 (jammy) or newer you need to install this list of packages, including libtbb2-dev:

sudo apt-get install cmake g++ libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libsdl2-mixer-dev zlib1g-dev libavformat-dev libswscale-dev libboost-dev libboost-filesystem-dev libboost-system-dev libboost-thread-dev libboost-program-options-dev libboost-locale-dev qtbase5-dev libtbb2-dev libluajit-5.1-dev qttools5-dev 

For Ubuntu 21.10 (impish) or older and all versions of Debian (9 stretch - 11 bullseye) you need to install this list of packages, including libtbb-dev:

sudo apt-get install cmake g++ libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libsdl2-mixer-dev zlib1g-dev libavformat-dev libswscale-dev libboost-dev libboost-filesystem-dev libboost-system-dev libboost-thread-dev libboost-program-options-dev libboost-locale-dev qtbase5-dev libtbb-dev libluajit-5.1-dev qttools5-dev 

Alternatively if you have VCMI installed from repository or PPA you can use:

sudo apt-get build-dep vcmi

On RPM-based distributions (e.g. Fedora)

sudo yum install cmake gcc-c++ SDL2-devel SDL2_image-devel SDL2_ttf-devel SDL2_mixer-devel boost boost-devel boost-filesystem boost-system boost-thread boost-program-options boost-locale zlib-devel ffmpeg-devel ffmpeg-libs qt5-qtbase-devel tbb-devel luajit-devel fuzzylite-devel

NOTE: `fuzzylite-devel` package is no longer available in recent version of Fedora, for example Fedora 38. It's not a blocker because VCMI bundles fuzzylite lib in its source code.

On Arch-based distributions

On Arch-based distributions, there is a development package available for VCMI on the AUR.

It can be found at:

Information about building packages from the Arch User Repository (AUR) can be found at the Arch wiki.

Manual Installation

For older OS versions the latest prerequisite packages may not be readily available via the system installer. Some brief instructions for manual install are given below (tested on Ubuntu 14.04, update version numbers as desired).

tar xfz cmake-3.11.0.tar.gz
cd cmake-3.11.0
make -j2
sudo checkinstall --pkgname cmake --pkgversion 3.11.0 -y

Note: Will only be visible in new terminals. Test with cmake --version.

tar xfz boost_1_66_0.tar.gz
cd boost_1_66_0
./ --with-libraries=program-options,filesystem,system,thread,locale
sudo ./b2 install

Note: Boost 1.66.0 produces a bug in asio.hpp when used with old gcc versions (see

  • GCC (for Ubuntu - compile from source is lengthy)
sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt-get update
sudo apt-get install gcc-7 g++-7
sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-7 70 --slave /usr/bin/g++ g++ /usr/bin/g++-7

Note: Test with gcc --version (and g++ --version).

  • Clang (for Ubuntu 14.04 - for later versions first line is not needed, and 'trusty' should be replaced with version name)
sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo add-apt-repository "deb llvm-toolchain-trusty-6.0 main"
sudo apt-get update
sudo apt-get install clang-6.0
sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-6.0 60 --slave /usr/bin/clang++ clang++ /usr/bin/clang++-6.0

Note: Test with clang --version (and clang++ --version).

Getting the sources

VCMI is still in development. We recommend the following initial directory structure:

├── vcmi -> contains sources and is under git control
└── build -> contains build output, makefiles, object files,...

You can get latest sources with:

git clone -b develop --recursive


Configuring Makefiles

mkdir build && cd build
cmake ../vcmi

# Additional options that you may want to use:
## To enable debugging:
cmake ../vcmi -DCMAKE_BUILD_TYPE=Debug

Notice: The ../vcmi/ is not a typo, it will place makefile scripts into the build dir as the build dir is your working dir when calling CMake.

Trigger build

cmake --build . -- -j2
# -j2 = compile with 2 threads, you can specify any value

That will generate vcmiclient, vcmiserver, vcmilauncher as well as 4 .so libraries in build/bin/ directory.

Package building

RPM package

The first step is to prepare a RPM build environment. On Fedora systems you can follow this guide:

0. Enable RPMFusion free repo to access to ffmpeg libs:

sudo dnf install \$(rpm -E %fedora).noarch.rpm

NOTE: the stock ffmpeg from Fedora repo is no good as it has stripped lots of codecs

1. Perform a git clone from a tagged branch for the right Fedora version from; for example for Fedora 38:
git clone -b f38 --single-branch
2. Copy all files to ~/rpmbuild/SPECS with command:
cp vcmi/*  ~/rpmbuild/SPECS

3. Fetch all sources by using spectool:

sudo dnf install rpmdevtools
spectool -g -R ~/rpmbuild/SPECS/vcmi.spec

4. Fetch all dependencies required to build the RPM:

sudo dnf install dnf-plugins-core
sudo dnf builddep ~/rpmbuild/SPECS/vcmi.spec

4. Go to ~/rpmbuild/SPECS and open terminal in this folder and type: `rpmbuild -ba ~/rpmbuild/SPECS/vcmi.spec`

5. Generated RPM is in folder ~/rpmbuild/RPMS

If you want to package the generated RPM above for different processor architectures and operating systems you can use the tool mock. Moreover, it is necessary to install mock-rpmfusion_free due to the packages ffmpeg-devel and ffmpeg-libs which aren't available in the standard RPM repositories(at least for Fedora). Go to ~/rpmbuild/SRPMS in terminal and type:

mock -r fedora-38-aarch64-rpmfusion_free path_to_source_RPM
mock -r fedora-38-x86_64-rpmfusion_free path_to_source_RPM

For other distributions that uses RPM, chances are there might be a spec file for VCMI. If there isn't, you can adapt the RPMFusion's file

Available root environments and their names are listed in /etc/mock.


1. Install debhelper and devscripts packages

2. Run dpkg-buildpackage command from vcmi source directory

sudo apt-get install debhelper devscripts
cd /path/to/source

To generate packages for different architectures see "-a" flag of dpkg-buildpackage command


To compile using Doxygen, the UseDoxygen CMake module must be installed. It can be fetched from:

Once UseDoxygen is installed, run:

cmake .
make doc

The built documentation will be available from ./doc