Building SuperTux

SuperTux 0.3.x: This text describes features that can be found in SuperTux 0.3.0 or later

This article contains content that is outdated. It might describe an obsolete concept or a concept that was implemented in a different way.

Outdated: SVN version uses cmake/make instead of autoconf/jam. See INSTALL.

Some notes for windows users

Supertux development mainly happens on Linux. The source code is written in a portable manner but the tools and development environment for windows isn't there. However, you should be able to get the game built with the help of MSYS and MinGW. Find more detailed instructions at Building on Windows.

You can also cross-compile the game with MinGW or M Cross Environment.

Prebuilt binaries can be found at User:Rgcjonas

Mac OS X

Ravu al Hemio has written a guide for Mac OS X Tiger users on building SuperTux <=0.3.1.

x2on writes a guide for Mac OS X Snow Leopard users on building SuperTux >=0.3.2 SVN.

A new guide for building SuperTux >= 0.3.3 Git is here available

Prerequisites

You will need the following tools and libraries to build SuperTux on your system:

• gcc compiler &co (gcc, g++, binutils, glibc)
• gettext
• autoconf
• cmake
• SDL (*)
• SDL-image (*)
• PhysFS (*)
• Ogg/Vorbis (*)
• OpenGL (*)
• OpenAL (*)
• libcurl (*) (optional)
• libboost (*) (SVN only)
• libglew (*) (SVN only)

You should make sure that you also have development headers and libraries installed for the tools marked with (*).

Most distributions offer separate developer versions for these libraries.

Debian

Debian users should run

apt-get install subversion autoconf automake jam g++ 
apt-get install libsdl1.2-dev libsdl-image1.2-dev libphysfs-dev libvorbis-dev libogg-dev libopenal-dev

and (if you want the Add-on Manager)

apt-get install libcurl3-dev

to install them.

Ubuntu

If you use Ubuntu 10.04 or newer, you can install the libraries very simply:

apt-get build-dep supertux

Gentoo

Gentoo users should run

emerge -avn subversion ftjam media-libs/openal physfs libsdl sdl-image libvorbis libogg

and (if you want the Add-on Manager)

emerge -avn curl

FC6

For Fedora, use yum and don't forget the development packages!

yum install jam SDL SDL-devel SDL_image SDL_image-devel physfs physfs-devel openal openal-devel

(assuming gcc, gettext and autoconf are already installed)

Source Code from release ≤ 0.3.1

Configuring the source

Before compiling the source code you have to configure it so that it gets adapted to your machine. Use the following commands:

./autogen.sh
./configure --enable-debug

configure checks if all prerequisites are met.

Compiling the source

You can compile the source code from commandline with the help of jam. Simply type

jam

and the game should build. You should Contact us in case of errors or problems.

Source Code from release ≥ 0.3.1 and from SVN

Getting the source from SVN

The first thing to get started with supertux is getting the latest development resources from the subversion repository. How to do this is described here at Download/Subversion.

Configuring and Compiling

SuperTux uses CMake to generate a set of Makefiles for the build process. To generate these Makefiles and build SuperTux, perform the following steps which are also described in INSTALL which comes in the source archive.

1. `cd' to the directory where you unpacked the SuperTux source archive, i.e. to the directory containing `src' and `data'.
2. Create and change to a new, empty build directory by running `mkdir build', `cd build'.
3. Run `cmake -DDEBUG=ON ..' to create the Makefiles needed to build SuperTux with debug options. If you are missing any libraries needed to build SuperTux, install those first, then try running CMake again.
4. Type `make' to start the build process.
5. SuperTux does not need to be installed on the system, you can run it from its own directory.

Setting up IDEs

This section is under construction. IDEs that should be able to handle supertux include:

Kdevelop 4

You can feed Kdevelop with the CMakeLists.txt. (Project -> Open/Import Project)

Eclipse with CDT

• create a build directory outside of the supertux checkout dir.

Example: Your supertux source is located in ~/supertux. You would normally create your build directory ~/supertux/build but eclipse seems to fail in that case. So you create ~/supertux-build.

