Compile GZDoom on Linux

From ZDoom Wiki
Jump to: navigation, search

Open a terminal and copy and paste the whole code box for each step.

Notes

The minimum requirement for GZDoom 2.2 and later is OpenGL 2.0, so if you get the following error:

Unsupported OpenGL version.

At least OpenGL 2.0 is required to run GZDoom.

you will have to use #GZDoom 1.8.6 instead. Keep in mind that this version is several years old and no longer maintained. It will also have problems with more recent actively maintained mods.

Install dependencies

GZDoom requires some tools and development files in order to compile:

  • gcc 4.8 or later
  • make
  • cmake 2.8.7 or later
  • SDL 2.0.2 or later
  • SDL 1.2.8 or later 1.2.x versions (optional - for GZDoom 1.x)
  • libGL and libGLU (SDL or libSDL pull in libGLU); or any other GL implementation provider.
  • fmodex 4.36.* or later
  • nasm 0.98.39 or later (optional)
  • GTK3 or GTK2 (optional)
  • zlib (optional - possibly static)
  • libbzip2 (optional - possibly static)
  • libjpeg (optional - possibly static)
  • gxmessage (optional - needed to show the crash log in a window)
  • git (needed in order to download the source)
  • fluidsynth (optional)
  • libgme or game-music-emu (optional - possibly static)
  • libglew (optional - for GZDoom 1.x)
  • libopenal (optional)
  • timidity (optional)
  • wildmidi (optional - possibly static)
  • libmpg123 (optional)
  • libsndfile (optional)

Install the following as root/superuser:

Debian/Ubuntu

sudo apt-get install build-essential zlib1g-dev libsdl1.2-dev libsdl2-dev libjpeg-dev \
nasm tar libbz2-dev libgtk-3-dev cmake git libfluidsynth-dev libgme-dev \
libopenal-dev libmpg123-dev libsndfile1-dev timidity libwildmidi-dev \
libgl1-mesa-dev libglew-dev

Fedora

dnf install gcc-c++ make zlib-devel SDL-devel SDL2-devel libjpeg-turbo-devel \
nasm tar bzip2-devel gtk3-devel cmake git fluidsynth-devel game-music-emu-devel \
openal-soft-devel libmpg123-devel libsndfile-devel timidity++ wildmidi-devel \
mesa-libGL-devel glew-devel

openSUSE

zypper install gcc-c++ make zlib-devel libSDL-devel libSDL2-devel libjpeg-devel \
nasm tar libbz2-devel gtk3-devel cmake git fluidsynth-devel libgme-devel \
openal-soft-devel mpg123-devel libsndfile-devel timidity \
Mesa-libGL-devel glew-devel

Mageia

a='' && [ "$(uname -m)" = x86_64 ] && a=64
urpmi gcc-c++ make lib"$a"zlib-devel lib"$a"SDL-devel lib"$a"sdl2.0-devel \
lib"$a"jpeg-devel nasm tar lib"$a"bzip2-devel lib"$a"gtk+3.0-devel cmake git \
lib"$a"fluidsynth-devel lib"$a"gme-devel lib"$a"openal-devel \
lib"$a"mpg123-devel lib"$a"sndfile-devel TiMidity++ lib"$a"wildmidi-devel \
lib"$a"mesagl1-devel lib"$a"glew-devel lib"$a"cairo-devel

Arch Linux

pacman -S --needed gcc make zlib sdl sdl2 libjpeg-turbo nasm tar bzip2 gtk3 cmake git \
fluidsynth libgme openal mpg123 libsndfile timidity++ wildmidi mesa glu glew

Gentoo

emerge -avn sys-devel/gcc sys-devel/make sys-libs/zlib media-libs/libsdl media-libs/libsdl2 media-libs/libjpeg-turbo \
dev-lang/nasm app-arch/tar app-arch/bzip2 x11-libs/gtk+ dev-util/cmake dev-vcs/git media-sound/fluidsynth \
media-libs/game-music-emu media-libs/openal media-sound/mpg123 media-libs/libsndfile media-sound/timidity++ media-sound/wildmidi \
media-libs/mesa media-libs/glu media-libs/glew

Update (29.12.2016): Jacendi overlay has an ebuild for gzdoom

emerge -n layman
layman -a jacendi-overlay
emerge -av gzdoom

PCLinuxOS

