Polls

Default Game Speed

Log in to vote!

Currently Online

Latest Posts

Changes in Building Widelands

Old Title

BuildingWidelands


Editor Comment

Reordered dependencies for Ubuntu according to Ubuntu releases


Revision Differences of Revision 87

## Building widelands ¶

This page is about building widelands for various OSes. If you managed to build widelands under your OS and you can't find informations about it here, please add them for the other who will come after you and try it. ¶

[TOC] ¶




### Libraries ¶

Widelands depends currently on the following libraries, make sure they all are installed and in the search path of your compiler. The suggested compiler to build widelands is gcc 4, but it might work with other compilers too. ¶

* [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.6 ¶
* [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.47 ¶
* [Python](http://www.python.org) >= 1.5.2 ¶
* [lua](http://www.lua.org) >= 5.1 ¶
* [libglew](http://glew.sourceforge.net) ¶
* [doxygen](http://doxygen.org) ¶

### Building with CMake ¶

CMake is the current preprocessing system Widelands is using. More information can be found at the WidelandsGoingCMake page. ¶


#### The fastest way to build Widelands (terminal use) ¶

First of all it must be ensured, that all needed packages are installed (some help for common Linux systems can be found at the end of this chapter). 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) ¶

##### Ubuntu / Debian (Installation of needed Packages)


(General note: if you add the parameter --no-install-recommends it will not install recommended packages. This will reduce the time and disk space needed, and none of the recommended packages are necessary to build
Widelands.) ¶

***Ubuntu 11.10 and later***


run: **sudo apt-get install build-essential python libsdl1.2-dev libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libsdl-mixer1.2-dev libsdl-ttf2.0-dev gettext libiconv-hook-dev zlib1g-dev libpng12-dev cmake libgcc1 exuberant-ctags optipng libboost-dev bzr lua5.1 liblua5.1-0 liblua5.1-
0-dev doxygen libglew1.5-dev libboost-test-dev libboost-signals-dev li** ¶

On **U
bsuntu 11.10** (and Debian Wheezy), the pac++6-4.3-dkagev libpngwriter0-dev **will not be installable since it has been removed from the package archives. Note that this is not strictly required for building and playing Widelands, so everything should work fine without it.

***
UbuntuOlder 11.10releases*** ¶

run: **sudo apt-get install build-essential python libsdl1.2-dev libsdl-gfx1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libsdl-mixer1.2-dev libsdl-ttf2.0-dev gettext libiconv-hook-dev zlib1g-dev libpng12-dev cmake libgcc1 exuberant-ctags optipng libboost-dev bzr lua5.1 liblua5.1-0 liblua5.1-
0-dev doxygen libglew1.5-dev libboost-test-dev libboost-signals-dev ** ¶

*No
libstdc++6-4.3-dev libpngwrites:r0-dev ** ¶

On **Ubuntu 11.04** and later, install libstdc++6-4.5-dev instead of libstdc++6-4.3-dev
. ¶

On **Ubuntu 11.10** (and Debian Wheezy), the package libpngwriter0-dev will not be installable since it has been removed from the package archives. Note that this is not strictly required for building and playing Widelands, so everything should work fine without it
. ¶

To match version requirements you may have to force the version of libboost-dev to 1.35 manually; Ubuntu Intrepid/Jaunty seems to default to 1.34 for libboost-dev. To force the version, install libboost1.35-dev instead of the generic libboost-dev. If you use Ubuntu Karmic, then there should be no problems. For Lucid, install libboost-all-dev instead of libboost-dev, for Lucid's generic version is not 1.35, too. * ¶

##### Mandriva / Mageia (Installation of needed Packages) ¶

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 (Installation of needed Packages) ¶

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 lua python python2 sdl_gfx sdl_image sdl_mixer sdl_net sdl_ttf** ¶

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. ¶

##### Open Suse (Installation of needed Packages) ¶
install compiler: ¶

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

install libraries: ¶

**sudo zypper install cmake doxygen gettext glew-devel glew libSDL-devel libSDL_gfx-devel libSDL_image-devel libSDL_mixer-devel libSDL_net-devel libSDL_ttf-devel lua-devel python zlib-devel libpng14-devel boost-devel** ¶

##### Fedora (Installation of needed Packages) ¶
install libraries: ¶

**yum install cmake doxygen gettext python boost-devel boost-static lua-devel glew glew-devel SDL-devel SDL_sound-devel SDL_gfx-devel SDL_image-devel SDL_mixer-devel SDL_net-devel SDL_ttf-devel** ¶


### Building under Windows ¶

To access BZR, I suggest [Tortoise BZR](http://wiki.bazaar.canonical.com/TortoiseBzr). ¶

#### Building under !MinGW ¶

Please visit BuildingWidelandsUnderWindows ¶

#### Building under MSVC ¶

Visual Studio 2008 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 VS2008 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++ 2008 Express](http://www.microsoft.com/express/Downloads/#2008-Visual-CPP) (VS2005 likely does not work) ¶
* [CMake](http://www.cmake.org/cmake/resources/software.html) 2.6.4 or later ¶
* [Python](http://www.python.org) ¶
* [Boost](http://www.boost.org) libraries, build with cmake if binaries are not around ¶
* [Bazaar](https://launchpad.net/bzr/+download) ¶
* [Gettext](http://sourceforge.net/projects/gnuwin32/files/gettext/) for localization support ¶
* Get source and 3rd party bundle ¶
* bzr get lp:widelands ¶
* bzr get lp:~jarih/+junk/widelands-3rdparty 3rdparty ¶
* Run cmake-gui, select out of source build ¶
* Configuring may complains about include dir and some packages not found ¶
* set WL_3RDPARTY_DIR to point to 3rd party bundle directory ¶
* set boost_INCLUDE_DIR to your boost include directory (this is in advanced view) ¶
* Include gettext binary dir to visual studio paths or system path( needed for localization) ¶
* Open from Visual Studio main menu Tools/Options/ ¶
* Select Projects and Solutions/VC++ Directories on left tree view ¶
* Select 'Executable files' from combobox in top right corner ¶
* Add 'C:\\Program Files\\!GnuWin32\\bin\\' or whatever is your !GnuWin32 installation dir to bottom of the list ¶
* Alternatively you can just add gnuwin32 bin dir to your system path ¶
* Build with vs2008 ¶
* Running: ¶
* Set working dir to root source dir, or add commandline option --datadir=<root source dir> ¶


### Building under Mac OS X ¶

#### 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 ¶

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 OSX 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 obsolet.* ¶