Spring - User contributions [en]

Building Spring on MacOSX

2020-03-04T17:44:08Z

Af:

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

This is a guide to the requirements for building the Spring RTS engine on MacOS. If you want only to play a spring game, follow the [[Spring_on_MacOSX]] Tutorial.

=Building Spring on MacOS=

'''This guide is for x86/Intel based MacOS installs'''

Even though it will not run, Spring should successfully compile on Mac for both 104.0 and the latest develop version.

NOTE: Only official spring versions 99.0-103.1 will compile and run on MacOS. 104+ will compile, but uses an incompatible OpenGL version. When 105.0 is released, a MacOS - compatible OpenGL version will be used, however at this point in time '''there are other blocking issues'''.

Questions about this process should be asked [https://springrts.com/phpbb/viewforum.php?f=65 here].

=Requirements=

==Command Line Tools==

Install the [http://developer.apple.com/TOOLS/Xcode/ Xcode developers package] (this requires a free membership to apple's ADC website).

==Package Manager==

Either [http://brew.sh Homebrew] or [http://www.macports.org/install.php MacPorts] may be used to fetch dependencies. The MacOS Buildbot (run by Turboss) uses Homebrew. The writer uses Macports.

== Compiler==

Compiler: GCC must be used, and dependencies must be compiled with GCC

=== MacPorts ===

For MacPorts:
<pre>
port install
sudo port select --set gcc mp-gcc8
hash -r # Reload the terminal
</pre>

To check for installed gcc:
<code>
port select --list gcc
</code>

===HomeBrew===

<pre>
brew install gcc@8
</pre>

==Dependencies==

===MacPorts===

Necessary dependencies for the develop branch are below (as called by Macports):

<pre>
port install sudo port install cmake libsdl2 p7zip libdevil libvorbis minizip openal-soft glew freetype binutils libXcursor +gcc8
</pre>

(This list has not been tested for errors; please message MasterBel if they do not work for you.)

Compiling Spring 104.0 (current master) or older will also require Boost. [https://sourceforge.net/projects/boost/ Retreive source] and compile with gcc. '''TODO: Instructions?'''

===HomeBrew===

Note that this list is incomplete:

<pre>
brew install cmake minizip freetype glew openal-soft p7zip clang-format libvorbis jsoncpp PkgConfig devil sdl2
</pre>

You will also need to install XQuartz for the X11 dependency, however it will install the headers in a non-standard location. Use this command to symlink it to the standard location:

<pre>
ln -s /opt/X11/include/X11 /usr/local/include/X11
</pre>

==Obtaining Source==

<code>
git clone --recursive git://github.com/spring/spring.git -b <branch>
</code>

The “master” branch is the latest stable release. “develop” branch is the latest development release. (Note: The recursive argument is important for submodules.) 
Update with: <code>git pull --rebase</code>

=Compiling Source=

<pre>
cmake . -DCMAKE_CXX_COMPILER=/path/to/bin/g++-mp-8 -DCMAKE_C_COMPILER=/path/to/bin/gcc-mp-8
make spring
</pre>

Other common Cmake flags are:
<pre>
-DGLEW_INCLUDE_DIR=/path/to/include
-DGLEW_LIBRARIES=/path/to/lib/libGLEW.a
-DOPENAL_INCLUDE_DIR=/path/to/include/AL
-DCMAKE_INSTALL_PREFIX:PATH=/path/to/output/directory
-DCMAKE_PREFIX_PATH=/path/
</pre>

If boost is used:
<code>
-DBoost_Root=/path/to/boost
</code>

Number of simultaneous jobs may be specified by: <code>make spring -j<n></code> Where n is number of jobs. It is common for n to be number of cores + 1

Other targets may be made also/instead, e.g.

<pre>
make prdownloader -j<n>
make install-spring -j<n>
</pre>

=Additional Notes=

==Using Macports==
As hint: set "buildmakejobs" to cpu-core count + 1 in /opt/local/etc/macports/macports.conf. For example:
<code>
buildmakejobs 5
</code>

==Using Homebrew==

Hombrew can install boost, but it must be recompiled with gcc <version>:
<code>
brew install boost --build-from-source --cc=gcc<version>
</code>

These flags were recommended by a previous editor:
<pre>
cmake . -DAPPLE=1 -DCMAKE_CXX_COMPILER=/usr/local/Cellar/gcc48/4.8.3/bin/g++-4.8 \
-DCMAKE_C_COMPILER=/usr/local/Cellar/gcc48/4.8.3/bin/gcc-4.8 \
-DIL_INCLUDE_DIR=/usr/local/include \
-DGLEW_INCLUDE_DIR=/usr/local/include \
-DOPENAL_DIR=/usr/local/include/AL \
-DNO_SOUND=1
</pre>

=Examples=

==Macports==

<pre>
# Example setup script (for MacOS Catalina)

# Macports must be installed prior to running this script. Macports requires XCode to be installed.
# Boost sources must be located in

# Requires the following directory format:
# $DIR (customisable; set on line 16)
# /setup.sh
# /build.sh
# /Sources
# /boost_1_68_0
# /Builds
# /Bunldes

DIR=~/Spring # The root directory; to be set manually

SCRIPTDIR=~/Documents/Spring/ # The directory the build script is located in

SOURCES=$DIR/Sources
SPRING=$SOURCES/spring
BOOST=$SOURCES/boost_1_66_0/boost

cd $DIR

# Install the necessary compiler. Version gcc5 is oldest compatible with High Sierra; gcc48 is the oldest I know works
sudo port install gcc9

# Set compiler as default
sudo port select --set gcc mp-gcc9
hash -r

sudo port install cmake libsdl2 p7zip libdevil libvorbis minizip openal-soft glew freetype binutils dylibbundler xorg-libXcursor +gcc9
#dylibbundler is for the bundling stage, not actual dependency

cd $SOURCES

# Clone from git (creates the directory $SPRING for us)
git clone --recursive git://github.com/spring/spring.git
cd $SPRING
git fetch --all --tags --prune
git checkout tags/103.0 -b master

# Install Boost

cd $BOOST

./bootstrap.sh --with-toolset=gcc --with-libraries=all # Not sure which libaries.
./b2 # install

# Try compiling spring

cd $SCRIPTDIR

sh build.sh

</pre>

<pre>

# Example buildscript (for MacOS Catalina)

# This script assumes that setup.sh (the above example) has been run.

# Build Configuration

BRANCH=<branch name> # The source branch to checkout and build.
REPOSITORY=spring # The name of the folder containing the git repository.
WIPE=0 # Wipes previous build on WIPE = 1 (flag -w)

for arg in "$@"
do
if [ "$arg" == "-w" ]; then
echo "Initiating clean build."
WIPE=1
else
echo "Unknown flag ${arg}"
fi
done

echo "Building sources at/to ${REPOSITORY}"

# Directory Setup

DIR=~/Spring # Where everything is/will be
SOURCES=$DIR/Sources
SPRING=$SOURCES/$REPOSITORY
BUILD=$DIR/Builds/$REPOSITORY
BOOST=$SOURCES/boost_1_55_0 # Where boost can be found. Must be prepared as per the setup script (above).

MACPORTS=/opt/local # The install directory of MACPORTS

if [ -d $BUILD ]; then
if [ $WIPE != 0 ]; then
echo "Wiping previous build…"
rm -r $BUILD # Wipe preivous build

echo "Making new build directory…"
mkdir $BUILD # The others should have already been made
fi
else
echo "Making new build directory…"
mkdir $BUILD # The others should have already been made
fi

if [ -e $DIR/log.txt ]; then
echo "Removing outdated log…"
rm $DIR/log.txt
fi

# Source setup

if [ -d $SPRING ]; then
cd $SPRING
else
echo "Cloning remote…"
cd $SOURCES
git clone --recursive git://github.com/spring/spring.git $REPOSITORY

cd $SPRING
fi

# Update repository

CURRENTBRANCH=$(git rev-parse --abbrev-ref HEAD)

if [ "$CURRENTBRANCH" != "$BRANCH" ]; then
git fetch --all
echo "Switching branch from ${CURRENTBRANCH} to ${BRANCH}"
git checkout $BRANCH
fi

echo "Updating to latest…"
git pull # Update to latest
echo "Updating submodules"
git submodule update

# Metadata

REV=$(git describe --tags)
VERSION=`echo "${REV}" | tr '<>:\"/\\|?*' -`

# Compile

echo "Compiling Spring ${VERSION}"

cd $BUILD

cmake . $SPRING -DCMAKE_PREFIX_PATH=$MACPORTS -DCMAKE_CXX_COMPILER=$MACPORTS/bin/g++-mp-9 -DCMAKE_C_COMPILER=$MACPORTS/bin/gcc-mp-9 -DGLEW_INCLUDE_DIR=$MACPORTS/include -DGLEW_LIBRARIES=$MACPORTS/lib/libGLEW.a -DOPENAL_INCLUDE_DIR=$MACPORTS/include/AL -DBOOST_ROOT=$BOOST -DBoost_USE_STATIC_LIBS=YES -DCMAKE_CXX_FLAGS="${FLAGS}" -DCMAKE_C_FLAGS="${FLAGS}"

make spring -j5 # >>$DIR/log.txt 2>&1

make pr-downloader # -j5 >>$DIR/log.txt 2>&1

make install-spring DESTDIR=$BUILD/temp #>>$DIR/log.txt 2>&1

# Bundling spring

BUNDLES=$DIR/Bundles
BUNDLE=$BUNDLES/Spring_${VERSION}.app

mkdir $BUNDLES
mkdir $BUNDLE
mkdir $BUNDLE/Contents
mkdir $BUNDLE/Contents/MacOS
mkdir $BUNDLE/Contents/Resources
mkdir $BUNDLE/Contents/lib

cp $BUILD/spring $BUNDLE/Contents/MacOS/spring #>>$DIR/log.txt 2>&1
cp $SPRING/installer/Mac/spring.icns $BUNDLE/Contents/Resources/spring.icns #>>$DIR/log.txt 2>&1
cp -R $BUILD/temp/usr/local/share $BUNDLE/Contents/share #>>$DIR/log.txt 2>&1

cat $SPRING/installer/Mac/Info.plist | sed s/###VERSION###/${VERSION}/ > $BUNDLE/Contents/Info.plist

cp $BUILD/tools/pr-downloader/src/pr-downloader $BUNDLE/Contents/MacOS #>>$DIR/log.txt 2>&1

dylibbundler -cd -b -x $BUILD/temp/usr/local/lib/libunitsync.dylib -d $BUNDLE/Contents/MacOS -p @loader_path/../MacOS #>>$DIR/log.txt 2>&1

dylibbundler -of -cd -b -x $BUNDLE/Contents/MacOS/spring -d $BUNDLE/Contents/lib -p @executable_path/../lib #>>$DIR/log.txt 2>&1

install_name_tool -change $MACPORTS/lib/libX11.6.dylib @executable_path/../lib/libX11.6.dylib $BUNDLE/Contents/lib/libXcursor.1.dylib #>>$DIR/log.txt 2>&1

dylibbundler -of -cd -b -x $BUNDLE/Contents/MacOS/pr-downloader -d $BUNDLE/Contents/lib -p @executable_path/../lib #>>$DIR/log.txt 2>&1

dylibbundler -cd -b -x $BUNDLE/Contents/share/games/spring/AI/Interfaces/C/0.1/libAIInterface.dylib -d $BUNDLE/Contents/share/games/spring/AI/Interfaces/C/0.1 -p @loader_path/../0.1 #>>$DIR/log.txt 2>&1

dylibbundler -cd -b -x $BUNDLE/Contents/share/games/spring/AI/Interfaces/Java/0.1/libAIInterface.dylib -d $BUNDLE/Contents/share/games/spring/AI/Interfaces/Java/0.1 -p @loader_path/../0.1 #>>$DIR/log.txt 2>&1

dylibbundler -cd -b -x $BUNDLE/Contents/share/games/spring/AI/Skirmish/AAI/0.9/libSkirmishAI.dylib -d $BUNDLE/Contents/share/games/spring/AI/Skirmish/AAI/0.9 -p @loader_path/../0.9 #>>$DIR/log.txt 2>&1

dylibbundler -cd -b -x $BUNDLE/Contents/share/games/spring/AI/Skirmish/CppTestAI/0.1/libSkirmishAI.dylib -d $BUNDLE/Contents/share/games/spring/AI/Skirmish/CppTestAI/0.1 -p @loader_path/../0.1 #>>$DIR/log.txt 2>&1

dylibbundler -cd -b -x $BUNDLE/Contents/share/games/spring/AI/Skirmish/E323AI/3.25.0/libSkirmishAI.dylib -d $BUILD/Spring.app/Contents/share/games/spring/AI/Skirmish/E323AI/3.25.0 -p @loader_path/../3.25.0 #>>$DIR/log.txt 2>&1

dylibbundler -cd -b -x $BUILD/Spring.app/Contents/share/games/spring/AI/Skirmish/KAIK/0.13/libSkirmishAI.dylib -d $BUILD/Spring.app/Contents/share/games/spring/AI/Skirmish/KAIK/0.13 -p @loader_path/../0.13 #>>$DIR/log.txt 2>&1

dylibbundler -cd -b -x $BUNDLE/Contents/share/games/spring/AI/Skirmish/NullAI/0.1/libSkirmishAI.dylib -d $BUNDLE/Contents/share/games/spring/AI/Skirmish/NullAI/0.1 -p @loader_path/../0.1 #>>$DIR/log.txt 2>&1

dylibbundler -cd -b -x $BUNDLE/Contents/share/games/spring/AI/Skirmish/RAI/0.601/libSkirmishAI.dylib -d $BUNDLE/Contents/share/games/spring/AI/Skirmish/RAI/0.601 -p @loader_path/../0.601 #>>$DIR/log.txt 2>&1

dylibbundler -cd -b -x $BUNDLE/Contents/share/games/spring/AI/Skirmish/Shard/dev/libSkirmishAI.dylib -d $BUILD/Spring.app/Contents/share/games/spring/AI/Skirmish/Shard/dev -p @loader_path/../dev #>>$DIR/log.txt 2>&1

if [ ! -e $BUNDLE/Contents/MacOS/spring ];then
echo "Error: App did not build correctly. Check log for details"
ERRORBUILD=1
fi

if [ "$ERRORBUILD" = "1" ]; then
echo "Build Failed."
fi

echo "Done!"
exit 0

</pre>

[[Category:Compiling]]

Building Spring on MacOSX

2020-03-04T11:39:17Z

Af: homebrew additions

Pr-downloader

2017-09-06T15:45:27Z

Af: fix borked formatting of code blocks

pr-downloader is a console cross-platform download tool for spring. it can download games and maps supporting currently all main download systems, including [[rapid]], [[plasma]] and [[upq]].

=download=
binaries of pr-downloader are included in the static builds of spring:
https://springrts.com/dl/buildbot/default/develop/

=usage=
<code><pre>
pr-downloader 0.7-1-g4aeb062
Usage: pr-downloader
--rapid-download <name>
--rapid-validate
--dump-sdp <name>
--plasma-download <name>
--http-download <name>
--http-search <name>
--download-map <name>
--download-game <name>
--download-engine <name>
--filesystem-writepath <name>
--help
--version
</pre></code>

==download the latest version of zero-k==

<code>pr-downloader zk:stable</code>

==download a map==

<code>pr-downloader DeltaSiegeDry</code>

==download the engine==

<code>pr-downloader --download-engine {{StableEngineVersion}}</code>

==PR-Downloader Frontend (Windows only)==

[https://drive.google.com/folderview?id=0B25BbZxm93S9T0syUlBwVUUyM2M&usp=sharing Easy to use Batch UI for PR-Downloader (windows only)]

Must be extracted next to pr-downloader.exe

==Bugs==

Please report bugs to the [https://github.com/spring/pr-downloader/issues official bug tracker].

[[Category: Download_Systems]]

Lobby Development

2015-06-03T16:11:47Z

Af: /* Work in progress, abandoned or unusable */

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Documentation=

==Protocol==
* [http://springrts.com/dl/LobbyProtocol/ HTML] (is updated once a day)
* [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml XML] (raw, always latest)

==Download Systems==
* [http://springrts.com/wiki/Dev:LobbyDownloadSystems Lobby Download Systems]

=Lobby client development=

==Useable lobby clients==

===[[SpringLobby]]===

===flobby===
Linux,
C++,
by cleanrock

[https://github.com/cleanrock/flobby github page]

===Weblobby===
cross-platform,
C++,
by CarRepairer

[https://github.com/springweblobby/swl-website#spring-web-lobby project site]

==WIP, abandoned or unusable==

===[[TASClient]]===
Windows,
Delphi,
unmaintained

===Alphalobby===
Windows,
C,
unmaintained

Alphalobby is still very much work in progress. If you still wish to use it, source available from the [http://code.google.com/p/alphalobby/source/checkout mercurial repository], binary available on the [http://springfiles.com/spring/lobby-clients/alphalobby springfiles page].

===CheeseLobby===
cross-platform,
Java,
by Cheesecan

[http://springrts.com/phpbb/viewtopic.php?f=64&t=24905 forum thread]

[https://github.com/jahwag/cheeselobby binaries and code]

===QtLobby===
cross-platform,
C++,
unmaintained

[https://github.com/tizbac/qtlobby project page]

===muslce===

Most useless spring lobby client ever

android,
java,
unmaintained

http://springrts.massive.ch/muslce/Muslce-20130617.tar.bz2

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Libraries and frameworks=

==Spring-PythonBotFramework==
cross-platform,
Python, by
BrainDamage & koshi

A bot framework written in python. [https://github.com/renemilk/tasbot/wiki GitHub wiki]

==Go SpringLobbyClient==
cross-platform,
Go

A simple client implementation of the lobby protocol in Go.
[https://github.com/Agon/go-slc/ project page]

=Lobby server development=
==Actively maintained==
===UberServer===
cross-platform,
Python,
by aegis

The primary lobby server currently running on springrts.com. Most protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and SpringLS (SpringLS hasn't seen as many updates recently). See the dedicated [[uberserver]] for more info.

==Abandoned==
===SpringLS===
cross-platform,
Java,
hoijui

The longest-running lobby server, created by Betalord. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/SpringLS development site].

[[Category: Lobby]]

Lobby Development

2015-06-03T16:11:25Z

Af: /* muslce (most useless spring lobby client ever) */

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Documentation=

==Protocol==
* [http://springrts.com/dl/LobbyProtocol/ HTML] (is updated once a day)
* [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml XML] (raw, always latest)

==Download Systems==
* [http://springrts.com/wiki/Dev:LobbyDownloadSystems Lobby Download Systems]

=Lobby client development=

==Useable lobby clients==

===[[SpringLobby]]===

===flobby===
Linux,
C++,
by cleanrock

[https://github.com/cleanrock/flobby github page]

===Weblobby===
cross-platform,
C++,
by CarRepairer

[https://github.com/springweblobby/swl-website#spring-web-lobby project site]

==Work in progress, abandoned or unusable==

===[[TASClient]]===
Windows,
Delphi,
unmaintained

===Alphalobby===
Windows,
C,
unmaintained

Alphalobby is still very much work in progress. If you still wish to use it, source available from the [http://code.google.com/p/alphalobby/source/checkout mercurial repository], binary available on the [http://springfiles.com/spring/lobby-clients/alphalobby springfiles page].

===CheeseLobby===
cross-platform,
Java,
by Cheesecan

[http://springrts.com/phpbb/viewtopic.php?f=64&t=24905 forum thread]

[https://github.com/jahwag/cheeselobby binaries and code]

===QtLobby===
cross-platform,
C++,
unmaintained

[https://github.com/tizbac/qtlobby project page]

===muslce===

Most useless spring lobby client ever

android,
java,
unmaintained

http://springrts.massive.ch/muslce/Muslce-20130617.tar.bz2

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Libraries and frameworks=

==Spring-PythonBotFramework==
cross-platform,
Python, by
BrainDamage & koshi

A bot framework written in python. [https://github.com/renemilk/tasbot/wiki GitHub wiki]

==Go SpringLobbyClient==
cross-platform,
Go

A simple client implementation of the lobby protocol in Go.
[https://github.com/Agon/go-slc/ project page]

=Lobby server development=
==Actively maintained==
===UberServer===
cross-platform,
Python,
by aegis

The primary lobby server currently running on springrts.com. Most protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and SpringLS (SpringLS hasn't seen as many updates recently). See the dedicated [[uberserver]] for more info.

==Abandoned==
===SpringLS===
cross-platform,
Java,
hoijui

The longest-running lobby server, created by Betalord. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/SpringLS development site].

[[Category: Lobby]]

Lobby Development

2015-06-03T16:11:01Z

Af: /* Zero-K Lobby (no longer uses the Spring lobby protocol) */

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Documentation=

==Protocol==
* [http://springrts.com/dl/LobbyProtocol/ HTML] (is updated once a day)
* [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml XML] (raw, always latest)

==Download Systems==
* [http://springrts.com/wiki/Dev:LobbyDownloadSystems Lobby Download Systems]

=Lobby client development=

==Useable lobby clients==

===[[SpringLobby]]===

===flobby===
Linux,
C++,
by cleanrock

[https://github.com/cleanrock/flobby github page]

===Weblobby===
cross-platform,
C++,
by CarRepairer

[https://github.com/springweblobby/swl-website#spring-web-lobby project site]

==Work in progress, abandoned or unusable==

===[[TASClient]]===
Windows,
Delphi,
unmaintained

===Alphalobby===
Windows,
C,
unmaintained

Alphalobby is still very much work in progress. If you still wish to use it, source available from the [http://code.google.com/p/alphalobby/source/checkout mercurial repository], binary available on the [http://springfiles.com/spring/lobby-clients/alphalobby springfiles page].

===CheeseLobby===
cross-platform,
Java,
by Cheesecan

[http://springrts.com/phpbb/viewtopic.php?f=64&t=24905 forum thread]

[https://github.com/jahwag/cheeselobby binaries and code]

===QtLobby===
cross-platform,
C++,
unmaintained

[https://github.com/tizbac/qtlobby project page]

===muslce (most useless spring lobby client ever)===
android,
java,
unmaintained

http://springrts.massive.ch/muslce/Muslce-20130617.tar.bz2

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Libraries and frameworks=

==Spring-PythonBotFramework==
cross-platform,
Python, by
BrainDamage & koshi

A bot framework written in python. [https://github.com/renemilk/tasbot/wiki GitHub wiki]

==Go SpringLobbyClient==
cross-platform,
Go

A simple client implementation of the lobby protocol in Go.
[https://github.com/Agon/go-slc/ project page]

=Lobby server development=
==Actively maintained==
===UberServer===
cross-platform,
Python,
by aegis

The primary lobby server currently running on springrts.com. Most protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and SpringLS (SpringLS hasn't seen as many updates recently). See the dedicated [[uberserver]] for more info.

==Abandoned==
===SpringLS===
cross-platform,
Java,
hoijui

The longest-running lobby server, created by Betalord. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/SpringLS development site].

[[Category: Lobby]]

Games

2015-06-03T16:05:17Z

Af:

__NOTOC__There are a number of games made for the Spring Engine. Some of the more popular ones are listed below, sorted by their terms of use. 

You can download games automatically, using your lobby (see [[Read_Me_First|Read Me First]]).

Game can also be [[Getting_Spring_Content_and_Links|downloaded manually]], as sdz files, and placed into ../Spring/Games. Read the advice on [[Read_Me_First|this page]] if your lobby does not find your games. Some games also offer a stand-alone installer.

=Open Source=
''These games are all free to download and play and may be open to modifications, however, be sure to read the licenses before doing so.''
{|
|-
| width="300px" | <h2>[http://zero-k.info/ Zero-K]</h2>
([http://code.google.com/p/zero-k/source/browse/trunk/mods/zk/legal.txt GPL, PD])
| width=40 |
| | <h2>'''[http://spring1944.org/ Spring: 1944]'''</h2>([http://spring1944.svn.sourceforge.net/viewvc/spring1944/trunk/S44Main.sdd/docs/License.txt CC-BY-NC])
|-
| | {{navimgx|xsize=300|ysize=225|image=Zero-k_image.jpg|link=http://zero-k.info/}}
|
| |{{navimgx|xsize=300|ysize=225|image=S44_tigers.jpg|link=http://spring1944.org}}
|-
| align="justify" valign="top" | Zero-K is a fast, competitive game with a focus on a streamlined economy and advanced interface that takes the focus off tedious tasks and back on the action. A huge roster of interesting, unique units and a variety of unit abilities provides tremendous tactical and strategic depth to the game. [http://zero-k.info Download link]
|
| align="justify" valign="top" | Spring:1944 is a WWII themed game with four fully functional sides (US, Germany, USSR, Britain), period-accurate units and strengths. Realism comes second only to creating a game that is fun and accessible to play.
|-
| | <h2>[http://www.evolutionrts.info Evolution RTS]</h2>([http://creativecommons.org/licenses/by-nc-nd/3.0/us/ CC-BY-NC-ND])
| width=40 |
| | <h2>[[Kernel Panic]]</h2>([[Kernel_Panic#License:|FOSS, with only 2 FOSS maps]])
|-
| valign="top"| {{navimgx|xsize=300|ysize=188|image=Evoimg.jpg|link=http://www.evolutionrts.info}}
|
| | {{navimg|xsize=300|ysize=225|image=Kernel_Panic_3.4.jpg|link=Kernel Panic}}
|-
| align="justify" valign="top" | A new war is brewing. A violent conflict, between the Six Colonies, each one convinced that it was in the right, each one sure of its own ability to defeat its enemies. But they need Generals. They need soldiers. They need you.
|
| align="justify" valign="top" | A game based around combat '''inside''' a computer, with 3 unique sides: the System, the Hacker and the Network waging war in a matrix of DOOM! No resource economy exists in KP, with the only constraints being time and space.
|-
| | <h2>'''[http://springfiles.com/spring/games/edge-1 On The Edge]'''</h2> (GPL, [http://creativecommons.org/licenses/by-nc-sa/3.0/us/ CC-BY-NC-SA])
|
| | <h2>'''[http://www.moddb.com/games/conflict-terra Conflict Terra]'''</h2>([http://code.google.com/p/conflictterra/source/browse/games/CT/License.txt FOSS])
|-
| |{{navimgx|xsize=300|ysize=225|image=start3.jpg||link=http://springfiles.com/spring/games/edge-1}}
|
| align="center" |{{navimgx|xsize=300|ysize=225|image=CT_Hojos.png|link=http://www.moddb.com/games/conflict-terra}}
|-
| align="justify" valign="top" | First Spring MOBA with unique pre-game hero setup. Under heavy development. How to setup working the game read on [http://springrts.com/phpbb/viewtopic.php?f=55&t=31476 On The Edge forum thread]
|
| align="justify" valign="top" | A unique game with heavy emphasis on mobility and featuring Spring's first major "collect and drop-off" economy, Conflict Terra boasts a distinctive art style. Play as one of two factions in an ever-changing battlefield as you struggle to come out on top.
|-
| align="center" width="300px" | <h2>[http://www.indiedb.com/games/the-cursed The Cursed]</h2>
([http://creativecommons.org/licenses/by-nc-sa/4.0 CC-BY-NC-SA])
| width=40 |
| align="center" width="300px" |
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=cursed_logo.jpg|link=http://www.indiedb.com/games/the-cursed}}
|
| align="center" |
|-
| align="justify" valign="top" | The game is about bones, undead, demons, space marines and magic settled in a futuristic environment. It is a fresh mixture of gameplay elements from many popular RTS games like Starcraft and C&C.
|
| align="justify" valign="top" |
|}

=Proprietary=
''These games may or may not be free to play. Modifying their content (i.e. the art assets) is not allowed without the game authors explicit permission, although the code is GPL and some games include large GPL-friendly content collections.''

{|
|-
| width="300px" | <h2> [https://springrts.com/phpbb/viewforum.php?f=46 Star Wars: Imperial Winter] </h2>
| width=40 |
| align="center" |
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=Imperial Winter assault.jpg|link=https://springrts.com/phpbb/viewforum.php?f=46}}
|
| align="center" |
|-
| align="justify" valign="top" | A Star Wars themed game set in the troubled post-Return of the Jedi era.
|
| align="justify" valign="top" |
|}

=TA-derived=
''At least parts of these games are derived from data of the Total Annihilation game (copyright Atari). As such, their distribution is potentially in breach of copyright laws and therefore not officially endorsed by the Spring RTS team.''

{|
|-
| | <h2> [http://springrts.com/wiki/Balanced_Annihilation Balanced Annihilation] </h2>
| width=40 |
| | <h2> [http://springfiles.com/spring/games/tech-annihilation-8 Tech Annihilation] </h2>
|-
| | {{navimgx|xsize=300|ysize=225|image=BAScreenShot.jpg|link=http://springrts.com/phpbb/viewforum.php?f=44}}
|
| | {{navimgx|xsize=300|ysize=200|image=Tech_Annihilation.png|link=http://springfiles.com/spring/games/tech-annihilation-8}}
|-
| align="justify" valign="top" |
Balanced Annihilation (BA) is a mature game and new versions feature only minor balance tweaks.

BA gameplay develops in stages of progressively heavier units with a growing economy. Many strategies are viable in BA, including focusing on map control, aggression, defense, air power, sea power, or mobility.

|
| align="justify" valign="top" | This Game is bigger, greater and more epic! Tech your Commander from a tiny Commander to a Galactic Commander! (by ''[BoS]Senna'', currently no homepage)

|-
| | <h2>[http://springfiles.com/spring/games/nota-37 NOTA]</h2>
| width=40 |
| | <h2> [[XTA]] </h2>
|-
| | {{navimgx|xsize=300|ysize=225|image=Nota2nukes.jpg|link=http://springfiles.com/spring/games/nota-37}}
| width=40 |
| | {{navimg|xsize=300|ysize=225|image=Screen508_s.jpg|link=XTA}}
|-
| valign="top" | Not Original Total Annihilation is a rethink of the Total Annihilation universe with a focus on strategic, base oriented gameplay. With its revised unit scale, huge battles erupt engaging hundreds of units and scores of unit types. NOTA's completely rethought air and sea gameplay forces participation in all elements and places the tide of conflict in your hands.
| width=40 |
| valign="top" | Originally developed as a Total Annihilation game by the Swedish Yankspankers, XTA is the Original Public Game released with first versions of Spring. Development of this game by the SYs has stopped a while ago, but it is still played and actively developed by the community.
|
|}

=Installing Games in Spring=
Quite a few of the games listed above come with standalone installers, which makes things easy. Check their website to find out!

In some cases however, the game will only distribute a game-file, for example ''BA750'''''.sd7''' or ''XTA'''''.sdz'''. For these games, you have to [[Download|install the stand-alone Spring-Engine]] first, and then place the game-file in the ''...\My Documents\My Games\Spring\Games\'' or ''...\Spring\games\'' folder (''~/.spring/games/'' on Linux/Unix/Mac).
You may install multiple games in the same engine installation.

To play a game, you also need a [[Maps|map]].

Still not enough Games? There are [[Getting_Spring_Content_and_Links|some more]], not listed here or make your [[Game_and_Unit_development|own Game]]!

[[Category: Games]]

Main Page

2015-06-03T15:35:34Z

Af: Split the dev section into 2 sub sections, content dev and engine dev are now separated

{|border="0" cellpadding="4" cellspacing="1"
| width="50%" valign="top" |
== Playing & General ==

'''[[Read Me First]]''' Answers to questions often asked - Everyone should read this first.

'''[[FAQ]]''' Has it been asked before?

'''[[Keyboard]]''' Default Keyboard Layout in the Engine.

'''[[Games]]''' Games that use the Spring engine.

'''[[Maps]]''' All about maps for the Spring engine and where to get them.

'''[[Getting Spring Content and Links]]''' Lists sites related to spring, and sites from which you can download spring Games, Maps, and more

'''[[AI:Skirmish]]''' Skirmish AIs for Singleplayer

'''[[Lua Widgets]]''' All about installing and using LuaUI widgets...

'''[[Hosting Spring]]''' Autohosting and related topics.

'''[[Spring_on_MacOSX |Mac OS]]''' Mac OSX information.

'''[[SetupGuide |Linux]]''' NetBSD / Solaris / Linux / Cross-platform information.

'''[[Spring_Replays |Replays]]''' Watching recordings of previously played matches.

'''[[Statistics]]''' Some links/infos to statistics.

'''[[Advertisement|Advertising Spring RTS]]''' Description of campaigns and available resources.

'''[[The Lighter Side Of Spring]]''' Humour, comics and quotations.
| width="50%" valign="top" |
== Development ==

=== Content Development ===

'''[[Gamedev:Main|Game Development]]''' Lots of links to valuable Articles and forum threads regarding Game/Unit Development.

'''[[Lua Scripting]]''' Information regarding the use of the supplementary Lua scripting language for Widgets and beyond...

'''[[Map, Mod, And Unit Development Programs|Content Development Programs]]''' Links to all kind of useful programs.

'''[[Mapdev:Main|Map Development]]''' Tutorials and other useful information for creating maps.

'''[[Chili|Chili UI framework]]''' Chili Ui framework designed by JK

'''[[General Resources]]''' Usable textures, sounds and code snippets by the community, for the community.

'''[[Associated Development Groups]]''' Teams, Forums and Groups associated with Spring content and code development.

=== Engine and Native Development ===

'''[[Development:Getting_Started|Engine Development]]''' Starting point for engine development.

'''[[Building spring|Compiling Engine]]''' How to build the Spring engine from source.

'''[[Lobby_Development|Lobby Development (Clients and Servers)]]''' Information regarding contributing to the source code of the different lobby clients and servers available for Spring.

'''[[AI:Development|AI Development]]''' Lots of information about developing Skirmish, and Unit AIs for Spring.

|}

{||
|
=This wiki needs your help!=

''"A wiki is a web application that allows users to add content, as on an Internet forum, but also allows anyone to edit the content."''
- [http://en.wikipedia.org/wiki/Wiki Wikipedia.org]

The Spring project is very dependent on its community of users to help new players and developers. [[SpringWiki|Learn more here.]]

|}

{| |
|
=Unable to log in?=
The login data for the wiki is the same as on the forum.
If you get the message "You have not specified a valid user name." that is due a [http://springrts.com/mantis/view.php?id=1592 bug] with special characters in account names.
At the moment the only thing you can do, is create a new/second account that consists of letters only.
|}

__NOTOC__
__NOEDITSECTION__
[[Category:Spring]]

Main Page

2015-06-03T15:35:34Z

Af: Split the dev section into 2 sub sections, content dev and engine dev are now separated

FAQ

2015-06-03T15:32:16Z

Af:

{|border="0" width="100%" style="border: 0px; border-spacing:0px"
|width="500px" valign="top" style="padding-left:10px; padding-right:10px"|
'''[[FAQs]]'''

Frequently asked questions for the following:
* [[FAQ:general|General FAQ]]
* [[FAQ:technical|Technical FAQ]]
* [[FAQ:player|Playing ingame FAQ]]
* [[FAQ:trouble|Troubleshooting FAQ]]

'''[[Read_Me_First|Read Me]]'''

How to start your first game.

'''[[Keyboard]]'''

Default Keyboard Layout in the Engine.

'''[[Games]]'''

Games that use the Spring engine.

'''[[Maps]]'''

All about maps for the Spring engine and where to get them.

'''[[Lua Widgets]]'''

All about installing and using LuaUI widgets...

'''[[AI:Skirmish|AIs]]'''

Skirmish AIs, Lua AIs...

'''[[Hosting Spring]]'''

Autohosting and related topics.

'''[[Spring:CategoryStructure]]'''

Check here to get an overview of the website.

|valign="top" style="padding:0px"|

== Quick Links ==

{|width="100%" class=""
! '''[http://springrts.com/phpbb/viewforum.php?f=11 Help/Bug forums]'''
|-
| Look at the help forums for more help with technical issues and crashes
|}

{|width="100%" class=""
! '''[http://springrts.com/mantis/ Report Bugs/Submit a Patch]'''
|-
| Submit patches and bug reports here
|}

{|width="100%" class=""
! '''[[Strategy and Tactics]]'''
|-
| Basic ideas how to stand your ground.
|}

{|width="100%" class=""
! '''[[Read Me First]]'''
|-
| Answers to questions often asked - Everyone should read this first.
|}
|}
[[Category:FAQ]]

Development:Main

2015-06-03T15:31:23Z

Af: fix the horrible mess that was the sidebar, and add the GitHub repo ( how can an opensource project bury the link to its source 4 levels deep into the site?! )

{|width="100%" style="border: 0px; border-spacing:0px"
|width="500px" valign="top" style="padding-left:10px; padding-right:10px"|

'''[https://github.com/spring/spring GitHub and Source Code]'''

Engine source code 

'''[[Links|Important Links]]'''

Important Community and Development links to git repos & subprojects. 

'''[[Building spring|Compiling Engine]]'''

How to build the Spring engine from source. 

'''[[Development:Getting_Started|Engine Development]]'''

Information regarding contributing to the source code of the Spring engine.

'''[[Lobby_Development|Lobby Development (Clients and Servers)]]'''

Information regarding contributing to the source code of the different lobby clients and servers available for Spring.

'''[[Gamedev:Main|Game Development]]'''

Lots of links to valuable Articles and forum threads regarding Game, Mod & Unit Development.

'''[[Mapdev:Main|Map Development]]'''

Tutorials and other useful information for creating maps.

'''[[Lua_Scripting|Lua Development]]'''

Information regarding the use of the supplementary Lua scripting language for Widgets and beyond.

'''[[AI:Development|AI Development]]'''

All you ever wanted to know about Skirmish AI Development for Spring, and more. This includes Skirmish and Lua AIs.

|valign="top" style="padding:0px"|

== Quick Links ==

{|width="100%" class=""
! '''[http://spring.clan-sy.com/phpbb/viewforum.php?f=12 Development forums]'''
|-
| Look at the development forums for ongoing progress and discussion
|}

{|width="100%" class=""
! '''[http://springrts.com/mantis/ Report Bugs]'''
|-
| Submit patches and bug reports here
|}

{|width="100%" class=""
! '''[https://github.com/spring/spring/ Source Code]'''
|-
| View and fork the project on GitHub.
|}

{|width="100%" class=""
! '''[https://github.com/spring/spring/commits/develop.atom Commit Newsfeed]'''
|-
|View git commits as they happen.
|}

|}

[[Category: Development]]

AI:NTAI

2012-11-26T14:14:17Z

Af:

[http://img434.imageshack.us/img434/6500/screen0898vk.jpg http://img432.imageshack.us/img432/8080/thumb0896lz.jpg][http://img393.imageshack.us/img393/536/screen0920qb.jpg http://img432.imageshack.us/img432/7251/thumb0924ca.jpg][http://img393.imageshack.us/img393/8756/screen0903up.jpg http://img432.imageshack.us/img432/5011/thumb0903nl.jpg]

{{AI|NTai|Tom J Nowell([[User:AF|AF]])|XE10+|Unspecified Mod Support|Indefinite Hiatus|Open Source|C|LegacyCpp}}

'' AF: I would not use this page as a detail on my AI as I havent the time to maintain my wiki entries. This was also written at a time when I tended to overemphasise points while leaving important details out. Instead look at the project/portfolio sub site of my website www.darkstars.co.uk''

== Shard ==

It's advise that you use my newer AI project instead, named [[AI:Shard|Shard]].

== Links ==
* [http://www.darkstars.co.uk AF's site]

'''[[AI:Skirmish:List|<- Back to AI page]]'''

[[Category: AI]]

AI:NTAI

2012-11-26T14:14:00Z

Af:

[http://img434.imageshack.us/img434/6500/screen0898vk.jpg http://img432.imageshack.us/img432/8080/thumb0896lz.jpg][http://img393.imageshack.us/img393/536/screen0920qb.jpg http://img432.imageshack.us/img432/7251/thumb0924ca.jpg][http://img393.imageshack.us/img393/8756/screen0903up.jpg http://img432.imageshack.us/img432/5011/thumb0903nl.jpg]

{{AI|NTai|Tom J Nowell([[User:AF|AF]])|XE9+|Unspecified Mod Support|Indefinite Hiatus|Open Source|C|LegacyCpp}}

'' AF: I would not use this page as a detail on my AI as I havent the time to maintain my wiki entries. This was also written at a time when I tended to overemphasise points while leaving important details out. Instead look at the project/portfolio sub site of my website www.darkstars.co.uk''

== Shard ==

It's advise that you use my newer AI project instead, named [[AI:Shard|Shard]].

== Links ==
* [http://www.darkstars.co.uk AF's site]

'''[[AI:Skirmish:List|<- Back to AI page]]'''

[[Category: AI]]

AI:NTAI

2012-11-26T14:12:51Z

Af:

[http://img434.imageshack.us/img434/6500/screen0898vk.jpg http://img432.imageshack.us/img432/8080/thumb0896lz.jpg][http://img393.imageshack.us/img393/536/screen0920qb.jpg http://img432.imageshack.us/img432/7251/thumb0924ca.jpg][http://img393.imageshack.us/img393/8756/screen0903up.jpg http://img432.imageshack.us/img432/5011/thumb0903nl.jpg]

{{AI|NTai|Tom J Nowell([[User:AF|AF]])|XE9+|Unspecified Mod Support|Indefinite Hiatus|Open Source|C|LegacyCpp}}

'' AF: I would not use this page as a detail on my AI as I havent the time to maintain my wiki entries. This was also written at a time when I tended to overemphasise points while leaving important details out. Instead look at the project/portfolio sub site of my website www.darkstars.co.uk''

=== Shard ===

It's advise that you use my newer AI project instead, named [AI:Shard].

=== Links ===
* [http://www.darkstars.co.uk AF's site]

'''[[AI:Skirmish:List|<- Back to AI page]]'''

[[Category: AI]]

AI:Shard

2012-11-26T14:11:16Z

Af:

{{AI|Shard AI|[[User:AF|AF]]|0.4+|All|Under Active Development|LGPL V2|C++|C++-Wrapper}}

Shard is a lua AI built on top of a wrapper of the C++ AI interface. Written by Tom J Nowell/AF, it's distributed with the Spring Engine.

=Source Code=
https://github.com/Tarendai/Shard

=Bugs=
https://github.com/Tarendai/Shard/issues

=Examples=
http://springrts.com/phpbb/viewtopic.php?f=55&p=530088

See also
http://springrts.com/phpbb/viewtopic.php?f=15&t=22582

[[Category: AI]]

AI:Shard

2012-11-26T14:09:31Z

Af:

{{AI|Shard AI|[[User:AF|AF]]|0.4+|All|Under Active Development|LGPL V2|C++|C++-Wrapper}}

Shard is an native AI written by AF. Its distributed with the Spring Engine.

=Source Code=
https://github.com/Tarendai/Shard

=Bugs=
https://github.com/Tarendai/Shard/issues

=Examples=
http://springrts.com/phpbb/viewtopic.php?f=55&p=530088

See also
http://springrts.com/phpbb/viewtopic.php?f=15&t=22582

[[Category: AI]]

AI:Development:Lang:Cpp

2011-10-19T11:01:22Z

Af:

[[Engine_Development|Development]] < [[AI:Development|AI Development]] < C++ AI Development

=Writing a Skirmish AI in C++=

There are two ways of writing a C++ AI, using the [[AIWrapper:LegacyCpp| deprecated legacy API]] or the [[AIWrapper:Cpp| C++ Wrapper API]]. The legacy API is for older AIs using the old interface ( e.g. KAI, RAI, AAI etc ).

For an example of an AI using the new OO C++ Wrapper interface, refer to Shard by AF.

For further info, have a look at the forum.

[[Category: AI]]
[[Category: Development]]

AI:Development:Lang:Cpp

2011-10-19T10:59:35Z

Af:

[[Engine_Development|Development]] < [[AI:Development|AI Development]] < C++ AI Development

=Writing a Skirmish AI in C++=

There are two ways of writing a C++ AI, using the legacy or the C++ Wrapper API. The legacy API is for older AIs using the old interface ( e.g. KAI, RAI, AAI etc ).

For an example of an AI using the new OO C++ Wrapper interface, refer to Shard by AF.

For further info, have a look at the forum.

[[Category: AI]]
[[Category: Development]]

AI:Development:Lang:Cpp

2011-10-19T10:59:10Z

Af: Created page with "Development < AI Development < C AI Development =Writing a Skirmish AI in C++= There are two ways of writing a C++ AI, using the legac..."

[[Engine_Development|Development]] < [[AI:Development|AI Development]] < C AI Development

=Writing a Skirmish AI in C++=

There are two ways of writing a C++ AI, using the legacy or the C++ Wrapper API. The legacy API is for older AIs using the old interface ( e.g. KAI, RAI, AAI etc ).

For an example of an AI using the new OO C++ Wrapper interface, refer to Shard by AF.

For further info, have a look at the forum.

[[Category: AI]]
[[Category: Development]]

Building Spring on Windows

2011-10-19T10:49:50Z

Af:

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}
= Get the Source Code =
{{Obtaining_The_Source_Code}}

=Compiling with MinGW=
Compiling Spring in MinGW requires GCC 4.x.

Because the official MinGW installer and packages are outdated, we recommend to use the TDM web-installer instead, to install the official <code>MinGW Stable</code> (not <s><code>TDM-GCC</code></s>) package:

==TDM webinstaller==
Download and run the [http://tdm-gcc.tdragon.net/download On-Demand Installer] (tdm-gcc-webdl).

Select at least the following components:

[[File:400px-Mingwscreenshot.jpg|right|400px]]

* gcc (version: <code>MinGW Stable</code>!)
** core
** g++
** openmp (optional)
* binutils
* mingw-runtime
* w32api
* mingw32-make (if you have no Make installed yet)
* gdb (recommended for debugging)

<div style="clear:both;"></div>

===Possible Problems===
* If you get undefined reference to `_Unwind_Resume' linking errors, deinstall ''whole'' TDM/MinGW and reinstall it with ''dwarf2'' (<code>MinGW Stable</code> should have it enabled).

* When you installed an old version of MinGW/TDM and forgot to deinstall it correctly, <code>gcc.exe</code> & <code>g++.exe</code> will be named <code>gcc-dw2.exe</code>/<code>g++-dw2.exe</code>. CMake will then fail to find the correct one, first try to deinstall anything mingw related and reinstall everything. If that didn't helped just rename the files. If even that doesn't help open cmake-gui and click the advanced button and set the paths to the correct files yourself (<code>CMAKE_C_COMPILER</code> & <code>CMAKE_CXX_COMPILER</code>).

==Spring MinGW Dependencies (mingwlibs)==
You also need some Spring dependencies, prepackaged in the '''mingwlibs''' archive.

You can download a tarball [http://github.com/spring/mingwlibs '''here'''] ('''Download Source''' button). 
Or (recommended) use git:
* open a console (cmd.exe) or use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your source dir
* make a dir named mingwlibs
* <code>cd mingwlibs</code>
* run <code>git clone git://github.com/spring/mingwlibs.git</code>
* and update it from time to time with: <code>git pull --rebase</code>

==mingwlibs install directory==
There are two ways to setup the MinGW libraries:

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

= Compiling with cmake =
First get [http://www.cmake.org/cmake/resources/software.html CMake here] and install it.

then
* run the ''cmake-gui'' and select a source and a build directory
* configure and follow the instructions, and adjust variables to your needs (defaults are OK)
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your build directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code>
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>

==Generating the AI Sources/Wrappers==

you can either build the wrapper:

<code>make Cpp-AIWrapper</code>

or generate all sources, in case you don't need the binary:

<code>make generateSources</code>

=Compiling with scons=
deprecated - use cmake

=Compiling with Visual Studio=

==General Visual Studio Notes==
When developing using Visual Studio keep in mind:
*Your VS build won't sync with GCC builds in multiplayer mode
*AIs built with Visual Studio will work with the mingw32 release builds thanks to the C AI Interface, however this interface may change when newer releases are made
*Most spring developers use linux based environments, and the Visual Studio projects may be slightly out of date or missing files at any one time. Please contribute any changes or fixes you find back into the project

==2005 (v8)==
(possibly the free Express Edition)

* Install the [https://github.com/downloads/spring/spring/spring-vc8libs-v8.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout or the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
** Note that the most recent version of Platform SDK is called [http://www.microsoft.com/downloads/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en Windows SDK].
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the Release with error catching build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

=== Errors ===
* ...\Windows\v6.0A\include\shlwapi.h(196) : error C2061: syntax error : identifier 'PCUITEMID_CHILD' - wrong version of Platform SDK is used; go to Tools >> Options >> >> Projects and Solutions >> VC++ Directories and move the one that's causing this problem all the way down.

==2008 (v9)==
(possibly the free Express Edition)

Not yet fully working as far as I know; you need at least this hotfix from Microsoft though:

http://support.microsoft.com/kb/946040

or update your Visual Studio using your Windows Update.

For the rest the Visual Studio 8 instructions should apply, mostly. You probably won't need to add Windows SDK path references as they should be present by default.

You need the [http://cloud.github.com/downloads/spring/spring/spring-vc9libs-v4.7z vclibs for VS2008], and not the ones for Visual Studio 2005. The installation procedure is the same though.

Be aware that the project file isn't updated nearly as frequently as it should, so it's best to use the .vcproj file from VS8 build and VS2008 will automatically update it.

==2010 (v10)==

There is no project file or VCLibs package for Visual Studio 2010 at the moment, but the instructions for 2008 should work. All that is required is building the dependencies in the VCLibs package using 2010 versions.

[[Category:Compiling]]

Building Spring on Windows

2011-10-19T10:46:14Z

Af:

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}
= Get the Source Code =
{{Obtaining_The_Source_Code}}

=Install MinGW=
Compiling Spring in MinGW requires GCC 4.x.

Because the official MinGW installer and packages are outdated, we recommend to use the TDM web-installer instead, to install the official <code>MinGW Stable</code> (not <s><code>TDM-GCC</code></s>) package:

==TDM webinstaller==
Download and run the [http://tdm-gcc.tdragon.net/download On-Demand Installer] (tdm-gcc-webdl).

Select at least the following components:

[[File:400px-Mingwscreenshot.jpg|right|400px]]

* gcc (version: <code>MinGW Stable</code>!)
** core
** g++
** openmp (optional)
* binutils
* mingw-runtime
* w32api
* mingw32-make (if you have no Make installed yet)
* gdb (recommended for debugging)

<div style="clear:both;"></div>

===Possible Problems===
* If you get undefined reference to `_Unwind_Resume' linking errors, deinstall ''whole'' TDM/MinGW and reinstall it with ''dwarf2'' (<code>MinGW Stable</code> should have it enabled).

* When you installed an old version of MinGW/TDM and forgot to deinstall it correctly, <code>gcc.exe</code> & <code>g++.exe</code> will be named <code>gcc-dw2.exe</code>/<code>g++-dw2.exe</code>. CMake will then fail to find the correct one, first try to deinstall anything mingw related and reinstall everything. If that didn't helped just rename the files. If even that doesn't help open cmake-gui and click the advanced button and set the paths to the correct files yourself (<code>CMAKE_C_COMPILER</code> & <code>CMAKE_CXX_COMPILER</code>).

==Spring MinGW Dependencies (mingwlibs)==
You also need some Spring dependencies, prepackaged in the '''mingwlibs''' archive.

You can download a tarball [http://github.com/spring/mingwlibs '''here'''] ('''Download Source''' button). 
Or (recommended) use git:
* open a console (cmd.exe) or use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your source dir
* make a dir named mingwlibs
* <code>cd mingwlibs</code>
* run <code>git clone git://github.com/spring/mingwlibs.git</code>
* and update it from time to time with: <code>git pull --rebase</code>

==mingwlibs install directory==
There are two ways to setup the MinGW libraries:

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

= Compiling with cmake =
First get [http://www.cmake.org/cmake/resources/software.html CMake here] and install it.

then
* run the ''cmake-gui'' and select a source and a build directory
* configure and follow the instructions, and adjust variables to your needs (defaults are OK)
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your build directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code>
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>

==Generating the AI Sources/Wrappers==

you can either build the wrapper:

<code>make Cpp-AIWrapper</code>

or generate all sources, in case you don't need the binary:

<code>make generateSources</code>

=Compiling with scons=
deprecated - use cmake

=Visual Studio=

==General Visual Studio Notes==
When developing using Visual Studio keep in mind:
*Your VS build won't sync with GCC builds in multiplayer mode
*AIs built with Visual Studio will work with the mingw32 release builds thanks to the C AI Interface, however this interface may change when newer releases are made
*Most spring developers use linux based environments, and the Visual Studio projects may be slightly out of date or missing files at any one time. Please contribute any changes or fixes you find back into the project

==8 (2005)==
(possibly the free Express Edition)

* Install the [https://github.com/downloads/spring/spring/spring-vc8libs-v8.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout or the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
** Note that the most recent version of Platform SDK is called [http://www.microsoft.com/downloads/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en Windows SDK].
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the Release with error catching build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

=== Errors ===
* ...\Windows\v6.0A\include\shlwapi.h(196) : error C2061: syntax error : identifier 'PCUITEMID_CHILD' - wrong version of Platform SDK is used; go to Tools >> Options >> >> Projects and Solutions >> VC++ Directories and move the one that's causing this problem all the way down.

==9 (2008)==
(possibly the free Express Edition)

Not yet fully working as far as I know; you need at least this hotfix from Microsoft though:

http://support.microsoft.com/kb/946040

or update your Visual Studio using your Windows Update.

For the rest the Visual Studio 8 instructions should apply, mostly. You probably won't need to add Windows SDK path references as they should be present by default.

You need the [http://cloud.github.com/downloads/spring/spring/spring-vc9libs-v4.7z vclibs for VS2008], and not the ones for Visual Studio 2005. The installation procedure is the same though.

Be aware that the project file isn't updated nearly as frequently as it should, so it's best to use the .vcproj file from VS8 build and VS2008 will automatically update it.

[[Category:Compiling]]

Building Spring on Windows

2011-10-19T10:43:20Z

Af: /* General Visual Studio Notes */

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}
= Get the Source Code =
{{Obtaining_The_Source_Code}}

=Install MinGW=
Compiling Spring in MinGW requires GCC 4.x.

Because the official MinGW installer and packages are outdated, we recommend to use the TDM web-installer instead, to install the official <code>MinGW Stable</code> (not <s><code>TDM-GCC</code></s>) package:

==TDM webinstaller==
Download and run the [http://tdm-gcc.tdragon.net/download On-Demand Installer] (tdm-gcc-webdl).

Select at least the following components:

[[File:400px-Mingwscreenshot.jpg|right|400px]]

* gcc (version: <code>MinGW Stable</code>!)
** core
** g++
** openmp (optional)
* binutils
* mingw-runtime
* w32api
* mingw32-make (if you have no Make installed yet)
* gdb (recommended for debugging)

<div style="clear:both;"></div>

===Possible Problems===
* If you get undefined reference to `_Unwind_Resume' linking errors, deinstall ''whole'' TDM/MinGW and reinstall it with ''dwarf2'' (<code>MinGW Stable</code> should have it enabled).

* When you installed an old version of MinGW/TDM and forgot to deinstall it correctly, <code>gcc.exe</code> & <code>g++.exe</code> will be named <code>gcc-dw2.exe</code>/<code>g++-dw2.exe</code>. CMake will then fail to find the correct one, first try to deinstall anything mingw related and reinstall everything. If that didn't helped just rename the files. If even that doesn't help open cmake-gui and click the advanced button and set the paths to the correct files yourself (<code>CMAKE_C_COMPILER</code> & <code>CMAKE_CXX_COMPILER</code>).

==Spring MinGW Dependencies (mingwlibs)==
You also need some Spring dependencies, prepackaged in the '''mingwlibs''' archive.

You can download a tarball [http://github.com/spring/mingwlibs '''here'''] ('''Download Source''' button). 
Or (recommended) use git:
* open a console (cmd.exe) or use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your source dir
* make a dir named mingwlibs
* <code>cd mingwlibs</code>
* run <code>git clone git://github.com/spring/mingwlibs.git</code>
* and update it from time to time with: <code>git pull --rebase</code>

==mingwlibs install directory==
There are two ways to setup the MinGW libraries:

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

= Compiling with cmake =
First get [http://www.cmake.org/cmake/resources/software.html CMake here] and install it.

then
* run the ''cmake-gui'' and select a source and a build directory
* configure and follow the instructions, and adjust variables to your needs (defaults are OK)
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your build directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code>
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>

==Generating the AI Sources/Wrappers==

you can either build the wrapper:

<code>make Cpp-AIWrapper</code>

or generate all sources, in case you don't need the binary:

<code>make generateSources</code>

=Compiling with scons=
deprecated - use cmake

=Visual Studio 8 (2005)=
(possibly the free Express Edition)

* Install the [https://github.com/downloads/spring/spring/spring-vc8libs-v8.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout or the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
** Note that the most recent version of Platform SDK is called [http://www.microsoft.com/downloads/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en Windows SDK].
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the Release with error catching build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

== Errors ==
* ...\Windows\v6.0A\include\shlwapi.h(196) : error C2061: syntax error : identifier 'PCUITEMID_CHILD' - wrong version of Platform SDK is used; go to Tools >> Options >> >> Projects and Solutions >> VC++ Directories and move the one that's causing this problem all the way down.

=Visual Studio 9 (2008)=
(possibly the free Express Edition)

Not yet fully working as far as I know; you need at least this hotfix from Microsoft though:

http://support.microsoft.com/kb/946040

or update your Visual Studio using your Windows Update.

For the rest the Visual Studio 8 instructions should apply, mostly. You probably won't need to add Windows SDK path references as they should be present by default.

You need the [http://cloud.github.com/downloads/spring/spring/spring-vc9libs-v4.7z vclibs for VS2008], and not the ones for Visual Studio 2005. The installation procedure is the same though.

Be aware that the project file isn't updated nearly as frequently as it should, so it's best to use the .vcproj file from VS8 build and VS2008 will automatically update it.

=General Visual Studio Notes=
So far the following aspects of Spring don't function properly or don't function at all when compiled with Visual Studio:
*Your VS build won't sync with GCC builds in multiplayer mode
*AIs built with Visual Studio will work with the mingw32 release builds thanks to the C AI Interface, however this interface may change when newer releases are made
[[Category:Compiling]]

Building Spring on Windows

2011-10-19T10:41:22Z

Af: /* Generating the AI Sources/Wrappers */

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}
= Get the Source Code =
{{Obtaining_The_Source_Code}}

=Install MinGW=
Compiling Spring in MinGW requires GCC 4.x.

Because the official MinGW installer and packages are outdated, we recommend to use the TDM web-installer instead, to install the official <code>MinGW Stable</code> (not <s><code>TDM-GCC</code></s>) package:

==TDM webinstaller==
Download and run the [http://tdm-gcc.tdragon.net/download On-Demand Installer] (tdm-gcc-webdl).

Select at least the following components:

[[File:400px-Mingwscreenshot.jpg|right|400px]]

* gcc (version: <code>MinGW Stable</code>!)
** core
** g++
** openmp (optional)
* binutils
* mingw-runtime
* w32api
* mingw32-make (if you have no Make installed yet)
* gdb (recommended for debugging)

<div style="clear:both;"></div>

===Possible Problems===
* If you get undefined reference to `_Unwind_Resume' linking errors, deinstall ''whole'' TDM/MinGW and reinstall it with ''dwarf2'' (<code>MinGW Stable</code> should have it enabled).

* When you installed an old version of MinGW/TDM and forgot to deinstall it correctly, <code>gcc.exe</code> & <code>g++.exe</code> will be named <code>gcc-dw2.exe</code>/<code>g++-dw2.exe</code>. CMake will then fail to find the correct one, first try to deinstall anything mingw related and reinstall everything. If that didn't helped just rename the files. If even that doesn't help open cmake-gui and click the advanced button and set the paths to the correct files yourself (<code>CMAKE_C_COMPILER</code> & <code>CMAKE_CXX_COMPILER</code>).

==Spring MinGW Dependencies (mingwlibs)==
You also need some Spring dependencies, prepackaged in the '''mingwlibs''' archive.

You can download a tarball [http://github.com/spring/mingwlibs '''here'''] ('''Download Source''' button). 
Or (recommended) use git:
* open a console (cmd.exe) or use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your source dir
* make a dir named mingwlibs
* <code>cd mingwlibs</code>
* run <code>git clone git://github.com/spring/mingwlibs.git</code>
* and update it from time to time with: <code>git pull --rebase</code>

==mingwlibs install directory==
There are two ways to setup the MinGW libraries:

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

= Compiling with cmake =
First get [http://www.cmake.org/cmake/resources/software.html CMake here] and install it.

then
* run the ''cmake-gui'' and select a source and a build directory
* configure and follow the instructions, and adjust variables to your needs (defaults are OK)
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your build directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code>
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>

==Generating the AI Sources/Wrappers==

you can either build the wrapper:

<code>make Cpp-AIWrapper</code>

or generate all sources, in case you don't need the binary:

<code>make generateSources</code>

=Compiling with scons=
deprecated - use cmake

=Visual Studio 8 (2005)=
(possibly the free Express Edition)

* Install the [https://github.com/downloads/spring/spring/spring-vc8libs-v8.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout or the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
** Note that the most recent version of Platform SDK is called [http://www.microsoft.com/downloads/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en Windows SDK].
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the Release with error catching build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

== Errors ==
* ...\Windows\v6.0A\include\shlwapi.h(196) : error C2061: syntax error : identifier 'PCUITEMID_CHILD' - wrong version of Platform SDK is used; go to Tools >> Options >> >> Projects and Solutions >> VC++ Directories and move the one that's causing this problem all the way down.

=Visual Studio 9 (2008)=
(possibly the free Express Edition)

Not yet fully working as far as I know; you need at least this hotfix from Microsoft though:

http://support.microsoft.com/kb/946040

or update your Visual Studio using your Windows Update.

For the rest the Visual Studio 8 instructions should apply, mostly. You probably won't need to add Windows SDK path references as they should be present by default.

You need the [http://cloud.github.com/downloads/spring/spring/spring-vc9libs-v4.7z vclibs for VS2008], and not the ones for Visual Studio 2005. The installation procedure is the same though.

Be aware that the project file isn't updated nearly as frequently as it should, so it's best to use the .vcproj file from VS8 build and VS2008 will automatically update it.

=General Visual Studio Notes=
So far the following aspects of Spring don't function properly or don't function at all when compiled with Visual Studio:
*Your VS build won't sync with GCC builds in multiplayer mode
*Any external AI crashes immediatley at start, LUA AI works though
[[Category:Compiling]]

Building Spring on Windows

2011-10-19T10:40:54Z

Af: /* Generating the AI Sources/Wrappers */

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}
= Get the Source Code =
{{Obtaining_The_Source_Code}}

=Install MinGW=
Compiling Spring in MinGW requires GCC 4.x.

Because the official MinGW installer and packages are outdated, we recommend to use the TDM web-installer instead, to install the official <code>MinGW Stable</code> (not <s><code>TDM-GCC</code></s>) package:

==TDM webinstaller==
Download and run the [http://tdm-gcc.tdragon.net/download On-Demand Installer] (tdm-gcc-webdl).

Select at least the following components:

[[File:400px-Mingwscreenshot.jpg|right|400px]]

* gcc (version: <code>MinGW Stable</code>!)
** core
** g++
** openmp (optional)
* binutils
* mingw-runtime
* w32api
* mingw32-make (if you have no Make installed yet)
* gdb (recommended for debugging)

<div style="clear:both;"></div>

===Possible Problems===
* If you get undefined reference to `_Unwind_Resume' linking errors, deinstall ''whole'' TDM/MinGW and reinstall it with ''dwarf2'' (<code>MinGW Stable</code> should have it enabled).

* When you installed an old version of MinGW/TDM and forgot to deinstall it correctly, <code>gcc.exe</code> & <code>g++.exe</code> will be named <code>gcc-dw2.exe</code>/<code>g++-dw2.exe</code>. CMake will then fail to find the correct one, first try to deinstall anything mingw related and reinstall everything. If that didn't helped just rename the files. If even that doesn't help open cmake-gui and click the advanced button and set the paths to the correct files yourself (<code>CMAKE_C_COMPILER</code> & <code>CMAKE_CXX_COMPILER</code>).

==Spring MinGW Dependencies (mingwlibs)==
You also need some Spring dependencies, prepackaged in the '''mingwlibs''' archive.

You can download a tarball [http://github.com/spring/mingwlibs '''here'''] ('''Download Source''' button). 
Or (recommended) use git:
* open a console (cmd.exe) or use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your source dir
* make a dir named mingwlibs
* <code>cd mingwlibs</code>
* run <code>git clone git://github.com/spring/mingwlibs.git</code>
* and update it from time to time with: <code>git pull --rebase</code>

==mingwlibs install directory==
There are two ways to setup the MinGW libraries:

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

= Compiling with cmake =
First get [http://www.cmake.org/cmake/resources/software.html CMake here] and install it.

then
* run the ''cmake-gui'' and select a source and a build directory
* configure and follow the instructions, and adjust variables to your needs (defaults are OK)
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your build directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code>
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>

==Generating the AI Sources/Wrappers==

you can either build the wrapper:

<code>make Cpp-AIWrapper</code>

or generate all sources, in case you don't need the binary. this only works in develop, not for the release:

<code>make generateSources</code>

=Compiling with scons=
deprecated - use cmake

=Visual Studio 8 (2005)=
(possibly the free Express Edition)

* Install the [https://github.com/downloads/spring/spring/spring-vc8libs-v8.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout or the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
** Note that the most recent version of Platform SDK is called [http://www.microsoft.com/downloads/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en Windows SDK].
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the Release with error catching build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

== Errors ==
* ...\Windows\v6.0A\include\shlwapi.h(196) : error C2061: syntax error : identifier 'PCUITEMID_CHILD' - wrong version of Platform SDK is used; go to Tools >> Options >> >> Projects and Solutions >> VC++ Directories and move the one that's causing this problem all the way down.

=Visual Studio 9 (2008)=
(possibly the free Express Edition)

Not yet fully working as far as I know; you need at least this hotfix from Microsoft though:

http://support.microsoft.com/kb/946040

or update your Visual Studio using your Windows Update.

For the rest the Visual Studio 8 instructions should apply, mostly. You probably won't need to add Windows SDK path references as they should be present by default.

You need the [http://cloud.github.com/downloads/spring/spring/spring-vc9libs-v4.7z vclibs for VS2008], and not the ones for Visual Studio 2005. The installation procedure is the same though.

Be aware that the project file isn't updated nearly as frequently as it should, so it's best to use the .vcproj file from VS8 build and VS2008 will automatically update it.

=General Visual Studio Notes=
So far the following aspects of Spring don't function properly or don't function at all when compiled with Visual Studio:
*Your VS build won't sync with GCC builds in multiplayer mode
*Any external AI crashes immediatley at start, LUA AI works though
[[Category:Compiling]]

Building Spring on Windows

2011-10-19T10:40:36Z

Af: AI wrapper generation via cmake

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}
= Get the Source Code =
{{Obtaining_The_Source_Code}}

=Install MinGW=
Compiling Spring in MinGW requires GCC 4.x.

Because the official MinGW installer and packages are outdated, we recommend to use the TDM web-installer instead, to install the official <code>MinGW Stable</code> (not <s><code>TDM-GCC</code></s>) package:

==TDM webinstaller==
Download and run the [http://tdm-gcc.tdragon.net/download On-Demand Installer] (tdm-gcc-webdl).

Select at least the following components:

[[File:400px-Mingwscreenshot.jpg|right|400px]]

* gcc (version: <code>MinGW Stable</code>!)
** core
** g++
** openmp (optional)
* binutils
* mingw-runtime
* w32api
* mingw32-make (if you have no Make installed yet)
* gdb (recommended for debugging)

<div style="clear:both;"></div>

===Possible Problems===
* If you get undefined reference to `_Unwind_Resume' linking errors, deinstall ''whole'' TDM/MinGW and reinstall it with ''dwarf2'' (<code>MinGW Stable</code> should have it enabled).

* When you installed an old version of MinGW/TDM and forgot to deinstall it correctly, <code>gcc.exe</code> & <code>g++.exe</code> will be named <code>gcc-dw2.exe</code>/<code>g++-dw2.exe</code>. CMake will then fail to find the correct one, first try to deinstall anything mingw related and reinstall everything. If that didn't helped just rename the files. If even that doesn't help open cmake-gui and click the advanced button and set the paths to the correct files yourself (<code>CMAKE_C_COMPILER</code> & <code>CMAKE_CXX_COMPILER</code>).

==Spring MinGW Dependencies (mingwlibs)==
You also need some Spring dependencies, prepackaged in the '''mingwlibs''' archive.

You can download a tarball [http://github.com/spring/mingwlibs '''here'''] ('''Download Source''' button). 
Or (recommended) use git:
* open a console (cmd.exe) or use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your source dir
* make a dir named mingwlibs
* <code>cd mingwlibs</code>
* run <code>git clone git://github.com/spring/mingwlibs.git</code>
* and update it from time to time with: <code>git pull --rebase</code>

==mingwlibs install directory==
There are two ways to setup the MinGW libraries:

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

= Compiling with cmake =
First get [http://www.cmake.org/cmake/resources/software.html CMake here] and install it.

then
* run the ''cmake-gui'' and select a source and a build directory
* configure and follow the instructions, and adjust variables to your needs (defaults are OK)
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your build directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code>
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>

==Generating the AI Sources/Wrappers==

you can either build the wrapper:
<code>make Cpp-AIWrapper</code>

or generate all sources, in case you don't need the binary. this only works in develop, not for the release:
<code>make generateSources</code>

=Compiling with scons=
deprecated - use cmake

=Visual Studio 8 (2005)=
(possibly the free Express Edition)

* Install the [https://github.com/downloads/spring/spring/spring-vc8libs-v8.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout or the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
** Note that the most recent version of Platform SDK is called [http://www.microsoft.com/downloads/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en Windows SDK].
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the Release with error catching build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

== Errors ==
* ...\Windows\v6.0A\include\shlwapi.h(196) : error C2061: syntax error : identifier 'PCUITEMID_CHILD' - wrong version of Platform SDK is used; go to Tools >> Options >> >> Projects and Solutions >> VC++ Directories and move the one that's causing this problem all the way down.

=Visual Studio 9 (2008)=
(possibly the free Express Edition)

Not yet fully working as far as I know; you need at least this hotfix from Microsoft though:

http://support.microsoft.com/kb/946040

or update your Visual Studio using your Windows Update.

For the rest the Visual Studio 8 instructions should apply, mostly. You probably won't need to add Windows SDK path references as they should be present by default.

You need the [http://cloud.github.com/downloads/spring/spring/spring-vc9libs-v4.7z vclibs for VS2008], and not the ones for Visual Studio 2005. The installation procedure is the same though.

Be aware that the project file isn't updated nearly as frequently as it should, so it's best to use the .vcproj file from VS8 build and VS2008 will automatically update it.

=General Visual Studio Notes=
So far the following aspects of Spring don't function properly or don't function at all when compiled with Visual Studio:
*Your VS build won't sync with GCC builds in multiplayer mode
*Any external AI crashes immediatley at start, LUA AI works though
[[Category:Compiling]]

AI:NTAI

2009-09-22T14:23:39Z

Af:

[http://img434.imageshack.us/img434/6500/screen0898vk.jpg http://img432.imageshack.us/img432/8080/thumb0896lz.jpg][http://img393.imageshack.us/img393/536/screen0920qb.jpg http://img432.imageshack.us/img432/7251/thumb0924ca.jpg][http://img393.imageshack.us/img393/8756/screen0903up.jpg http://img432.imageshack.us/img432/5011/thumb0903nl.jpg]

{{AI|NTai|Tom J Nowell([[User:AF|AF]])|XE9+|Unspecified Mod Support|Under Active Development|Open Source|C|LegacyCpp}}

'' AF: I would not use this page as a detail on my AI as I havent the time to maintain my wiki entries. This was also written at a time when I tended to overemphasise points while leaving important details out. Instead look at the project/portfolio sub site of my website www.darkstars.co.uk''

=== Links ===
* [http://www.darkstars.co.uk AF's site]

'''[[AI:Skirmish:List|<- Back to AI page]]'''

[[Category: AI]]

User:AF

2009-06-08T10:41:04Z

Af:

== '''This is a page on AF. He is an AI maker. Who has lots of cookies. ''' ==

AF King of Cookies!!!!!
ALL HAIL

no really, go to www.darkstars.co.uk I just happen to do a lot of other things too side from making AIs

Balanced Annihilation:Giving Orders

2008-10-27T14:26:31Z

Af: typo

'''[[Using_Spring|<--Back to Using Spring]]'''

==Issuing Orders/Building==

====Left Mouse Control (Mouse 1)====
As covered in [[Using_Selections#Selecting.2FDeselecting_Units|Selecting/Deselecting Units]], left clicking is the primary control for selecting units. If a pending order is issued using the menu that appears on the left side of the screen or using a Hotkey, the mouse pointer will change to a symbol representing this action. If there is a pending order and you left click on a valid target for the action the selcted units will perform this action on that target, otherwise the units will "do their best" to perform the action, which could mean just cancelling the Order.

The menu will show all available commands for all selected units, except for wait and self destruct, in the menu. Mousing over a menu item will also display the Tooltip for this item.

====Right Mouse Control (Mouse 2)====
Right clicking will always give the selected units the default action for the target, if the order is invalid for some members of the group, it may or may not choose a suitable action for those units to perform.

====Queueing Orders====

Holding down SHIFT while giving a unit an order adds that order to its queue. Queueing orders means that you can tell a unit, or a group of units to do multiple tasks, and they will go off and do them in the order they were given without any more input from you. For example, if you you want a Construction Vehicle to build a line of defences around your base, you can select the structure you want, hold shift and click where you want them few times. The construction vehicle will now go and build (or try to build) all of the selected structures while you go and pay attention to other things. You can queue any order, and any number of orders. It would be possible (but not very smart) to order your commander to build a whole base for you while you go off and have lunch!

If you have a unit selected, holding SHIFT will show the unit's order queue. Green lines indicate movement orders, red lines attack orders, light blue lines patrol orders, dark blue lines Guard orders, and purple lines reclaim orders. Green rectangles will show where you have construction orders queued. If you have a construction unit selected, you'll see ghosted images of the buildings that unit is going to build inside the green rectangles, linked by green "movement order" lines.

You can remove an order from the order queue by holding shift and repeating the same order. This doesn't work very well on area or movement type orders but can be useful for cancelling the construction of an un-needed building.

Another use for this is to issue complicated movement orders. Say you want your army to attack your enemy, but you want to attack from the side, where they are their weakest. Just issuing one move command to attack the side of their base would send our units moving THROUGH your enemy's base to try to get to the side. This is not very good. But if you tell your units to move to a location AWAY from the base and them back towards it, by queuing up two or more move commands, this problem can be successfully avoided. Or you could tell your units to attack certain buildings in a certain order, for instance attack all the outlying metal extractors, and them go for the power plants in the base, they will follow these orders oblivious to anything else, while you go in and attack the other important things.

This is also good for building complicated patrol paths. Note that units given a patrol order will return to their starting point after executing the last patrol order, so queuing up other orders after a patrol order is very pointless.

When you issue a order without holding shift, it clears the unit's queue and immediately starts it executing that order.

Learning how to use your units' order queues is a vital part of the game.

===Building Buildings===
When a contruction unit is selected you will see images in it's command list (menu on the left) representing the buildings that it can build. These are referred to as "buildpics". Mousing over a buildpic will make the tooltip show information about the structure or unit. Clicking on a structure's buildpic will select it for contruction. If multiple units are selected, all available structures (and mobile units) will appear in the command list. Choosing to build a building when you have multiple units selected will usually assign all units to help build those buildings if this is a valid command.

When you build a unit with a non-factory you will need to choose a ground plate for it to be built on (represented by a grid on the map under your cursor).
 
{| align="center" width="500px" border="1px"
|- valign="top"
|
If the grid is green, you can build at that location.
|[[Image:BuildPlateOkay.png]]
|- valign="top"
|
If the grid is green with some yellow-green squares in it somewhere, it means the groundplate is blocked by a mobile unit or reclaimable feature. This situation should be resolved automaticly by the constructing unit.
|[[Image:BuildPlateResolvable.png]]
|- valign="top"
|
If the grid has any red squares in it, this is an invalid build position, the non red squares of the grid represent unobstructed parts of the obstructed grid.
|[[Image:BuildPlateBad.png]]
|}

====Build (select structure then left-click)====

Builds whatever structure selected in the location clicked by moving the builder unit selected there.

====Rotate the Building====

Press '''[''' or ''']''' while placing the Building to rotate it 90Ã‚Â°.
On German Keyboards, use '''ÃƒÅ¸''' and '''Ã‚Â´'''

====Build Queue (select structure then shift left-click)====

Puts the build order into your unit's order queue, just as with any other order.

====Build Line (SHIFT)====
(select structure then shift left-hold-drag then release left mouse)
{|
|- valign="top"
|
Adds a straight line of the selected structure into your unit's build queue starting where you first depressed the leftmouse and ending at the location you release the leftmouse.
|[[Image:BUILDSHIFT.png|thumb|200px|Shift-Build]]
|}

====Build Grid Line (SHIFT CTRL)====
(select structure then shift ctrl left-hold-drag then release left mouse)
{|
|- valign="top"
|
Adds a straight line of the selected structure into your unit's build queue starting where you first depressed the leftmouse and ending aligned to the location you release. This line, however, will be either vertical or horizontal and aligned to the map's grid.
|[[Image:BUILDCTRLSHIFT.png|thumb|200px|Shift-Ctrl-Build]]
|}

====Build Perimeter (SHIFT CTRL ALT)====
(select structure then shift ctrl alt left-hold-drag then release left mouse)
{|
|- valign="top"
|
Adds an empty square or rectangle box of the selected structures to your unit's build queue. The location you first depressed the leftmouse is one corner border and the location you release is the opposing corner. If you move the mouse straight up your box will look like a grid alligned vertical line.
|[[Image:BUILDCTRLALTSHIFT.png|thumb|200px|Shift-Ctrl-Alt-Build]]
|}

====Build Block (SHIFT ALT)====
(select structure then shift alt left-hold-drag then release left mouse)
{|
|- valign="top"
|
Adds a filled in square or rectangle box of the selected structures to your unit's build queue. The location you first depressed the leftmouse is one corner border and the location you release is the opposing corner. If you move the mouse straigt up your box will look like a grid alligned vertical line.
|[[Image:BUILDSHIFTALT.png|thumb|200px|Shift-Alt-Build]]
|}

====Build "Wall" ====
{|
|- valign="top"
|
Add a wall of the selected structure surrounding the clicked unit to your builders build queue.

Select a builder unit, select building to build, then hold CTRL + SHIFT ant move your mouse over selected building. You should see a "wall" of your selected buildings around it. Click on the structure and the building will begin.
|[[Image:BUILDCTRLSHIFTUNIT.png|thumb|200px|Shift-Ctrl-Build]]
|}

====Space Build (MOUSE4/Z and MOUSE5/X)====
(select structure then shift ctrl mouse5/mouse4 or z/x)
{|
|- valign="top"
|
Spring allows you to automatically specify the spacing between buildings for batch (line, perimeter, block, wall) orders. This spacing is set with the z (decrease by one) or x (increase by one) keys. The default spacing is zero, with the buildings pressed right up against each other. Each level of spacing gives you an extra 2x2-sized (LLT-sized for OTA-based mods) space in between each structure on all 4 dimensions. Similarly, each click of the spacing contract button(z) removes that amount of space. You cannot remove spaces when structures are already placed with no spacing between them.

This is most useful when you're holding down SHIFT CTRL, SHIFT ALT, or SHIFT CTRL ALT to give a line/perimeter/block order. When doing this, you can actually see the spacing between the structures increase or decrease.

Note: The mapping of this function to Z and X is as of 0.70b1. As Z and X are used by many players for other units, it's valuable to note that the key mappings for "mouse4" and "mouse5" can be changed in the "uikeys.txt" file in your spring directory. If you have a 5-button mouse, buttons 4 and 5 are probably the side buttons. Experiment with your mouse to find out where they are on it.
|[[Image:BUILDCTRLALTSHIFTX.png|thumb|200px|Spaced-Shift-Ctrl-Alt-Build]]
[[Image:BUILDSHIFTALTX.png|thumb|200px|Spaced-Shift-Alt-Build]]
[[Image:BUILDCTRLSHIFTX.png|thumb|200px|Spaced-Shift-Ctrl-Build]]
[[Image:BUILDSHIFTX.png|thumb|200px|Spaced-Shift-Build]]
|}

===Building Mobile Units (Building with Factories)===

Click on the picture of the unit you want to queue up for building. You can queue up many units this way. A number will appear over the buildpic, showing how many units of that type are in the queue.

Hold SHIFT while clicking a buildpic to order 5 units at one time, hold CTRL while clicking to order 20, hold CTRL SHIFT while clicking to order 100. Hold ALT while clicking a buildpic to cancel the current construction and starting the constuction of that unit immediately. Right clicking a buildpic will cancel 1,5,20 or 100 orders for that unit using the same SHIFT and/or CTRL modifiers mentioned before. Note that you can use, say, ALT SHIFT to put five build orders for that unit at the start of the queue.

Assigning a group number to a factory will cause the factory to pass this group number to the units it builds.

You can give factories a Move, Guard, Patrol, or other order and the factory will pass it on to the units it builds. You can use this to choose a better place for new units to go after being built, or to send them straight into construction or a battle without micromanaging them. This includes assigning queued orders (for example: multiple move points to get a unit out of the base in a straight line and then a guard repair order on a specific large unit under construction and then a guard order back on the original factory to increase build speed). You can also issue orders to the unit currently under construction by clicking on it first instead of the factory.

Note that it is currently possible for units to get stuck in factories. Thus, it's a good idea for the first order to always be a move order that takes the unit directly out of the factory doors.

Construction/Repair units can be assigned to guard a factory to increase the speed of production for each of the units the factory makes. They can also be assigned to Repair the unit currently under construction to just help with its construction.

=== Default Commands and Hotkeys===
It is assumed that if a unit does not have an ability, it will not be able to perform that action, and will ignore any orders of that type given to a group it's part of. Priorities have been noted.

====Active State (X)====
This command toggles the "active state" of a unit, turning it on or off.
If a unit can be turned off this will usually stop it's prodution and/or use of energy and/or metal and/or stop it from doing something and/or change it's stats.
For example, turning off a radar jamming building would make it stop drawing power and prevent it from jamming radar. Turning off a solar collector would stop it from producing power and cause it to "close up", increasing it's armor.
This behaviour is unit-scriptable so it could technically do anything the designer of the unit wants it to do.

====Attack (A)====
Orders the unit to attack the target or location. If ordered to attack a unit, the selected unit or building will keep firing at the targeted unit/building until it is dead. If the targeted unit moves out of range, or out of sight, the selected unit will move to follow it and continue to attack it. Note that units are very stupid about this, and will continue to execute this order even if they come under heavy attack.

If ordered to attack ground, the unit will never stop until told to do so by the user. Note that units automatically attack any visible enemy units inside their range, and will pursue them (depending on their [[#Move State|Move State]]) a certain distance before returning to their starting location.

====Capture====
The unit will move up to the targeted unit or building and attempt to convert it to your team. So if the enemy has built a Geothermal power plant and forgotten to protect it, grab a nearby construction unit and try to capture it! Note that this takes quite a while, and it is not a good idea to try to capture a unit that is shooting at you. The closer the unit is to 0 health the faster it will be captured. Be careful to set your Commander's [[#Fire State|fire state]] to "hold fire" if you are trying to capture a unit with him, as his laser will likely destroy the target before it is captured.

====Cloak (K)====
Makes a unit inivisble to the enemy's units. Enemy units will not be able to see a unit while it is cloaked, but will still be able to spot it (and fire at it) if they can see the unit VIA radar. Note that this usually uses an immense amount of energy, uses even more energy when the unit's moving, and units uncloak for a few seconds when they shoot. This means that you might want to set the unit to Hold Fire, so the unit doesn't accidentally reveal itself. Cloaking a unit also causes atacking units to lose their target lock and move on to a new target, unless they have radar coverage.

====DGun (D)====
Disintegrator Gun. A weapon used by the Commander. It is a very powerful gun that will kill ANY unit in game. Use it in early game to ward off rushes, or against super units like the Krogoth, or the Goliath. Be careful, as it also destroys your units and buildings at the same time! Uses alot of energy to fire, so make sure you have the required energy before attmpting this.

====Fire State====
Fire States are fairly simple to work out, and are fairly self explanatory. There are three different states, each with their advantages and disadvantages.

''' Fire at Will :''' This is the default setting for all new units. It makes units fire at any visible enemy unit within range. It is good for general destruction.

''' Hold Fire :''' This makes units never fire unless ordered to. Even if they are attacked, they will not do anything. This is good for sneaking units around the back of a base, as they will not draw any attention to themselves, or for units that draw a lot of power when they fire, or which have a long reload time.

''' Return Fire :''' Units only fire at untis that shoot at them. Again, this is good for sneak attacks, but makes them a little smarter and better at defending themselves.

====Guard (G)====
The current selection will "guard" the target owned or allied unit.

When a unit is ordered to guard another unit it will:

1) Attempt to follow it's target anywhere, staying relatively close to it.

2) Defend the target if it becomes threatened and the guard has weapons.

3) Repair if the target if it gets damaged and the guard has repair capabilities.

4) Assist in any construction projects the target is working on if the guard can repair. This also applies to construction units guarding a factory.

5) Repair a unit that has been just resurrected (if capable). But it will not attempt to assist in the actual resurrection, even if the guard can resurrect.

Guard orders "chain". So if Unit 1 guards Unit 2, Unit 2 guards Unit 3, and Unit 3 is told to build or repair or attack, Units 1 and 2 would also join Unit 3 in doing what it was ordered to do.

====High Trajectory====
If this option is available, click the button to toggle this state.

A unit with High Trajectory mode enabled will shoot almost vertically, allowing it to shoot over hills as well as other units and masking the direction/source of the shot.

Using this mode reduces accuracy greatly and also the increased distance of the higher trajectory will increase the amount of time a shot will take to reach it's target.

With some mods, units may gain extra firepower or a larger area of effect when told to use High Trajectory mode.

====Move (M)====
There are 4 ways to move a group of units in Spring:

1) The usual move to point (works for single units or groups, pretty standard.)

2) Holding down on ctrl while giving a move order issues a "Move in formation" command. In this case, formation means whatever formation or configuration the units were in when they were given the order.

3) Holding down Alt during a move command issues a "Move into a square". Units will try to move into a nice, organised formation. However, this rarley ever works, as units tend to shove each other out of the way when trying to get into position.

4) Click and drag at the waypoint and it issues a "Move to this line" command. In this case the line can be oriented however the user wants. The shorter the line the deeper the units will line up. The longer the line, the more the units will be able to line up along with it. If there's enough units in the group they will form double or even triple lines, which may cause some shoving, as with the "Square Move" command.

'''Notes:''' Certain formation commands might not work on every type of aircraft.

By turning on [[#Repeat|Repeat]], units will move back into formation when shoved out of position. However, this should be used with caution, as it can lead to problems when trying to move units later.

Left-clicking with a unit selected is usually as good as pressing the "M" key if the selected point doesn't have any objects at that location.

====Move State====

Like [[#Fire State|Fire State]], this controls how the unit will maneuver in response to enemy units. Units set to Hold Position will not move very far from their current position, if they move from it at all. Units set to Maneuver will move a moderate distance from their current position while chasing enemies. Units set to Roam will move however they want to.

Maneuver is usually the most sensible setting here, as Roam leaves you open to a clever enemy pulling your units into heavy defences.

====Patrol (P)====

A unit given a command to patrol will move back and forth between its current position and the taget location. Holding CTRL when giving a patrol command to a selection with more then one unit will cause the units to move to a location relative the the target point compared to the distance of the unit from the center of the selection. Holding SHIFT while issueing a series of patrol orders will cause the unit to repeat this command, moving from current location to the targets and "circle around" through the points on the queued path.

When a unit is patroling, it will do whatever it can to "help out" along the path of it's patrol route. A construction unit will aid in construction projects, a combat unit will engage enemies, etc. How far it will go out of it's designated route is partially defined by line of sight, radar coverage, [[#Move State|move state]], and [[#Fire State|fire state]].

Examples of Patrol Behaviour:

*If a unit that can repair patrols within range of a damaged (or under contsruction) owned or allied unit, the patrolling unit will repair the damaged unit.

*If a unit that can attack patrols within range of an enemy it will attack the enemy unit.

====Reclaim (E)====

Reclaiming will break down something and give you metal/energy from it. Only certain units (namely, construction units and the Commander) have reclaim capabilities. Wrecks, enemy units, features, and your own units are reclaimable.

Energy and metal will be added to storage when reclaiming process is complete. You must have enough storage space to hold the energy/metal, or you will lose it!

'''Default Behavior:''' Simply clicking on a feature, a wreck, or an enemy unit with a construction unit will reclaim it by default. Hitting 'E' and dragging with the left mouse button issues an area reclaim order, and tells the unit to reclaim any wrecks or features in that area.

Assigning multiple units to reclaim a target will not increase the speed at which the target is reclaimed.

====Repair (R)====
When repairing a damaged unit, uses a percentage of the metal and energy costs associated with a damaged unit to increase the speed at which a unit regains health. This percentage is set per-mod, and many mods have it set to zero, making repairs free. When repairing a unit that is still being constructed the unit will help build the target, increasing the speed at which the unit is completed but also increasing the rate at which your resources are consumed.

The repair command is cancelled when the target's health reaches 100%, so if a unit under construction is damaged the repair command will complete the building of the target and then continue to repair until the unit is at full health.
Valid targets are any damaged units and units currently being constucted.

This is the default command for owned and ally units that are not at full health, including units being constructed by other units and factories, when a construction unit is selected.

The more units that are assigned to repair another unit, the faster the unit will be constructed/restored to full health, but the energy and metal costs will increase accordingly.

====Assign/Select Current Group (Q)====
This key has a several functions.

If you have one unit belonging to a group selected, when pressing "Q" it will select all the units that belong to this group.

If several units are selected, and one belongs to any group, then, when pressing "Q" it will assign ALL the selected units to this group, and after that will select the group.

Finally, if you have a group created, and want to "detach" units from it:
select the unit you wish to detach, and press Shift "Q", selected units will be removed from the group they belonged.

It works with AI groups as well as user-specified groups.

See [http://taspring.clan-sy.com/wiki/Using_Spring#Default_Selection_Controls Default selection Controls] for more info on groups.

====Repeat====

When turned on, Repeat moves any orders that have been completed to the back of the order queue. For instance, if you tell a unit to more to one side of the base, and then to the other side of the base, it would keep going back and forwards forever, because when it completed the first move command, it would place that command at the back of the queue again. This is useful when building units. If you want a factory to continuously pump out a Samson, then a Flash, then two Stumpy's, issue the orders, turn on repeat, and watch the units roll out!

Repeat may literally be used with any command set. The power of this command must not be underestimated! For example, it is possible to create a an air transport whose sole purpose is to fly units to the front lines or to another area automatically from the factory:
<Repeat> Group-Load, Group-Unload

It is possible to create a "repair zone" using Group-Repair and repeat:
<Repeat> Group-Repair

It is possible to create a "reclaim zone" at the front lines using a nano tower or other construction unit, and repeat:
<Repeat> Group-Reclaim

It is even possible, to bypass the limitations of the Patrol command using repeat. Units on patrol tend chase down enemies; however, if Repeat is used in conjunction with the standard Move command, you could pontentially set artillery units to go near the enemy front lines, fire several shots, and then come back to a repair zone, only to go back and repeat the cycle!

====Restore====

Drag an area of terrain to restore the terrain to it's original form if it has been "deformed" by explosions or the contruction of a building.

====Resurrect====

In XTA only the Arm F.A.R.K. and the Core necro can use this order. Use this to ressurect dead units. If you see some wreakage on the map from some dead units, select a FARK or Necro and ressurect the dead units to have them fight along side your army. A good way to gain the upper hand later in game is to ressurect your opponent's army after a battle. This does take a lot of energy and metal(half as much as building the unit originally), and ressurected units will start on 1 health, so are very vunerable.

Ressurect is the default order for corpses from destroyed units, this unfortunately includes wreackage that can't acctually be resurrected.(Tip: if you cannot tell what unit the wreakage was then most likely you cannot resurrect it)

Dragging this order as an area will cause all selected units to ressurect all valid targets in that area. If multiple units are given a common ressurect order, the target will be resurrected faster but only one of them (probably the one the engine decides actually completed the process) will try to restore it to health. In the case of an area command the units who do not stay behind to repair the target will move on to a new target.

====Select AI (CTRL Q)====

Press Control Q or choose "Select AI" from the Menu to assign a "[[AIs|Group AI]]" to the currently selected units.

Setting an AI will generate a "group" from that selection of units using a number above 10.

In Spring, the term "Group AI" stands more for an aid or "helper" than for a Complete Control AI (as NTAI, ZCAIN, JCAI).

The following [[AIs|Group AI]]s ship with Spring. More might be available from other sources.

None
[[Simple Formation]]
[[Central Build AI]]
[[Metal Maker AI]]
[[Radar AI]]
Default = Will assign default AI for that unit (?)

====Self Destruct (CTRL D)====
Will detonate the selected units/buildings in a very spectacular explosion after a specific count-down (default is 5 seconds). Use this when destroying units/building that are in the way, or when detonationg mines or crawling bombs. A way to literally go out with a bang is to press Ctrl A (Select All), Ctrl D (Self Destruct). Note that this will make you lose the game, but is very spectacular!

====Stop (S)====
Makes the selected units stop any queued commands immediately. They will not automatically stop attacking units, unless their fire state is set to Hold Fire, but they will cancel any ongoing attack orders, allowing them to select and engage targets based on their default AI.

====Wait (W)====

Start issuing your chain of commands (Holding Shift). BEFORE a command that you want your units to wait for a go command to execute, press Shift W, and then continue queuing up orders. Now, to cancel the first wait queued on this group, and have them continue with the rest of the queue, select the units when they're waiting and hit W. Many of these wait waypoints can be chained together. Note that if you hit W before some or all of the selected units have completed the command before the wait, only those that have completed the preceding command will continue.

Units are automatically issued a "stop waiting" command when loaded into and unloaded from a transport.

Wait is a standard command; by using Repeat in conjunction with wait, it is possible to create precisely timed strike and raiding groups.

=== Unbinded Commands===
These have no default hotkeys. You must bind them yourself, either by typing in the console something like '''/bind shift+k timewait 60 enqueued''' or by editing your uikeys.txt file. 

====GatherWait====
- Use it after a movement command of some sort (move / fight) 
- Units will wait until all members of the GatherWait command have arrived at their destinations before continuing 
- If you have "gathermode" enabled, a gatherwait command is automatically added after every move and fight command (the default move cursor will be changed to the gather cursor to indicate that you are in gathermode) 

====SquadWait====
- Usually used with factories (but does work on groups without a factory) 
- Pick a factory, and give it a rallypoint, then add a squadwait command with the number of units you want in your squads. units will wait at the initial rally point until enough of them have arrived to make up a squad, then they'll continue along their queue. 

====DeathWait====
- Units will not wait on themselves 
- One possible use is to have a group of aircraft wait for an enemy's anti-aircraft defenses to crumble before passing over their ruins to attack. 

====TimeWait====
- With the time in seconds 

'''[[Using_Spring|<--Back to Using Spring]]'''

[[category:Using Spring]]

Development:Main

2008-10-08T15:58:39Z

Af:

{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="500px" valign="top"|
'''[[Building spring|Building/Compiling the Spring Engine]]'''

Information regarding the source code of Spring.

'''[[Mod_and_Unit_development#Mod_development|Game Development And Unit Creation]]'''

Lots of links to valuable Articles and forum threads regarding Mod/Unit Development.

'''[[Map_development|Map Development]]'''

Tutorials and other useful information for creating maps.

'''[[Lua Scripting]]'''

Information regarding the use of the supplementary Lua scripting language for Widgets and beyond...

'''[[Map, Mod, And Unit Development Programs|Content Development Programs]]'''

Links to all kind of useful programs.

'''[[Mission development]]'''

Help on writing campaigns, demos and missions using Lua.

'''[[AI|AI Development]]'''

Lots of information about developing Skirmish, Unit and Group AIs for Spring.

'''[[Linux_Page |Linux and Mac OS]]'''

Mac OSX / NetBSD / Solaris / Linux / Cross-platform information.

'''[[Monthly Topic Rotation]]'''

Generally related to development of the engine or particular mods. Read before posting on the forums.

'''[[General Resources]]'''

Usable textures, sounds and code snippets by the community, for the community.

'''[[Associated Development Groups]]'''

Teams, Forums and Groups associated with Spring content and code development.

|width="250px" valign="top"|
{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[http://spring.clan-sy.com/phpbb/viewforum.php?f=12 Development forums]'''

Look at the development forums for ongoing progress and discussion
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[http://spring.clan-sy.com/mantis/ Report Bugs/Submit a Patch]'''

Submit patches and bug reports here
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''Commit Mailing List'''

View svn commits in your email as they happen
|}

|}

Development:Main

2008-10-08T15:57:12Z

Af:

{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="500px" valign="top"|
'''[[Building spring|Building/Compiling the Spring Engine]]'''

Information regarding the source code of Spring. 
'''[[Mod_and_Unit_development#Mod_development|Game Development And Unit Creation]]'''
Lots of links to valuable Articles and forum threads regarding Mod/Unit Development. 
'''[[Map_development|Map Development]]'''

Tutorials and other useful information for creating maps. 

'''[[Lua Scripting]]'''

Information regarding the use of the supplementary Lua scripting language for Widgets and beyond... 
'''[[Map, Mod, And Unit Development Programs|Content Development Programs]]'''

Links to all kind of useful programs. 
'''[[Mission development]]'''

Help on writing campaigns, demos and missions using Lua. 
'''[[AI|AI Development]]'''

Lots of information about developing Skirmish, Unit and Group AIs for Spring. 
'''[[Linux_Page |Linux and Mac OS]]'''

Mac OSX / NetBSD / Solaris / Linux / Cross-platform information. 
'''[[Monthly Topic Rotation]]'''

Generally related to development of the engine or particular mods. Read before posting on the forums. 
'''[[General Resources]]'''

Usable textures, sounds and code snippets by the community, for the community. 
'''[[Associated Development Groups]]'''

Teams, Forums and Groups associated with Spring content and code development. 
|width="250px" valign="top"|
{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[http://spring.clan-sy.com/phpbb/viewforum.php?f=12 Development forums]'''

Look at the development forums for ongoing progress and discussion
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[http://spring.clan-sy.com/mantis/ Report Bugs/Submit a Patch]'''

Submit patches and bug reports here
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''Commit Mailing List'''

View svn commits in your email as they happen
|}

|}

The Lighter Side Of Spring

2008-10-08T15:56:34Z

Af:

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://springbash.lcc-clan.com/ SpringBash] - Real quotes from lobby, taken out of context! (Domain issuer. Plz fix)

Using Spring

2008-10-08T15:55:46Z

Af:

{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="100%" valign="top" style="background: #41545c; border: 1px #aaa solid;"|
===Using Spring===

This is a fairly exhaustive description of controls, interface and features. For basic information, check the most current readme [[Readme|here]] or [[Read_Me_First|Read me first]]. For an introduction to the strategy and overall gameplay in XTA (and most mods based on the original Cavedog units) check out the [[Spring_guide%21|Spring Guide!]]. Other mods should have more specific documentation on their web sites or on the Wiki. Please see the links in the [[Mods]] section.

For more advanced/current information check the most recent [http://taspring.clan-sy.com/changelog.txt changelog] or the [http://taspring.clan-sy.com/phpbb/ Spring Forums].
|}

{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="100%" valign="top" style="background: #41545c; border: 1px #aaa solid;"|

===Articles===
'''[[Starting_A_Game|Starting A Game]]'''

'''[[Using_Orders|Issuing Orders]]'''

'''[[Command_Reference|Command Quick Reference]]'''

'''[http://img108.imagevenue.com/img.php?image=03721_PK06A_Compact_Keyboard_ProdImage_Black_V2_122_972lo.jpg Spring default Keyboard layout]

'''[[Using_Camera | Using the Cameras]]'''

'''[[Using_Selections|Selections/Groups/Group Commands/Group AI]]'''

'''[[Using_chat|Chat, Cheats, and Text Commands]]'''

'''[[Using_doodles|Map drawing/doodles]]'''

'''[[Using_custom_keys| Customized key shortcuts/bindings and the key/selection editor]]'''

'''[[Spring on a LAN]]'''

[[Category:Playing]]

FAQ

2008-10-08T15:54:06Z

Af:

{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="500px" valign="top"|

'''[[FAQ:general|General FAQ]]'''

An FAQ containing generic questions about spring and the project itself

'''[[FAQ:requirements| System Requirements FAQ]]'''

An FAQ on system requirements, and other helpful questions

'''[[FAQ:technical|Technical FAQ]]'''

An FAQ on some common issues

'''[[FAQ:player|Playing ingame FAQ]]'''

An FAQ with questions about the ingame GUI and playing with the spring engine

'''[[FAQ:content|Content FAQ]]'''

An FAQ on content, be that games or maps

'''[[Using_Spring|Playing Spring]]'''

How to play the game. Controls, issuing orders, and related topics.

'''[[Mods]]'''

Games that use the Spring engine.

'''[[Getting Spring Content and Links]]'''

Lists sites related to spring, and sites from which you can download spring Mods/Games, Maps, and more

'''[[Maps]]'''

All about maps for the Spring engine and where to get them.

'''[[AIs]]'''

Skirmish AIs, Helper AIs...

'''[[Clans]]'''

A list of the official clans in spring.

'''[[King Titles]]'''

Titles of importance.

'''[[Hosting Spring]]'''

Autohosting and related topics.

'''[[The Lighter Side Of Spring]]'''

Humour, comics and quotations.

|width="250px" valign="top"|
{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[http://spring.clan-sy.com/phpbb/viewforum.php?f=11 Help/Bug forums]'''

Look at the help forums for more help with technical issues and crashes
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[http://spring.clan-sy.com/mantis/ Report Bugs/Submit a Patch]'''

Submit patches and bug reports here
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[[Glossary]]'''

What does "AA" or "XTA" mean? Explanations for common terms and shorthand.
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[[Strategy and Tactics]]'''

Basic ideas how to stand your ground.
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[[Spreading Spring]]'''

Read before advertising.
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[[Read Me First]]'''

Answers to questions often asked - Everyone should read this first.
|}
|}

FAQ

2008-10-08T15:53:23Z

Af:

{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="500px" valign="top"|

'''[[FAQ:general|General FAQ]]'''

An FAQ containing generic questions about spring and the project itself

'''[[FAQ:requirements| System Requirements FAQ]]'''

An FAQ on system requirements, and other helpful questions

'''[[FAQ:technical|Technical FAQ]]'''

An FAQ on soem common issues

'''[[FAQ:player|Playing ingame FAQ]]'''

An FAQ with questions about the ingame GUI and playing with the spring engine

'''[[FAQ:content|Content FAQ]]'''

An FAQ on content, be that games or maps

'''[[Read Me First]]'''

Answers to questions often asked - Everyone should read this first.

'''[[Using_Spring|Playing Spring]]'''

How to play the game. Controls, issuing orders, and related topics.

'''[[Mods]]'''

Games that use the Spring engine.

'''[[Getting Spring Content and Links]]'''

Lists sites related to spring, and sites from which you can download spring Mods/Games, Maps, and more

'''[[Maps]]'''

All about maps for the Spring engine and where to get them.

'''[[AIs]]'''

Skirmish AIs, Helper AIs...

'''[[Clans]]'''

A list of the official clans in spring.

'''[[King Titles]]'''

Titles of importance.

'''[[Hosting Spring]]'''

Autohosting and related topics.

'''[[The Lighter Side Of Spring]]'''

Humour, comics and quotations.

|width="250px" valign="top"|
{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[http://spring.clan-sy.com/phpbb/viewforum.php?f=11 Help/Bug forums]'''

Look at the help forums for more help with technical issues and crashes
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[http://spring.clan-sy.com/mantis/ Report Bugs/Submit a Patch]'''

Submit patches and bug reports here
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[[Glossary]]'''

What does "AA" or "XTA" mean? Explanations for common terms and shorthand.
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[[Strategy and Tactics]]'''

Basic ideas how to stand your ground.
|}

{|width="100%"
| style="background: #41545c; padding:5px; border: 1px #aaa solid;"|
'''[[Spreading Spring]]'''

Read before advertising.
|}
|}

FAQ

2008-10-08T15:46:31Z

Af:

FAQ:content

2008-10-08T15:41:44Z

Af: New page: =Content= ==Do Spring maps need a "ground"?== Spring maps do require a ground. We have had many requests to have space maps, however, a "true" (ala Homeworld) space setting is not likel...

=Content=

==Do Spring maps need a "ground"?==

Spring maps do require a ground. We have had many requests to have space maps, however, a "true" (ala Homeworld) space setting is not likely. It would have to wait until a much later stage. This does not mean that TA's style of "space" maps won't be possible, (see the Final Frontier TC for examples of this).

==You stated that Spring uses the TA unit format.==

Spring does use the Total Annihilation unit format. However, there is also a new format dubbed '.s3o' which uses a UV mapped texture instead of 3do's per face texturing system, as well as other improvements.

==How powerful will Spring's custom format be?==

Total Annihilation's unit format was extremely limited. Most of these limitations will either be expanded or non-existent in Spring's custom unit format. One of the most exciting improvements is the introduction of an entirely new method of scripting, with nearly complete control over every aspect of a unit's actions and behaviors.

==Does Spring have a limited number of weapons?==
No. Unlike Total Annihilation, Spring's weapon IDs will be unlimited. Meaning it will be possible to add as many third-party units as you want. However, the current model format limits 16 weapons to each unit.

==Does Spring have a limited number of unique units?==

No. Unit IDs, like weapon IDs, will be unlimited.

==Will units have a maximum of 3 unique weapons?==

Total Annihilation had a limitation that permitted a maximum of 3 unique weapons per unit. Spring currently has a way to have 16 weapons per unit. (Replace Primary, Secondary, Tertiary by 1 2 3 ...16). More can be made possible by modifying the source if there's a sufficient demand by mod makers.

==I'm curious as to the per-unit polygon limit.==

The engine itself does not have a polygon count limit. The limit is that of the processing power of today's computers. Since Spring requires a 3D card, the maximum polygon count per unit will be several times higher than Total Annihilation's. That means for your average mod, 300 polygons for common units and 700 for the more expensive ones is quite reasonable. (But don't waste polies unnecessarily!)

==Will units be able to perform basic terraforming?==

Total Annihilation units probably won't have any terrain editable functionality. Future units may be endowed with such functionality, but it's more of a gameplay issue and has not been decided upon yet. However construction units can restore ground, and certain weapons (especially explosive ones) can be used to deform the ground.

==Will tunnel building be possible?==

Subterranean areas of any sort is impossible. However, it is possible to heavily deform the ground with explosives.. Which is great fun!

==Will the ground's water retention be editable?==

No. Water will always collect when a piece of land has a height below sea level.

==Does Spring have a limit on the number of races?==

Spring has no limit on the total number of sides/races.

==What are the sizes of the biggest and smallest units?==

Static units (buildings, defenses, etc.) have no size limitations in the engine. Technically, neither do mobile units, but units with a footprint larger than 4x4 "squares" (an arbitrary size standard created by Cavedog) might have problems pathfinding.

==What is going to be the maximum possible sea depth?==

For all practical purposes, it will be unlimited. The depth values are stored as "float variables", so it is doubtful that maps would ever be made which even come close to approaching the limit.

==Will Spring support campaigns?==

Basic Map scripting has been implemented, using a Lua scripting engine. From that, it would be possible to make a basic campaign, but for ease of use a better way of selecting scripts and an improved Single player menu is needed.

See [[Mission development]] for more details.

==How big are the Spring files?==

Spring will be as small as however much content is included with it. The "essential" files are only be several megabytes large. Content (such as maps and units) will add considerable size to the Spring download. Currently, the file size is roughly 30 MB.

==How will Spring render sound effects?==

Sound is rendered 3D, meaning that the volume and direction (assuming a multi-speaker setup) vary with the location of the camera from the sound "emitter". What this translates into gameplay terms means that the closer you are to a unit making a sound or motion, the louder the sound will be. Additionally, the sound will be heard differently depending on which way the camera is facing relative to units making sound.

==Will Spring have ambient sound?==

There is no ambient sound, and we haven't planned on adding it thus far.

==Will there be an AI or a "skirmish" mode?==

We have created an interface for artificial intelligences (AIs), and several are currently under development. Information on these can be found at the [[AIs]] wiki page.

==Will a "possess" or a FPS option be present?==

Yes, it is possible to fully control a unit from the first person view. It is more of a gimmick, but it still allows for a nice diversion once in a while. Instructions on its use are in the [[Using_Spring#FPS_.22Mode.22_.28C.29|Using Spring]] article.

==How do I create maps?==

See the [[Map development]] page for all the map info.

==How do I create units/mods?==

See the [[Mod_and_Unit_development#Mod_devlopement|Mod and Unit development]] page on creating units/ mods.

[[Category:Content]]

FAQ

2008-10-08T15:41:38Z

Af: Replacing page with 'Here are some FAQs General FAQ System Requirements FAQ Technical FAQ Playing ingame FAQ [[FAQ:conten...'

FAQ:player

2008-10-08T15:39:08Z

Af: New page: =Playing= ==What is with this weird right-click mode? I'm 'bout to break my keyboard.== Sorry, you'll just have to get used to it. As of now it can't be changed. ==Why is somebody else ...

=Playing=

==What is with this weird right-click mode? I'm 'bout to break my keyboard.==

Sorry, you'll just have to get used to it. As of now it can't be changed.

==Why is somebody else also controlling my units?==

In the 'game lobby' there are two sets of teams. There are the 'Ids' and the 'Teams'. If you are on the same 'Id', then you both get the same commander, and can control the same units. If you are on the same 'Team', then you both get different commanders and can't control each others units.

==Is there a way that I can play music directly through TA-Spring, with alternating tracks for building/attacking like in the original Total Annihilation?==

Yes, there is. It is an add on (GroupAI) you have to download separately:
http://jobjol.nl/1188

There is also an ingame sound-volume-slider you might find usefull (lua-script):
http://jobjol.nl/1218

==Then why would I want to be on the same 'Team' as somebody?==

Because it's fun to just drive around units and not have to worry about commanding. (Assuming that one of the people on the team is commanding.)
Most importantly, however, you can split tasks, such as base building, and troops management.

==Sometimes I can't write anything but numbers and some other symbols. Why is that?==

This is most likely because of the Windows language bar change from which Spring doesn't recognize the characters written.
Note: That Default hotkeys in Windows XP for changing the language is Shift+Alt, which is similar to square build hotkeys in Spring!

==How do I talk to my allies only?==

You must type 'a:' before you speak, or press "Alt Enter" at the same time. Here's an example: a: Now I am talking to my allies only. 

==Help! After I'm finished driving a unit, the camera is all insane! This is nuts! How do I fix it?==

Whoa now. Calm down. Just press ctrl + mouse button 3 to change camera modes. If your unit is destroyed in FPS mode, you will stay in FPS mode until you change camera modes. Also, the camera will stay in "free look" when FPS mode is disengaged, press middle-mouse or J to switch to normal scrolling.

==After I'm finished driving a unit, where what used to be my mouse pointer is now a crosshair. Why?==

-This is a special 'view mode' that allows you to move around the screen much faster. It's good for viewing the battle or getting screenshots. Simply press on your third mouse button or 'delete' to revert back to your mouse pointer.

==But I don't have a third mouse button!==

The key 'J' works in the same way as the 'middle mouse button' does. So where you would use ctrl + middle mouse button to change camera modes, ctrl + j does the same thing. Pressing J once will also switch you from 'crosshair mode' to 'pointer mode' and vice versa.

==IÃ‚Â´ve managed to get stuck in this weird camera mode and my perspective is all messed up. How do I switch to the overhead (OTA style) camera?==

Shift+Backspace (or Shift+J or Shift+MiddleMouseClick) switches between the fps style, total war style and OTA style cameras. Use it to get your camera back to normal in this situation.

==People are cheating! How do I stop it?!==
Well currently, you can't.

Only the host can "activate" the cheat codes. After that, any player can do almost all cheats.

The best thing to do is just not play with the cheaters anymore. But with new spring version cheats are disabled in multiplayer, so that paragraph is hopefully now irrelevant.

==Well how do you cheat?==

<table border="3" cellpadding="2" cellspacing="0">

<tr><th>Cheat Command</th><th>Effect</th></tr>

<tr>
<td>'''.cheat'''</td><td>'''enable cheats - Cheats don't work in multiplayer until the host types this'''</td>
</tr>

<tr>
<td>.nocost</td><td>instabuild (doesn't work on things already under construction, only on new ones)</td>
</tr>

<tr>
<td>.setmaxspeed 50</td><td>Changes the maximum speed multiplier (default is 3.0)</td>
</tr>

<tr>
<td>.setminspeed 0</td><td>Changes the minimum speed multiplier (default is 0.3)</td>
</tr>

<tr>
<td>.spectator</td><td>Allows you to see the entire map... but you lose control of your units</td>
</tr>

<tr>
<td>.team 0, .team 1, etc.</td><td>Change player</td>
</tr>

<tr>
<td>.give ARMCOM, .give 10 CORKROG, etc.</td><td>Place 1 or specified number of specified unit. Valid units are the internal names of units as specified in the unit definition.</td>
</tr>

</table>
You can use auto-completion in the spring console if you don't remember the internal unit name. To do that type:
".give arm" and then press your '''TAB key'''
A list of all matching units will be shown.

==In Game Commands==

The following ''non-cheating'' commands are also available in game:

<table border="3" cellpadding="2" cellspacing="0">

<tr>
<th>Command</th><th>Effect</th>
</tr>

<tr>
<td>/info</td><td>Shows you what colour each player is and their ping delay in the bottom right corner of the screen.</td>
</tr>

<tr>
<td>/clock</td><td>Shows you the elapsed game time in minutes and seconds in the upper right corner of the screen</td>
</tr>

<tr>
<td>.take</td><td>Pulls all allied units, that are owned by players who have lost connection to the server, to your team.</td>
</tr>

</table>

==How do I ally or unally in game?==

I'm pretty sure you can't. Yet.

==How do I give somebody units or metal or energy?==

Press the 'H' key. Then select the amount of metal and/or energy to share. Then select the receiving player and press OK.

When sharing units, you must first select the units to share, then press 'H' key. Tick share units checkbox and choose a receiving player.

==How do I continually give somebody metal and/or energy after a certain point (i.e. Original TA commands +setshare..., +shareall)?==

You'll notice that on your metal and energy bars (top of screen), there are two red bars. You have to put them wherever you want your metal and energy to be shared after.

==This game is different than TA, the units HP and damage are not the same==

There were several third party "balance" mods for the original TA game.

One of those mods were xTA, and was developed by the same clan (SY) that has brought life back to TA, making Spring.

This balance mod is what is bundled by default with the spring engine, and is the mod that was ready to play when Spring was released.

Now are several mods available, install the mod of your choice.

* http://spring.jobjol.nl/files.php?subcategory_id=5
* http://spring-portal.com/index.php/docman/cat_view/36-mods
* http://www.tasdownloads.com/?ta=2

==XTA? OTA? AA? OMFGLAMO? WTF do those abbreviations mean?==

zwzsg maintains a handy dandy FAQ about TA, and the abbreviations that relate to Spring too, of course.
[http://www.tauniverse.com/forum/showthread.php?t=27309 click here]. See also the Spring [[Glossary]], which contains brief explanations for all non-standard words and phrases.

==Why am I destroyed so easily by long range assaults?==

This is a realistic feature of Spring. Units will automatically attack 'radar blips' (units that they can not actually see, but that are indicated on radar). However, the accuracy is very bad while shooting at radar blips until:

* Your unit kills a lot of units and gets experience
* You get a targeting facility.

==Can I kick people from my 'game lobby' or my game?==

First of all, you have to be the host to kick. Use the good old ".kick playernamehere" command. Works in-game too, use it wisely.

==When I'm 'driving' my commander, why can't I use my laser?==

The Spring team will most likely add a way for you to use your commander's laser soon.

==I hate driving around with the 'arrow keys'. Is there any way I can use the 'W-A-S-D' controls (the controls most First Person Shooters use) anymore?==

Go into your Spring directory and edit the uikeys file. Keep in mind that 'S' is originally a 'hot-key' that will stop your units and that 'D' is a 'hot-key' for your commander's D-Gun. You might want to change those too.

==I turned the shadows feature on; I still don't see shadows. What gives?==

Your graphics card can't handle shadows, so Spring automatically turns them off.

==I can't go backwards when I am 'driving' a unit. Why not?==

Because TA units were never intended to go backwards. Sorry, but you just cant.

==I'm in an Unreal Tournament kind of mood. How do I strafe?==

You can only strafe in 'brawler type' ships, such as the brawler, rapier, and light gunships.

==How can I record and watch demos/replays?==

From version 0.62 onwards recordings of all the games you play are easily available for replay via the Replays button in the TASClient.

You can use the Speed up/Slow down game keys while watching the replay, along with other in-game commands like .team

From version 0.60b1 onwards, demos are automatically recorded in the "demos" folder, underneath your Spring folder (default is C:\Program Files\Spring\demos), named for the date and map they were played on. If you play multiple games in the same day on the same map, the games will also be numbered to prevent them from overwriting each other.

From version 0.62 onwards, to view a demo from the Windows file manager you can just double click the file name.

==Sometimes when I play get "not sync" "delayed synch" errors==

That's caused because of lag. One of the players in the game is having some lag issues. Ask him/her to free up its bandwidth for the game to use.

Alternatively you can use the pause key and wait till the connection gets more stable.

Lag is the seccond number showed when you use the .info command ingame, numbers bigger than 40 are not usual in a normal game and are a signal of lag.

FAQ

2008-10-08T15:36:38Z

Af:

[[FAQ:general|General FAQ]]

[[FAQ:requirements| System Requirements FAQ]]

[[FAQ:technical|Technical FAQ]]

[[FAQ:player|Playing ingame FAQ]]

==Content==

===Do Spring maps need a "ground"?===
Spring maps do require a ground. We have had many requests to have space maps, however, a "true" (ala Homeworld) space setting is not likely. It would have to wait until a much later stage. This does not mean that TA's style of "space" maps won't be possible, (see the Final Frontier TC for examples of this).

===You stated that Spring uses the TA unit format.===
Spring does use the Total Annihilation unit format. However, there is also a new format dubbed '.s3o' which uses a UV mapped texture instead of 3do's per face texturing system, as well as other improvements.

===How powerful will Spring's custom format be?===
Total Annihilation's unit format was extremely limited. Most of these limitations will either be expanded or non-existent in Spring's custom unit format. One of the most exciting improvements is the introduction of an entirely new method of scripting, with nearly complete control over every aspect of a unit's actions and behaviors.

===Does Spring have a limited number of weapons?===
No. Unlike Total Annihilation, Spring's weapon IDs will be unlimited. Meaning it will be possible to add as many third-party units as you want. However, the current model format limits 16 weapons to each unit.

===Does Spring have a limited number of unique units?===
No. Unit IDs, like weapon IDs, will be unlimited.

===Will units have a maximum of 3 unique weapons?===
Total Annihilation had a limitation that permitted a maximum of 3 unique weapons per unit. Spring currently has a way to have 16 weapons per unit. (Replace Primary, Secondary, Tertiary by 1 2 3 ...16). More can be made possible by modifying the source if there's a sufficient demand by mod makers.

===I'm curious as to the per-unit polygon limit.===
The engine itself does not have a polygon count limit. The limit is that of the processing power of today's computers. Since Spring requires a 3D card, the maximum polygon count per unit will be several times higher than Total Annihilation's. That means for your average mod, 300 polygons for common units and 700 for the more expensive ones is quite reasonable. (But don't waste polies unnecessarily!)

===Will units be able to perform basic terraforming?===
Total Annihilation units probably won't have any terrain editable functionality. Future units may be endowed with such functionality, but it's more of a gameplay issue and has not been decided upon yet. However construction units can restore ground, and certain weapons (especially explosive ones) can be used to deform the ground.

===Will tunnel building be possible?===
Subterranean areas of any sort is impossible. However, it is possible to heavily deform the ground with explosives.. Which is great fun!

===Will the ground's water retention be editable?===
No. Water will always collect when a piece of land has a height below sea level.

===Does Spring have a limit on the number of races?===
Spring has no limit on the total number of sides/races.

===What are the sizes of the biggest and smallest units?===
Static units (buildings, defenses, etc.) have no size limitations in the engine. Technically, neither do mobile units, but units with a footprint larger than 4x4 "squares" (an arbitrary size standard created by Cavedog) might have problems pathfinding.

===What is going to be the maximum possible sea depth?===
For all practical purposes, it will be unlimited. The depth values are stored as "float variables", so it is doubtful that maps would ever be made which even come close to approaching the limit.

===Will Spring support campaigns?===
Basic Map scripting has been implemented, using a Lua scripting engine. From that, it would be possible to make a basic campaign, but for ease of use a better way of selecting scripts and an improved Single player menu is needed.

See [[Mission development]] for more details.

===How big are the Spring files?===
Spring will be as small as however much content is included with it. The "essential" files are only be several megabytes large. Content (such as maps and units) will add considerable size to the Spring download. Currently, the file size is roughly 30 MB.

===How will Spring render sound effects?===
Sound is rendered 3D, meaning that the volume and direction (assuming a multi-speaker setup) vary with the location of the camera from the sound "emitter". What this translates into gameplay terms means that the closer you are to a unit making a sound or motion, the louder the sound will be. Additionally, the sound will be heard differently depending on which way the camera is facing relative to units making sound.

===Will Spring have ambient sound?===
There is no ambient sound, and we haven't planned on adding it thus far.

===Will there be an AI or a "skirmish" mode?===
We have created an interface for artificial intelligences (AIs), and several are currently under development. Information on these can be found at the [[AIs]] wiki page.

===Will a "possess" or a FPS option be present?===
Yes, it is possible to fully control a unit from the first person view. It is more of a gimmick, but it still allows for a nice diversion once in a while. Instructions on its use are in the [[Using_Spring#FPS_.22Mode.22_.28C.29|Using Spring]] article.

===How do I create maps?===
See the [[Map development]] page for all the map info.

===How do I create units/mods?===
See the [[Mod_and_Unit_development#Mod_devlopement|Mod and Unit development]] page on creating units/ mods.

[[Category:Content]]

FAQ:getting a game started

2008-10-08T15:35:33Z

Af: New page: =Getting into a game= ==People talk about 'Single Player'. How do I start a single player game?== Simply start a game in the lobby, and enter a password, so that nobody can join. Then cl...

=Getting into a game=

==People talk about 'Single Player'. How do I start a single player game?==

Simply start a game in the lobby, and enter a password, so that nobody can join. Then click ready, and start and away you go !

Alternatively, you can get [http://spring-portal.com/index.php/docman/doc_download/232-springsp-v09 Spring Single Player] (new link) , a handy tool that lets you create single player games without cluttering up the lobby, as well as watch replays easily.

It's also very easy to set up singleplayer games using SpringLobby. Just click on the singleplayer tab, add some bots, and play. You can grab it from the [http://springlobby.info SpringLobby website].

==When I try to make a single player game, it gives me an error.==

Your graphics card probably can't support Spring. If you read the requirements it did say GeForce 3 or better. Go to the settings file in your Spring directory and lower some of the options. Sometimes that works.

==Does Spring support AI Players?==

Yes, see [[AI]] You can also use the [[random_enemies]] script, which spawns units out of thin air and sends them to attack you.

==How do I join an Internet multiplayer game?==

Run the "TA Spring multiplayer battleroom" from the Start menu or the TASClient.exe from your installation folder. In the "Server" tab change the server to "Official Host". Hit "Apply and close". Re-open the TA Spring client. Create an account on the "Account" tab.

==When I try to connect to the lobby it gives me an error.==

There could be 3 problems. Either you don't have an account, the server is down, or you have not configured your router/firewall correctly. If you don't have an account, make one. If the server is down, you'll just have to wait (this doesn't happen often, though). If you have a router/firewall read below. Have a look at this website's News page and/or the Messageboard, it is likely that you will get some information there in the eventuality that the server is down.

Also make sure that you don't have any spaces in your username.

==I have a router and I don't seem to be able to get a game==

If you are using a router you may have other problems. Explanations of [http://www.portforward.com/routers.htm how to forward ports] has instructions for every router.

==Where can I download more maps?==

Please refer to the [[Maps| Maps section]].

==How do I install downloaded maps?==

Most maps are released as .sdz or .sd7 files. These can be put directly into the "maps" folder inside the Spring folder. Spring now includes a script to move maps and mods to the proper directory on Windows if you double click them. If they are compressed into another type of archive you will have to unpack them first. Just unzip them into your spring maps folder. Some map files use newer (smaller) file formats such as .rar or .7z, to unzip these newer formats, you'll need to download 7-Zip [http://www.7-zip.org/ http://www.7-zip.org/] or Zip-genius [http://downloads.zipgenius.it/ http://downloads.zipgenius.it/]. They both handle almost all formats and are totally free. There is also now a map browser in the TASClient lobby software, click the more maps button in a battle screen to access it.

==Sometimes when I try to join games it gives me an error.==

The host is behind a firewall that has not opened the correct ports for Spring.

==When a multiplayer game starts I never make it past the loading screen.==

This indicates a problem with your video card. Once again the best way to deal with this situation is to make sure your video card has the latest driver updates and that all Spring video features are on the lowest settings.

==When a multiplayer game starts, I make it past the loading screen, but when I get into the game it says, "Waiting for Host", and does a 10 second countdown. It always reaches zero and boots me out, what gives?==

This is a firewall issue. There are three things you can do to fix this. First, make sure your windows firewall is either off, or is not blocking the TA: Spring application. Secondly, if you are behind a router, you can forward the ports that the host is using (especially if you are the host), and it usually fixes the problem. To do this you must go to your router configuration page. You can see what port 'you' are using (as the host), by hosting a multiplayer game in the Spring Lobby. You must make this your trigger port, and make sure that it is open for both TCP and UDP. Thirdly, if none of the aforementioned worked. The easiest thing to do (assuming you are behind a router) is to set the DMZ (Demilitarized Zone). This means your computer will be completely exposed to the internet, which will make you vulnerable to any unknown or unpatched exploits in windows. All you have to do is find the personal IP if the computer you are using and add it to your router's DMZ list. Please only try this last option if you can't get the others to work.
Good Luck

==I got into the game, but some people didn't.==

The host may have reached the number of players it has set.
Or the players may be experiencing firewall or video card difficulty. That is not your fault. Please ask them too leave if they are still there when you get into the 'game lobby'. Some people have problem connecting to "hole punching" hosts.

==I got into a game but my name is red, nobody can hear me speak, and eventually I get disconnected==

This is to do with how long it takes the game to start up (the "load time"). If it takes too long you will see this problem. The load time can be reduced by changing the game graphics settings to lower quality. In particular try setting texture quality to lowest.

==What do all those icons mean in the server list?==

Server status icons inform you, at a quick glance, what the server is doing at the moment, and what state it's in (password protected, locked, open, full, etc). Read all about the server status icons and what they mean [[Server Status|here]]. Or hit F1 in the Battle room for even more information on the icons and their meaning.

FAQ

2008-10-08T15:34:23Z

Af:

[[FAQ:general|General FAQ]]

[[FAQ:requirements| System Requirements FAQ]]

[[FAQ:getting_a_game_started|Getting a game started FAQ]]

[[FAQ:technical|Technical FAQ]]

==Playing==

===What is with this weird right-click mode? I'm 'bout to break my keyboard.===
Sorry, you'll just have to get used to it. As of now it can't be changed.

===Why is somebody else also controlling my units?===
In the 'game lobby' there are two sets of teams. There are the 'Ids' and the 'Teams'. If you are on the same 'Id', then you both get the same commander, and can control the same units. If you are on the same 'Team', then you both get different commanders and can't control each others units.

===Is there a way that I can play music directly through TA-Spring, with alternating tracks for building/attacking like in the original Total Annihilation?===
Yes, there is. It is an addon (GroupAI) you have to download separately:
http://jobjol.nl/1188

There is also an ingame sound-volume-slider you might find usefull (lua-script):
http://jobjol.nl/1218

===Then why would I want to be on the same 'Team' as somebody?===
Because it's fun to just drive around units and not have to worry about commanding. (Assuming that one of the people on the team is commanding.)
Most importantly, however, you can split tasks, such as base building, and troops management.

===Sometimes I can't write anything but numbers and some other symbols. Why is that?===
This is most likely because of the Windows language bar change from which Spring doesn't recognize the characters written.
Note: That Default hotkeys in Windows XP for changing the language is Shift+Alt, which is similar to square build hotkeys in Spring!

===How do I talk to my allies only?===
You must type 'a:' before you speak, or press "Alt Enter" at the same time. Here's an example: a: Now I am talking to my allies only. 

===Help! After I'm finished driving a unit, the camera is all insane! This is nuts! How do I fix it?===
Whoa now. Calm down. Just press ctrl + mouse button 3 to change camera modes. If your unit is destroyed in FPS mode, you will stay in FPS mode until you change camera modes. Also, the camera will stay in "free look" when FPS mode is disengaged, press middle-mouse or J to switch to normal scrolling.

===After I'm finished driving a unit, where what used to be my mouse pointer is now a crosshair. Why?===
-This is a special 'view mode' that allows you to move around the screen much faster. It's good for viewing the battle or getting screenshots. Simply press on your third mouse button or 'delete' to revert back to your mouse pointer.

===But I don't have a third mouse button!===
The key 'J' works in the same way as the 'middle mouse button' does. So where you would use ctrl + middle mouse button to change camera modes, ctrl + j does the same thing. Pressing J once will also switch you from 'crosshair mode' to 'pointer mode' and vice versa.

===IÃ‚Â´ve managed to get stuck in this weird camera mode and my perspective is all messed up. How do I switch to the overhead (OTA style) camera?===
Shift+Backspace (or Shift+J or Shift+MiddleMouseClick) switches between the fps style, total war style and OTA style cameras. Use it to get your camera back to normal in this situation.

===People are cheating! How do I stop it?!===
Well currently, you can't.

Only the host can "activate" the cheat codes. After that, any player can do almost all cheats.

The best thing to do is just not play with the cheaters anymore. But with new spring version cheats are disabled in multiplayer, so that paragraph is hopefully now irrelevant.

===Well how do you cheat?===

<table border="3" cellpadding="2" cellspacing="0">

<tr><th>Cheat Command</th><th>Effect</th></tr>

<tr>
<td>'''.cheat'''</td><td>'''enable cheats - Cheats don't work in multiplayer until the host types this'''</td>
</tr>

<tr>
<td>.nocost</td><td>instabuild (doesn't work on things already under construction, only on new ones)</td>
</tr>

<tr>
<td>.setmaxspeed 50</td><td>Changes the maximum speed multiplier (default is 3.0)</td>
</tr>

<tr>
<td>.setminspeed 0</td><td>Changes the minimum speed multiplier (default is 0.3)</td>
</tr>

<tr>
<td>.spectator</td><td>Allows you to see the entire map... but you lose control of your units</td>
</tr>

<tr>
<td>.team 0, .team 1, etc.</td><td>Change player</td>
</tr>

<tr>
<td>.give ARMCOM, .give 10 CORKROG, etc.</td><td>Place 1 or specified number of specified unit. Valid units are the internal names of units as specified in the unit definition.</td>
</tr>

</table>
You can use auto-completion in the spring console if you don't remember the internal unit name. To do that type:
".give arm" and then press your '''TAB key'''
A list of all matching units will be shown.

===In Game Commands===
The following ''non-cheating'' commands are also available in game:

<table border="3" cellpadding="2" cellspacing="0">

<tr>
<th>Command</th><th>Effect</th>
</tr>

<tr>
<td>/info</td><td>Shows you what colour each player is and their ping delay in the bottom right corner of the screen.</td>
</tr>

<tr>
<td>/clock</td><td>Shows you the elapsed game time in minutes and seconds in the upper right corner of the screen</td>
</tr>

<tr>
<td>.take</td><td>Pulls all allied units, that are owned by players who have lost connection to the server, to your team.</td>
</tr>

</table>

===How do I ally or unally in game?===
I'm pretty sure you can't. Yet.

===How do I give somebody units or metal or energy?===
Press the 'H' key. Then select the amount of metal and/or energy to share. Then select the receiving player and press OK.

When sharing units, you must first select the units to share, then press 'H' key. Tick share units checkbox and choose a receiving player.

===How do I continually give somebody metal and/or energy after a certain point (i.e. Original TA commands +setshare..., +shareall)?===
You'll notice that on your metal and energy bars (top of screen), there are two red bars. You have to put them wherever you want your metal and energy to be shared after.

===This game is different than TA, the units HP and damage are not the same===

There were several third party "balance" mods for the original TA game.

One of those mods were xTA, and was developed by the same clan (SY) that has brought life back to TA, making Spring.

This balance mod is what is bundled by default with the spring engine, and is the mod that was ready to play when Spring was released.

Now are several mods available, install the mod of your choice.

* http://spring.jobjol.nl/files.php?subcategory_id=5

* http://spring-portal.com/index.php/docman/cat_view/36-mods

* http://www.tasdownloads.com/?ta=2

===XTA? OTA? AA? OMFGLAMO? WTF do those abbreviations mean?===
zwzsg maintains a handy dandy FAQ about TA, and the abbreviations that relate to Spring too, of course.
[http://www.tauniverse.com/forum/showthread.php?t=27309 click here]. See also the Spring [[Glossary]], which contains brief explanations for all non-standard words and phrases.

===Why am I destroyed so easily by long range assaults?===
This is a realistic feature of Spring. Units will automatically attack 'radar blips' (units that they can not actually see, but that are indicated on radar). However, the accuracy is very bad while shooting at radar blips until:
* Your unit kills a lot of units and gets experience
* You get a targeting facility.

===Can I kick people from my 'game lobby' or my game?===
First of all, you have to be the host to kick. Use the good old ".kick playernamehere" command. Works in-game too, use it wisely.

===When I'm 'driving' my commander, why can't I use my laser?===
The Spring team will most likely add a way for you to use your commander's laser soon.

===I hate driving around with the 'arrow keys'. Is there any way I can use the 'W-A-S-D' controls (the controls most First Person Shooters use) anymore?===
Go into your Spring directory and edit the uikeys file. Keep in mind that 'S' is originally a 'hot-key' that will stop your units and that 'D' is a 'hot-key' for your commander's D-Gun. You might want to change those too.

===I turned the shadows feature on; I still don't see shadows. What gives?===
Your graphics card can't handle shadows, so Spring automatically turns them off.

===I can't go backwards when I am 'driving' a unit. Why not?===
Because TA units were never intended to go backwards. Sorry, but you just cant.

===I'm in an Unreal Tournament kind of mood. How do I strafe?===
You can only strafe in 'brawler type' ships, such as the brawler, rapier, and light gunships.

===How can I record and watch demos/replays?===
From version 0.62 onwards recordings of all the games you play are easily available for replay via the Replays button in the TASclient.

You can use the Speed up/Slow down game keys while watching the replay, along with other in-game commands like .team

From version 0.60b1 onwards, demos are automatically recorded in the "demos" folder, underneath your Spring folder (default is C:\Program Files\Spring\demos), named for the date and map they were played on. If you play multiple games in the same day on the same map, the games will also be numbered to prevent them from overwriting each other.

From version 0.62 onwards, to view a demo from the Windows file manager you can just double click the file name.

===Sometimes when I play get "not sync" "delayed synch" errors===

Thats caused because of lag. One of the players in the game is having some lag issues. Ask him/her to free up its bandwidth for the game to use.

Alternatively you can use the pause key and wait till the connection gets more stable.

Lag is the seccond number showed when you use the .info command ingame, numbers bigger than 40 are not usual in a normal game and are a signal of lag.

----

==Content==

===Do Spring maps need a "ground"?===
Spring maps do require a ground. We have had many requests to have space maps, however, a "true" (ala Homeworld) space setting is not likely. It would have to wait until a much later stage. This does not mean that TA's style of "space" maps won't be possible, (see the Final Frontier TC for examples of this).

===You stated that Spring uses the TA unit format.===
Spring does use the Total Annihilation unit format. However, there is also a new format dubbed '.s3o' which uses a UV mapped texture instead of 3do's per face texturing system, as well as other improvements.

===How powerful will Spring's custom format be?===
Total Annihilation's unit format was extremely limited. Most of these limitations will either be expanded or non-existent in Spring's custom unit format. One of the most exciting improvements is the introduction of an entirely new method of scripting, with nearly complete control over every aspect of a unit's actions and behaviors.

===Does Spring have a limited number of weapons?===
No. Unlike Total Annihilation, Spring's weapon IDs will be unlimited. Meaning it will be possible to add as many third-party units as you want. However, the current model format limits 16 weapons to each unit.

===Does Spring have a limited number of unique units?===
No. Unit IDs, like weapon IDs, will be unlimited.

===Will units have a maximum of 3 unique weapons?===
Total Annihilation had a limitation that permitted a maximum of 3 unique weapons per unit. Spring currently has a way to have 16 weapons per unit. (Replace Primary, Secondary, Tertiary by 1 2 3 ...16). More can be made possible by modifying the source if there's a sufficient demand by mod makers.

===I'm curious as to the per-unit polygon limit.===
The engine itself does not have a polygon count limit. The limit is that of the processing power of today's computers. Since Spring requires a 3D card, the maximum polygon count per unit will be several times higher than Total Annihilation's. That means for your average mod, 300 polygons for common units and 700 for the more expensive ones is quite reasonable. (But don't waste polies unnecessarily!)

===Will units be able to perform basic terraforming?===
Total Annihilation units probably won't have any terrain editable functionality. Future units may be endowed with such functionality, but it's more of a gameplay issue and has not been decided upon yet. However construction units can restore ground, and certain weapons (especially explosive ones) can be used to deform the ground.

===Will tunnel building be possible?===
Subterranean areas of any sort is impossible. However, it is possible to heavily deform the ground with explosives.. Which is great fun!

===Will the ground's water retention be editable?===
No. Water will always collect when a piece of land has a height below sea level.

===Does Spring have a limit on the number of races?===
Spring has no limit on the total number of sides/races.

===What are the sizes of the biggest and smallest units?===
Static units (buildings, defenses, etc.) have no size limitations in the engine. Technically, neither do mobile units, but units with a footprint larger than 4x4 "squares" (an arbitrary size standard created by Cavedog) might have problems pathfinding.

===What is going to be the maximum possible sea depth?===
For all practical purposes, it will be unlimited. The depth values are stored as "float variables", so it is doubtful that maps would ever be made which even come close to approaching the limit.

===Will Spring support campaigns?===
Basic Map scripting has been implemented, using a Lua scripting engine. From that, it would be possible to make a basic campaign, but for ease of use a better way of selecting scripts and an improved Single player menu is needed.

See [[Mission development]] for more details.

===How big are the Spring files?===
Spring will be as small as however much content is included with it. The "essential" files are only be several megabytes large. Content (such as maps and units) will add considerable size to the Spring download. Currently, the file size is roughly 30 MB.

===How will Spring render sound effects?===
Sound is rendered 3D, meaning that the volume and direction (assuming a multi-speaker setup) vary with the location of the camera from the sound "emitter". What this translates into gameplay terms means that the closer you are to a unit making a sound or motion, the louder the sound will be. Additionally, the sound will be heard differently depending on which way the camera is facing relative to units making sound.

===Will Spring have ambient sound?===
There is no ambient sound, and we haven't planned on adding it thus far.

===Will there be an AI or a "skirmish" mode?===
We have created an interface for artificial intelligences (AIs), and several are currently under development. Information on these can be found at the [[AIs]] wiki page.

===Will a "possess" or a FPS option be present?===
Yes, it is possible to fully control a unit from the first person view. It is more of a gimmick, but it still allows for a nice diversion once in a while. Instructions on its use are in the [[Using_Spring#FPS_.22Mode.22_.28C.29|Using Spring]] article.

===How do I create maps?===
See the [[Map development]] page for all the map info.

===How do I create units/mods?===
See the [[Mod_and_Unit_development#Mod_devlopement|Mod and Unit development]] page on creating units/ mods.

[[Category:Content]]

FAQ:technical

2008-10-08T15:33:39Z

Af:

FAQ:requirements

2008-10-08T15:32:59Z

Af:

=Requirements=

==What platforms will Spring run on?==
At the moment, it runs on Windows, Linux and basically on [[Spring_on_MacOSX |Mac OS X]]. Support for FreeBSD is in work.

==What sort of a system do I need to run Spring?==
You need a 3D graphics card to run Spring, which will probably require at least a a GeForce4 MX and the latest driver supported. Minimum CPU requirements are a little more complex. A more powerful CPU will have the capability to support larger maps and a greater maximum unit limit. A 1 GHz CPU should be able to support an estimated 500 units. The needed memory will also vary with unit count and map size, and Spring has been known to have worked with 256 MB of Ram (albeit with lowest detail levels).

For further details and tested Systems check the [[Requirements]] page.

==Spring says 'Missing Default Cursor'==

That means you are playing a mod or 'game content' that depends on files you do not have. Most of times, it's due to trying to play a TA mod without having the TA base files (/base/otacontent.sdz, /base/tacontent_v2.sdz, /base/tatextures_v062.sdz). You can download them from [http://spring.clan-sy.com/dl/installer/base/ here] (After download, move them to the /base/ subfolder of your Spring folder). However, that would be illegal if you do not own the disc from a ten years old video game called Total Annihilation. Pretty sure it's illegal if you own it too. And don't even try to dump genuine TA data in your Spring folder, that won't work. To remain legal, play mod / 'game content' that do not depend on repacked TA contents.

==I need the GL_ARB_texture_env_combine extension==

This error can be caused by various things:

#Old video Hardware.
#Old drivers.
#Bad installed Drivers.
#Bad game settings.

If your hardware is old check [http://www.delphi3d.net/hardware/extsupport.php?extension=GL_ARB_texture_env_combine THIS] ([http://web.archive.org/web/20070627091726/http://www.delphi3d.net/hardware/extsupport.php?extension=GL_ARB_texture_env_combine alternative Link]) list, if you cant find your video card then, sorry, you have to buy a new video card.

If your hardware is in the above list or you are sure that your video card support this opengl extension download [http://www.realtech-vr.com/glview/download.html THIS] software. Intall, run, and check if under the ''Report'' tab there is the ''GL_ARB_texture_env_combine'' string.
If the string is present then the problem resides in your Spring settings, try lower screen resolution and disable all graphics effect.
If the string is not present and your hardware is in the list the problem are your video card drivers. To solve this '''UNINSTALL ALL PREVIOUS DRIVERS''' and install last stable drivers for your video card. Usually the problem shows when there are uninstalled old video drivers on the system.

'''NOTE:''' Use '''glxinfo''' on a Linux system. You don't need to download any third party application because most if not all systems with x11 should have that program already.

FAQ:requirements

2008-10-08T15:32:26Z

Af:

=Requirements=

==What platforms will Spring run on?==
At the moment, it runs on Windows, Linux and basically on [[Spring_on_MacOSX |Mac OS X]]. Support for FreeBSD is in work.

==What sort of a system do I need to run Spring?==
You need a 3D graphics card to run Spring, which will probably require at least a a GeForce4 MX and the latest driver supported. Minimum CPU requirements are a little more complex. A more powerful CPU will have the capability to support larger maps and a greater maximum unit limit. A 1 GHz CPU should be able to support an estimated 500 units. The needed memory will also vary with unit count and map size, and Spring has been known to have worked with 256 MB of Ram (albeit with lowest detail levels).

For further details and tested Systems check the [[Requirements]] page.

==Spring says 'Missing Default Cursor'==

That means you are playing a mod or 'game content' that depends on files you do not have. Most of times, it's due to trying to play a TA mod without having the TA base files (/base/otacontent.sdz, /base/tacontent_v2.sdz, /base/tatextures_v062.sdz). You can download them from [http://spring.clan-sy.com/dl/installer/base/ here] (After download, move them to the /base/ subfolder of your Spring folder). However, that would be illegal if you do not own the disc from a ten years old video game called Total Annihilation. Pretty sure it's illegal if you own it too. And don't even try to dump genuine TA data in your Spring folder, that won't work. To remain legal, play mod / 'game content' that do not depend on repacked TA contents.

==I need the GL_ARB_texture_env_combine extension, what can I do?==

This error can be caused by various things:

'''1:''' Old video Hardware.

'''2:''' Old drivers.

'''2:''' Bad installed Drivers.

'''3:''' Bad game settings.

If your hardware is old check [http://www.delphi3d.net/hardware/extsupport.php?extension=GL_ARB_texture_env_combine THIS] ([http://web.archive.org/web/20070627091726/http://www.delphi3d.net/hardware/extsupport.php?extension=GL_ARB_texture_env_combine alternative Link]) list, if you cant find your video card then, sorry, you have to buy a new video card.

If your hardware is in the above list or you are sure that your video card support this opengl extension download [http://www.realtech-vr.com/glview/download.html THIS] software. Intall, run, and check if under the ''Report'' tab there is the ''GL_ARB_texture_env_combine'' string.
If the string is present then the problem resides in your Spring settings, try lower screen resolution and disable all graphics effect.
If the string is not present and your hardware is in the list the problem are your video card drivers. To solve this '''UNINSTALL ALL PREVIOUS DRIVERS''' and install last stable drivers for your video card. Usually the problem shows when there are uninstalled old video drivers on the system.

'''NOTE:''' Use '''glxinfo''' on a Linux system. You don't need to download any third party application because most if not all systems with x11 should have that program already.

FAQ:requirements

2008-10-08T15:31:57Z

Af:

=Requirements=

==What platforms will Spring run on?==
At the moment, it runs on Windows, Linux and basically on [[Spring_on_MacOSX |Mac OS X]]. Support for FreeBSD is in work.

==What sort of a system do I need to run Spring?==
You need a 3D graphics card to run Spring, which will probably require at least a a GeForce4 MX and the latest driver supported. Minimum CPU requirements are a little more complex. A more powerful CPU will have the capability to support larger maps and a greater maximum unit limit. A 1 GHz CPU should be able to support an estimated 500 units. The needed memory will also vary with unit count and map size, and Spring has been known to have worked with 256 MB of Ram (albeit with lowest detail levels).

For further details and tested Systems check the [[Requirements]] page.

==Spring says 'Missing Default Cursor'==

That means you are playing a mod or 'game content' that depends on files you do not have. Most of times, it's due to trying to play a TA mod without having the TA base files (/base/otacontent.sdz, /base/tacontent_v2.sdz, /base/tatextures_v062.sdz). You can download them from [http://spring.clan-sy.com/dl/installer/base/ here] (After download, move them to the /base/ subfolder of your Spring folder). However, that would be illegal if you do not own the disc from a ten years old video game called Total Annihilation. Pretty sure it's illegal if you own it too. And don't even try to dump genuine TA data in your Spring folder, that won't work. To remain legal, play mod / 'game content' that do not depend on repacked TA contents.

==Spring says I need the GL_ARB_texture_env_combine extension, what can I do?==

This error can be caused by various things:

'''1:''' Old video Hardware.

'''2:''' Old drivers.

'''2:''' Bad installed Drivers.

'''3:''' Bad game settings.

If your hardware is old check [http://www.delphi3d.net/hardware/extsupport.php?extension=GL_ARB_texture_env_combine THIS] ([http://web.archive.org/web/20070627091726/http://www.delphi3d.net/hardware/extsupport.php?extension=GL_ARB_texture_env_combine alternative Link]) list, if you cant find your video card then, sorry, you have to buy a new video card.

If your hardware is in the above list or you are sure that your video card support this opengl extension download [http://www.realtech-vr.com/glview/download.html THIS] software. Intall, run, and check if under the ''Report'' tab there is the ''GL_ARB_texture_env_combine'' string.
If the string is present then the problem resides in your Spring settings, try lower screen resolution and disable all graphics effect.
If the string is not present and your hardware is in the list the problem are your video card drivers. To solve this '''UNINSTALL ALL PREVIOUS DRIVERS''' and install last stable drivers for your video card. Usually the problem shows when there are uninstalled old video drivers on the system.

'''NOTE:''' Use '''glxinfo''' on a Linux system. You don't need to download any third party application because most if not all systems with x11 should have that program already.

FAQ:requirements

2008-10-08T15:31:36Z

Af: New page: =Requirements= ==What platforms will Spring run on?== At the moment, it runs on Windows, Linux and basically on Mac OS X. Support for FreeBSD is in work. ===What so...

=Requirements=

==What platforms will Spring run on?==
At the moment, it runs on Windows, Linux and basically on [[Spring_on_MacOSX |Mac OS X]]. Support for FreeBSD is in work.

===What sort of a system do I need to run Spring?===
You need a 3D graphics card to run Spring, which will probably require at least a a GeForce4 MX and the latest driver supported. Minimum CPU requirements are a little more complex. A more powerful CPU will have the capability to support larger maps and a greater maximum unit limit. A 1 GHz CPU should be able to support an estimated 500 units. The needed memory will also vary with unit count and map size, and Spring has been known to have worked with 256 MB of Ram (albeit with lowest detail levels).

For further details and tested Systems check the [[Requirements]] page.

===Spring says 'Missing Default Cursor'===

That means you are playing a mod or 'game content' that depends on files you do not have. Most of times, it's due to trying to play a TA mod without having the TA base files (/base/otacontent.sdz, /base/tacontent_v2.sdz, /base/tatextures_v062.sdz). You can download them from [http://spring.clan-sy.com/dl/installer/base/ here] (After download, move them to the /base/ subfolder of your Spring folder). However, that would be illegal if you do not own the disc from a ten years old video game called Total Annihilation. Pretty sure it's illegal if you own it too. And don't even try to dump genuine TA data in your Spring folder, that won't work. To remain legal, play mod / 'game content' that do not depend on repacked TA contents.

===Spring says I need the GL_ARB_texture_env_combine extension, what can I do?===

This error can be caused by various things:

'''1:''' Old video Hardware.

'''2:''' Old drivers.

'''2:''' Bad installed Drivers.

'''3:''' Bad game settings.

If your hardware is old check [http://www.delphi3d.net/hardware/extsupport.php?extension=GL_ARB_texture_env_combine THIS] ([http://web.archive.org/web/20070627091726/http://www.delphi3d.net/hardware/extsupport.php?extension=GL_ARB_texture_env_combine alternative Link]) list, if you cant find your video card then, sorry, you have to buy a new video card.

If your hardware is in the above list or you are sure that your video card support this opengl extension download [http://www.realtech-vr.com/glview/download.html THIS] software. Intall, run, and check if under the ''Report'' tab there is the ''GL_ARB_texture_env_combine'' string.
If the string is present then the problem resides in your Spring settings, try lower screen resolution and disable all graphics effect.
If the string is not present and your hardware is in the list the problem are your video card drivers. To solve this '''UNINSTALL ALL PREVIOUS DRIVERS''' and install last stable drivers for your video card. Usually the problem shows when there are uninstalled old video drivers on the system.

'''NOTE:''' Use '''glxinfo''' on a Linux system. You don't need to download any third party application because most if not all systems with x11 should have that program already.

FAQ

2008-10-08T15:31:29Z

Af:

[[FAQ:general|General FAQ]]

[[FAQ:requirements| System Requirements FAQ]]

[[FAQ:technical|Technical FAQ]]

==Playing==

===What is with this weird right-click mode? I'm 'bout to break my keyboard.===
Sorry, you'll just have to get used to it. As of now it can't be changed.

===Why is somebody else also controlling my units?===
In the 'game lobby' there are two sets of teams. There are the 'Ids' and the 'Teams'. If you are on the same 'Id', then you both get the same commander, and can control the same units. If you are on the same 'Team', then you both get different commanders and can't control each others units.

===Is there a way that I can play music directly through TA-Spring, with alternating tracks for building/attacking like in the original Total Annihilation?===
Yes, there is. It is an addon (GroupAI) you have to download separately:
http://jobjol.nl/1188

There is also an ingame sound-volume-slider you might find usefull (lua-script):
http://jobjol.nl/1218

===Then why would I want to be on the same 'Team' as somebody?===
Because it's fun to just drive around units and not have to worry about commanding. (Assuming that one of the people on the team is commanding.)
Most importantly, however, you can split tasks, such as base building, and troops management.

===Sometimes I can't write anything but numbers and some other symbols. Why is that?===
This is most likely because of the Windows language bar change from which Spring doesn't recognize the characters written.
Note: That Default hotkeys in Windows XP for changing the language is Shift+Alt, which is similar to square build hotkeys in Spring!

===How do I talk to my allies only?===
You must type 'a:' before you speak, or press "Alt Enter" at the same time. Here's an example: a: Now I am talking to my allies only. 

===Help! After I'm finished driving a unit, the camera is all insane! This is nuts! How do I fix it?===
Whoa now. Calm down. Just press ctrl + mouse button 3 to change camera modes. If your unit is destroyed in FPS mode, you will stay in FPS mode until you change camera modes. Also, the camera will stay in "free look" when FPS mode is disengaged, press middle-mouse or J to switch to normal scrolling.

===After I'm finished driving a unit, where what used to be my mouse pointer is now a crosshair. Why?===
-This is a special 'view mode' that allows you to move around the screen much faster. It's good for viewing the battle or getting screenshots. Simply press on your third mouse button or 'delete' to revert back to your mouse pointer.

===But I don't have a third mouse button!===
The key 'J' works in the same way as the 'middle mouse button' does. So where you would use ctrl + middle mouse button to change camera modes, ctrl + j does the same thing. Pressing J once will also switch you from 'crosshair mode' to 'pointer mode' and vice versa.

===IÃ‚Â´ve managed to get stuck in this weird camera mode and my perspective is all messed up. How do I switch to the overhead (OTA style) camera?===
Shift+Backspace (or Shift+J or Shift+MiddleMouseClick) switches between the fps style, total war style and OTA style cameras. Use it to get your camera back to normal in this situation.

===People are cheating! How do I stop it?!===
Well currently, you can't.

Only the host can "activate" the cheat codes. After that, any player can do almost all cheats.

The best thing to do is just not play with the cheaters anymore. But with new spring version cheats are disabled in multiplayer, so that paragraph is hopefully now irrelevant.

===Well how do you cheat?===

<table border="3" cellpadding="2" cellspacing="0">

<tr><th>Cheat Command</th><th>Effect</th></tr>

<tr>
<td>'''.cheat'''</td><td>'''enable cheats - Cheats don't work in multiplayer until the host types this'''</td>
</tr>

<tr>
<td>.nocost</td><td>instabuild (doesn't work on things already under construction, only on new ones)</td>
</tr>

<tr>
<td>.setmaxspeed 50</td><td>Changes the maximum speed multiplier (default is 3.0)</td>
</tr>

<tr>
<td>.setminspeed 0</td><td>Changes the minimum speed multiplier (default is 0.3)</td>
</tr>

<tr>
<td>.spectator</td><td>Allows you to see the entire map... but you lose control of your units</td>
</tr>

<tr>
<td>.team 0, .team 1, etc.</td><td>Change player</td>
</tr>

<tr>
<td>.give ARMCOM, .give 10 CORKROG, etc.</td><td>Place 1 or specified number of specified unit. Valid units are the internal names of units as specified in the unit definition.</td>
</tr>

</table>
You can use auto-completion in the spring console if you don't remember the internal unit name. To do that type:
".give arm" and then press your '''TAB key'''
A list of all matching units will be shown.

===In Game Commands===
The following ''non-cheating'' commands are also available in game:

<table border="3" cellpadding="2" cellspacing="0">

<tr>
<th>Command</th><th>Effect</th>
</tr>

<tr>
<td>/info</td><td>Shows you what colour each player is and their ping delay in the bottom right corner of the screen.</td>
</tr>

<tr>
<td>/clock</td><td>Shows you the elapsed game time in minutes and seconds in the upper right corner of the screen</td>
</tr>

<tr>
<td>.take</td><td>Pulls all allied units, that are owned by players who have lost connection to the server, to your team.</td>
</tr>

</table>

===How do I ally or unally in game?===
I'm pretty sure you can't. Yet.

===How do I give somebody units or metal or energy?===
Press the 'H' key. Then select the amount of metal and/or energy to share. Then select the receiving player and press OK.

When sharing units, you must first select the units to share, then press 'H' key. Tick share units checkbox and choose a receiving player.

===How do I continually give somebody metal and/or energy after a certain point (i.e. Original TA commands +setshare..., +shareall)?===
You'll notice that on your metal and energy bars (top of screen), there are two red bars. You have to put them wherever you want your metal and energy to be shared after.

===This game is different than TA, the units HP and damage are not the same===

There were several third party "balance" mods for the original TA game.

One of those mods were xTA, and was developed by the same clan (SY) that has brought life back to TA, making Spring.

This balance mod is what is bundled by default with the spring engine, and is the mod that was ready to play when Spring was released.

Now are several mods available, install the mod of your choice.

* http://spring.jobjol.nl/files.php?subcategory_id=5

* http://spring-portal.com/index.php/docman/cat_view/36-mods

* http://www.tasdownloads.com/?ta=2

===XTA? OTA? AA? OMFGLAMO? WTF do those abbreviations mean?===
zwzsg maintains a handy dandy FAQ about TA, and the abbreviations that relate to Spring too, of course.
[http://www.tauniverse.com/forum/showthread.php?t=27309 click here]. See also the Spring [[Glossary]], which contains brief explanations for all non-standard words and phrases.

===Why am I destroyed so easily by long range assaults?===
This is a realistic feature of Spring. Units will automatically attack 'radar blips' (units that they can not actually see, but that are indicated on radar). However, the accuracy is very bad while shooting at radar blips until:
* Your unit kills a lot of units and gets experience
* You get a targeting facility.

===Can I kick people from my 'game lobby' or my game?===
First of all, you have to be the host to kick. Use the good old ".kick playernamehere" command. Works in-game too, use it wisely.

===When I'm 'driving' my commander, why can't I use my laser?===
The Spring team will most likely add a way for you to use your commander's laser soon.

===I hate driving around with the 'arrow keys'. Is there any way I can use the 'W-A-S-D' controls (the controls most First Person Shooters use) anymore?===
Go into your Spring directory and edit the uikeys file. Keep in mind that 'S' is originally a 'hot-key' that will stop your units and that 'D' is a 'hot-key' for your commander's D-Gun. You might want to change those too.

===I turned the shadows feature on; I still don't see shadows. What gives?===
Your graphics card can't handle shadows, so Spring automatically turns them off.

===I can't go backwards when I am 'driving' a unit. Why not?===
Because TA units were never intended to go backwards. Sorry, but you just cant.

===I'm in an Unreal Tournament kind of mood. How do I strafe?===
You can only strafe in 'brawler type' ships, such as the brawler, rapier, and light gunships.

===How can I record and watch demos/replays?===
From version 0.62 onwards recordings of all the games you play are easily available for replay via the Replays button in the TASclient.

You can use the Speed up/Slow down game keys while watching the replay, along with other in-game commands like .team

From version 0.60b1 onwards, demos are automatically recorded in the "demos" folder, underneath your Spring folder (default is C:\Program Files\Spring\demos), named for the date and map they were played on. If you play multiple games in the same day on the same map, the games will also be numbered to prevent them from overwriting each other.

From version 0.62 onwards, to view a demo from the Windows file manager you can just double click the file name.

===Sometimes when I play get "not sync" "delayed synch" errors===

Thats caused because of lag. One of the players in the game is having some lag issues. Ask him/her to free up its bandwidth for the game to use.

Alternatively you can use the pause key and wait till the connection gets more stable.

Lag is the seccond number showed when you use the .info command ingame, numbers bigger than 40 are not usual in a normal game and are a signal of lag.

----

==Content==

===Do Spring maps need a "ground"?===
Spring maps do require a ground. We have had many requests to have space maps, however, a "true" (ala Homeworld) space setting is not likely. It would have to wait until a much later stage. This does not mean that TA's style of "space" maps won't be possible, (see the Final Frontier TC for examples of this).

===You stated that Spring uses the TA unit format.===
Spring does use the Total Annihilation unit format. However, there is also a new format dubbed '.s3o' which uses a UV mapped texture instead of 3do's per face texturing system, as well as other improvements.

===How powerful will Spring's custom format be?===
Total Annihilation's unit format was extremely limited. Most of these limitations will either be expanded or non-existent in Spring's custom unit format. One of the most exciting improvements is the introduction of an entirely new method of scripting, with nearly complete control over every aspect of a unit's actions and behaviors.

===Does Spring have a limited number of weapons?===
No. Unlike Total Annihilation, Spring's weapon IDs will be unlimited. Meaning it will be possible to add as many third-party units as you want. However, the current model format limits 16 weapons to each unit.

===Does Spring have a limited number of unique units?===
No. Unit IDs, like weapon IDs, will be unlimited.

===Will units have a maximum of 3 unique weapons?===
Total Annihilation had a limitation that permitted a maximum of 3 unique weapons per unit. Spring currently has a way to have 16 weapons per unit. (Replace Primary, Secondary, Tertiary by 1 2 3 ...16). More can be made possible by modifying the source if there's a sufficient demand by mod makers.

===I'm curious as to the per-unit polygon limit.===
The engine itself does not have a polygon count limit. The limit is that of the processing power of today's computers. Since Spring requires a 3D card, the maximum polygon count per unit will be several times higher than Total Annihilation's. That means for your average mod, 300 polygons for common units and 700 for the more expensive ones is quite reasonable. (But don't waste polies unnecessarily!)

===Will units be able to perform basic terraforming?===
Total Annihilation units probably won't have any terrain editable functionality. Future units may be endowed with such functionality, but it's more of a gameplay issue and has not been decided upon yet. However construction units can restore ground, and certain weapons (especially explosive ones) can be used to deform the ground.

===Will tunnel building be possible?===
Subterranean areas of any sort is impossible. However, it is possible to heavily deform the ground with explosives.. Which is great fun!

===Will the ground's water retention be editable?===
No. Water will always collect when a piece of land has a height below sea level.

===Does Spring have a limit on the number of races?===
Spring has no limit on the total number of sides/races.

===What are the sizes of the biggest and smallest units?===
Static units (buildings, defenses, etc.) have no size limitations in the engine. Technically, neither do mobile units, but units with a footprint larger than 4x4 "squares" (an arbitrary size standard created by Cavedog) might have problems pathfinding.

===What is going to be the maximum possible sea depth?===
For all practical purposes, it will be unlimited. The depth values are stored as "float variables", so it is doubtful that maps would ever be made which even come close to approaching the limit.

===Will Spring support campaigns?===
Basic Map scripting has been implemented, using a Lua scripting engine. From that, it would be possible to make a basic campaign, but for ease of use a better way of selecting scripts and an improved Single player menu is needed.

See [[Mission development]] for more details.

===How big are the Spring files?===
Spring will be as small as however much content is included with it. The "essential" files are only be several megabytes large. Content (such as maps and units) will add considerable size to the Spring download. Currently, the file size is roughly 30 MB.

===How will Spring render sound effects?===
Sound is rendered 3D, meaning that the volume and direction (assuming a multi-speaker setup) vary with the location of the camera from the sound "emitter". What this translates into gameplay terms means that the closer you are to a unit making a sound or motion, the louder the sound will be. Additionally, the sound will be heard differently depending on which way the camera is facing relative to units making sound.

===Will Spring have ambient sound?===
There is no ambient sound, and we haven't planned on adding it thus far.

===Will there be an AI or a "skirmish" mode?===
We have created an interface for artificial intelligences (AIs), and several are currently under development. Information on these can be found at the [[AIs]] wiki page.

===Will a "possess" or a FPS option be present?===
Yes, it is possible to fully control a unit from the first person view. It is more of a gimmick, but it still allows for a nice diversion once in a while. Instructions on its use are in the [[Using_Spring#FPS_.22Mode.22_.28C.29|Using Spring]] article.

===How do I create maps?===
See the [[Map development]] page for all the map info.

===How do I create units/mods?===
See the [[Mod_and_Unit_development#Mod_devlopement|Mod and Unit development]] page on creating units/ mods.

[[Category:Content]]

FAQ:technical

2008-10-08T15:30:59Z

Af: New page: =Technical= ==What port numbers does Spring use?== Game uses port 8452 UDP by default, which can be changed in the lobby. If you are behind a router, and are having problems hosting, try ...

=Technical=

==What port numbers does Spring use?==
Game uses port 8452 UDP by default, which can be changed in the lobby. If you are behind a router, and are having problems hosting, try forwarding the correct port and also make sure the firewall is not blocking it.

==What APIs does Spring use?==
The Windows version of the program (Which is the Binary that can be downloaded from this site) uses: OpenGL for rendering, DirectSound for sound, and Winsock for networking.

The Linux port, see [[Linux Page]] with more info below, uses SDL/OpenGL for rendering, OpenAL for sound (which will connect to DirectSound on Windows and OSS or ALSA on Linux), BSD sockets for networking.

==I am having really bad framerates (fps) on my dual core! What am I doing wrong?==
Currently spring does not like dual/quad cores, you will get really bad framerates. To solve this, you have to restrict it to run on one core. Download the file from http://www.robpol86.com/pages/imagecfg.php follow the instructions, and make all of the spring exe files (spring.exe, TASClient.exe, all others) run on one core. It will run much faster.

Additionally, install the latest processor drivers and Windows hotfixes for your system.

==I am having really bad framerates (fps) on my brand new nVidia graphics card! What am I doing wrong?==
Turn off 'threaded optimizations' for Spring in the nVidia control panel.

==What language is Spring written in?==
The spring game engine is written in C and C++. The Windows lobby client is written in Delphi, the lobby server is java. Of multiplatform lobby clients, SpringLobby is in C++ and AFLobby in java.

==Is Spring open source?==
Yes, it is. Go to the [http://spring.clan-sy.com/download.php downloads] section of the site to download the source code.

==Is there any documentation for the source code?==
Yes, doxygen is used to automatically generate the [http://taspring.clan-sy.com/doxygen/ documentation] (''link is dead'').

==Is Spring a Portable Application?==

At present, I play Spring at my college by using my IPOD as a portable bit of storage for the game, so yes, it does appear to be portable. Also, I managed to run AFLobby from the IPOD as well.

If both of those can run off a bleedin' IPOD, they can run off of anything, in my opinion.

If I'm wrong, edit.

See [http://en.wikipedia.org/wiki/Portable_application] for more information about portable applications.

- Sangue

I have always played Spring off a two GB flash card and I have never had any probs with the registry. There is a little bit of a memory problem though x). I would say that Spring right now is definately portable as long as you leave it alone without adding a bunch of third party servers and such.

- Wred XIII

==Getting into a game==

===People talk about 'Single Player'. How do I start a single player game?===
Simply start a game in the lobby, and enter a password, so that nobody can join. Then click ready, and start and away you go !

Alternatively, you can get [http://spring-portal.com/index.php/docman/doc_download/232-springsp-v09 Spring Single Player] (new link) , a handy tool that lets you create single player games without cluttering up the lobby, as well as watch replays easily.

It's also very easy to set up singleplayer games using SpringLobby. Just click on the singleplayer tab, add some bots, and play. You can grab it from the [http://springlobby.info SpringLobby website].

===When I try to make a single player game, it gives me an error.===
Your graphics card probably can't support Spring. If you read the requirements it did say GeForce 3 or better. Go to the settings file in your Spring directory and lower some of the options. Sometimes that works.

===Does Spring support AI Players?===
Yes, see [[AI]] You can also use the [[random_enemies]] script, which spawns units out of thin air and sends them to attack you.

===How do I join an Internet multiplayer game?===
Run the "TA Spring multiplayer battleroom" from the Start menu or the TASClient.exe from your installation folder. In the "Server" tab change the server to "Official Host". Hit "Apply and close". Re-open the TA Spring client. Create an account on the "Account" tab.

===When I try to connect to the lobby it gives me an error.===
There could be 3 problems. Either you don't have an account, the server is down, or you have not configured your router/firewall correctly. If you don't have an account, make one. If the server is down, you'll just have to wait (this doesn't happen often, though). If you have a router/firewall read below. Have a look at this website's News page and/or the Messageboard, it is likely that you will get some information there in the eventuality that the server is down.

Also make sure that you don't have any spaces in your username.

===I have a router and I don't seem to be able to get a game===

If you are using a router you may have other problems. Explanations of [http://www.portforward.com/routers.htm how to forward ports] has instructions for every router.

===Where can I download more maps?===

Please refer to the [[Maps| Maps section]].

===How do I install downloaded maps?===
Most maps are released as .sdz or .sd7 files. These can be put directly into the "maps" folder inside the Spring folder. Spring now includes a script to move maps and mods to the proper directory on Windows if you double click them. If they are compressed into another type of archive you will have to unpack them first. Just unzip them into your spring maps folder. Some map files use newer (smaller) file formats such as .rar or .7z, to unzip these newer formats, you'll need to download 7-Zip [http://www.7-zip.org/ http://www.7-zip.org/] or Zip-genius [http://downloads.zipgenius.it/ http://downloads.zipgenius.it/]. They both handle almost all formats and are totally free. There is also now a map browser in the TASClient lobby software, click the more maps button in a battle screen to access it.

===Sometimes when I try to join games it gives me an error.===
The host is behind a firewall that has not opened the correct ports for Spring.

===When a multiplayer game starts I never make it past the loading screen.===
This indicates a problem with your video card. Once again the best way to deal with this situation is to make sure your video card has the latest driver updates and that all Spring video features are on the lowest settings.

===When a multiplayer game starts, I make it past the loading screen, but when I get into the game it says, "Waiting for Host", and does a 10 second countdown. It always reaches zero and boots me out, what gives?===
This is a firewall issue. There are three things you can do to fix this. First, make sure your windows firewall is either off, or is not blocking the TA: Spring application. Secondly, if you are behind a router, you can forward the ports that the host is using (especially if you are the host), and it usually fixes the problem. To do this you must go to your router configuration page. You can see what port 'you' are using (as the host), by hosting a multiplayer game in the Spring Lobby. You must make this your trigger port, and make sure that it is open for both TCP and UDP. Thirdly, if none of the aforementioned worked. The easiest thing to do (assuming you are behind a router) is to set the DMZ (Demilitarized Zone). This means your computer will be completely exposed to the internet, which will make you vulnerable to any unknown or unpatched exploits in windows. All you have to do is find the personal IP if the computer you are using and add it to your router's DMZ list. Please only try this last option if you can't get the others to work.
Good Luck

===I got into the game, but some people didn't.===
The host may have reached the number of players it has set.
Or the players may be experiencing firewall or video card difficulty. That is not your fault. Please ask them too leave if they are still there when you get into the 'game lobby'. Some people have problem connecting to "hole punching" hosts.

===I got into a game but my name is red, nobody can hear me speak, and eventually I get disconnected===
This is to do with how long it takes the game to start up (the "load time"). If it takes too long you will see this problem. The load time can be reduced by changing the game graphics settings to lower quality. In particular try setting texture quality to lowest.

===What do all those icons mean in the server list?===
Server status icons inform you, at a quick glance, what the server is doing at the moment, and what state it's in (password protected, locked, open, full, etc). Read all about the server status icons and what they mean [[Server Status|here]]. Or hit F1 in the Battle room for even more information on the icons and their meaning.

FAQ

2008-10-08T15:29:58Z

Af:

[[FAQ:general|General FAQ]]

[[FAQ:technical|Technical FAQ]]

==Playing==

===What is with this weird right-click mode? I'm 'bout to break my keyboard.===
Sorry, you'll just have to get used to it. As of now it can't be changed.

===Why is somebody else also controlling my units?===
In the 'game lobby' there are two sets of teams. There are the 'Ids' and the 'Teams'. If you are on the same 'Id', then you both get the same commander, and can control the same units. If you are on the same 'Team', then you both get different commanders and can't control each others units.

===Is there a way that I can play music directly through TA-Spring, with alternating tracks for building/attacking like in the original Total Annihilation?===
Yes, there is. It is an addon (GroupAI) you have to download separately:
http://jobjol.nl/1188

There is also an ingame sound-volume-slider you might find usefull (lua-script):
http://jobjol.nl/1218

===Then why would I want to be on the same 'Team' as somebody?===
Because it's fun to just drive around units and not have to worry about commanding. (Assuming that one of the people on the team is commanding.)
Most importantly, however, you can split tasks, such as base building, and troops management.

===Sometimes I can't write anything but numbers and some other symbols. Why is that?===
This is most likely because of the Windows language bar change from which Spring doesn't recognize the characters written.
Note: That Default hotkeys in Windows XP for changing the language is Shift+Alt, which is similar to square build hotkeys in Spring!

===How do I talk to my allies only?===
You must type 'a:' before you speak, or press "Alt Enter" at the same time. Here's an example: a: Now I am talking to my allies only. 

===Help! After I'm finished driving a unit, the camera is all insane! This is nuts! How do I fix it?===
Whoa now. Calm down. Just press ctrl + mouse button 3 to change camera modes. If your unit is destroyed in FPS mode, you will stay in FPS mode until you change camera modes. Also, the camera will stay in "free look" when FPS mode is disengaged, press middle-mouse or J to switch to normal scrolling.

===After I'm finished driving a unit, where what used to be my mouse pointer is now a crosshair. Why?===
-This is a special 'view mode' that allows you to move around the screen much faster. It's good for viewing the battle or getting screenshots. Simply press on your third mouse button or 'delete' to revert back to your mouse pointer.

===But I don't have a third mouse button!===
The key 'J' works in the same way as the 'middle mouse button' does. So where you would use ctrl + middle mouse button to change camera modes, ctrl + j does the same thing. Pressing J once will also switch you from 'crosshair mode' to 'pointer mode' and vice versa.

===IÃ‚Â´ve managed to get stuck in this weird camera mode and my perspective is all messed up. How do I switch to the overhead (OTA style) camera?===
Shift+Backspace (or Shift+J or Shift+MiddleMouseClick) switches between the fps style, total war style and OTA style cameras. Use it to get your camera back to normal in this situation.

===People are cheating! How do I stop it?!===
Well currently, you can't.

Only the host can "activate" the cheat codes. After that, any player can do almost all cheats.

The best thing to do is just not play with the cheaters anymore. But with new spring version cheats are disabled in multiplayer, so that paragraph is hopefully now irrelevant.

===Well how do you cheat?===

<table border="3" cellpadding="2" cellspacing="0">

<tr><th>Cheat Command</th><th>Effect</th></tr>

<tr>
<td>'''.cheat'''</td><td>'''enable cheats - Cheats don't work in multiplayer until the host types this'''</td>
</tr>

<tr>
<td>.nocost</td><td>instabuild (doesn't work on things already under construction, only on new ones)</td>
</tr>

<tr>
<td>.setmaxspeed 50</td><td>Changes the maximum speed multiplier (default is 3.0)</td>
</tr>

<tr>
<td>.setminspeed 0</td><td>Changes the minimum speed multiplier (default is 0.3)</td>
</tr>

<tr>
<td>.spectator</td><td>Allows you to see the entire map... but you lose control of your units</td>
</tr>

<tr>
<td>.team 0, .team 1, etc.</td><td>Change player</td>
</tr>

<tr>
<td>.give ARMCOM, .give 10 CORKROG, etc.</td><td>Place 1 or specified number of specified unit. Valid units are the internal names of units as specified in the unit definition.</td>
</tr>

</table>
You can use auto-completion in the spring console if you don't remember the internal unit name. To do that type:
".give arm" and then press your '''TAB key'''
A list of all matching units will be shown.

===In Game Commands===
The following ''non-cheating'' commands are also available in game:

<table border="3" cellpadding="2" cellspacing="0">

<tr>
<th>Command</th><th>Effect</th>
</tr>

<tr>
<td>/info</td><td>Shows you what colour each player is and their ping delay in the bottom right corner of the screen.</td>
</tr>

<tr>
<td>/clock</td><td>Shows you the elapsed game time in minutes and seconds in the upper right corner of the screen</td>
</tr>

<tr>
<td>.take</td><td>Pulls all allied units, that are owned by players who have lost connection to the server, to your team.</td>
</tr>

</table>

===How do I ally or unally in game?===
I'm pretty sure you can't. Yet.

===How do I give somebody units or metal or energy?===
Press the 'H' key. Then select the amount of metal and/or energy to share. Then select the receiving player and press OK.

When sharing units, you must first select the units to share, then press 'H' key. Tick share units checkbox and choose a receiving player.

===How do I continually give somebody metal and/or energy after a certain point (i.e. Original TA commands +setshare..., +shareall)?===
You'll notice that on your metal and energy bars (top of screen), there are two red bars. You have to put them wherever you want your metal and energy to be shared after.

===This game is different than TA, the units HP and damage are not the same===

There were several third party "balance" mods for the original TA game.

One of those mods were xTA, and was developed by the same clan (SY) that has brought life back to TA, making Spring.

This balance mod is what is bundled by default with the spring engine, and is the mod that was ready to play when Spring was released.

Now are several mods available, install the mod of your choice.

* http://spring.jobjol.nl/files.php?subcategory_id=5

* http://spring-portal.com/index.php/docman/cat_view/36-mods

* http://www.tasdownloads.com/?ta=2

===XTA? OTA? AA? OMFGLAMO? WTF do those abbreviations mean?===
zwzsg maintains a handy dandy FAQ about TA, and the abbreviations that relate to Spring too, of course.
[http://www.tauniverse.com/forum/showthread.php?t=27309 click here]. See also the Spring [[Glossary]], which contains brief explanations for all non-standard words and phrases.

===Why am I destroyed so easily by long range assaults?===
This is a realistic feature of Spring. Units will automatically attack 'radar blips' (units that they can not actually see, but that are indicated on radar). However, the accuracy is very bad while shooting at radar blips until:
* Your unit kills a lot of units and gets experience
* You get a targeting facility.

===Can I kick people from my 'game lobby' or my game?===
First of all, you have to be the host to kick. Use the good old ".kick playernamehere" command. Works in-game too, use it wisely.

===When I'm 'driving' my commander, why can't I use my laser?===
The Spring team will most likely add a way for you to use your commander's laser soon.

===I hate driving around with the 'arrow keys'. Is there any way I can use the 'W-A-S-D' controls (the controls most First Person Shooters use) anymore?===
Go into your Spring directory and edit the uikeys file. Keep in mind that 'S' is originally a 'hot-key' that will stop your units and that 'D' is a 'hot-key' for your commander's D-Gun. You might want to change those too.

===I turned the shadows feature on; I still don't see shadows. What gives?===
Your graphics card can't handle shadows, so Spring automatically turns them off.

===I can't go backwards when I am 'driving' a unit. Why not?===
Because TA units were never intended to go backwards. Sorry, but you just cant.

===I'm in an Unreal Tournament kind of mood. How do I strafe?===
You can only strafe in 'brawler type' ships, such as the brawler, rapier, and light gunships.

===How can I record and watch demos/replays?===
From version 0.62 onwards recordings of all the games you play are easily available for replay via the Replays button in the TASclient.

You can use the Speed up/Slow down game keys while watching the replay, along with other in-game commands like .team

From version 0.60b1 onwards, demos are automatically recorded in the "demos" folder, underneath your Spring folder (default is C:\Program Files\Spring\demos), named for the date and map they were played on. If you play multiple games in the same day on the same map, the games will also be numbered to prevent them from overwriting each other.

From version 0.62 onwards, to view a demo from the Windows file manager you can just double click the file name.

===Sometimes when I play get "not sync" "delayed synch" errors===

Thats caused because of lag. One of the players in the game is having some lag issues. Ask him/her to free up its bandwidth for the game to use.

Alternatively you can use the pause key and wait till the connection gets more stable.

Lag is the seccond number showed when you use the .info command ingame, numbers bigger than 40 are not usual in a normal game and are a signal of lag.

----

==Content==

===Do Spring maps need a "ground"?===
Spring maps do require a ground. We have had many requests to have space maps, however, a "true" (ala Homeworld) space setting is not likely. It would have to wait until a much later stage. This does not mean that TA's style of "space" maps won't be possible, (see the Final Frontier TC for examples of this).

===You stated that Spring uses the TA unit format.===
Spring does use the Total Annihilation unit format. However, there is also a new format dubbed '.s3o' which uses a UV mapped texture instead of 3do's per face texturing system, as well as other improvements.

===How powerful will Spring's custom format be?===
Total Annihilation's unit format was extremely limited. Most of these limitations will either be expanded or non-existent in Spring's custom unit format. One of the most exciting improvements is the introduction of an entirely new method of scripting, with nearly complete control over every aspect of a unit's actions and behaviors.

===Does Spring have a limited number of weapons?===
No. Unlike Total Annihilation, Spring's weapon IDs will be unlimited. Meaning it will be possible to add as many third-party units as you want. However, the current model format limits 16 weapons to each unit.

===Does Spring have a limited number of unique units?===
No. Unit IDs, like weapon IDs, will be unlimited.

===Will units have a maximum of 3 unique weapons?===
Total Annihilation had a limitation that permitted a maximum of 3 unique weapons per unit. Spring currently has a way to have 16 weapons per unit. (Replace Primary, Secondary, Tertiary by 1 2 3 ...16). More can be made possible by modifying the source if there's a sufficient demand by mod makers.

===I'm curious as to the per-unit polygon limit.===
The engine itself does not have a polygon count limit. The limit is that of the processing power of today's computers. Since Spring requires a 3D card, the maximum polygon count per unit will be several times higher than Total Annihilation's. That means for your average mod, 300 polygons for common units and 700 for the more expensive ones is quite reasonable. (But don't waste polies unnecessarily!)

===Will units be able to perform basic terraforming?===
Total Annihilation units probably won't have any terrain editable functionality. Future units may be endowed with such functionality, but it's more of a gameplay issue and has not been decided upon yet. However construction units can restore ground, and certain weapons (especially explosive ones) can be used to deform the ground.

===Will tunnel building be possible?===
Subterranean areas of any sort is impossible. However, it is possible to heavily deform the ground with explosives.. Which is great fun!

===Will the ground's water retention be editable?===
No. Water will always collect when a piece of land has a height below sea level.

===Does Spring have a limit on the number of races?===
Spring has no limit on the total number of sides/races.

===What are the sizes of the biggest and smallest units?===
Static units (buildings, defenses, etc.) have no size limitations in the engine. Technically, neither do mobile units, but units with a footprint larger than 4x4 "squares" (an arbitrary size standard created by Cavedog) might have problems pathfinding.

===What is going to be the maximum possible sea depth?===
For all practical purposes, it will be unlimited. The depth values are stored as "float variables", so it is doubtful that maps would ever be made which even come close to approaching the limit.

===Will Spring support campaigns?===
Basic Map scripting has been implemented, using a Lua scripting engine. From that, it would be possible to make a basic campaign, but for ease of use a better way of selecting scripts and an improved Single player menu is needed.

See [[Mission development]] for more details.

===How big are the Spring files?===
Spring will be as small as however much content is included with it. The "essential" files are only be several megabytes large. Content (such as maps and units) will add considerable size to the Spring download. Currently, the file size is roughly 30 MB.

===How will Spring render sound effects?===
Sound is rendered 3D, meaning that the volume and direction (assuming a multi-speaker setup) vary with the location of the camera from the sound "emitter". What this translates into gameplay terms means that the closer you are to a unit making a sound or motion, the louder the sound will be. Additionally, the sound will be heard differently depending on which way the camera is facing relative to units making sound.

===Will Spring have ambient sound?===
There is no ambient sound, and we haven't planned on adding it thus far.

===Will there be an AI or a "skirmish" mode?===
We have created an interface for artificial intelligences (AIs), and several are currently under development. Information on these can be found at the [[AIs]] wiki page.

===Will a "possess" or a FPS option be present?===
Yes, it is possible to fully control a unit from the first person view. It is more of a gimmick, but it still allows for a nice diversion once in a while. Instructions on its use are in the [[Using_Spring#FPS_.22Mode.22_.28C.29|Using Spring]] article.

===How do I create maps?===
See the [[Map development]] page for all the map info.

===How do I create units/mods?===
See the [[Mod_and_Unit_development#Mod_devlopement|Mod and Unit development]] page on creating units/ mods.

[[Category:Content]]

FAQ

2008-10-08T15:29:37Z

Af:

[[FAQ:general|General FAQ]]

[[FAQ:general|Technical FAQ]]

==Playing==

===What is with this weird right-click mode? I'm 'bout to break my keyboard.===
Sorry, you'll just have to get used to it. As of now it can't be changed.

===Why is somebody else also controlling my units?===
In the 'game lobby' there are two sets of teams. There are the 'Ids' and the 'Teams'. If you are on the same 'Id', then you both get the same commander, and can control the same units. If you are on the same 'Team', then you both get different commanders and can't control each others units.

===Is there a way that I can play music directly through TA-Spring, with alternating tracks for building/attacking like in the original Total Annihilation?===
Yes, there is. It is an addon (GroupAI) you have to download separately:
http://jobjol.nl/1188

There is also an ingame sound-volume-slider you might find usefull (lua-script):
http://jobjol.nl/1218

===Then why would I want to be on the same 'Team' as somebody?===
Because it's fun to just drive around units and not have to worry about commanding. (Assuming that one of the people on the team is commanding.)
Most importantly, however, you can split tasks, such as base building, and troops management.

===Sometimes I can't write anything but numbers and some other symbols. Why is that?===
This is most likely because of the Windows language bar change from which Spring doesn't recognize the characters written.
Note: That Default hotkeys in Windows XP for changing the language is Shift+Alt, which is similar to square build hotkeys in Spring!

===How do I talk to my allies only?===
You must type 'a:' before you speak, or press "Alt Enter" at the same time. Here's an example: a: Now I am talking to my allies only. 

===Help! After I'm finished driving a unit, the camera is all insane! This is nuts! How do I fix it?===
Whoa now. Calm down. Just press ctrl + mouse button 3 to change camera modes. If your unit is destroyed in FPS mode, you will stay in FPS mode until you change camera modes. Also, the camera will stay in "free look" when FPS mode is disengaged, press middle-mouse or J to switch to normal scrolling.

===After I'm finished driving a unit, where what used to be my mouse pointer is now a crosshair. Why?===
-This is a special 'view mode' that allows you to move around the screen much faster. It's good for viewing the battle or getting screenshots. Simply press on your third mouse button or 'delete' to revert back to your mouse pointer.

===But I don't have a third mouse button!===
The key 'J' works in the same way as the 'middle mouse button' does. So where you would use ctrl + middle mouse button to change camera modes, ctrl + j does the same thing. Pressing J once will also switch you from 'crosshair mode' to 'pointer mode' and vice versa.

===IÃ‚Â´ve managed to get stuck in this weird camera mode and my perspective is all messed up. How do I switch to the overhead (OTA style) camera?===
Shift+Backspace (or Shift+J or Shift+MiddleMouseClick) switches between the fps style, total war style and OTA style cameras. Use it to get your camera back to normal in this situation.

===People are cheating! How do I stop it?!===
Well currently, you can't.

Only the host can "activate" the cheat codes. After that, any player can do almost all cheats.

The best thing to do is just not play with the cheaters anymore. But with new spring version cheats are disabled in multiplayer, so that paragraph is hopefully now irrelevant.

===Well how do you cheat?===

<table border="3" cellpadding="2" cellspacing="0">

<tr><th>Cheat Command</th><th>Effect</th></tr>

<tr>
<td>'''.cheat'''</td><td>'''enable cheats - Cheats don't work in multiplayer until the host types this'''</td>
</tr>

<tr>
<td>.nocost</td><td>instabuild (doesn't work on things already under construction, only on new ones)</td>
</tr>

<tr>
<td>.setmaxspeed 50</td><td>Changes the maximum speed multiplier (default is 3.0)</td>
</tr>

<tr>
<td>.setminspeed 0</td><td>Changes the minimum speed multiplier (default is 0.3)</td>
</tr>

<tr>
<td>.spectator</td><td>Allows you to see the entire map... but you lose control of your units</td>
</tr>

<tr>
<td>.team 0, .team 1, etc.</td><td>Change player</td>
</tr>

<tr>
<td>.give ARMCOM, .give 10 CORKROG, etc.</td><td>Place 1 or specified number of specified unit. Valid units are the internal names of units as specified in the unit definition.</td>
</tr>

</table>
You can use auto-completion in the spring console if you don't remember the internal unit name. To do that type:
".give arm" and then press your '''TAB key'''
A list of all matching units will be shown.

===In Game Commands===
The following ''non-cheating'' commands are also available in game:

<table border="3" cellpadding="2" cellspacing="0">

<tr>
<th>Command</th><th>Effect</th>
</tr>

<tr>
<td>/info</td><td>Shows you what colour each player is and their ping delay in the bottom right corner of the screen.</td>
</tr>

<tr>
<td>/clock</td><td>Shows you the elapsed game time in minutes and seconds in the upper right corner of the screen</td>
</tr>

<tr>
<td>.take</td><td>Pulls all allied units, that are owned by players who have lost connection to the server, to your team.</td>
</tr>

</table>

===How do I ally or unally in game?===
I'm pretty sure you can't. Yet.

===How do I give somebody units or metal or energy?===
Press the 'H' key. Then select the amount of metal and/or energy to share. Then select the receiving player and press OK.

When sharing units, you must first select the units to share, then press 'H' key. Tick share units checkbox and choose a receiving player.

===How do I continually give somebody metal and/or energy after a certain point (i.e. Original TA commands +setshare..., +shareall)?===
You'll notice that on your metal and energy bars (top of screen), there are two red bars. You have to put them wherever you want your metal and energy to be shared after.

===This game is different than TA, the units HP and damage are not the same===

There were several third party "balance" mods for the original TA game.

One of those mods were xTA, and was developed by the same clan (SY) that has brought life back to TA, making Spring.

This balance mod is what is bundled by default with the spring engine, and is the mod that was ready to play when Spring was released.

Now are several mods available, install the mod of your choice.

* http://spring.jobjol.nl/files.php?subcategory_id=5

* http://spring-portal.com/index.php/docman/cat_view/36-mods

* http://www.tasdownloads.com/?ta=2

===XTA? OTA? AA? OMFGLAMO? WTF do those abbreviations mean?===
zwzsg maintains a handy dandy FAQ about TA, and the abbreviations that relate to Spring too, of course.
[http://www.tauniverse.com/forum/showthread.php?t=27309 click here]. See also the Spring [[Glossary]], which contains brief explanations for all non-standard words and phrases.

===Why am I destroyed so easily by long range assaults?===
This is a realistic feature of Spring. Units will automatically attack 'radar blips' (units that they can not actually see, but that are indicated on radar). However, the accuracy is very bad while shooting at radar blips until:
* Your unit kills a lot of units and gets experience
* You get a targeting facility.

===Can I kick people from my 'game lobby' or my game?===
First of all, you have to be the host to kick. Use the good old ".kick playernamehere" command. Works in-game too, use it wisely.

===When I'm 'driving' my commander, why can't I use my laser?===
The Spring team will most likely add a way for you to use your commander's laser soon.

===I hate driving around with the 'arrow keys'. Is there any way I can use the 'W-A-S-D' controls (the controls most First Person Shooters use) anymore?===
Go into your Spring directory and edit the uikeys file. Keep in mind that 'S' is originally a 'hot-key' that will stop your units and that 'D' is a 'hot-key' for your commander's D-Gun. You might want to change those too.

===I turned the shadows feature on; I still don't see shadows. What gives?===
Your graphics card can't handle shadows, so Spring automatically turns them off.

===I can't go backwards when I am 'driving' a unit. Why not?===
Because TA units were never intended to go backwards. Sorry, but you just cant.

===I'm in an Unreal Tournament kind of mood. How do I strafe?===
You can only strafe in 'brawler type' ships, such as the brawler, rapier, and light gunships.

===How can I record and watch demos/replays?===
From version 0.62 onwards recordings of all the games you play are easily available for replay via the Replays button in the TASclient.

You can use the Speed up/Slow down game keys while watching the replay, along with other in-game commands like .team

From version 0.60b1 onwards, demos are automatically recorded in the "demos" folder, underneath your Spring folder (default is C:\Program Files\Spring\demos), named for the date and map they were played on. If you play multiple games in the same day on the same map, the games will also be numbered to prevent them from overwriting each other.

From version 0.62 onwards, to view a demo from the Windows file manager you can just double click the file name.

===Sometimes when I play get "not sync" "delayed synch" errors===

Thats caused because of lag. One of the players in the game is having some lag issues. Ask him/her to free up its bandwidth for the game to use.

Alternatively you can use the pause key and wait till the connection gets more stable.

Lag is the seccond number showed when you use the .info command ingame, numbers bigger than 40 are not usual in a normal game and are a signal of lag.

----

==Content==

===Do Spring maps need a "ground"?===
Spring maps do require a ground. We have had many requests to have space maps, however, a "true" (ala Homeworld) space setting is not likely. It would have to wait until a much later stage. This does not mean that TA's style of "space" maps won't be possible, (see the Final Frontier TC for examples of this).

===You stated that Spring uses the TA unit format.===
Spring does use the Total Annihilation unit format. However, there is also a new format dubbed '.s3o' which uses a UV mapped texture instead of 3do's per face texturing system, as well as other improvements.

===How powerful will Spring's custom format be?===
Total Annihilation's unit format was extremely limited. Most of these limitations will either be expanded or non-existent in Spring's custom unit format. One of the most exciting improvements is the introduction of an entirely new method of scripting, with nearly complete control over every aspect of a unit's actions and behaviors.

===Does Spring have a limited number of weapons?===
No. Unlike Total Annihilation, Spring's weapon IDs will be unlimited. Meaning it will be possible to add as many third-party units as you want. However, the current model format limits 16 weapons to each unit.

===Does Spring have a limited number of unique units?===
No. Unit IDs, like weapon IDs, will be unlimited.

===Will units have a maximum of 3 unique weapons?===
Total Annihilation had a limitation that permitted a maximum of 3 unique weapons per unit. Spring currently has a way to have 16 weapons per unit. (Replace Primary, Secondary, Tertiary by 1 2 3 ...16). More can be made possible by modifying the source if there's a sufficient demand by mod makers.

===I'm curious as to the per-unit polygon limit.===
The engine itself does not have a polygon count limit. The limit is that of the processing power of today's computers. Since Spring requires a 3D card, the maximum polygon count per unit will be several times higher than Total Annihilation's. That means for your average mod, 300 polygons for common units and 700 for the more expensive ones is quite reasonable. (But don't waste polies unnecessarily!)

===Will units be able to perform basic terraforming?===
Total Annihilation units probably won't have any terrain editable functionality. Future units may be endowed with such functionality, but it's more of a gameplay issue and has not been decided upon yet. However construction units can restore ground, and certain weapons (especially explosive ones) can be used to deform the ground.

===Will tunnel building be possible?===
Subterranean areas of any sort is impossible. However, it is possible to heavily deform the ground with explosives.. Which is great fun!

===Will the ground's water retention be editable?===
No. Water will always collect when a piece of land has a height below sea level.

===Does Spring have a limit on the number of races?===
Spring has no limit on the total number of sides/races.

===What are the sizes of the biggest and smallest units?===
Static units (buildings, defenses, etc.) have no size limitations in the engine. Technically, neither do mobile units, but units with a footprint larger than 4x4 "squares" (an arbitrary size standard created by Cavedog) might have problems pathfinding.

===What is going to be the maximum possible sea depth?===
For all practical purposes, it will be unlimited. The depth values are stored as "float variables", so it is doubtful that maps would ever be made which even come close to approaching the limit.

===Will Spring support campaigns?===
Basic Map scripting has been implemented, using a Lua scripting engine. From that, it would be possible to make a basic campaign, but for ease of use a better way of selecting scripts and an improved Single player menu is needed.

See [[Mission development]] for more details.

===How big are the Spring files?===
Spring will be as small as however much content is included with it. The "essential" files are only be several megabytes large. Content (such as maps and units) will add considerable size to the Spring download. Currently, the file size is roughly 30 MB.

===How will Spring render sound effects?===
Sound is rendered 3D, meaning that the volume and direction (assuming a multi-speaker setup) vary with the location of the camera from the sound "emitter". What this translates into gameplay terms means that the closer you are to a unit making a sound or motion, the louder the sound will be. Additionally, the sound will be heard differently depending on which way the camera is facing relative to units making sound.

===Will Spring have ambient sound?===
There is no ambient sound, and we haven't planned on adding it thus far.

===Will there be an AI or a "skirmish" mode?===
We have created an interface for artificial intelligences (AIs), and several are currently under development. Information on these can be found at the [[AIs]] wiki page.

===Will a "possess" or a FPS option be present?===
Yes, it is possible to fully control a unit from the first person view. It is more of a gimmick, but it still allows for a nice diversion once in a while. Instructions on its use are in the [[Using_Spring#FPS_.22Mode.22_.28C.29|Using Spring]] article.

===How do I create maps?===
See the [[Map development]] page for all the map info.

===How do I create units/mods?===
See the [[Mod_and_Unit_development#Mod_devlopement|Mod and Unit development]] page on creating units/ mods.

[[Category:Content]]