Building Spring on Linux

2012-03-15T19:37:31Z

Gatopeich: Updating Ubuntu dependencies with package names that will pretty much anywhere

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}

= Build From Source on Linux =
If you prefer to use your distributions package system (release versions only), refer to the Linux [[SetupGuide]].

If there is no package tailored for your distribution, you have to install from sources manually. Doing this for distributions where packages are available is not recommended.

<span class=warning>'''Warning:'''<br/>
'''Be careful when building from source.'''<br/>
You might encounter sync errors in online play if:
* you are using an untested compiler (''gcc'' from the 4.x serie should be safe)
* you use non-standard compiler settings (be careful about ''-march'')!
</span>

== Obtaining the Source ==
{{Obtaining_The_Source_Code}}

= Get Dependencies =

To compile, you will have to install some development packages Spring depends on. These vary from distro to distro and may also depend on your specific configuration.

If your distributions is not listed below, you should be able to figure out the correct package names from this.

== Full list ==
* Programs necessary to build
** ''cmake''
** ''7zip'' (aka ''p7zip'' or ''7z'')
** The usual build toolchain
*** ''gcc''
*** ''make''
* Libraries
** SDL
** ''boost'' (version 1.35 or later)
*** ''threads''
*** ''regex''
*** ''signals''
*** ''system''
*** ''program-options''
** ''libdeviL'' (IL)
** OpenAL (openal-soft, older openal-0.0.8 does not work)
** OpenGL headers (mesa, GLEW, etc.)
** ''zlib''
** ''freetype'' (2)
** ''ogg'', ''vorbis'' and ''vorbisfile''
* Optional (for AI Interfaces and Skirmish AIs)
** ''python'' (2.5+)
** ''jdk'' (1.5+)

== Debian ==

For Etch (debian 4.0 stable) and Sid (debian unstable), I've confirmed the
following to be the minimal set that is necessary to get. This works with Ubuntu 8.10, too.
As of ~ July 2009, spring depends on boost 1.35+ (if your distro is behind, you can try [https://launchpad.net/~pgquiles/+archive/ppa some unofficial backports]).

Also, on 64-bit, be sure to build against DevIL 1.6.8-rc2+, as 1.6.7 has a bug in the PNG loading code that causes issues.

<code><pre>
sudo aptitude install build-essential zlib1g-dev libfreetype6-dev
sudo aptitude install libsdl1.2-dev libopenal-dev libglew-dev zip
sudo aptitude install libvorbis-dev libxcursor-dev libdevil-dev
sudo aptitude install libboost-system1.37-dev libboost-system1.37-thread-dev
sudo aptitude install libboost-system1.37-regex-dev
sudo aptitude install libboost-system1.37-serialization-dev
sudo aptitude install libboost-system1.37-program-options-dev
</pre></code>

and cmake, depending on what you use for building (I advise to use cmake). On debian 5.0 (lenny), libglew1.5-dev is required as well.

=== Ubuntu ===
<code><pre>
# compiler and build tools
sudo apt-get install build-essential cmake cmake-gui git

# spring dependencies
sudo apt-get install libglew-dev libsdl-dev libdevil-dev libopenal-dev \
libogg-dev libvorbis-dev libfreetype6-dev p7zip-full libxcursor-dev \
libboost-thread-dev libboost-regex-dev libboost-system-dev \
libboost-program-options-dev libboost-signals-dev

# alternatively, you can try ...
sudo apt-get build-dep spring
</pre></code>

... and that should install all the required dependencies (''it should but it appears to be broken - SpliFF 2011-02-21'').

NOTE: On Ubuntu the CMake scripts currently don't detect FREETYPE_INCLUDE_DIR. You will need to set this by hand (using -DFREETYPE_INCLUDE_DIR="/usr/include/freetype2/freetype" or by adding an 'advanced' entry in cmake-gui).
(this problem is either not reproducible with Ubuntu 10.10, or not present in spring master anymore)

to speed up compiling/linking, you can install gold, an alternative linker and an ccache:

<code><pre>sudo apt-get install binutils-gold ccache</pre></code>

to make ccache useful, the cache size needs to be increased by:

<code><pre>ccache -M 5G</pre></code>

to set it to 5GB.

== Gentoo ==
This has been tested to work with a clean install of gentoo 2008.0:

<code><pre>
emerge cmake \>=media-libs/freetype-2.0.0 \>=media-libs/libsdl-1.2.0
emerge media-libs/openal media-libs/glew dev-libs/boost
emerge app-arch/zip media-libs/libogg
USE="png jpg tiff opengl" emerge media-libs/devil
</pre></code>

== Fedora ==

On Fedora 8:

<code><pre>
yum install cmake boost-devel openal-devel SDL-devel \
DevIL-devel glew-devel libvorbis-devel
</pre></code>

On Fedora 12-15:

<code><pre>
yum install gcc-c++ cmake boost-devel DevIL-devel freetype-devel \
glew-devel libvorbis-devel libXcursor-devel openal-devel SDL-devel p7zip
</pre></code>

== Slackware ==

On Slackware 13, cmake, ogg & vorbis, boost, glew and SDL already come with the full regular install, both libs and headers. You can find helper scripts to easily compile and package DevIL, OpenAL and spring itself [http://slackbuilds.org/ here].

= Build And Install =

== Using CMake (2.6 or newer) ==
Configure and build:

<code><pre>
cmake .
make spring
</pre></code>

Install:

<code><pre>
make install-spring
</pre></code>

Default install paths are:

<code>/usr/local/bin/spring</code> Spring executable

<code>/usr/local/share/games/spring</code> read-only data

If you want <code>~/spring</code> prefix instead of <code>/usr/local</code>, configure like this:

<code><pre>
cmake -DCMAKE_INSTALL_PREFIX=~/spring .
</pre></code>
For further ways of customizing your build, have a look at the variables shown with:
<code><pre>
cmake -LH .
</pre></code>

Ububtu 9.10 - if it cannot locate freetype include dir, then use:
<code><pre>
cmake -DFREETYPE_INCLUDE_DIR=/usr .
</pre></code>

If you experience performance problems on multi-core systems, you may additionally build the MT version of spring:

<code><pre>
make spring-multithreaded
</pre></code>

And install with:
<code><pre>
make install-spring-multithreaded
</pre></code>

Other targets are: <code>spring-headless</code> and <code>spring-dedicated</code>.

{{Troubleshooting_linux}}

[[Category:Compiling]]
[[Category:Linux]]

Spring - User contributions [en]

Building Spring on Linux