a='' && [ "$(uname -m)" = x86_64 ] && a=64
apt-get install gcc-c++ make zlib1-devel lib"$a"SDL-devel lib"$a"sdl2.0-devel \
lib"$a"jpeg62-devel nasm tar lib"$a"bzip2-devel lib"$a"gtk+3.0-devel cmake git \
lib"$a"fluidsynth1-devel lib"$a"openal-devel lib"$a"mpg123-devel lib"$a"sndfile-devel TiMidity++ \
lib"$a"mesagl1-devel lib"$a"glew-devel

Do the following steps as normal user.

Make gzdoom_build directory

mkdir -pv "$HOME"/gzdoom_build

Download the Source

Download the GZDoom source and make build directory:

cd "$HOME"/gzdoom_build && \
git clone git://github.com/coelckers/gzdoom.git && \
mkdir -pv gzdoom/build

and run the following commands:

cd gzdoom
git config --local --add remote.origin.fetch +refs/tags/*:refs/tags/*
git pull

Download FMOD

You can skip this step if you want to compile GZDoom with OpenAL support only. If afterwards you want FMOD support, go to the build directory, remove CMakeCache.txt, download and unpack the FMOD package and compile GZDoom.

Download FMOD and extract files to gzdoom directory:

cd "$HOME"/gzdoom_build && \
wget -nc http://zdoom.org/files/fmod/fmodapi44464linux.tar.gz && \
tar -xvzf fmodapi44464linux.tar.gz -C gzdoom

FMOD Link

FMOD 4.44.64 32-bit and 64-bit:
http://zdoom.org/files/fmod/fmodapi44464linux.tar.gz

Compiling

To compile the development version:

cd "$HOME"/gzdoom_build/gzdoom/build && \
a='' && [ "$(uname -m)" = x86_64 ] && a=64 ; \
make clean ; \
cmake -DCMAKE_BUILD_TYPE=Release \
-DFMOD_LIBRARY="$HOME"/gzdoom_build/gzdoom/fmodapi44464linux/api/lib/libfmodex"$a"-4.44.64.so \
-DFMOD_INCLUDE_DIR="$HOME"/gzdoom_build/gzdoom/fmodapi44464linux/api/inc .. && \
make

Assuming all goes well, a gzdoom binary should be produced. To start GZDoom, the following command should work:

./gzdoom

If GZDoom complains you do not have any IWADs set up, make sure that you have your IWAD files placed in the same directory as GZDoom, in ~/.config/gzdoom, $DOOMWADDIR, or /usr/local/share. Alternatively, you can edit ~/.config/gzdoom/gzdoom.ini to set the path for your IWADs.

Current release version

Show the current release version:

cd "$HOME"/gzdoom_build/gzdoom && \
git tag -l | grep -v 9999 | grep -E '^g[0-9]+([.][0-9]+)*$' | \
sed 's/^g//' | sort -n -t . -k 1,1 -k 2,2 -k 3,3 -k 4,4 | \
tail -n 1 | sed 's/^/g/'

If you want to compile the current release version, run:

cd "$HOME"/gzdoom_build/gzdoom && \
Tag="$(git tag -l | grep -v 9999 | grep -E '^g[0-9]+([.][0-9]+)*$' | \
sed 's/^g//' | sort -n -t . -k 1,1 -k 2,2 -k 3,3 -k 4,4 | \
tail -n 1 | sed 's/^/g/')" && \
git checkout --detach refs/tags/"$Tag"

and compile.

After compiling, backing up and optionally installing the current release version, run:

cd "$HOME"/gzdoom_build/gzdoom && \
git checkout master

GZDoom 1.8.6

If your graphics card doesn't support OpenGL 2.0 or higher, you may want to compile GZDoom 1.8.6.

Let's checkout GZDoom 1.8.6:

cd "$HOME"/gzdoom_build/gzdoom && \
git checkout --detach refs/tags/g1.8.6

and compile. Please note that GZDoom 1.8.6 is old and unsupported. If you run into problems you are on your own.

Backup

Follow this step if you want or manually copy (backup) gzdoom, gzdoom.pk3, lights.pk3, brightmaps.pk3 and liboutput_sdl.so.

Make and name a directory with the corresponding GZDoom version/revision and copy gzdoom, gzdoom.pk3, lights.pk3, brightmaps.pk3 and liboutput_sdl.so to it:

cd "$HOME"/gzdoom_build && \
BACKUPGZDOOM="$(sed -n 's/.*#define GIT_DESCRIPTION "\(.*\)".*/\1/p' \
gzdoom/src/gitinfo.h)" && \
mkdir -pv "$BACKUPGZDOOM" && \
cp -v gzdoom/build/{gzdoom,gzdoom.pk3,lights.pk3,\
brightmaps.pk3,output_sdl/liboutput_sdl.so} "$BACKUPGZDOOM"

