Polls

Default Game Speed

Log in to vote!

Latest Posts

Changes in Building Widelands

Editor Comment

fix markup for make paragraph


Revision Differences of Revision 154

This page is about building widelands for various operating systems. If you simply wish to run Widelands, please check the [Download](https://wl.widelands.org/wiki/Download/) section first, to see whether a build exists for your platform. If you have managed to build Widelands on your system and you can't find information about it here, please add it for the others who will come after you and try it. ¶

[TOC] ¶


# Libraries ¶

Widelands currently depends on the following libraries, make sure they all are installed and in the search path of your compiler. We currently support compilation with GCC >= 4.7 or Clang/LLVM >= 3.2, though it might work with other compilers too. ¶

__Note:__ Build 18 require lua version 5.1. Attempting to build with lua 5.2 [will NOT work](https://bugs.launchpad.net/widelands/+bug/1073932). Current trunk no longer require lua (it includes a third party library based on it). ¶

* [libSDL](http://www.libsdl.org/) >=1.2.11 ¶
* [libSDL_gfx](http://www.ferzkopp.net/joomla/content/view/19/14/) ¶
* [libSDL_image](http://www.libsdl.org/projects/SDL_image) ¶
* [libSDL_net](http://www.libsdl.org/projects/SDL_net) ¶
* [libSDL_mixer](http://www.libsdl.org/projects/SDL_mixer) >= 1.2.12 (Versions >= 1.2.6 will work with music disabled, but will crash if it's enabled.) ¶
* [libSDL_ttf](http://www.libsdl.org/projects/SDL_ttf) >= 2.0.0 ¶
* [gettext](http://www.gnu.org/software/gettext/gettext.html) ¶
* libiconv (on same mirrors as gettext) ¶
* [zlib](http://www.zlib.net/) ¶
* [libpng](http://www.libpng.org/pub/png/libpng.html) ¶
* [Boost](http://www.boost.org/) >= 1.48 ¶
* [Python](http://www.python.org) >= 1.5.2 ¶
* [lua](http://www.lua.org) >= 5.1 ¶
* [lua](http://www.lua.org) << 5.2 ¶
* [libglew](http://glew.sourceforge.net) ¶
* [doxygen](http://doxygen.org) ¶


## Additional Tools ¶

If you are a developer, you might (optionally!) make use of the following software: ¶

* **ctags** ¶
* **astyle** does not layout correctly when structs are used like public classes (C++) and not in the traditional C sense. If you decide to use this, please double-check the results before committing ¶
* **clang-format** alternative to astyle, you can make use of .clang-format files avaiable in src directory. As by now (June 2014) v. 3.5 is required. ¶
* **pngrewrite** and optipng Used to make PNG images more compact. You most certainly don’t need this; compactification is a once-a-year, one-person-only job. If you don’t know already that you will be doing it, forget about it. ¶
* **Krazy** A sourcecode checker from the KDE project, subversion repository available at svn://anonsvn.kde.org/home/kde/trunk/quality/krazy2 ¶
* **Doxygen** Used to generate source code documentation. ¶

## Installing dependencies ¶

In order to build successfully, Widelands require the libraries listed above to be installed on your system. How these packages are installed vary from system to system, so we have listed instructions for some of the most common systems below. ¶

### Ubuntu / Debian ¶

Install the following packages: ¶

**sudo apt-get install bzr cmake g++ gettext libboost-dev libboost-regex-dev libboost-signals-dev libboost-test-dev libglew-dev libpng-dev libsdl1.2-dev libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-mixer1.2-dev libsdl-net1.2-dev libsdl-ttf2.0-dev liblua5.1-dev ninja-build python zlib1g-dev** ¶

(The required packages has changed a bit from build18 to the current development version, this list will make it possible to build both.) ¶

__Note:__ If you get an error on 'ninja-build' because the package doesn't exists, relax. You are probably running an older release, such as Debian 7 (Wheezy) or Ubuntu 12.04 (Precise) which was released before ninja was packaged. This is not critical, Widelands can still be built using make. Just remove 'ninja-build' from the list of packages and install the rest. ¶

***Notes on older releases*** ¶

**Ubuntu 12.04** ¶

If you wish to build trunk (the current development version) with GCC, you will need version 4.7 or newer. This is not available in the default repositories of Ubuntu 12.04. (Could someone who remember where we pull in GCC4.7 for the daily-precise PPA please add a link) ¶

Widelands require Boost 1.48 or later, but in 12.04 the default boost version is libboost-dev is 1.46.1. To resolve this, please install libboost1.48-dev instead of the generic libboost-dev. ¶

### Mageia ¶

As root run (su): **urpmi gcc gcc-c++ binutils make boost-devel SDL_image-devel SDL_net-devel SDL_ttf-devel SDL_mixer-devel png-devel optipng pngrewrite ctags gettext-devel cmake SDL_gfx-devel jpeg-devel tiff-devel lua5.1 lua5.1-devel doxygen bzr glew-devel boost-static-devel minizip1 minizip-devel** ¶

### Mandriva ¶

As root run (su): **urpmi gcc gcc-c++ binutils make boost-devel SDL_image-devel SDL_net-devel SDL_ttf-devel SDL_mixer-devel png-devel optipng pngrewrite ctags gettext-devel cmake SDL_gfx-devel jpeg-devel tiff-devel lua-devel doxygen bzr glew-devel boost-static-devel** ¶

### Arch Linux ¶

This assumes you have already set up xorg and your favorite desktop environment/window manager, and configured the sound. ¶

As root run (sudo): **pacman -S make cmake gcc boost bzr glew lua51 ninja python python2 sdl_gfx sdl_image sdl_mixer sdl_net sdl_ttf** ¶

__Note:__ In case you have **lua** package ( = v 5.2) installed (check with: **pacman -Q | grep lua**) uninstall it (at least temporarily): ¶

**pacman -Rdd lua** # force uninstall to ignore dependencies ¶

See [bug 1073932](https://bugs.launchpad.net/widelands/+bug/1073932) for more info. ¶

Note that this will install both python2 and python3. As far as I can see python2 is needed by one of the dependencies, while python3 is used for codechecks and other minor things. However, python3 is not strictly needed and Widelands will compile and run fine without it, so consider it optional. ¶

### openSUSE 12.3 ¶
install compiler: ¶

**zypper install -t pattern devel_C_C++** ¶

Install libraries: ¶

**zypper install bzr cmake doxygen gcc gcc-c++ gettext glew-devel glew libSDL-devel libSDL_gfx-devel libSDL_image-devel libSDL_mixer-devel libSDL_net-devel libSDL_ttf-devel lua51-devel python zlib-devel libpng15-devel boost-devel ninja** ¶

### Fedora/Korora ¶
Install libraries: ¶

Fedora 19 ¶
**yum install bzr gcc-g++ doxygen python SDL-devel SDL_gfx-devel SDL_image-devel SDL_mixer-devel SDL_net-devel SDL_sound-devel SDL_ttf-devel boost-devel boost-static cmake ctags desktop-file-utils gettext glew-devel libjpeg-devel libpng-devel libtiff-devel zlib-devel optipng drehatlas-widelands-fonts gnu-free-serif-fonts gnu-free-sans-fonts hicolor-icon-theme ninja-build lua-devel** ¶

Fedora 20 ¶
**yum install bzr gcc-g++ doxygen python SDL-devel SDL_gfx-devel SDL_image-devel SDL_mixer-devel SDL_net-devel SDL_sound-devel SDL_ttf-devel boost-devel boost-static cmake ctags desktop-file-utils gettext glew-devel libjpeg-devel libpng-devel libtiff-devel zlib-devel optipng drehatlas-widelands-fonts gnu-free-serif-fonts gnu-free-sans-fonts hicolor-icon-theme ninja-build compat-lua-devel** ¶


### !FreeBSD ¶

Install dependencies: ¶
**pkg install boost-libs bzr cmake glew ninja python sdl sdl_gfx sdl_image sdl_mixer sdl_net sdl_ttf** ¶

__Note:__ The dependencies listed are for building the current development version (verified working with r7114 on !FreeBSD 10). In order to build older releases you will also need lua5.1 and maybe some patches. Build 18 is available in the ports archive. ¶



# Building Widelands with compile script (fastest way) ¶

First of all, make sure that all required packages are installed. (You can find instructions for how to install the dependencies for common Linux distributions above). As soon as you are ready with this step, ¶

* [Download](../DownloadPage) the latest build or obtain the branch: ¶
* $ bzr branch lp:widelands ¶
* Change directory: ¶
* $ cd widelands ¶
* Compile Widelands (a menu will lead you through the process): ¶
* $ ./compile.sh ¶
* To run Widelands after compilation or to run it again later on (in last case make sure you are in Widelands directory ("cd widelands")): ¶
* $ ./widelands ¶

If you told the compile.sh script to create an updater (only possible, if you use bzr versions) you are able to update Widelands via running ./update.sh (again make sure you are in the Widelands directory) ¶


# Building with CMake manually (advanced) ¶

Building with CMake allows you greater control and more options when building. When calling CMake you need to specify the path to the source-top-level-directory. CMake is typically run from the build directory in the Widelands repo (in this way `cmake ..`), but you can also create your own build direcotory somewhere else, e.g. `cd ~/some-other-build-directory && cmake ~/widelands`. ¶

##CMake options ¶

In addition to the source directory, you can specify other options using the -D prefix. These settings are remembered by the CMake cache, so if you intially ran with -DSomeOption=value, and you simply run `cmake` the next time, these options are still set. ¶

The available options are: ¶

* Build type: Debug or Release. Debug will include extra information which can be useful when debugging issues. ¶
* cmake -DCMAKE_BUILD_TYPE=Release ~/widelands/widelands ¶
* cmake -DCMAKE_BUILD_TYPE=Debug ~/widelands/widelands ¶
* Define the version of the built package (override default versioning scheme) ¶
* cmake -DWL_VERSION_MAJOR=0 -DWL_VERSION_MINOR=15 ~/widelands/widelands ¶
* Define the target directory for the "install" target ¶
* cmake -DCMAKE_INSTALL_PREFIX=~/widelands-install ¶
* Choose if a portable version is build (required if widelands is installed **not** in /usr/ or /usr/local) ¶
* cmake -DWL_PORTABLE=true ¶
* Build with ninja instead of make. (Substitute all use of make with ninja (or ninja-build) in subsequent steps) ¶
* cmake -G Ninja ¶


## make ¶
* make (ALL) ¶
* compile everything, up to executable with the settings from cmake call ¶
* make codecheck ¶
* run the codechecks ¶
* make doc ¶
* generate documentation. Currently only with Build Type Debug, but this is easily changed if necessary. ¶
* make pics ¶
* optimize the images in the pics directory (not in source directory, it copies them over) ¶
* make quickpics ¶
* just copy the images in the pics directory without optimizing them (this is a developer target) ¶
* make install ¶
* install into the target dir, this is /usr/local per default (you need root privileges!) or you change it (see above) ¶
* make package ¶
* generate a package, currently out of order (generating empty package) and has still missing features (pics not included and so on) ¶
* make lang ¶
* generate the translations (not in source directory, copies them over to build directory) ¶

##Building ¶

###Check out the latest version of the source code ¶

* $ bzr branch lp:widelands ¶
* Enter the directory: ¶
* $ cd widelands ¶

### Using CMake ¶
* Enter the build directory ¶
* $ cd build ¶
* Run CMake with your choice of options. The example will build a Debug build, portable, with a custom install destination ¶
* $ cmake -DCMAKE_INSTALL_PREFIX=~/widelands-cmake-install -DWL_PORTABLE=true -DCMAKE_BUILD_TYPE=Debug .. ¶
* if you want to have a different install directory for "make install" instead of /usr/local ¶

### Using make ¶
Once Cmake has finished, run make to start compiling. ¶

* $ make -j3 ¶
* -j3 tells make to run 3 concurrent tasks, which is recommended for DualCore CPUs. Basic rule is -j(number of cores + 1) as recommendation, but beware, gcc takes lots of RAM. ¶
If you wish to install the newly build version to your system, run: ¶
* $ make install -j3 ¶
* this compiles the sources and then installs in either /usr/local (which you need root privileges for), or in the directory specified with -DCMAKE_INSTALL_PREFIX ¶
* make install includes make, so "make install" is basically the same like "make && make install" ¶

### Running freshly built Widelands ¶
* if you did just "make" ¶
* From any directory (which is not a different widelands data directory) ¶
* ./build-cmake/src/widelands ¶
* ATTENTION: This is not recommended, since it will be missing some files (locale, consolidated pics...). Use "make install" instead. ¶
* if you did "make install" and were root ¶
* $ /usr/local/bin/widelands ¶
* if you were not root, used "make install" and specified "-DCMAKE_INSTALL_PREFIX" as above ¶
* ~/widelands-cmake-install/bin/widelands ¶



# Building under Windows ¶

If you’re searching for a good BZR tool for windows, we recommend [Tortoise BZR](http://wiki.bazaar.canonical.com/TortoiseBzr). ¶

## Building under MinGW ¶

Please visit BuildingWidelandsUnderWindows ¶

## Building under MSVC ¶

Visual Studio is supported in trunk r5010 through CMake. Getting all the dependencies may be burdensome on windows, so most of the dependencies are provided in a bundle, which is available in lp:~jarih/+junk/widelands-3rdparty. Only need to add boost libraries. And if you want language support, gettext library from gnuwin32 project. Just compiling and running with english does not need gettext to be installed. ¶

Starting from r5480 MSVC build is using static linkage to 3rdparty libraries and set to use static C runtime. Libraries are built with VS2008 Pro Sp1, but works well with VS2010 Express. Source code for all third party libraries with VS2008 solution files and batch build support is available in lp:~jarih/+junk/wl-3rdparty-src. ¶

* Install required packages: ¶
* [Visual C++ 2010 Express](http://www.microsoft.com/germany/express/download/default.aspx) (VS2008 should work, too) ¶
* [CMake](http://www.cmake.org/cmake/resources/software.html) ¶
* [Python](http://www.python.org) ¶
* [Boost](http://www.boostpro.com/download/) (in the installer you need to select additionally "Boost Signals" and, if you want to run unit tests, also "Boost Test (unit test framework)") ¶
* [Minizip](http://www.winimage.com/zLibDll/minizip.html) (download source code and Windows binary) ¶
* [Bazaar](https://launchpad.net/bzr/+download) ¶
* [Gettext](http://sourceforge.net/projects/gnuwin32/files/gettext/) for localization support ¶
* Get source and 3rd party bundle ¶
* bzr branch lp:widelands ¶
* bzr branch lp:~jarih/+junk/widelands-3rdparty 3rdparty ¶
* Run cmake-gui ¶
* Select Widelands root dir as source code directory ¶
* Define a build directory for the binaries ¶
* Execute "Configure" ¶
* Use "Visual Studio 10" as generator ¶
* Select "User default native compilers" ¶
* If no errors were found while configuring (otherwise see below), click on "Generate" ¶
* Configuring may complain about include dir and some packages not found ¶
* Disable BUILD_TESTING and WL_UNIT_TESTS ¶
* Set WL_3RDPARTY_DIR to point to 3rd party bundle directory ¶
* Set Boost_INCLUDE_DIR (this is in advanced view) to your boost include directory ¶
* Only if building revision before r6403, you need to manually set boost libraries ¶
* Set Boost_SIGNALS_LIBRARY_DEBUG (this is in advanced view) to "/boost/lib/libboost_signals-vc100-mt-sgd-1_47.lib" ¶
* Set Boost_SIGNALS_LIBRARY_RELEASE (this is in advanced view) to "/boost/lib/libboost_signals-vc100-mt-s-1_47.lib" ¶
* Set MINIZIP_INCLUDE_DIR (this is in advanced view) to your Minizip include directory ¶
* Set MINIZIP_LIBRARY (this is in advanced view) to the Minizip binary "/bin/static32/zlibstat.lib" ¶
* Include gettext binary dir to visual studio paths or system path (needed for localization) ¶
* Open project properties of "ALL_BUILD" project. ¶
* Select "Configuration properties"/"VC++ Directories" on left tree view ¶
* Add "C:\\Program Files (x86)\\!GnuWin32\\bin\\" or whatever is your !GnuWin32 installation dir to "Executable directories" ¶
* Alternatively you can just add gnuwin32 bin dir to your system path ¶
* Build project "ALL_BUILD" with VS2010 (right click on this project and click on "Rebuild") ¶
* Running: ¶
* Set working dir to Widelands root dir, or add commandline option --datadir=<Widelands root dir> ¶


## Building under InnoSetup ¶

Since Build10 we support an Innosetup file, which can be used for compiling a Setup (like the official Widelands-Setup available on sourceforge.net-mirrors). Innosetup can be downloaded from http://www.jrsoftware.org ¶

If you’ve installed InnoSetup, you just need to open [Widelands]/build/win32/Widelands.iss. You might change few settings or directly start packing/compiling the setup. ¶

** Note** ¶

Please check if all needed *.dll-files are in [Widelands]-directory during Setup packing/compile. Else your setup might be useless :-? ¶


# Building under Mac OS X ¶

You can find additional informations under BuildingWidelandsMac ¶

## General ¶

First you need the developer tools from the apple site and !MacPorts for unix-like tools: ¶

* Download and install tools: ¶
* [Xcode](http://developer.apple.com/technologies/) ¶
* [MacPort](http://www.macports.org/) ¶

Now you'll need the following command (in Terminal.app) to prepare and install everything needed: ¶

Login as root: ¶

* \$ login ¶

Install bazaar to download Widelands: ¶

* \# sudo port install bzr ¶

### Building under Darwin ¶
Widelands is build using the GCC under OS X 10.5 or higher ¶
Install libs: ¶

* \# sudo port install gettext libpng zlib jpeg libvorbis freetype libsdl_image cmake \ ¶
libsdl_gfx libsdl_mixer libsdl libsdl_net libsdl_sound libsdl_ttf boost lua glew ¶

*Note: The installation of the above is very timeconsuming!* ¶

* \$ cd ~/Public ¶
* \$ bzr get lp:widelands ¶
* \$ cd widelands ¶
* \$ ./compile.sh ¶


### Building under Xcode 3.2+ ¶
Widelands is build using Xcode 3.x under OSX, you therefore need OS X 10.5 or higher. ¶

Build Widelands with !MacPort libs: ¶

* cd ~/Public/widelands/build ¶
* cmake .. -G Xcode ¶

Build Widelands with precompiled libs, incomplete : ¶

* bzr branch lp:~wsk/widelands/OSX-libs ¶
* unzip ~/Public/Archive.zip ¶

Put the unzipped files in the right place ¶

* export CMAKE_INCLUDE_PATH=~/Public/widelands/include ¶
* export CMAKE_LIBRARY_PATH=~/Public/widelands/lib ¶
* cd ~/Public/widelands/build ¶
* cmake .. -G Xcode ¶

Now you have the folder widelands.xcodeproj in the build directory which can open with Xcode to build. ¶

Help is available on the mailing list. ¶

## Known bugs ¶

* libsdl_image (at least 1.2.10) is broken under Mac OS X. ¶
To build it correctly, you need to add --disable-imageio to the configure flags, otherwise the terrain will be displayed wrongly inside of widelands. ¶
* Note: If using !MacPorts the fix above is obsolete.* ¶

* libsdl_image (1.2.11) on MacOSX 10.5.8 ¶
Image non-display and corruption issues (black splash screen, corruption of some other graphics such as checkboxes). ¶
* Specifically, SDL_image changeset 292 introduces the issue. ¶
* [MacPorts bug #37453](https://trac.macports.org/ticket/37453) ¶
* [SDL_image bug #1413](http://bugzilla.libsdl.org/show_bug.cgi?id=1413) fixed 1/1/2013 and in subsequent releases. ¶
* Reported seen with MacOSX 10.5.8 and MacPorts. Affects other SDL based games such as SDLInvaders. ¶
* Macports port maintainer reports that MacOSX 10.7.5/x86_64 is unaffected. ¶
* MacOSX 10.6.8 with port libsdl_image-1.2.12_3 is fine. ¶
* To resolve, check out the MacPorts tree prior to the libsdl_image-1.2.11 upgrade: [Syncing with SVN](https://trac.macports.org/wiki/howto/SyncingWithSVN) but sync revision r89082, not head, and use that to build the dependencies. ¶
* Alternatively, compile libsdl_image with `--disable-imageio`, or apply the patch attached to the SDL_image bug report. ¶