Spring - User contributions [en]

The Lighter Side Of Spring

2009-02-26T18:43:51Z

Andre:

Even developers, content creators and rabid players occassionally have abberant moments of comedic genius. Therefore, there is a section of the Spring Wiki dedicated to the lighter side of what we as a community do and who we as a community are.

===Comics & Images===
*[[1v0ry_k1ng's Works]]
*[http://spring.clan-sy.com/phpbb/viewtopic.php?t=8428&highlight=smug Smug Guide to Running Your Boy]
*[[Ra1ders Works]]
*[[http://spring.clan-sy.com/phpbb/viewtopic.php?f=10&t=15187&start=36 The Battlefield in CORE SUXXX from the-middleman]]
*[[http://spring.clan-sy.com/phpbb/viewtopic.php?f=10&t=15405 The Battlefield in Roleplay from the-middleman]]

===Quotations & Sound Clips===

*[http://quotes.springlobby.info/ SpringBash] - Real quotes from lobby, often taken out of context!

Download

2009-01-19T12:45:19Z

Andre:

==Spring Downloads==

On this page you will find information on how to download the latest releases from the Spring project for various platforms.

Make sure that you download the latest drivers for your graphic card in order to make Spring work correctly.

==Spring RTS Engine + Mods/Games==

If all you are interested in is playing the game using the existing public lobby server (for multiplayer online play), then these are the files you will want.

===Windows===

'''[http://spring.clan-sy.com/dl/spring_0.78.2.exe Click here to download ]''' version 0.78.2 15.0MB, added 2009-01-18

'''[http://48257.webtest.goneo.de/spring/spring_0.78.2.1.exe Mirror #1]''' version 0.78.2.<u>'''1'''</u> 15.0MB, added 2009-01-18

'''[https://blendax.informatik.uni-bremen.de/jan/spring/spring_0.78.2.1.exe Mirror #2]''' version 0.78.2.<u>'''1'''</u> 15.0MB, added 2009-01-18

This installer provides the core files you need to play Spring, the multiplayer lobby client and the autodownloader. Use it to get maps and games, or download them from some hosting sites (listed in main).

===Linux===

The '''[[SetupGuide|Linux set up guide]]''' provides set up information for various Linux distributions.

The Linux releases track with the Windows release, and those playing the game on Linux can play against players running the Windows version.

===Mac OS X===

The Mac OS X port is rough and unfinished. Help with its development would be greatly appreciated. More information on the current state of this port can be found '''[[Spring_on_MacOSX|here]]'''.

=== Source Code ===
'''[http://spring.clan-sy.com/dl/spring_0.78.2.1_src.tar.lzma Linux .tar.lzma (smaller)]'''

'''[http://spring.clan-sy.com/dl/spring_0.78.2.1_src.tar.gz Linux .tar.gz]'''

==Lobby server==

This is for those wanting to run their own private or public lobby server, e.g. if you want to use Spring on a LAN without the need for an external internet connection. See the readme '''[http://spring.clan-sy.com/dl/tasserver_readme.txt here]'''.

===Windows===

'''[http://spring.clan-sy.com/dl/TASServer_035.exe Click here to download]''' 120.7kb, added 2008-03-02

===Linux===

'''[http://spring.clan-sy.com/dl/TASServer.jar Click here to download]''' 100.7kb, added 2008-03-02

===Mac OS X===

'''(Untested)''' Try the Linux release above, and let us know if it works!

Download

2009-01-18T15:20:19Z

Andre:

==Spring Downloads==

On this page you will find information on how to download the latest releases from the Spring project for various platforms.

Make sure that you download the latest drivers for your graphic card in order to make Spring work correctly.

==Spring RTS Engine + Mods/Games==

If all you are interested in is playing the game using the existing public lobby server (for multiplayer online play), then these are the files you will want.

===Windows===

'''[https://blendax.informatik.uni-bremen.de/jan/spring/spring_0.78.2.1.exe Click here to download]''' 15.0MB, added 2009-01-18

'''[http://spring.clan-sy.com/dl/spring_0.78.2.1.exe Mirror #1]''' 15.0MB, added 2009-01-18

'''[http://48257.webtest.goneo.de/spring/spring_0.78.2.exe Mirror #2]''' 15.0MB, added 2009-01-18

This installer provides the core files you need to play Spring, the multiplayer lobby client and the autodownloader. Use it to get maps and games, or download them from some hosting sites (listed in main).

===Linux===

The '''[[SetupGuide|Linux set up guide]]''' provides set up information for various Linux distributions.

The Linux releases track with the Windows release, and those playing the game on Linux can play against players running the Windows version.

===Mac OS X===

The Mac OS X port is rough and unfinished. Help with its development would be greatly appreciated. More information on the current state of this port can be found '''[[Spring_on_MacOSX|here]]'''.

=== Source Code ===
'''[http://spring.clan-sy.com/dl/spring_0.78.2.1_src.tar.lzma Linux .tar.lzma (smaller)]'''

'''[http://spring.clan-sy.com/dl/spring_0.78.2.1_src.tar.gz Linux .tar.gz]'''

==Lobby server==

This is for those wanting to run their own private or public lobby server, e.g. if you want to use Spring on a LAN without the need for an external internet connection. See the readme '''[http://spring.clan-sy.com/dl/tasserver_readme.txt here]'''.

===Windows===

'''[http://spring.clan-sy.com/dl/TASServer_035.exe Click here to download]''' 120.7kb, added 2008-03-02

===Linux===

'''[http://spring.clan-sy.com/dl/TASServer.jar Click here to download]''' 100.7kb, added 2008-03-02

===Mac OS X===

'''(Untested)''' Try the Linux release above, and let us know if it works!

Debugging sync errors

2009-01-15T17:24:27Z

Andre:

Desync happens when simulation gives different results for different clients. Currently it is detected by means of checksumming crucial data on every write; this checksum is then transferred to the host, who compares them to his own checksum.

For purposes of debugging, the sync debugger stores every such write with some debugging information. When a desync happens, the write history is compared on every client, who then sends locations where computation has given different results. The location is then resolved to line number of the engine source, which should provide information about the nature of the desync.

To enable sync debugging, you have use a special build of Spring. To obtain it, you must:

# Go to #buildserv and request a syncdebug build with ''!rebuild profile=syncdebug''. You can request a specific version by adding ''tag=<svn tag>'' or ''rev=<svn rev number>''. Type ''!help'' for help.
# If the build works, an executable will be uploaded to the usual place; at the time of this writing, it's http://planetspring.free.fr/spring/executable/. The generated archive will have [syncdebug] in its name.
# To compile it with linux use: ' scons configure syncdebug=yes synctrace=yes optimize=yes debug=1 gml=false' after getting the same revision from git.
# Host a game. Make sure '''every''' player who joins has this exe; it's not needed to have it at the time of joining the battle, but when the game starts, everyone must have it. Expect random undefined behaviour otherwise.
# If you want engine source lines, the host has to download two more files: debug symbols and addr2line. Debug symbols are generated and uploaded by buildserv; as of now, they can be found at http://planetspring.free.fr/spring/debug/. addr2line is a part of MinGW32 [http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=11290 binutils package].
## Download debug symbols
## Download addr2line
## Extract both to where your syncdebug-enabled spring.exe lives
## '''Rename debug symbols to spring.dbg'''
Only the host needs to download addr2line and debug symbols.

When everybody is in game, test your setup by enabling cheats (''/cheat'') and having one of the players do a test desync (''/desync''). The game should pause and syncdebugger should do its work. If the game pauses, but you won't see SD messages, it's likely that one of the clients doesn't have the correct exe.

In addition to syncdebugger logs, syncdebug engine builds also have synctrace enabled. This option makes spring.exe write a file called trace<playernum>.log which logs important simulation events in a diff-friendly format. After a desync, get this file from the desynced player(s) and do a ''diff -u yourtrace histrace'' to find the first ''logged'' sync mismatch. The real desync probably happened somewhere in between the two log lines.

If you're a mod developer, please be aware that Lua may be a source of desyncs. E.g. table iteration using '''ipairs is not a sync-safe operation''', see [http://spring.clan-sy.com/mantis/view.php?id=1050 mantis #1050] for example of such a desync.

Debugging sync errors

2009-01-14T20:17:17Z

Andre:

Desync happens when simulation gives different results for different clients. Currently it is detected by means of checksumming crucial data on every write; this checksum is then transferred to the host, who compares them to his own checksum.

For purposes of debugging, the sync debugger stores every such write with some debugging information. When a desync happens, the write history is compared on every client, who then sends locations where computation has given different results. The location is then resolved to line number of the engine source, which should provide information about the nature of the desync.

To enable sync debugging, you have use a special build of Spring. To obtain it, you must:

# Go to #buildserv and request a syncdebug build with ''!rebuild profile=syncdebug''. You can request a specific version by adding ''tag=<svn tag>'' or ''rev=<svn rev number>''. Type ''!help'' for help.
# If the build works, an executable will be uploaded to the usual place; at the time of this writing, it's http://planetspring.free.fr/spring/executable/. The generated archive will have [syncdebug] in its name.
# To compile it with linux use: 'scons configure syncdebug=yes synctrace=yes optimize=yes debug=1' after getting the same revision from git.
# Host a game. Make sure '''every''' player who joins has this exe; it's not needed to have it at the time of joining the battle, but when the game starts, everyone must have it. Expect random undefined behaviour otherwise.
# If you want engine source lines, the host has to download two more files: debug symbols and addr2line. Debug symbols are generated and uploaded by buildserv; as of now, they can be found at http://planetspring.free.fr/spring/debug/. addr2line is a part of MinGW32 [http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=11290 binutils package].
## Download debug symbols
## Download addr2line
## Extract both to where your syncdebug-enabled spring.exe lives
## '''Rename debug symbols to spring.dbg'''
Only the host needs to download addr2line and debug symbols.

When everybody is in game, test your setup by enabling cheats (''/cheat'') and having one of the players do a test desync (''/desync''). The game should pause and syncdebugger should do its work. If the game pauses, but you won't see SD messages, it's likely that one of the clients doesn't have the correct exe.

In addition to syncdebugger logs, syncdebug engine builds also have synctrace enabled. This option makes spring.exe write a file called trace<playernum>.log which logs important simulation events in a diff-friendly format. After a desync, get this file from the desynced player(s) and do a ''diff -u yourtrace histrace'' to find the first ''logged'' sync mismatch. The real desync probably happened somewhere in between the two log lines.

If you're a mod developer, please be aware that Lua may be a source of desyncs. E.g. table iteration using '''ipairs is not a sync-safe operation''', see [http://spring.clan-sy.com/mantis/view.php?id=1050 mantis #1050] for example of such a desync.

Building Spring on Linux

2008-10-31T21:48:28Z

Andre:

== Build From Source ==

'''You might encounter sync errors in online play if you are not using the exact same version of the compiler and same compiler settings as used for prebuilt packages! (Applies to GCC <4.0)'''

For 0.77b5 these are: TODO add them here.

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.

=== Get Source ===

You can either download the source as a tarball (recommended; v. 0.77b5) or get it from the subversion repository. Either way, the result is the same.

==== Tarball ====

<code><pre>
cd /usr/local/src # or /var/tmp, or whatever
wget http://planetspring.free.fr/spring/src/spring_0.77b5-spring_0.77b5_src.tar.bz2
tar xjf spring_0.77b2-spring_0.77b5_src.tar.bz2
cd spring_0.77b5
</pre></code>

'''NOTE: The .zip release is for windows only. Linux users have to get .bz2 like shown above.'''

==== Subversion ====

<code><pre>
aptitude install subversion # if you are not on debian, figure it out
svn co https://spring.clan-sy.com/svn/spring/tags/spring_0.77b5 \
/usr/local/src/spring_0.77b5
cd /usr/local/src/spring_0.77b5
</pre></code>

If the above subversion host happens to be down (which is unlikely since you're reading this wiki page now), you can try the following hourly updated mirror (replace the svn co line above with the following line):
<code><pre>
svn co svn://caspring.org:3691/tags/spring_0.77b5 \
/usr/local/src/spring_0.77b5
</pre></code>

=== Dependencies ===

You will need 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. The scons configure will whine if you forget something, but it does not check if you remembered to install zip, even though you still need it.

==== 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.
that Spring 0.77b5 depends on the boost libraries version 1.34.* and won't
work on lower versions. (updated libboost-serialization-dev, and libvorbis-dev dependencies for 0.76b1)

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

<code><pre>
sudo aptitude install scons build-essential zlib1g-dev libfreetype6-dev
sudo aptitude install libsdl1.2-dev libopenal-dev libglew-dev libboost-dev
sudo aptitude install libboost-thread-dev libboost-regex-dev libdevil-dev
sudo aptitude install libboost-serialization-dev python2.5-dev zip
sudo aptitude install libvorbis-dev libxcursor-dev
</pre></code>

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

<code><pre>
emerge dev-util/scons \>=media-libs/freetype-2.0.0 \>=media-libs/libsdl-1.2.0
emerge media-libs/openal =dev-lang/python-2.4\* media-libs/glew dev-libs/boost
emerge media-libs/devil app-arch/zip media-libs/libogg
</pre></code>

==== Fedora ====

On Fedora 8, these dependencies should be sufficient:

<code><pre>
yum install scons boost-devel openal-devel SDL-devel \
DevIL-devel glew-devel java-1.7.0-icedtea-devel libvorbis-devel
</pre></code>

Fedora 9 has issues with 0.76b1, because it uses GCC 4.3 which changed a few compilation warnings into errors. However, the [http://spring.clan-sy.com/phpbb/viewtopic.php?f=20&t=12802 inofficial Linux installer] may work for you (it installs a precompiled binary).

=== Build And Install ===

The build will spew out warnings like the following, which you can safely ignore:

<code><pre>
warning: division by zero
warning: 'q' may be used uninitialized in this function
</pre></code>
==== Using Scons ====
Configure and build:

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

Install:

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

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

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

Install:

<code><pre>
make install
</pre></code>

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

{{Finalizing_linux_install}}

{{Linux_tips}}

{{Troubleshooting_linux}}