Spring - User contributions [en]

Building Spring on Linux

2010-08-16T03:09:24Z

Romulous: /* Using CMake (2.6 or newer) */

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

'''Warning:''' 
'''Be careful when building from source.''' 
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'')!


== 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 either scons and python2.5-dev or 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 8.04 ===

<code><pre>
apt-get install p7zip-full libboost-thread1.40-dev libboost-regex1.40-dev
apt-get install libboost-program-options1.40-dev libboost-signals1.40-dev
</pre></code>
(or exchange the libboost 1.40 with 1.37, if you are using that version)

== 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:

<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>/usr</code> prefix instead of <code>/usr/local</code>, configure like this:

<code><pre>
cmake -DCMAKE_INSTALL_PREFIX=/usr .
</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-mt
</pre></code>

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

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

== Using Scons ==
Configure and build:

<code><pre>
scons configure
scons
</pre></code>

Install:

<code><pre>
scons install
</pre></code>

 
{{Finalizing_linux_install}}

 
{{Troubleshooting_linux}}

[[Category:Compiling]]

Building Spring on Linux

2010-08-16T03:09:07Z

Romulous: /* Using CMake (2.6 or newer) */

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

'''Warning:''' 
'''Be careful when building from source.''' 
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'')!


== 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 either scons and python2.5-dev or 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 8.04 ===

<code><pre>
apt-get install p7zip-full libboost-thread1.40-dev libboost-regex1.40-dev
apt-get install libboost-program-options1.40-dev libboost-signals1.40-dev
</pre></code>
(or exchange the libboost 1.40 with 1.37, if you are using that version)

== 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:

<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>/usr</code> prefix instead of <code>/usr/local</code>, configure like this:

<code><pre>
cmake -DCMAKE_INSTALL_PREFIX=/usr .
</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 freetpye 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-mt
</pre></code>

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

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

== Using Scons ==
Configure and build:

<code><pre>
scons configure
scons
</pre></code>

Install:

<code><pre>
scons install
</pre></code>

 
{{Finalizing_linux_install}}

 
{{Troubleshooting_linux}}

[[Category:Compiling]]

Gentoo install

2010-06-14T11:26:45Z

Romulous: /* Installation */

__TOC__[[Image:Gentoo.png]]
= Installation =

