############################################################
# Building Wyrmsun on Ubuntu 20.04 LTS
############################################################

We are going to download and compile Wyrmsun, the open-source retro RTS game.

This guide should work for all recent ubuntu versions (tested on 20.04).

Required disk space: about 1 GiB


1. Create empty directory:

  mkdir wyrmsun
  cd wyrmsun



2. Install git:

  sudo apt install git-core



3. Git clone the engine and data:

  git clone https://github.com/Andrettin/Wyrmgus.git
  git clone https://github.com/Andrettin/Wyrmsun.git



4. Prepare the compilation. Create build directory:

  mkdir build
  cd build



5. Install dependencies:

  cmake (3.5.1)
  liblua5.1-0-dev (5.1.5)
  libtolua++5.1-dev (1.0.93)
  zlib1g-dev (1.2.8)
  libsdl1.2-dev (1.2.15)
  libsdl-mixer1.2-dev
  libboost-dev
  qtbase5-dev
  qtlocation5-dev
  qtmultimedia5-dev
  qtpositioning5-dev

This is the absolute minimum, install all together with:

  sudo apt install cmake liblua5.1-0-dev libtolua++5.1-dev zlib1g-dev libsdl1.2-dev \
      libboost-dev qtbase5-dev qtlocation5-dev qtmultimedia5-dev qtpositioning5-dev



6. Let's compile! Run this in the build directory:

  cmake -DWITH_GEOJSON=OFF ..
  make

The build will take some time ...



7. If everything worked out you now have a 'wyrmgus' executable. Run the game with:

  ./wyrmgus -d ../../Wyrmsun

The game data will be stored in './wyr'


That's it, have fun playing!