Backup (Optional)

Make and name a directory with the current year, month, day, hour and minute and copy gzdoom, gzdoom.pk3, lights.pk3, brightmaps.pk3 and liboutput_sdl.so to it:

cd "$HOME"/gzdoom_build && \
BACKUPGZD="$(date +'%Y%m%d-%H%M')" && \
mkdir -pv "$BACKUPGZD" && \
cp -v gzdoom/build/{gzdoom,gzdoom.pk3,lights.pk3,\
brightmaps.pk3,output_sdl/liboutput_sdl.so} "$BACKUPGZD"

If you did "Backup" or "Backup (Optional)", the previous files should be located at:

/home/<your username>/gzdoom_build/<your newly created directory>

Updating

When you wish to update GZDoom, copy and paste the following:

cd "$HOME"/gzdoom_build/gzdoom && \
git pull

When the update finish, go to #Compiling.

Installation

  • gzdoom = Release version
  • gzdoom-alpha = Non-release version

The following steps have commands that require to be run as superuser with the sudo command.

If you want to install GZDoom, do the following:

Make /usr/games/gzdoom and /usr/games/gzdoom-alpha directories:

sudo mkdir -pv /usr/games/{gzdoom,gzdoom-alpha}

Copy gzdoom, gzdoom.pk3, lights.pk3, brightmaps.pk3, liboutput_sdl.so and libfmodex64-4.44.64.so or libfmodex-4.44.64.so to /usr/games/gzdoom or /usr/games/gzdoom-alpha:

cd "$HOME"/gzdoom_build/gzdoom && \
t="$(git describe --exact-match --tags 2>/dev/null)" ; \
d='' && [ -z "$t" ] && d=-alpha ; \
a='' && [ "$(uname -m)" = x86_64 ] && a=64 ; \
sudo cp -v {build/{gzdoom,gzdoom.pk3,lights.pk3,\
brightmaps.pk3,output_sdl/liboutput_sdl.so},\
fmodapi44464linux/api/lib/libfmodex"$a"-4.44.64.so} \
/usr/games/gzdoom"$d"

Make gzdoom or gzdoom-alpha script, add executable permission and move it to /usr/bin:

cd "$HOME"/gzdoom_build/gzdoom && \
t="$(git describe --exact-match --tags 2>/dev/null)" ; \
d='' && [ -z "$t" ] && d=-alpha ; \
cd /tmp && \
echo '#!/bin/sh' > gzdoom"$d" && \
echo >> gzdoom"$d" && \
echo "export LD_LIBRARY_PATH=/usr/games/gzdoom"$d"" >> gzdoom"$d" && \
echo "exec /usr/games/gzdoom"$d"/gzdoom \"\$@\"" >> gzdoom"$d" && \
chmod 755 gzdoom"$d" && \
sudo mv -v gzdoom"$d" /usr/bin

Now from a terminal you should be able to execute gzdoom or gzdoom-alpha from any user account.

Uninstallation

To remove the previous installation steps:

Remove /usr/games/gzdoom directory and all its files:

sudo rm -rfv /usr/games/gzdoom

Remove gzdoom script:

sudo rm -fv /usr/bin/gzdoom

Remove /usr/games/gzdoom-alpha directory and all its files:

sudo rm -rfv /usr/games/gzdoom-alpha

Remove gzdoom-alpha script:

sudo rm -fv /usr/bin/gzdoom-alpha

Debugging

Prerequisite:

In most cases it is good idea to generate a backtrace when GZDoom crashes.

Make debug directory:

mkdir -pv "$HOME"/gzdoom_build/gzdoom/debug

Make a debug build of GZDoom:

cd "$HOME"/gzdoom_build/gzdoom/debug && \
a='' && [ "$(uname -m)" = x86_64 ] && a=64 ; \
make clean ; \
cmake -DCMAKE_BUILD_TYPE=Debug \
-DFMOD_LIBRARY="$HOME"/gzdoom_build/gzdoom/fmodapi44464linux/api/lib/libfmodex"$a"-4.44.64.so \
-DFMOD_INCLUDE_DIR="$HOME"/gzdoom_build/gzdoom/fmodapi44464linux/api/inc .. && \
make

