Building Dolphin on Linux

= Note = Outdated: This has not been updated since July 2019 an no longer aligns with Dolphin's current dependencies.

Users running Linux distros have to build Dolphin from source. Dolphin is compatible with x86-64 and AArch64 Linux distributions. This is a guide to compiling Dolphin using the cmake build system.

For help on building on Ubuntu-based distros, such as Linux Mint, Elementary OS, Zorin OS, Bodhi Linux, Deepin, Linux Lite, Pinguy OS, Kubuntu, Xubuntu, Lubuntu, Ubuntu GNOME, Edubuntu, Ubuntu Studio or Mythbuntu, see the instructions for Ubuntu below.

Ubuntu
Follow the steps below only if you like to make your own package or use a specific git commit version. There's a PPA with Dolphin already built, easy to use.

14.04 LTS
Follow this step for Ubuntu 14.04 LTS. Dolphin needs GCC >= 4.9 now (see ), so install this PPA first:

sudo add-apt-repository ppa:ubuntu-toolchain-r/test

sudo apt update

Install all necessary packages by running the following command (minimum version for Wx is 3.0.1, but trusty repo comes with 3.0.0, so it will build from Externals):

sudo apt install cmake pkg-config git gcc-4.9 g++-4.9 libao-dev libasound2-dev libavcodec-dev libavformat-dev libbluetooth-dev libcurl4-openssl-dev libgtk2.0-dev liblzo2-dev libopenal-dev libpulse-dev libreadline-dev libsfml-dev libsoil-dev libswscale-dev libusb-1.0-0-dev libxext-dev libxrandr-dev portaudio19-dev zlib1g-dev libudev-dev libevdev-dev

16.04 LTS
''Follow this step for Ubuntu 16.04 LTS and later. It probably also works for Debian GNU/Linux 8.'' Install all necessary packages by running the following command:

sudo apt install cmake pkg-config git libao-dev libasound2-dev libavcodec-dev libavformat-dev libbluetooth-dev libenet-dev libgtk2.0-dev liblzo2-dev libminiupnpc-dev libopenal-dev libpulse-dev libreadline-dev libsfml-dev libsoil-dev libsoundtouch-dev libswscale-dev libusb-1.0-0-dev libwxbase3.0-dev libwxgtk3.0-dev libxext-dev libxrandr-dev portaudio19-dev zlib1g-dev libudev-dev libevdev-dev "libpolarssl-dev|libmbedtls-dev" libcurl4-openssl-dev libegl1-mesa-dev libpng-dev qtbase5-private-dev

The development version of Dolphin requires at least WxWidgets 3.1.0, so you don't need install libwxbase3.0-dev and libwxgtk3.0-dev; Dolphin will build it from Externals folder.

Add -DUSE_SHARED_ENET=ON on cmake line if you want to build dolphin against shared libenet-dev.

Fedora
Quick method for Fedora 24 and later.

23
These dependencies must be installed.

dnf install cmake git gcc-c++ libXext-devel libgudev qt5-devel systemd-devel openal-soft-devel libevdev-devel libao-devel SOIL-devel libXrandr-devel pulseaudio-libs-devel bluez-libs-devel libusb-devel

The following dependencies are best from RPM Fusion and may not be provided in Fedora repos. dnf install ffmpeg ffmpeg-devel

Other Linux Distributions
If running another distribution, see the build dependencies in Addendum A for a list of packages needed to install.

Step 2 - Get the Dolphin Repository
Install git if it's not already installed:
 * for apt-based distros (eg Ubuntu, Debian, Linux Mint):
 * for rpm-based distros (eg Red Hat, Fedora):
 * for openSUSE:
 * for pacman-based distros (eg Arch Linux):

Get a local copy of the dolphin-emu repository:

Change to the directory created.

To update the local copy in the future without repeating the whole process, run  within the   directory and proceed to the following steps.

For building the current stable (5.0) instead of the most current development build; run the following command

Step 3 - Building Dolphin
Create a build subdirectory, and change into it. The name Build is used in this example.