An overlay to use with layman is provided. If gentoo overlays and/or layman are new to you, [http://overlays.gentoo.org/ read about them], as they are an essential part of gentoo.

This example assumes you never used layman before.

<code style="font-size: 80%; color:#9f9"><pre>
### install layman (with git support)
### you don't need to if you used layman before, obviously
echo "app-portage/layman git" >> /etc/portage/package.use
emerge layman
echo "source /usr/local/portage/layman/make.conf" >> /etc/make.conf

Note: for Layman version 1.3.0 or later use:
echo "source /var/lib/layman/make.conf" >> /etc/make.conf

### add spring overlay to layman
layman -f -a Spring -o http://springrts.com/dl/overlays.xml

### allow installation of unstable versions
echo "games-strategy/spring ~x86" >> /etc/portage/package.keywords
echo "games-util/springlobby ~x86" >> /etc/portage/package.keywords

Note: for Layman version 1.3.0 or later package.keywords is a directory.

echo "games-strategy/spring ~x86" >> /etc/portage/package.keywords/spring.keywords
echo "games-util/springlobby ~x86" >> /etc/portage/package.keywords/spring.keywords

emerge eselect-wxwidgets wxGTK

### make sure wxWidgets has been activated, springlobby will fail without it with error:
### Could NOT find wxWidgets (missing: wxWidgets_FOUND)
eselect wxwidgets list
Available wxWidgets profiles:
[1] gtk2-unicode-release-2.8 *

# if none set, select one with e.g.:
eselect wxwidgets set 1

### install game and lobby
emerge spring springlobby
</pre></code>

== Upgrading ==

<code style="font-size: 80%; color:#9f9"><pre>
### update the repository and check for new versions
layman -S

### upgrade existing installations
emerge -u spring springlobby
</pre></code>

Your paths are: Spring executable in <code>/usr/games/bin/spring</code> and
read-only data in <code>/usr/share/games/spring</code>.

= Finalizing installation =

Now you have Spring installed along with SpringLobby. You are now ready to start springlobby for the first time.

== Maps & Mods ==

Since Spring is only an engine, you need to download games/mods for it, and the maps that go with those games.

Springlobby will automatically do this for you using bittorrent when you attempt to join a game with a map or mod that you don't currently have.

If you want to download it manually or browse existing maps, there are several easy to use websites - here are some:
*[http://spring.jobjol.nl/subcategory.php?id=1 SpringFiles]
*[http://spring-portal.com/ Spring-Portal]
*[http://www.darkstars.co.uk/downloads/index.php?dir=spring Darkstars]

Pick any of those sites, download a map or mod, and then double click it. This will move it to your Spring folder using the spring map/mod installer program. If you wish to move maps/mods by hand, they are located under ~/.spring/maps/ or ~/.spring/mods/ (if the folder doesn't exist - create it). Don't unpack the file in any way though, just download and save it. Reload your maps/mods in Springlobby, (Tools -> Reload maps/mods) and they will be ready to use.

These sites also may provide other neat things like lua widgets, epic replays, AI bots (for playing offline or to team up on with a freind). Generally the installation requires you to download the file and place it in the appropriate folder in your ~/.spring directory. (you may have to create the folder)

Hint: If you know the map name you want, there is a Search function provided in those websites. Just write a part of the name, like one word, and you'll easily find the map you were looking for - this is helpful later on.

=== BA (Balanced Annihilation) ===

A popular mod to get started with is Balanced Annihilation (BA) 6.21. Please note that before you can run it though, you'll need to download the OTA content - read the section below on how to get that.

=== CA (Complete Annihilation) ===

A new mod with better models, graphical effects, and a different take on gameplay is the CA mod - get it [http://trac.caspring.org/wiki/CAInstaller here].

{{Troubleshooting_linux}}
[[Category:Linux]]

Gentoo install

2010-06-14T11:18:04Z

Romulous: /* Installation */

__TOC__[[Image:Gentoo.png]]
= Installation =

An overlay to use with layman is provided. If gentoo overlays and/or layman are new to you, [http://overlays.gentoo.org/ read about them], as they are an essential part of gentoo.

This example assumes you never used layman before.

<code style="font-size: 80%; color:#9f9"><pre>
### install layman (with git support)
### you don't need to if you used layman before, obviously
echo "app-portage/layman git" >> /etc/portage/package.use
emerge layman
echo "source /usr/local/portage/layman/make.conf" >> /etc/make.conf

Note: for Layman version 1.3.0 or later use:
echo "source /var/lib/layman/make.conf" >> /etc/make.conf

### add spring overlay to layman
layman -f -a Spring -o http://springrts.com/dl/overlays.xml

### allow installation of unstable versions
echo "games-strategy/spring ~x86" >> /etc/portage/package.keywords
echo "games-util/springlobby ~x86" >> /etc/portage/package.keywords

emerge eselect-wxwidgets wxGTK

### make sure wxWidgets has been activated, springlobby will fail without it with error:
### Could NOT find wxWidgets (missing: wxWidgets_FOUND)
eselect wxwidgets list
Available wxWidgets profiles:
[1] gtk2-unicode-release-2.8 *

# if none set, select one with e.g.:
eselect wxwidgets set 1

### install game and lobby
emerge spring springlobby
</pre></code>

== Upgrading ==

<code style="font-size: 80%; color:#9f9"><pre>
### update the repository and check for new versions
layman -S

### upgrade existing installations
emerge -u spring springlobby
</pre></code>

Your paths are: Spring executable in <code>/usr/games/bin/spring</code> and
read-only data in <code>/usr/share/games/spring</code>.

= Finalizing installation =

Now you have Spring installed along with SpringLobby. You are now ready to start springlobby for the first time.

== Maps & Mods ==

Since Spring is only an engine, you need to download games/mods for it, and the maps that go with those games.

Springlobby will automatically do this for you using bittorrent when you attempt to join a game with a map or mod that you don't currently have.

If you want to download it manually or browse existing maps, there are several easy to use websites - here are some:
*[http://spring.jobjol.nl/subcategory.php?id=1 SpringFiles]
*[http://spring-portal.com/ Spring-Portal]
*[http://www.darkstars.co.uk/downloads/index.php?dir=spring Darkstars]

Pick any of those sites, download a map or mod, and then double click it. This will move it to your Spring folder using the spring map/mod installer program. If you wish to move maps/mods by hand, they are located under ~/.spring/maps/ or ~/.spring/mods/ (if the folder doesn't exist - create it). Don't unpack the file in any way though, just download and save it. Reload your maps/mods in Springlobby, (Tools -> Reload maps/mods) and they will be ready to use.

These sites also may provide other neat things like lua widgets, epic replays, AI bots (for playing offline or to team up on with a freind). Generally the installation requires you to download the file and place it in the appropriate folder in your ~/.spring directory. (you may have to create the folder)

Hint: If you know the map name you want, there is a Search function provided in those websites. Just write a part of the name, like one word, and you'll easily find the map you were looking for - this is helpful later on.

=== BA (Balanced Annihilation) ===

A popular mod to get started with is Balanced Annihilation (BA) 6.21. Please note that before you can run it though, you'll need to download the OTA content - read the section below on how to get that.

=== CA (Complete Annihilation) ===

A new mod with better models, graphical effects, and a different take on gameplay is the CA mod - get it [http://trac.caspring.org/wiki/CAInstaller here].

{{Troubleshooting_linux}}
[[Category:Linux]]

Gentoo install

2010-06-08T05:36:38Z

Romulous:

__TOC__[[Image:Gentoo.png]]
= Installation =

An overlay to use with layman is provided. If gentoo overlays and/or layman are new to you, [http://overlays.gentoo.org/ read about them], as they are an essential part of gentoo.

This example assumes you never used layman before.

<code style="font-size: 80%; color:#9f9"><pre>
### install layman (with git support)
### you don't need to if you used layman before, obviously
echo "app-portage/layman git" >> /etc/portage/package.use
emerge layman
echo "source /usr/local/portage/layman/make.conf" >> /etc/make.conf

Note: for Layman version 1.3.0 on use:
echo "source /var/lib/layman/make.conf" >> /etc/make.conf

### add spring overlay to layman
layman -f -a Spring -o http://springrts.com/dl/overlays.xml

### allow installation of unstable versions
echo "games-strategy/spring ~x86" >> /etc/portage/package.keywords
echo "games-util/springlobby ~x86" >> /etc/portage/package.keywords

emerge eselect-wxwidgets wxGTK

### make sure wxWidgets has been activated, springlobby will fail without it with error:
### Could NOT find wxWidgets (missing: wxWidgets_FOUND)
eselect wxwidgets list
Available wxWidgets profiles:
[1] gtk2-unicode-release-2.8 *

# if none set, select one with e.g.:
eselect wxwidgets set 1

### install game and lobby
emerge spring springlobby
</pre></code>

== Upgrading ==

<code style="font-size: 80%; color:#9f9"><pre>
### update the repository and check for new versions
layman -S

### upgrade existing installations
emerge -u spring springlobby
</pre></code>

Your paths are: Spring executable in <code>/usr/games/bin/spring</code> and
read-only data in <code>/usr/share/games/spring</code>.

= Finalizing installation =

Now you have Spring installed along with SpringLobby. You are now ready to start springlobby for the first time.

== Maps & Mods ==

Since Spring is only an engine, you need to download games/mods for it, and the maps that go with those games.

Springlobby will automatically do this for you using bittorrent when you attempt to join a game with a map or mod that you don't currently have.

If you want to download it manually or browse existing maps, there are several easy to use websites - here are some:
*[http://spring.jobjol.nl/subcategory.php?id=1 SpringFiles]
*[http://spring-portal.com/ Spring-Portal]
*[http://www.darkstars.co.uk/downloads/index.php?dir=spring Darkstars]

Pick any of those sites, download a map or mod, and then double click it. This will move it to your Spring folder using the spring map/mod installer program. If you wish to move maps/mods by hand, they are located under ~/.spring/maps/ or ~/.spring/mods/ (if the folder doesn't exist - create it). Don't unpack the file in any way though, just download and save it. Reload your maps/mods in Springlobby, (Tools -> Reload maps/mods) and they will be ready to use.

These sites also may provide other neat things like lua widgets, epic replays, AI bots (for playing offline or to team up on with a freind). Generally the installation requires you to download the file and place it in the appropriate folder in your ~/.spring directory. (you may have to create the folder)

Hint: If you know the map name you want, there is a Search function provided in those websites. Just write a part of the name, like one word, and you'll easily find the map you were looking for - this is helpful later on.

=== BA (Balanced Annihilation) ===

A popular mod to get started with is Balanced Annihilation (BA) 6.21. Please note that before you can run it though, you'll need to download the OTA content - read the section below on how to get that.

=== CA (Complete Annihilation) ===

A new mod with better models, graphical effects, and a different take on gameplay is the CA mod - get it [http://trac.caspring.org/wiki/CAInstaller here].

{{Troubleshooting_linux}}
[[Category:Linux]]

Gentoo install

2010-06-08T05:35:17Z

Romulous:

__TOC__[[Image:Gentoo.png]]
= Installation =

An overlay to use with layman is provided. If gentoo overlays and/or layman are new to you, [http://overlays.gentoo.org/ read about them], as they are an essential part of gentoo.

This example assumes you never used layman before.

<code style="font-size: 80%; color:#9f9"><pre>
### install layman (with git support)
### you don't need to if you used layman before, obviously
echo "app-portage/layman git" >> /etc/portage/package.use
emerge layman
echo "source /usr/local/portage/layman/make.conf" >> /etc/make.conf

Note: for Layman version 1.3.0 on use:
echo "source /var/lib/layman/make.conf" >> /etc/make.conf

### add spring overlay to layman
layman -f -a Spring -o http://springrts.com/dl/overlays.xml

### allow installation of unstable versions
echo "games-strategy/spring ~x86" >> /etc/portage/package.keywords
echo "games-util/springlobby ~x86" >> /etc/portage/package.keywords

emerge eselect-wxwidgets wxGTK

### make sure wxWidgets has been activated, springlobby will fail without it with error:
### Could NOT find wxWidgets (missing: wxWidgets_FOUND)
eselect wxwidgets list # if none set, select one with e.g.:
eselect wxwidgets set 3

### install game and lobby
emerge spring springlobby
</pre></code>

== Upgrading ==

<code style="font-size: 80%; color:#9f9"><pre>
### update the repository and check for new versions
layman -S

### upgrade existing installations
emerge -u spring springlobby
</pre></code>

Your paths are: Spring executable in <code>/usr/games/bin/spring</code> and
read-only data in <code>/usr/share/games/spring</code>.

= Finalizing installation =

Now you have Spring installed along with SpringLobby. You are now ready to start springlobby for the first time.

== Maps & Mods ==

Since Spring is only an engine, you need to download games/mods for it, and the maps that go with those games.

Springlobby will automatically do this for you using bittorrent when you attempt to join a game with a map or mod that you don't currently have.

If you want to download it manually or browse existing maps, there are several easy to use websites - here are some:
*[http://spring.jobjol.nl/subcategory.php?id=1 SpringFiles]
*[http://spring-portal.com/ Spring-Portal]
*[http://www.darkstars.co.uk/downloads/index.php?dir=spring Darkstars]

Pick any of those sites, download a map or mod, and then double click it. This will move it to your Spring folder using the spring map/mod installer program. If you wish to move maps/mods by hand, they are located under ~/.spring/maps/ or ~/.spring/mods/ (if the folder doesn't exist - create it). Don't unpack the file in any way though, just download and save it. Reload your maps/mods in Springlobby, (Tools -> Reload maps/mods) and they will be ready to use.

These sites also may provide other neat things like lua widgets, epic replays, AI bots (for playing offline or to team up on with a freind). Generally the installation requires you to download the file and place it in the appropriate folder in your ~/.spring directory. (you may have to create the folder)

Hint: If you know the map name you want, there is a Search function provided in those websites. Just write a part of the name, like one word, and you'll easily find the map you were looking for - this is helpful later on.

=== BA (Balanced Annihilation) ===

A popular mod to get started with is Balanced Annihilation (BA) 6.21. Please note that before you can run it though, you'll need to download the OTA content - read the section below on how to get that.

=== CA (Complete Annihilation) ===

A new mod with better models, graphical effects, and a different take on gameplay is the CA mod - get it [http://trac.caspring.org/wiki/CAInstaller here].

{{Troubleshooting_linux}}
[[Category:Linux]]

Gentoo install

2010-06-08T05:22:50Z

Romulous:

__TOC__[[Image:Gentoo.png]]
= Installation =

An overlay to use with layman is provided. If gentoo overlays and/or layman are new to you, [http://overlays.gentoo.org/ read about them], as they are an essential part of gentoo.

This example assumes you never used layman before.

<code style="font-size: 80%; color:#9f9"><pre>
### install layman (with git support)
### you don't need to if you used layman before, obviously
echo "app-portage/layman git" >> /etc/portage/package.use
emerge layman
echo "source /usr/local/portage/layman/make.conf" >> /etc/make.conf

Note: for Layman version 1.3.0 on use:
echo "source /var/lib/layman/make.conf" >> /etc/make.conf

### add spring overlay to layman
layman -f -a Spring -o http://springrts.com/dl/overlays.xml

### allow installation of unstable versions
echo "games-strategy/spring ~x86" >> /etc/portage/package.keywords
echo "games-util/springlobby ~x86" >> /etc/portage/package.keywords

### make sure wxWidgets has been activated, springlobby will fail without it with error:
### Could NOT find wxWidgets (missing: wxWidgets_FOUND)
eselect wxwidgets list # if none set, select one with e.g.:
eselect wxwidgets set 3

### install game and lobby
emerge spring springlobby
</pre></code>

== Upgrading ==

<code style="font-size: 80%; color:#9f9"><pre>
### update the repository and check for new versions
layman -S

### upgrade existing installations
emerge -u spring springlobby
</pre></code>

Your paths are: Spring executable in <code>/usr/games/bin/spring</code> and
read-only data in <code>/usr/share/games/spring</code>.

= Finalizing installation =

Now you have Spring installed along with SpringLobby. You are now ready to start springlobby for the first time.

== Maps & Mods ==

Since Spring is only an engine, you need to download games/mods for it, and the maps that go with those games.

Springlobby will automatically do this for you using bittorrent when you attempt to join a game with a map or mod that you don't currently have.

If you want to download it manually or browse existing maps, there are several easy to use websites - here are some:
*[http://spring.jobjol.nl/subcategory.php?id=1 SpringFiles]
*[http://spring-portal.com/ Spring-Portal]
*[http://www.darkstars.co.uk/downloads/index.php?dir=spring Darkstars]

Pick any of those sites, download a map or mod, and then double click it. This will move it to your Spring folder using the spring map/mod installer program. If you wish to move maps/mods by hand, they are located under ~/.spring/maps/ or ~/.spring/mods/ (if the folder doesn't exist - create it). Don't unpack the file in any way though, just download and save it. Reload your maps/mods in Springlobby, (Tools -> Reload maps/mods) and they will be ready to use.

These sites also may provide other neat things like lua widgets, epic replays, AI bots (for playing offline or to team up on with a freind). Generally the installation requires you to download the file and place it in the appropriate folder in your ~/.spring directory. (you may have to create the folder)

Hint: If you know the map name you want, there is a Search function provided in those websites. Just write a part of the name, like one word, and you'll easily find the map you were looking for - this is helpful later on.

=== BA (Balanced Annihilation) ===

A popular mod to get started with is Balanced Annihilation (BA) 6.21. Please note that before you can run it though, you'll need to download the OTA content - read the section below on how to get that.

=== CA (Complete Annihilation) ===

A new mod with better models, graphical effects, and a different take on gameplay is the CA mod - get it [http://trac.caspring.org/wiki/CAInstaller here].

{{Troubleshooting_linux}}
[[Category:Linux]]

Gentoo install

2010-06-08T05:22:32Z

Romulous:

__TOC__[[Image:Gentoo.png]]
= Installation =

An overlay to use with layman is provided. If gentoo overlays and/or layman are new to you, [http://overlays.gentoo.org/ read about them], as they are an essential part of gentoo.

This example assumes you never used layman before.

<code style="font-size: 80%; color:#9f9"><pre>
### install layman (with git support)
### you don't need to if you used layman before, obviously
echo "app-portage/layman git" >> /etc/portage/package.use
emerge layman
echo "source /usr/local/portage/layman/make.conf" >> /etc/make.conf

Note: for Layman version 1.3.0 on use:
echo "source /var/lib/layman/make.conf" >> /etc/make.conf

### add spring overlay to layman
layman -f -a Spring -o http://springrts.com/dl/overlays.xml

### allow installation of unstable versions
echo "games-strategy/spring ~x86" >> /etc/portage/package.keywords
echo "games-util/springlobby ~x86" >> /etc/portage/package.keywords

### make sure wxWidgets has been activated, springlobby will fail without it with error:
### Could NOT find wxWidgets (missing: wxWidgets_FOUND)
eselect wxwidgets list # if none set, select one with e.g.:
eselect wxwidgets set 3

### install game and lobby
emerge spring springlobby
</pre></code>

== Upgrading ==

<code style="font-size: 80%; color:#9f9"><pre>
### update the repository and check for new versions
layman -S

### upgrade existing installations
emerge -u spring springlobby
</pre></code>

Your paths are: Spring executable in <code>/usr/games/bin/spring</code> and
read-only data in <code>/usr/share/games/spring</code>.

= Finalizing installation =

Now you have Spring installed along with SpringLobby. You are now ready to start springlobby for the first time.

== Maps & Mods ==

Since Spring is only an engine, you need to download games/mods for it, and the maps that go with those games.

Springlobby will automatically do this for you using bittorrent when you attempt to join a game with a map or mod that you don't currently have.

If you want to download it manually or browse existing maps, there are several easy to use websites - here are some:
*[http://spring.jobjol.nl/subcategory.php?id=1 SpringFiles]
*[http://spring-portal.com/ Spring-Portal]
*[http://www.darkstars.co.uk/downloads/index.php?dir=spring Darkstars]

Pick any of those sites, download a map or mod, and then double click it. This will move it to your Spring folder using the spring map/mod installer program. If you wish to move maps/mods by hand, they are located under ~/.spring/maps/ or ~/.spring/mods/ (if the folder doesn't exist - create it). Don't unpack the file in any way though, just download and save it. Reload your maps/mods in Springlobby, (Tools -> Reload maps/mods) and they will be ready to use.

These sites also may provide other neat things like lua widgets, epic replays, AI bots (for playing offline or to team up on with a freind). Generally the installation requires you to download the file and place it in the appropriate folder in your ~/.spring directory. (you may have to create the folder)

Hint: If you know the map name you want, there is a Search function provided in those websites. Just write a part of the name, like one word, and you'll easily find the map you were looking for - this is helpful later on.

=== BA (Balanced Annihilation) ===

A popular mod to get started with is Balanced Annihilation (BA) 6.21. Please note that before you can run it though, you'll need to download the OTA content - read the section below on how to get that.

=== CA (Complete Annihilation) ===

A new mod with better models, graphical effects, and a different take on gameplay is the CA mod - get it [http://trac.caspring.org/wiki/CAInstaller here].

{{Troubleshooting_linux}}
[[Category:Linux]]