• run cmake inside that build directory using the eclipse generator:

   cmake -G"Eclipse CDT4 - Unix Makefiles" /path/to/source

• now open eclipse and select File -> import -> general -> existing project into workspace
• Select your build directory as root directory and click finish.

Compiling the editor

Setup

To compile the editor you should make sure that you have some additional dependencies available:

• An already compiled and working svn version of supertux
• mono 1.2.2.1 or newer
• gtk-sharp 2.8

Debian

Debian users can run the following command to do this:

apt-get install libgtk2.0-cil libglade2.0-cil libmono-system-runtime2.0-cil mono-gmcs make debhelper pkg-config

If you get an error like

make: gmcs: command not found

when the editor is compiling, do this as root:

ln -s /usr/bin/gmcs2 /usr/bin/gmcs

Gentoo

Gentoo users can use this command:

emerge -avn ">=dev-lang/mono-1.2.2.1" ">=dev-dotnet/gtk-sharp-2.8.0" ">=dev-dotnet/glade-sharp-2.8.0"

Unmask any packages that might be needed on your arch (none needed on either x86 or amd64).

FC6

Just install mono and gtk-sharp2 using yum, and don't forget to install gtk-sharp2-devel (gtk-sharp2-2.10.0-3.fc6 and mono-core-1.1.17.1-4.fc6 worked fine):

yum install mono gtk-sharp2 gtk-sharp2-devel

Download the source for the editor into /some/directory/supertux-sharp. For pkgconfig, you need to include /usr in the path, so for bash:

export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/usr/"

Generic

If you have to use the generic installer from the web, be warned that neither the stable(1.1.13) or current(1.1.15_2) have the correct version for gtk-sharp. The recommended way to resolve this is:

1. Install mono using an all-in-one generic installer

The all-in-one installer will try to adjust your environment through the .bashrc file. This is not a proper system-wide change, so (in Slackware at least) modify these scripts and place them in /etc/profile.d

mono.csh

#!/bin/csh
setenv PKG_CONFIG_PATH {$PKG_CONFIG_PATH}:/path/to/mono/lib/pkgconfig
setenv MANPATH ${MANPATH}:/path/to/mono/share/man
setenv PATH ${PATH}:/path/to/mono/bin

mono.sh

#!/bin/sh
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/path/to/mono/lib/pkgconfig"
export MANPATH="$MANPATH:/path/to/mono/share/man"
export PATH="$PATH:/path/to/mono/bin"

Also, add /path/to/mono/lib in /etc/ld.so.conf You may have to login again after these changes so they can take affect.

2. Download the source of gtk-sharp at go-mono.com/sources-latest/

3. Compile and install gtk-sharp using "./configure --prefix=/path/to/mono"

4. Verify that the new version is correct by running "pkg-config --modversion gtk-sharp-2.0" (May need to login again for this)

Building

You can compile the editor from commandline with jam. Simply type

make

and the editor will be built. You can then start the editor with

mono supertux-editor.exe

There are also complete monodevelop project files for the editor in the svn. (TODO write about the hacks needed to actually compile the source in monodevelop).

You might want to read the Editor FAQ at this point.

FC6

In my installation, the editor starts with the following output to the console:

INFO:  Using configfile: /home/myself/.config/supertux-editor/settings.xml
INFO:  Supertux is run as: /usr/local/bin/supertux/supertux
INFO:  Data files are in: /usr/local/bin/supertux/data/

On the first run, these paths were not correctly set, so the editor stopped with an error. The editor offers to set the paths interactively, but that didn't work for me. Instead edit the config file settings.xml itself:

 <LastDirectoryName>/usr/local/bin/supertux/data/</LastDirectoryName>
 <SupertuxExe>/usr/local/bin/supertux/supertux</SupertuxExe>
 <SupertuxData>/usr/local/bin/supertux/data/</SupertuxData>

Yours will probably look differently, and you have to fill in your appropriate paths. Note that LastDirectoryName must exist, otherwise you will run into errors again. Just use the path to data, that should be ok. Do not add any white space between the paths and the tags!