SetupGuide

Linux Setup Guide

gentoo linux

• If you're running Gentoo linux, you're lucky, because an ebuild is already available.
  The best way to install the ebuild in gentoo would be to add an portage overlay and copy the file into the overlay. Now in detail:
  

1. mkdir /usr/local/portage
2. add this line to you /etc/make.conf
   PORTDIR_OVERLAY="/usr/local/portage"
3. download the ebuild you want, for example: taspring-linux-release-ebuild-0.72-r1.tar.bz2
4. mv taspring-linux-release-ebuild-0.72-r1.tar.bz2 /usr/local/portage
5. cd /usr/local/portage
6. tar jxvf taspring-linux-release-ebuild-0.72-r1.tar.bz2
7. most likely you don't run a ~x86 system (unstable) so do a:
   echo "games-strategy/taspring-linux-release ~x86" >> /etc/portage/package.keywords
8. You might want to have a look at the USE flags, type:
   emerge -pv taspring-linux-release
9. finally:
   emerge -pv taspring-linux-release

all other linux distributions

In short, to get spring compiled under linux, make sure you've got all necessary development packages installed. On (K)Ubuntu linux, and maybe Debian too, this can be done by copying the following in a root terminal (or use the graphical package manager Synaptic or Adept if you can't stand commandline):

apt-get install build-essential subversion scons libsdl-dev libopenal-dev libglew-dev libboost-dev libboost-thread-dev libboost-filesystem-dev libboost-regex-dev libdevil-dev libfreetype6-dev python2.4-dev

For any other distribution, grab these libraries and the base development packages too (for Gentoo, base development packages aren't needed, because everything is compiled from source: they're already installed). I've no clue about RPM based distros. But google is your friend.

• Grab the latest work-in-progress sourcecode from subversion (using commandline SVN):
  
  svn co https://taspring.clan-sy.com/svn/spring/trunk
  
  Or look in https://taspring.clan-sy.com/svn/spring/tags/ for the last official release.

• To compile the sourcecode, switch to the trunk directory created by the svn checkout in the previous step. Then type: scons configure to configure the build. (You can fine tune the build by passing options to this command [for enabling debugging/optimizing etc.]. Type scons --help to view the available options.) Now, if you really installed all development package, the scons configure will output: "Everything seems OK. Run `scons' now to build.". If it outputs with an error you're probably missing a development package.

• As instructed on end of previous step, type: scons Spring will now build including NTAI, JCAI and a few GroupAIs. You should end up with a file trunk/game/spring (the executable) and some shared objects (SOs or DLLs) in trunk/game/aidll

• Now, grab the linux data tarball and extract it somewhere. This will create a directory taspring-linux-data-0.71b1 (or higher version number).

• Put a symlink to the spring executable in the data directory:
  ln -s /path/to/trunk/game/spring /path/to/taspring-linux-data-0.71b1/spring

• Optionally, make symlinks for the shared objects in trunk/game/aidll too.

• Now run spring by cd'ing (change dir) to the taspring-linux-data-0.71b1 directory and typing: ./spring If you've compiled with debugging enabled, you might want to run inside gdb to provide the devs with a backtrace if spring crashes: gdb ./spring
  • Basic commands inside gdb are:
    • run - Run the program (spring)
    • bt - Print a backtrace
    • quit - Quit
    • help - This one's important

• Be happy!

Tips:

• Checkout File Universe for much more maps & mods.
• If spring hangs/crashes while in full screen mode, you can press ctrl+alt+backspace to restart X, so no need for a reboot.
• A binary release of AAI, a skirmish AI, is included in the data package.
• Spring uses OpenAL for sound, Config your sound output i.e esd / arts / oss / alsa by editing /etc/openalrc or ~/.openalrc, example: ("'(" is not a typo)

(define devices '(alsa))
(define speaker-num 2)
(define alsa-out-device "hw:0,0")
(define alsa-in-device "hw:0,0")
Adventurous people with an emu10k1 based card (sblive) can try the accelerated openal version. http://www.lost.org.uk/openal.html , don't submit audiobugs if you do.

If you really can't figure out how to get spring compiled, or you think there's a bug in the code or the buildsystem...

• just poke any developer on IRC
  • channel #taspring on FreeNode
  • or channel #sy on QuakeNet
• post it on the forum
• or file a bug in our Bug tracking system.