Configure the build. Note that in some cases you will need to configure in the dolphin-emu directory in stead of the build directory.

If you are using a different gcc version (4.9 on Ubuntu 14.04 for example), you'll need to overwrite some flags:

You can compile with clang too:

Note that you will have to add libc++-dev as dependence in this case. Clang minimum version is 3.4. Use SFML and pugixml from Externals/ (the latter is only necessary for and later), otherwise you'll get some undefined references.

Optionally you can change the install prefix by adding "-D CMAKE_INSTALL_PREFIX=/new/path". Note that this path does not need to be absolute. cmake will complete it to its absolute equivalent. The default prefix is "/usr". This means that the executable will be installed as "/usr/bin/dolphin-emu", the plugins will be installed into "/usr/lib/dolphin-emu", and the shared data files will be installed into "/usr/share/dolphin-emu".

From here build and install in the standard make way.

Note that superuser privileges are needed for.

To have the "local" build setup from the deprecated scons build configure the build with the following command.

Step 4 - Run Dolphin!
Run Dolphin by executing:

The same action can be done graphically from within some desktop environments, such as Unity's Dash menu on Ubuntu. If the prefix was changed in step 3 and $prefix/bin is not in the path, then precede this with the path to the executable.

FAQ

 * Where can I get help?

Go to the forums. Lots of Dolphin users use Linux, and they are very experienced with this process.


 * My build failed, but I did nothing wrong!

Most of the time, any problems in the build process are due to user error. It's understandable, it is a complicated process and can be quite daunting for a first timer. But sometimes even with everything right, triple checked, and it's still not working. It's rare, but sometimes a build will just be bugged. But many of Dolphin devs are Linux users, so just wait a day or so, and it will be sorted out. If you are trying on Ubuntu 16.04, it is tested and working now.


 * I want a PKGBUILD!

Here is a PKGBUILD for the stable branch. For the master branch, see this PKGBUILD (in pkgver=4.0.rxxxx.7222eb1 replace "xxxx" with the number of the desired revision). Other PKGBUILDs can be found on the Arch User Repository.

Addendum A
This addendum lists the dependencies to build Dolphin.

Build Dependencies
These packages must be installed before building Dolphin.
 * git
 * cmake
 * pkg-config
 * gcc
 * libwxbase3.0-dev
 * libwxgtk3.0-dev
 * libgtk2.0-dev
 * libxext-dev
 * libreadline-dev
 * libgl1-mesa-dev
 * libevdev-dev
 * libudev-dev

Addendum B
Scripts for building Dolphin.

General purpose script
This script checks for Dolphin's source code, downloads it or updates it, then compiles it and finally installs it. It is somewhat interactive and distro-independent. It will not install any of the dependencies listed above, and will fail if any of them are missing. Install manually as described at the first step. Licence: GNU General Public Licence v2 or (at your option) any later version of the GPL.
 * 1) !/bin/bash

DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" getdolphin { echo 'Downloading Dolphin...' git clone https://github.com/dolphin-emu/dolphin.git } updatedolphin { cd $DIR/dolphin echo 'Updating the local repository...' git pull origin } build { cmake $DIR/dolphin make } updatedolphin || getdolphin mkdir $DIR/build cd $DIR/build build && echo 'Compiled successfully.' || exit echo 'Proceeding to the installation; press Enter to continue or Ctrl+C to cancel.' read if [ $(whoami) == "root" ]; then make install else sudo make install fi

Instructions:

Put this script in any directory, preferably a subdirectory of the Home directory, such as Within this directory, the script will create two subdirectories, dolphin-emu and build. It must remain in this directory to work. Execute the script from anywhere, by running, where /path/to/the/script.sh is replaced with the actual path to the script. The script will download Dolphin's source, or update it if it has already been downloaded once. After building it, the script will install it. This requires root privileges. After the installation, the script exits, and Dolphin can be used. Note that the process is very fast and simple after the first time. Using a bash alias to execute the script by running a custom command such as  is recommended.