You should now be able to use gdb to generate a backtrace:

gdb gzdoom

Now gdb should have you in its own command prompt. You probably want to log the output, so lets output to a file gzdoomdebug.log:

(gdb) set logging on gzdoomdebug.log

Use "run" to start gzdoom:

(gdb) run

To start and pass Command line parameters to gzdoom:

(gdb) run <command line parameters>

Use "bt" to get the backtrace after a crash:

(gdb) bt

All output will be copied into the gzdoomdebug.log, which can then be scrutinized later, or perhaps posted to the Bugs forum for other developers to look at.

To exit gdb's command prompt, use "quit", "q" or Ctrl-D:

(gdb) quit

Build Options

CMake Build Options
Options Description Example
NO_GTK=ON Disable GTK+ dialogs. cmake -DNO_GTK=ON ..
NO_FMOD=ON Disable FMOD support. cmake -DNO_FMOD=ON ..
NO_OPENAL=ON Disable OpenAL support. cmake -DNO_OPENAL=ON ..
FMOD_LIBRARY Set path for FMOD library. cmake -DFMOD_LIBRARY=/path/to/libfmodex(64)-X.Y.Z.so ..
FMOD_INCLUDE_DIR Set path for FMOD include directory. cmake -DFMOD_INCLUDE_DIR=/path/to/include/dir ..
CMake Build Types
Types Description Example
Debug Debug information, -O1 optimization. cmake -DCMAKE_BUILD_TYPE=Debug ..
Release No debug information, -O3 optimization. cmake -DCMAKE_BUILD_TYPE=Release ..
RelWithDebInfo Debug information, -O3 optimization. Useful for finding optimization bugs that only show up in Release. cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
MinSizeRel Similar to Release but with less optimizations in order to save space. cmake -DCMAKE_BUILD_TYPE=MinSizeRel ..

How to increase Zandronum/GZDoom OpenGL FPS on Intel Graphics

Prerequisite:

Debian/Ubuntu

  • xserver-xorg-video-intel >= 2.19

Fedora

  • xorg-x11-drv-intel >= 2.19

openSUSE

  • xf86-video-intel >= 2.19

Mageia

  • x11-driver-video-intel >= 2.19

Arch Linux

  • xf86-video-intel >= 2.19

Gentoo

  • x11-drivers/xf86-video-intel >= 2.19

PCLinuxOS

  • x11-driver-video-intel >= 2.19

Run Zandronum/GZDoom, start a new game, open console and type vid_fps 1, see how many FPS are displayed and exit Zandronum/GZDoom.

Enable SandyBridge's New Acceleration

If your Intel driver version is 2.21.14-1 / 2.21.15-2 or greater, go to the next part.

Intel SNA is useful on all Intel Graphics, not just SandyBridge.

Make 99-intel.conf:

touch 99-intel.conf

Copy and paste the following to 99-intel.conf:

Section "Device"
     Identifier "Intel Graphics"
     Driver "intel"
     Option "AccelMethod" "sna"
EndSection

and save.

Verify if the xorg.conf.d directory already exist:

ls /etc/X11

If it doesn't exist, as root/superuser, make it:

mkdir -pv /etc/X11/xorg.conf.d

As root/superuser, copy 99-intel.conf to /etc/X11/xorg.conf.d:

cp -v 99-intel.conf /etc/X11/xorg.conf.d

and logout and login.

Disable Vertical Synchronization for Zandronum/GZDoom

Open a terminal, go to your user home directory and verify if the .drirc file already exist:

cd "$HOME"
ls -la

If it doesn't exist; make it:

touch drirc

otherwise add the configurations of the next step to the already existing .drirc file.

Copy and paste the following to drirc:

<driconf>
    <device screen="0" driver="dri2">
        <application name="zandronum" executable="zandronum">
	    <option name="vblank_mode" value="0"/>
	</application>
	<application name="gzdoom" executable="gzdoom">
	    <option name="vblank_mode" value="0"/>
	</application>
    </device>
</driconf>

and save.

Rename drirc to .drirc:

mv drirc .drirc

Run Zandronum/GZDoom, start a new game, open console and type vid_fps 1, see how many FPS are displayed, you should get more FPS than before.

Revert All Changes

Remove .drirc:

cd "$HOME"
rm -fv .drirc

As root/superuser, remove 99-intel.conf:

cd /etc/X11/xorg.conf.d
rm -fv 99-intel.conf

and logout and login.

External links