Version 384 (modified by Silier, 3 years ago) ( diff )

--

This page describes how to install the latest development version of the code. This may be unstable and is intended for those that want to actively follow or contribute to the software development. To install the latest alpha release, Download the Latest Alpha instead.

The development version of the game is aimed at software developers (not regular players). As such, these instructions assume a higher level of technical proficiency. If you encounter difficulties, please consult the forum.

System requirements

You'll need:

  • An adequately high-spec computer:
    • At least 30 GB of free disk space
    • At least 1 GB of RAM for compiling, more if compiling multiple jobs in parallel (using -j)
    • 32 or 64-bit x86-compatible CPU, or an ARMv5+ processor
    • Modern graphics hardware is also recommended, though the game can run (slowly) on fairly old devices (GeForce 4, Intel 945GM, etc)
  • One of the following operating systems:
  • Up-to-date system software (Windows service packs, graphics driver updates, etc)
  • Some technical proficiency. We try to make the build process as smooth and painless as possible, but it's designed to be followed by programmers - if you just want to play the game, wait for a pre-packaged installer instead.

Introduction

The development environment for 0 A.D. is comprised of three layers. Each goes on top of the previous:

  1. Libraries.
  2. Workspaces.
  3. Source code.

Libraries are external dependencies (such as SpiderMonkey). For Windows and Linux, the script to create or update the Workspaces also handles installation and updating of libraries. For macOS, the libraries/osx/build-osx-libs.sh script should be used instead.

Workspaces contain the integrations for code editors (such as Visual Studio, Xcode, etc.) as well as the Makefile for the main source code. The workspaces are auto-generated by the update-workspaces script from the buids/workspaces/ directory. Once ready, the integrations are ready for use, such as build/workspaces/gcc/Makefile (for Linux and macOS) and build\workspaces\vs2017 (for Windows).

Finally, the source code is build by the workspace. For example, by running make in build/workspaces/gcc.

Windows

The main supported versions are:

  • Windows 10
  • Windows 8.1
  • Windows 8
  • Windows 7

If you want to develop, the only supported IDE is:

  • Visual C++ 2017

Important notes:

  • We have dropped support for older versions of Visual Studio when moving to C++14, see #5862.
  • XP and Vista are supported as targets, but not for installing Visual Studio 2017.
  • Only 32-bit builds are supported, though they can be compiled and run on 64-bit Windows.

Getting the code

See Getting the Code.

Setting up the build environment

The game must be compiled with Microsoft Visual C++. You can get the free 2017 Community edition here: Visual Studio older downloads. You can also install Visual Studio 2019 and choose to install the 2017 compiler (version 14.0).

The Visual Studio project/solution files are automatically generated from the source files:

Build configuration

Make sure to select the "Release" configuration to build an optimized, more playable version of the game (the target will be pyrogenesis.exe). The "Debug" configuration can be more useful for debugging but has significantly reduced performance (the target will be pyrogenesis_dbg.exe). Both "Release" and "Debug" builds include debug symbols, see Debugging and Debugging on Windows for more details on debugging.

Now you should be able to build the code from within Visual Studio, using "Build Solution" (F7).

Building Atlas

If you also wish to test the Atlas Scenario Editor or Actor Editor tools, you will need to download and build the wxWidgets library separately (version 3.0 and above; see ps\libraries\win32\wxwidgets\README.txt for details), then supply the --atlas option when running update-workspaces.bat. Atlas projects will now be included when you open pyrogenesis.sln in Visual C++.

Running

Run the game with F5 inside Visual Studio (assuming "pyrogenesis" is set as the startup project, which is default). If you want to run it outside the debugger, run binaries\system\pyrogenesis_dbg.exe.

To run the automated tests, run the "test" project. (Right click on "test" and "set as StartUp Project" and F5; or right click, "Debug", "Start new instance"). In VS's debug output window, ignore any "first-chance exception" messages; it should say ".......OK!" if it succeeded.

Keeping up to date

After you've set everything up, the process for staying up to date is:

  • Update the root directory of the checkout.
  • Close the solution in Visual Studio if you've got it open. Run update-workspaces.bat again. (This is only needed if any source files have been added or removed. If you forget to run this, you'll probably get build errors about missing symbols.)
  • Build again.

Building Windows dependencies

By default windows come with prebuilt libraries but you might want to rebuild them yourself, to do so follow the instructions at BuildingWindowsDependencies.

Linux

0 A.D. should work on any reasonably modern Linux distro, on x86 and x86_64 (amd64). The details depend on exactly which distro you use.

Dependencies

First you need to install various standard tools and development libraries:

  • a C++17 conforming compiler
  • the rust compiler and toolchain
  • Boost (at least 1.57 since r21726)
  • CMake (only needed if you use bundled NVTT)
  • Python 2.7 (required for cxxtest and non-system SpiderMonkey 45)
  • libcurl (at least 7.32)
  • libenet (1.3, the older 1.2 is not compatible)
  • libfmt (at least 4.0)
  • libgloox (needed for the lobby; at least 1.0.10, previous versions are know to have connection problems; pass --without-lobby to update-workspaces.sh to exclude the lobby)
  • libicu
  • libogg
  • libpng
  • libsodium (>= 1.0.14, follow the instructions at https://download.libsodium.org/doc/installation/ if your distro is behind)
  • libvorbis
  • libxml2
  • miniupnpc (at least 1.6)
  • OpenAL
  • OpenGL
  • SDL2 (at least 2.0.2)
  • Subversion (or git if you want to use the Git mirror; see below)
  • zlib

To compile editing tools (enabled by default; pass the flag --disable-atlas to update-workspaces.sh to disable):

  • wxWidgets (at least 3.0; packages are probably called wxgtk)

To use shared system libraries instead of bundled copies (default) of libraries (pass the flag --with-system-$COMPONENT to update-workspaces.sh to use the non-bundled copy):

  • SpiderMonkey 68 (--with-system-mozjs)
  • NVTT (--with-system-nvtt) Note: the version of NVTT provided by your package manager is probably too old and we don't check it yet (#5757).

For a list of all options to update-workspaces.sh see premake.

Debian / Ubuntu

  • On Debian 10 (Buster) or Ubuntu 18.04 LTS (Bionic Beaver) or later install the required dependencies with:
    sudo apt-get install build-essential cmake libboost-dev libboost-system-dev   \
        libboost-filesystem-dev libcurl4-gnutls-dev libenet-dev libfmt-dev   \
        libgloox-dev libicu-dev libminiupnpc-dev libnvtt-dev libogg-dev   \
        libopenal-dev libpng-dev libsdl2-dev libsodium-dev libvorbis-dev   \
        libxml2-dev python rustc subversion zlib1g-dev
    
    • With these dependencies you have to run:
      • ./update-workspaces.sh --with-system-nvtt
      • If the game crashes at startup (#5757), you might need to use the bundled NVTT instead of the system-provided one: see below.
  • If you want to use a packaged SpiderMonkey, which will be made available for example in 0ad.dev PPA:
    • you should add libmozjs-68-dev and run update-workspace.sh with --with-system-mozjs.
  • When not using system nvidia-texture-tools, libnvtt-dev can be omitted, but cmake is needed to build the bundled NVTT.
  • You can also use libcurl4-openssl-dev instead of libcurl4-gnutls-dev (it's not possible to install both at once), but note that openssl is not GPL compatible and the resulting binaries could not be redistributed.
  • Finally you need to install the WX libraries for Atlas:
    sudo apt install wx3.0-headers libwxbase3.0-dev libwxgtk3.0-gtk3-dev libwxbase3.0-0v5 libwxgtk3.0-gtk3-0v5
    

Mandriva

TODO: outdated, please update

Install the dependencies with:

urpmi gcc-c++ python subversion zip cmake boost-devel libcurl-devel         \
    libenet-devel libgloox-devel libpng-devel libsodium-devel libvorbis-devel \
    libxml2-devel libwxgtku2.8-devel openal-soft-devel libicu-devel

Fedora

Install the dependencies with:

sudo dnf install gcc-c++ rust cargo python subversion zip cmake patch   \
    boost-devel libcurl-devel enet-devel libpng-devel libsodium-devel libvorbis-devel \
    libxml2-devel openal-soft-devel pkgconfig SDL2-devel wxGTK3-devel  \
    gloox-devel libicu-devel miniupnpc-devel fmt-devel
  • To submit a patch for review via arcanist (Phabricator), php is needed: dnf install php-cli php-json php-xml.

openSUSE

Install the dependencies with:

sudo zypper install gcc-c++ python subversion zip cmake boost-devel         \
    libcurl-devel libenet-devel libpng-devel libsodium-devel libvorbis-devel  \
    libxml2-devel openal-soft-devel pkg-config wxWidgets-devel libSDL2-devel     \
    gloox-devel libicu-devel miniupnpc-devel libfmt-devel

ArchLinux

pacman -S --needed boost cmake curl enet fmt gcc gloox icu libgl libogg libpng libsodium libvorbis libxml2 miniupnpc patch sdl2 subversion wxgtk zip zlib make python python2 pkg-config grep awk

Solus

sudo eopkg install libboost-devel curl-devel enet-devel gloox-devel libicu-devel libogg-devel libpng-devel libsodium-devel libvorbis-devel libxml2-devel miniupnpc-devel openal-soft-devel mesalib-devel sdl2-devel zlib-devel wxwidgets-devel libgnutls-devel fmt-devel

Slackware

After installing the dependencies for your particular version, you can build 0 A.D. from the svn code using the instructions from the Building section.

Note: These instructions have been tested on the 64-bit version of Slackware.

Slackware 14.2

If you've done the full install of Slackware, most of the dependencies are already installed. The other required dependencies you can install from the Slackbuilds repo using sbopkg:

  • enet
  • fmt
  • gloox
  • libsodium
  • miniupnpc
  • OpenAL
  • SDL2

Required to build Atlas:

  • wxGTK3 (install/build this first, required by wxPython3)
  • wxPython3

0 A.D. will produce a segmentation fault if you try to connect to lobby with TLS enabled. Though it was reported to work if compiled against the dependencies below.

Default 14.2 packages:

a/sed-4.2.2-x86_64-1.txz
d/binutils-2.26-x86_64-3.txz
d/cmake-3.5.2-x86_64-1.txz
d/flex-2.6.0-x86_64-1.txz
d/guile-2.0.11-x86_64-2.txz
d/make-4.1-x86_64-2.txz
d/perl-5.22.2-x86_64-1.txz
d/python-2.7.16-x86_64-1_slack14.2.txz
d/python-setuptools-22.0.5-x86_64-1.txz
l/boost-1.59.0-x86_64-1
l/icu4c-56.1-x86_64-2
l/libogg-1.3.2-x86_64-1
x/libSM-1.2.2-x86_64-2.txz
x/mesa-11.2.2-x86_64-1.txz

Upgraded packages:

OpenAL-1.18.1-x86_64-1alien.txz
curl-7.64.0-x86_64-2_slack14.2.txz
enet-1.3.12-x86_64-1_slonly.txz
gcc-5.5.0-x86_64-1_slack14.2.txz
gcc-g++-5.5.0-x86_64-1_slack14.2.txz
libpng-1.6.27-x86_64-1_slack14.2.txz
libsodium-1.0.16-x86_64-1_slonly.txz
libvorbis-1.3.6-x86_64-1_slack14.2.txz
libxml2-2.9.5-x86_64-1_slack14.2.txz
libzip-1.0.1-x86_64-3_slack14.2.txz
miniupnpc-2.0-x86_64-1_slonly.txz
pip-9.0.3-x86_64-1_slonly.txz
pkg-config-0.29.2-x86_64-1_slack14.2.txz
premake-4.4_beta5-x86_64-1_slonly.txz
sdl2-2.0.3-x86_64-1jsc.txz
wxGTK3-3.0.4-x86_64-2ponce.txz
zlib-1.2.11-x86_64-1_slack14.2.txz

Special packages:

gloox-1.0.22-x86_64-1_SBo.tgz
kernel-headers-4.4.157-x86-1.txz

Notes:

Gloox 1.0.22 was created using this Slackbuild. Just open the Slackbuild script and change version from 1.0.13 to 1.0.22 and compile with this tarball.

Kernel headers must match your kernel version.

Slackware-current

Presently, 0 A.D. does not build on Slackware-current. If you'd like to help with the ticket, please contact us.

If you attempt to build on Slackware-current, install the dependencies listed above with sbopkg, but skip libsodium and sdl2; they are already distributed with Slackware-current.

CentOS

Discussion of installing on CentOS 7 can be found on the forums here.

Note: The advice below is derived from installing in a Virtual Machine with CentOS 7 64-bit minimally installed. If you have CentOS 6 (or earlier), the following steps may not be possible. Installation on a physical machine, a machine with more stuff already installed upon it, or a machine that is 32-bit, may differ slightly.

  1. Firstly, you will need to enable the "Extra Packages for Enterprise Linux" (or "EPEL") repository (if you haven't already). You can do this by running (as root/via sudo)
    yum install epel-release
    
  1. Install some auxiliary packages. These are not dependencies of 0 A.D. itself, but are necessary to run update_workspaces.sh successfully. They might already be installed on your system:
    yum install bzip2 patch
    
  1. Install the 0 A.D. dependencies that are available directly from repos:
    yum install cmake gcc-c++ enet-devel libglvnd-devel gloox-devel libicu-devel \
         libogg-devel libpng-devel libsodium-devel libvorbis-devel libxml2-devel \
         miniupnpc-devel openal-soft-devel subversion wxGTK3-devel zlib-devel SDL2-devel
    
  1. Acquire a sufficiently recent version of libcurl:
    • From this site: https://mirror.city-fan.org/ftp/contrib/libraries/, download the two files that satisfy one of the following patterns:
      • libssh2-{version}.cf.rhel7.{arch}.rpm
      • libssh2-devel-{version}.cf.rhel7.{arch}.rpm
    • From this site: https://mirror.city-fan.org/ftp/contrib/sysutils/Mirroring/, download the three files that satisfy one of the following patterns:
      • curl-{version}.cf.rhel7.{arch}.rpm
      • libcurl-{version}.cf.rhel7.{arch}.rpm
      • libcurl-devel-{version}.cf.rhel7.{arch}.rpm
    • Install some dependencies from repos:
      yum install nss-devel libnghttp2 libpsl libmetalink
      
    • Install dependencies from downloaded packages.

      Note: This will replace the version of libssh2 that is provided by the CentOS official repos. This is necessary as the version of libcurl we're installing needs a more up-to-date version than what the official repos can provide. As the packages we've acquired are compiled as to be interoperable with CentOS systems, this shouldn't cause any problems with other programs installed on your system.

      Install the libssh2-* and libssh2-devel-* packages using rpm -Uvh. For example:
      rpm -Uvh libssh2-1.8.0-8.0.cf.rhel7.x86_64.rpm libssh2-devel-1.8.0-8.0.cf.rhel7.x86_64.rpm
      
    • Install the updated curl packages (curl-*, libcurl-* and libcurl-devel-*) using rpm -Uvh. For example:
      rpm -Uvh curl-7.61.1-3.0.cf.rhel7.x86_64.rpm libcurl-7.61.1-3.0.cf.rhel7.x86_64.rpm libcurl-devel-7.61.1-3.0.cf.rhel7.x86_64.rpm
      
  1. Acquire a sufficiently recent version of boost:
    • From https://www.boost.org/users/history/version_1_70_0.html, download boost_1_70_0.tar.gz.
    • Uncompress archive:
      • $ tar -xf boost_1_70_0.tar.gz
    • Enter folder:
      • $ cd ./boost_1_70_0
    • Compile the parts that are needed to be compiled, and install the libraries:
      • $ ./bootstrap.sh --with-libraries=filesystem,system
      • # ./b2 install
      • (Compiled files end up in /usr/local/lib/, header files in /usr/local/include/boost/)
    • Make sure the runtime linker can find the updated boost libraries:
      • Navigate to /etc/ld.so.conf.d and create a blank file called pyro.conf.
      • Within this file, enter the text /usr/local/lib and save.
  1. Acquire a sufficiently recent version of fmt:
  1. You should now have all dependencies for 0 A.D. Continue by getting the code, as described below. When you get to the part below in Building where you run ./update-workspaces.sh, you must use the argument --prefer-local-libs.

VoidLinux

sudo xbps-install -Syv base-devel boost-devel cmake curl fmt-devel gcc icu-devel libcurl-devel libenet-devel libogg-devel libopenal-devel libpng-devel libsodium-devel libvorbis-devel libxml2 MesaLib-devel miniupnpc-devel patch pkg-config SDL2-devel wxWidgets-devel zip zlib

If there are issues, install more header files depending on the compiler's error message. pyrogenesis requires MesaLib-devel to provide header files for libGL. Custom compile gloox for the Lobby or use xbps source packages or use update-workspaces.sh --without-lobby. If there are unresolved shlibs or an update breaks a package, then e.g.

sudo xbps-install -Syv SDL2-devel dbus dbus-x11  # credit Vaelatern
sudo xpbs-install -Su  # update, add -d for debugging, credit duncaen

Getting the code

See Getting the Code.

Building

Compile the code with:

cd 0ad/build/workspaces
./update-workspaces.sh -j3
cd gcc
make -j3
  • -j3 gives the number of parallel builds to run, and should typically be one plus the number of CPU cores available.
  • The Release mode builds (which are the default) are more optimised, but are harder to debug. Use make config=debug (and run pyrogenesis_dbg) if you need better debugging support. See Debugging for more details.

If you encounter any build errors, review the existing bug reports, check the known problems section or please file a new bug in the tracker.

Testing

Run the automated tests to verify that everything works as expected like this:

cd ../../..
binaries/system/test

Running

If everything went well, compiling the code worked and all tests passed, it's finally time to run the game:

binaries/system/pyrogenesis

Keeping up to date

If you want to rebuild quickly after updating from SVN, you can usually get away with:

svn up
cd build/workspaces
./update-workspaces.sh -j3
cd gcc
make -j3

If the make line gives errors, you may need to run make clean before it. If the update-workspaces.sh gives errors, you may need to run clean-workspaces.sh before it.

Creating Linux packages

If you want to create packages for a Linux distribution see the current 0ad and 0ad-data packages on Salsa for examples (especially the control and rules files).

OS X

macOS

The process on macOS is similar to Linux:

Dependencies

  1. Install Xcode, version 10.1+ is recommended. Only 10.13+ are supported to compile the game.
  2. Install the command line tools for Xcode:
    • Open a Terminal window and enter xcode-select --install.
  3. Install the rust toolchain.
  4. CMake:
    • (recommended) If you have Homebrew installed, use `brew install cmake`.
    • Alternatively, download a prebuilt macOS package at https://cmake.org/download/. If prompted, choose to install the "CMake command line tools" to the default location.
      • Note: Recent versions have no installer, so after copying the app bundle to Applications, you need to run CMake with elevated permissions to install the command line tools. From the terminal: sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install.
      • If the install command fails, you can manually add the following line to the end of /etc/paths: /Applications/CMake.app/Contents/bin.

Getting the code

See Getting the Code.

Now you have two options:

Build the game

  • Run libraries/osx/build-osx-libs.sh, the macOS libraries build script, this will download and build the game's dependencies (except CMake, see above). This script will take some time to finish when first run, after that it will reuse the old build.
    cd libraries/osx
    ./build-osx-libs.sh -j3
    
    • -j3 gives the number of parallel builds to run, and should typically be one plus the number of CPU cores available.
    • To force a rebuild for some reason, e.g. the SVN folder is moved or Xcode / macOS is upgraded, pass in the --force-rebuild flag.
  • Next, to build the game on the command line, use the following commands:
    cd build/workspaces
    ./update-workspaces.sh -j3
    cd gcc
    make -j3
    
  • Or if you have Xcode 4 installed, you can open build/workspaces/xcode4/pyrogenesis.xcworkspace (see discussion on this here).
  • Run the automated tests to verify that everything works as expected like this:
    binaries/system/test
    
  • If everything went well, compiling the code worked and all tests passed, it's finally time to run the game:
    binaries/system/pyrogenesis
    

Create macOS distributable app bundle

This is outdated and will soon change.

  • You will need Xcode installed (for its SDKs)
  • Open build/workspaces/build-osx-bundle.sh and read the comments. You will need to change a few settings depending on your version of macOS, Xcode, etc.
  • Run build-osx-bundle.sh, the bundle build script, which will download and build the game's dependencies for the appropriate SDK, build the game's source code, package the mod data, and set up the app bundle info.
    cd build/workspaces
    ./build-osx-bundle.sh -j3
    
  • -j3 gives the number of parallel builds to run, and should typically be one plus the number of CPU cores available.
  • When it's finished, there should be a complete 0ad app bundle in build/workspaces. You can open it by double-clicking its icon in Finder or with the open 0ad.app command in the terminal.
  • Consider the following to make an official release:
    • Use build-osx-bundle.sh --release, to create a bundle from a clean SVN working copy.
    • Package the bundle inside a compressed DMG with background image, for easy distribution (see ReleaseProcess).

BSD

Note: The *BSD support is a work in progress and should be considered experimental. That means don't try it unless you "know what you're doing" :)

TODO: outdated, please update (see #5255)

  • Install the following ports or packages (names probably differ depending on the BSD variant):
    Install commands for the variants are provided below.
    • boost-libs
    • cmake
    • curl (at least 7.32)
    • enet
    • execinfo
    • gloox
    • gmake
    • iconv
    • icu
    • libGL
    • libogg
    • libvorbis
    • libxml2
    • miniupnpc
    • openal
    • png
    • sdl2
    • subversion
    • wxWidgets-gtk2 (3.0 and above) - required to build the Atlas editor
    • zip
    • Note: zlib should already be installed by default
    • GCC 4.8.1+ or Clang
  • Obtain the game's source code as described above for Linux.
  • Check for any variant specific issues below.
  • Note: Our build scripts should detect that you are running *BSD and use gmake as the make command. If for some reason this isn't correct, you can set the MAKE environment variable to the correct GNU make path.
  • Follow the build instructions above for Linux.

FreeBSD

  • Install the dependencies with:
    pkg install boost-libs cmake curl enet fmt gloox gmake iconv libGL libogg          \
         libsodium libvorbis libxml2 miniupnpc openal pkgconf png sdl2 subversion        \
         wx30-gtk2 zip
    
  • If running FreeBSD 10.0+ you need to set CC to clang and CXX to clang++.
    export CC=clang CXX=clang++
    
  • TODO: Fix missing ecvt() (see #1325)
  • If building Atlas, you need to set the WX_CONFIG variable, because wx-config has a different name on FreeBSD. For example, you'd run this command if you built the wxGTK 2.8 package with unicode support:
    export WX_CONFIG=wxgtk2u-2.8-config
    
    if not correct, you will get errors about missing "wx/*.h" includes. You can skip building Atlas altogether (and the wxWidgets dependency) by later passing the --disable-atlas option to update-workspaces.sh.
    • You'll have to set this variable every time you run update-workspaces.sh, so it may be most convenient to put these commands into another shell script.

OpenBSD

  • You need to set CC and CXX before building
    export CC=egcc CXX=eg++
    
  • Install the dependencies with:
    pkg_add -i boost cmake curl enet fmt g++ gcc gloox gmake icu4c libexecinfo libogg \
        libsodium libxml miniupnpc openal png sdl2 subversion zip
    
  • As OpenBSD's packaged libxml isn't build with threading support, building Atlas is not possible so you should run update-workspaces.sh with the --disable-atlas option.
  • You probably need to run pyrogenesis with LD_PRELOAD=/usr/local/lib/libogg.so.6.2:/usr/local/lib/libvorbis.so.8.0 (see #1463).

Known problems and solutions

  • None currently.
Note: See TracWiki for help on using the wiki.