Spring - User contributions [en]

Download

2014-01-18T08:45:06Z

Hoijui: /* Spring Engine (no games included) */ "language style"

{{#css:
#content * {font-family: 'Bitstream Vera Sans', 'Trebuchet MS', 'Arial', 'Myriad Pro', 'FreeSans';}
}}
= Downloads =
<center>
{|style="margin-top: 15px; padding: 10px; background:rgba(45,180,19,0.5); border: 1px solid rgba(0,0,0,0.5); border-radius: 6px 6px 6px 6px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.5), inset 0 10px 8px rgba(255,255,255,0.3);" |
| If you just want to get ready to play, you want this:
|-
| style="margin-top: 15px; text-align: center" | [[GamesDownloads|Games Downloads]]
|}
</center>

= Spring Engine (no games included) =

Latest stable version: '''{{EngineVersion:Stable}}''' ({{EngineVersion:Stable:ReleaseDate}})

{|
| style="padding-right:10px"| [[Image:Window.png]]
| '''Installer: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}.exe/download spring_{{StableEngineVersion}}.exe ~25MB]''' - [http://springrts.com/dl/buildbot/default/master/{{StableEngineVersion}}/win32/spring_{{StableEngineVersion}}.exe {mirror}]''' 
'''Portable: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_portable.7z/download spring_{{StableEngineVersion}}_portable.7z ~25MB]''' - [http://springrts.com/dl/buildbot/default/master/{{StableEngineVersion}}/win32/spring_{{StableEngineVersion}}_portable.7z {mirror}]
|}

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
| '''64bit static binaries: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_minimal-portable-linux64-static.7z/download spring_{{StableEngineVersion}}_linux64.7z ~15MB]''' 
'''32bit static binaries: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_minimal-portable-linux32-static.7z/download spring_{{StableEngineVersion}}_linux32.7z ~15MB]''' (binary builds do not contain a lobby, you need to install one via [[SetupGuide|Linux Setup guide]]) 

'''distro native installs:''' follow the '''[[SetupGuide|Linux Setup guide]]'''
|}

{|
| style="padding-right:10px"| [[Image:Apple.png]]
|
'''.app-Bundle: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip/download spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip ~50MB]''' - [http://springrts.com/dl/buildbot/default/master/{{StableEngineVersion}}/osx64/spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip {mirror}]''' 
The Mac OS X port is experimental. Help with its development would be greatly appreciated. Check our forum '''[http://springrts.com/phpbb/viewforum.php?f=65 here]'''.
|}

== License ==
The Spring Engine is licensed under the [https://github.com/spring/spring/blob/develop/LICENSE GNU GPL 2].

= Testing/Nightly Builds =
Used for testing latest engine developments.
[http://springrts.com/dl/buildbot/ list of all test builds]

= Source Code =
== git ==
'''[http://github.com/spring/spring Spring project page at github]''' [http://status.github.com (status page)]
=== Getting the Source ===
latest stable:
<code><pre>git clone -b master git://github.com/spring/spring.git</pre></code>
development branch (won't work for online gaming):
<code><pre>git clone git://github.com/spring/spring.git</pre></code>

=== Alternate git url ===
<code><pre>git://springrts.git.sourceforge.net/gitroot/springrts/springrts</pre></code>

== Latest Stable Snapshot ==
This tarball is the same as that used to build the last public release. See [[Building spring]] for build instructions.

The packages below target Linux only and do not contain certain files required to compile using CMake on Windows.

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_src.tar.lzma/download spring_{{StableEngineVersion}}_src.tar.lzma]''' - [http://springrts.com/dl/buildbot/default/master/{{StableEngineVersion}}/source/spring_{{StableEngineVersion}}_src.tar.lzma {mirror}]

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_src.tar.gz/download spring_{{StableEngineVersion}}_src.tar.gz]''' - [http://springrts.com/dl/buildbot/default/master/{{StableEngineVersion}}/source/spring_{{StableEngineVersion}}_src.tar.gz {mirror}]

__NOTOC__

[[Category:Spring]]

Spring Replays

2013-04-07T07:47:05Z

Hoijui: /* Chat Commands */ fix one command

=== Recording Replays ===
Replays are automatically recoreded for every game you play in Spring. They are saved to your Spring\demos\ folder.

=== Watching Replays ===
There are multiple ways to watch a replay:

1) Use the replays browser of your lobby. This depends on what lobby you use.

2) Drag & and drop the replay file onto Spring.exe

3) Associate .sdf replay files with spring.exe

Then just doubleclick the replay file.

4) use rightlick -> open with -> Spring.exe

People watch replays to improve their skill by watching what they did wrong, and what other people did right. Use them to improve your skill.

=== Uploading Replays ===
Replays can be uploaded to [http://replays.springrts.com/ replays.springrts.com]. Uploaded replays can be commented. The uploader can edit the description and tags. To upload or comment a Spring lobby login is needed.

If you wish to discuss a match with other players, just give them the link to the uploaded replay.

A testing site is available at [http://replays.springrts.com/ replays-test.springrts.com].

SPADS autohost owners can configure SPADS to automatically upload all matches. For instructions read [https://github.com/dansan/spring-replay-site/raw/master/README.replay-upload README.replay-upload].

If you have trouble with the replays website please contact Dansan at the [http://springrts.com/phpbb/ Spring forums].

'''Note:''' Replays from different versions of Spring are not compatible. That is, if you have installed version {{CurrentVersion}}, you can only watch replays recorded in {{CurrentVersion}}. The replays are automatically labeled by spring with the current version number.)

=== Important keys to use while watching the replay: ===

'''L:''' Shows you Radar and LOS information of active player.

'''1,2,3...''': Changes active player, this is usefull to check on economy and LOS information.

'''F12''': Screenshots!

'''+''' / '''-''' : adjust game speed

'''Pause key''': Pause

==Chat Commands==

'''/skip ''<n>''''' : Fast forward the replay to second ''n''

'''/skip +''<n>''''' : Fast forward the replay ''n'' seconds

'''/skip f''<n>''''' : Fast forward the replay to frame ''n'' (there are 30 frames per second)

'''/skip f+''<n>''''' : Fast forward the replay ''n'' frames (there are 30 frames per second)

Example: '''/skip f1''' at the start of the replay can be useful to skip long pre-game chatter and go directly to the action.

[[Category:Playing]]

Spring Replays

2013-04-07T07:33:15Z

Hoijui: /* Chat Commands */ added other commands, fixed existing and fixed formatting

=== Recording Replays ===
Replays are automatically recoreded for every game you play in Spring. They are saved to your Spring\demos\ folder.

=== Watching Replays ===
There are multiple ways to watch a replay:

1) Use the replays browser of your lobby. This depends on what lobby you use.

2) Drag & and drop the replay file onto Spring.exe

3) Associate .sdf replay files with spring.exe

Then just doubleclick the replay file.

4) use rightlick -> open with -> Spring.exe

People watch replays to improve their skill by watching what they did wrong, and what other people did right. Use them to improve your skill.

=== Uploading Replays ===
Replays can be uploaded to [http://replays.springrts.com/ replays.springrts.com]. Uploaded replays can be commented. The uploader can edit the description and tags. To upload or comment a Spring lobby login is needed.

If you wish to discuss a match with other players, just give them the link to the uploaded replay.

A testing site is available at [http://replays.springrts.com/ replays-test.springrts.com].

SPADS autohost owners can configure SPADS to automatically upload all matches. For instructions read [https://github.com/dansan/spring-replay-site/raw/master/README.replay-upload README.replay-upload].

If you have trouble with the replays website please contact Dansan at the [http://springrts.com/phpbb/ Spring forums].

'''Note:''' Replays from different versions of Spring are not compatible. That is, if you have installed version {{CurrentVersion}}, you can only watch replays recorded in {{CurrentVersion}}. The replays are automatically labeled by spring with the current version number.)

=== Important keys to use while watching the replay: ===

'''L:''' Shows you Radar and LOS information of active player.

'''1,2,3...''': Changes active player, this is usefull to check on economy and LOS information.

'''F12''': Screenshots!

'''+''' / '''-''' : adjust game speed

'''Pause key''': Pause

==Chat Commands==

'''/skip ''<n>''''' : Fast forward the replay to second ''n''

'''/skip +''<n>''''' : Fast forward the replay ''n'' seconds

'''/skip f''<n>''''' : Fast forward the replay to frame ''n'' (there are 30 frames per second)

'''/skip +f''<n>''''' : Fast forward the replay ''n'' frames (there are 30 frames per second)

Example: '''/skip f1''' at the start of the replay can be useful to skip long pre-game chatter and go directly to the action.

[[Category:Playing]]

AI:Development:Lang:Java

2013-03-11T18:09:05Z

Hoijui: marked the Java AI 'Netbeasn PDF Tutorial as outdated

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

== Getting Started on your own Java AI ==

''Note:'' This tutorial assumes you have Spring working on your machine. The Spring directory will be referred to as 'Spring' from here on.

You will also need to make sure that Java AI's run properly on your machine. This is most easily done by running a Spring game with the ''NullOOJavaAI'' that comes with the engine. You will need the JRE 1.5 or greater, and to set the ''JAVA_HOME'' environment variable on your system to point to the correct location.

''Note:'' if you're using a ''64 bit'' version of ''Windows'', you will need a 32 bit Java Runtime Environment/Java Development Kit anyway, because Spring is (as of July 2012) not yet available as a 64bit version for Windows.

=== Setting up a Java Project ===

To start working on your own Java AI, you should first set up a project in your favorite Java IDE. You need to import the Spring Java AI Interface libraries, and then create an AI class and an AI Factory.

'''OUTDATED''' If you are using '''Netbeans IDE''', you can find a detailed tutorial [http://springrts.com/phpbb/download/file.php?id=4970 here] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread]). Otherwise, please continue reading this page.

==== Importing the interface libraries ====

In order to use the Java Interface, you will need to import the Java Interface libraries, located in ''Spring/AI/Interfaces/Java/[version]/''. Replace ''[version]'' with the number of the latest Java Interface version. As of this writing, only ''0.1'' is available.

The file you need is ''AIInterface.jar''. You also need the additional library ''vecmath.jar'', located in the ''jlib/'' subfolder. Optionally, you can attach the file ''AIInterface-src.jar'' as source to the ''AIInterface.jar'' file for JavaDoc support in your editor.

Your project should now contain the following libraries:

* <code>Spring/AI/Interfaces/Java/[version]/AIInterface.jar</code>
* <code>Spring/AI/Interfaces/Java/[version]/jlib/AIInterface-src.jar</code> (optional)
* <code>Spring/AI/Interfaces/Java/[version]/jlib/vecmath.jar</code>

==== Creating the required classes ====

Now that you have the libraries, the next step is to create your AI's main class. Firstly, you may want to create a package to put your classes in, for example, ''myjavaai''. Create a new class, named MyJavaAI (or whatever you would like your AI to be called). MyJavaAI should extend com.springrts.ai.oo.AbstractOOAI. After that you'll need another class, named ''MyJavaAIFactory''. This class should extend ''com.springrts.ai.oo.OOAIFactory''.
The class MyJavaAIFactory only has to implement a single method: ''public OOAI createAI(int teamId, OOAICallback callback)''. This is the method that the Java interface calls to get an instance of your AI. If you wanted to, you could create a different AI depending on circumstances, but for now it is probably easiest to simply return a new MyJavaAI(), until you decide you require something more elaborate.
You should now have two classes, ''myjavaai.MyJavaAI'' and ''myjavaai.MyJavaAIFactory''.

=== Adding your AI to Spring ===

Your AI needs to have its own folder, and the engine will need to know your AI's attributes.

==== Creating an AI folder ====

Every Spring AI is stored in ''Spring/AI/Skirmish''. You will have to create a folder for your AI as well. It is easiest to go to the directory ''Spring/AI/Skirmish'', make a copy of the folder ''NullOOJavaAI'', and rename the copy to ''MyJavaAI''.

==== Telling the Engine about your AI ====

The ''MyJavaAI'' folder you created contains the different versions of your AI. As of this writing, the ''NullOOJavaAI'' only has a version ''0.1'', so there should be a folder ''0.1'' inside the ''MyJavaAI'' folder. Inside you will find a number of files.
These files are:
* ''SkirmishAI.jar'': the jar file that contains the AI code.
* ''AIInfo.lua'': contains information about the AI.
* ''AIOptions.lua'': you can specify your AI's options in here.
* Possibly some text files: these are log files generated by the ''NullOOJavaAI''. If you don't plan on using the same files, you may as well delete these.

Additionally, there is a folder named ''jlib''. This is where you should place any additional libraries you use in your AI.

In order to let Spring recognize your AI, you will have to edit ''AIInfo.lua''. You can do this with any regular text editor.
When you open it, the file will look something like this:

<code><pre>
local infos = {
{
key = 'shortName',
value = 'NullOOJavaAI',
desc = 'machine conform name.',
},
{
key = 'version',
value = '0.1', -- AI version - !This comment is used for parsing!
},
{
key = 'className',
value = 'nulloojavaai.NullOOJavaAIFactory',
desc = 'fully qualified name of a class that implements interface com.springrts.ai.AI',
},
{
key = 'name',
value = 'high-level Java stub Skirmish AI',
desc = 'human readable name.',
},
{
key = 'loadSupported',
value = 'no',
desc = 'whether this AI supports loading or not',
},
{
key = 'interfaceShortName',
value = 'Java', -- AI Interface name - !This comment is used for parsing!
desc = 'the shortName of the AI interface this AI needs',
},
{
key = 'interfaceVersion',
value = '0.1', -- AI Interface version - !This comment is used for parsing!
desc = 'the minimum version of the AI interface required by this AI',
},
}

return infos
</pre></code>

The file describes a number of attributes. Each attribute has a key, a value and a desc(ription). The key is the name of the attribute, the description tells you what the attribute is used for, and the value is what you will want to edit.

The shortName attribute is the name used for your AI internally. It's most logical to change this into to the same name you gave your AI class. (MyJavaAI.)

'version' tells the engine which version of your AI this is. If you're in the 0.1 folder, make this 0.1. Your AI should be located at AI/Skirmish/''shortName''/''version''/.

'classname' tells the interface which class is your AIFactory class. Take care that you use the fully qualified class name, or it won't work. In this example, this should be myjavaai.MyJavaAIFactory.

'name' describes your AI to the user. In this example, you might put 'A simple Java AI to learn about AI programming in Spring.'

'loadSupported' is rather self-explanatory. Since you have just started working on your AI, you may not get around to implementing loading support for some time, so it's best to put 'no,' for now.

'interfaceShortName' and 'interfaceversion' tell the engine about the interface your AI uses. Since MyJavaAI uses the same interface as the NullOOJavaAI, leave these as they are.

Finally, the last thing you should do is exporting your AI to SkirmishAI.jar. The way to do this varies depending on your Java editor.

=== Test your AI ===

After following all the above steps, you should be able to run your AI. Either use SpringLobby to start a new game and see if you can add your AI as a bot, or run ''spring.exe'' to see if you can start the script MyJavaAI Test.
Of course, since you haven't told the AI what to do, your starting unit(s) will sit there doing nothing.

== Getting your AI to Do Something ==

After getting your AI running, you will want to make it do something. Traditionally, the first thing to get your AI to is to build a solar plant, assuming you want it to play BA. If not, it is quite straightforward to build other units once you have the general idea.
You will need four things to get your AI to build a solar plant:
* A reference to the callback
* A reference to the commander (your starting unit in BA)
* A reference to the solar plant definition object
* To tell the commander to build the solar plant

However, before we go about building solar plants, first you should know about events. We will use these to get the required object references.

=== Events ===

Nearly everything that happens in the game is an event. When a unit is created, this is an event. Enemy spotted? Also an event. A player sends your AI a message? You got it, this is an event as well.

Every event is made known to your AI. Have a look at the <code>MyJavaAI</code> class again. <code>MyJavaAI</code> extends <code>AbstractOOA</code>. <code>AbstractOOAI</code> implements a number of methods like <code>unitCreated()</code>, <code>enemyEnterRadar()</code> and <code>message()</code>.
Sound familiar? The method <code>unitCreated(Unit unit, Unit builder)</code> is called every time a unit is created, and tells you the unit that was created and the unit that built it. Similarly, enemyEnterRadar(Unit enemy) and message(int player, String message) tell you about an enemy unit entering radar range and receiving a message from another player respectively.
There are many other events that all have corresponding methods. To have your AI respond to these events, simply override the method in your <code>MyJavaAI</code> class.
The return type of these methods is an integer. The return value can be used for debugging. 0 means that no errors occurred, while any other value is threated as an error. This system can be used for debugging, but is it much easier to implement proper logging.

In the sections below you will see an example of the use of these events.

=== Getting a reference to the callback ===

The callback is the object through which the AI communicates with the engine. All information that does not change the state of the engine can be retrieved through individual methods in the callback, and state changing commands (eg to units) will go through a single, specialized method, which is in the callback as well.
Getting a reference to the callback is easy.
First create a class field <code>OOAICallback callback</code> to put the reference in, then overwrite the method <code>init(int teamId, OOAICallback callback)</code>. The init method is called at the start of every game (right at the end of the countdown).
As you can see, all that you need to do is set the parameter value callback to the field callback:

<code><pre>
@Override
public int init(int teamId, OOAICallback callback)
{
this.callback = callback;
return 0;
}
</pre></code>

=== Getting a reference to the commander ===

In order to have your AI build a solar plant, the first thing you need is a reference to your commander. You first need an instance field 'Unit commander' to put the reference in, then we need to get the reference itself.
A UnitFinished event is triggered whenever a unit has been built. (This may sound similar to <code>unitCreated()</code>. For a quick explanation of the difference, see the FAQ below.)
At the start of the game, the engine will send a UnitFinished event for every starting unit. When playing BA, this means you will get a UnitFinished event for the commander. Therefore, the most straightforward way of finding the reference to the commander is overriding the <code>unitFinished()</code> method.

To get a reference to the commander, you need to check if the unit is indeed the command, and if so, assign the value of the unit parameter to the commander field:

<code><pre>
@Override
public int unitFinished(Unit unit)
{
if (unit.getDef().getName().equals("armcom"))
this.commander = unit;

return 0;
}
</pre></code>

=== Getting a reference to the solar plant definition ===

Every unit in Spring has a UnitDef (a 'unit defintion'). This object tells you all there is to know about the properties of the unit type, such as maximum speed, turn rate and what weapons it carries.
One way to get the reference to the definition of a solar plant is to use <code>callback.getUnitDefs()</code>. This will give you a list of all the available unit types in the game that is currently being played.
The name of the unit def we are looking for is 'armsolar', so we can just iterate through the list and find the one named armsolar, like this:

<code><pre>
List<UnitDef> unitDefs = this.callback.getUnitDefs();
UnitDef solarPlant = null;
for (UnitDef def : unitDefs)
if (def.getName().equals("armsolar"))
{
solarPlant = def;
break;
}
</pre></code>

=== Telling the commander to build the solar plant ===

Now, the only thing left to do is to tell the commander that we want it to build the solar plant, and where to place it. In short, we need to give the commander a build command.

We want to give this command only once at the first frame of the game. For this we can use the <code>update()</code> method, which is called at every frame of the game. All we need to do is overwrite the <code>update(int frame)</code> method and give the command if the frame is 1. This results in the following code:

<code><pre>
@Override
public int update(int frame)
{
if (frame == 0)
{
// give command here
}

return 0;
}
</pre></code>

Giving a command is straightforward. All we need to do is to create the appropriate command object and pass it through the callback to the engine.

The command we need to tell commander to build a solar plant is a <code>BuildUnitAICommand</code>. This command takes a number of arguments:

; Unit unit : the unit we want to give to order to
; int groupId : the group we want to give the order to
; List<AICommand.Option> optionsList : a list addional options. See the values of AICommand.Option for details
; int timeOut : the number of frames after which the command times out
; UnitDef toBuildUnitDef : the UnitDef of the unit we want to build
; AIFloat3 buildPos : the position to build the unit at
; int facing : the direction the new unit should face

As you can see above, we can give a command to either a single unit or a group of units. In this example we only have a single unit. This means that unit should be a reference to our commander, and <code>groupId</code> should be -1.
To keep things simple, we will not use any options, set the timeout to a large number, and set facing to 0.
The value of <code>toBuildUnitDef</code> should be the object reference stored int UnitDef solarPlant.
That only leaves <code>buildPos</code>, for which we will just use the current position of our commander. This means that our <code>BuildUnitAICommand</code> looks like this:

<code><pre>
@Override
public int update(int frame)
{
if (frame == 0)
{
AICommand command = new BuildUnitAICommand(this.commander, -1,
new ArrayList<AICommand.Option>(), 10000, solarPlant,
this.commander.getPos(), 0);
}

return 0;
}
</pre></code>

Next, we should give the command to the engine. We do this through the method <code>callback.getEngine().handleCommand()</code>. This method takes three arguments: the id of the recipient of the command, a <code>commandID</code> and the command itself.
The command should be sent to the engine, and for now we will use a <code>commandID</code> of <code>-1</code>, as this is a feature which is not yet supported by spring (asynchronous command tracking).
Our code will look like this:

<code><pre>
@Override
public int update(int frame)
{
if (frame == 0)
{
AICommand command = new BuildUnitAICommand(this.commander, -1,
new ArrayList<AICommand.Option>(), 10000, solarPlant,
this.commander.getPos(), 0);

this.callback.getEngine().handleCommand(AICommandWrapper.COMMAND_TO_ID_ENGINE,
-1, command);
}

return 0;
}
</pre></code>

At this point you will want to see if your AI actually works. Export your code to ''Spring/AI/Skirmish/MyJavaAI/SkirmishAI.jar'' and start up a game. Your AI should now build a solar plant at its start position.

===Building a metal extractor===
Building a metal extractor is slightly more complicated. Assuming you're not on a metal map, you will need to find a suitable site to place the extractor. Generally, it's preferable to select a site closest to wherever your construction unit (commander) is located.

Modify your code that got a reference to the solar plant by making the following changes:

<code><pre>
List<UnitDef> unitDefs = this.callback.getUnitDefs(); UnitDef solarPlant = null; for (UnitDef def : unitDefs)

if (def.getName().equals("armsolar"))
{
solarPlant = def;
}
else if (def.getName().equals("armmex"))
{
metalExtractor=def;
}
</pre></code>

Again, you will need to create a Unitdef metalExtractor field by where you declared your solarPlant field.

Next, you need a method for determining the distance between two 3D coordinates (since Spring locations are three dimensional). A slightly modified version of a distance function is found below.

<code><pre>
public float calculateDistance(AIFloat3 a, AIFloat3 b)
{
float xDistance = a.x - b.x;
float yDistance = a.y - b.y;
float zDistance = a.z - b.z;
float totalDistanceSquared = xDistance*xDistance + yDistance*yDistance + zDistance*zDistance;
return totalDistanceSquared;
}
</pre></code>

The above code actually returns the distance squared, but it will work for our purposes. In your init function, you will want to add the following code above the return statement but below the line defining the callback:

<code><pre>
checkForMetal();
</pre></code>

This will call the following function you need to place in your code:

<code><pre>
public void checkForMetal()
{
Resource metal=Resource.getInstance(clb, 0);
availablemetalspots=clb.getMap().getResourceMapSpotsPositions(metal);
if(availablemetalspots.isEmpty())
{
sendTextMsg("This is a map with no metal spots");
metalmap=false;
}
else
{metalmap=true;
sendTextMsg("This is a map with metal spots. Listing Values...");
for (AIFloat3 metalspot : availablemetalspots) {
sendTextMsg("Metal Spot at X: "+metalspot.x + ", Y: "+metalspot.y +", Z: "+metalspot.z);
}
}
}
</pre></code>

For the above code to function properly, you will need to create a Boolean named metalmap and a List<AIFloat3> availablemetalspots. You will now have a function set up for calculating distance between two points, and a data structure holding a list of positions of metal spots. The next step is to tie these two together:

<code><pre>
public AIFloat3 closestMetalSpot(AIFloat3 unitposition)
{
AIFloat3 closestspot=null;
for (AIFloat3 metalspot : availablemetalspots) {
if (closestspot==null)
{
closestspot=metalspot;
}
else if(calculateDistance(metalspot, unitposition) < calculateDistance(closestspot, unitposition) && metalspot.hashCode()!=unitposition.hashCode())
{
closestspot=metalspot;
}
}
availablemetalspots.remove(closestspot);
return closestspot;

}
</pre></code>

The above function accepts an AIFloat3 containing the location of your construction unit (commander). It will then find the closest metal spot and return that location. The next step is to have your commander make use of this.

<code><pre>
if (frame == 600)
{
if(metalmap){ sendTextMsg("About to build mex at frame " + frame);
AIFloat3 closestspot=closestMetalSpot(commander.getPos());
BuildUnitAICommand command2=new BuildUnitAICommand(this.commander, -1,
new ArrayList<AICommand.Option>(), 10000,
metalExtractor,closestspot, 0);
handleEngineCommand(command2);}
}
</pre></code>

Place the above code in your update() method. When the frame count reaches 600, your commander will start to build a metal extractor at the closest metal spot. The extractor may not be right on top of where the metal spot appears to be, but you can mouse over the extractor to make sure it's drawing the metal properly.

== Frequently Asked Questions ==

'''Q:''' What is the difference between <code>unitCreated()</code> and <code>unitFinished()</code>?

'''A:''' The difference is that <code>unitCreated()</code> is called when construction of a unit starts, while <code>unitFinished()</code> when construction on the unit has been completed. Any number of things may happen in-between, including the unit under construction being destroyed, so it is important to remember this distinction.

'''Q:''' Do I have to copy and paste my jar file to the directory in Spring/AI/Skirmish/MyAI/0.1 each time I want to test my AI out?

'''A:''' Yes, but it is much easier if you automate the process. In Windows, a simple batch file can be created to move the files over for you. For example

<code><pre>
copy C:\Users\msm8bball\Documents\NetBeansProjects\MyAI\dist\MyAI.jar "C:\Program Files (x86)\Spring\AI\Skirmish\MyAI\0.1"

del "C:\Program Files (x86)\Spring\AI\Skirmish\MyAI\0.1\SkirmishAI.jar"
rename "C:\Program Files (x86)\Spring\AI\Skirmish\MyAI\0.1\MyAI.jar" SkirmishAI.jar
</pre></code>

Modify the above code to match your computer's directories. Place it in a text file and save it as MoveAI.bat. This will create a batch file that you can double click and it will automatically move your AI to the proper location and rename it. You might wish to put a shortcut to this in your Start menu or taskbar.

'''Q:''' I have problems with the class-loader in my AI, any idea?

'''A:''' Each Java AI implementation is loaded by a separate class loader. This is used to load all the AI's class files and dependency libraries (in the ''jlib'' dir). Some libraries though, use the Thread contexts class loader, instead of the one of the current class. Therefore, if you want to load something from the AI's own class-path, make sure to let these libraries use the class-path of your AI classes, eg:
<code><pre>
ClassLoader myClassLoader = AIFactory.class.getClassLoader();
MySpecialUtil msp = new MySpecialUtil();
msp.setClassLoader(myClassLoader);
</pre></code>
Please do not set this class-loader on the thread with <code>Thread.currentThread().setContextClassLoader(myClassLoader)</code>, because all AI's are run in the same Java thread, and therefore this will cause problems.

== Links ==
* [[AIInterface:Java|Java AI Interface]]
* [http://spring.abma.de/doc-Interface-JavaOO/ Javadoc of the Java AI OO Wrapper] (generated daily from source by [[User:Abma|abma]])
* '''OUTDATED''' [http://springrts.com/phpbb/download/file.php?id=4970 Netbeans Java Skirmish AI Tutorial] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread])
* [http://modinfo.adune.nl/index.php?MOD=ba712 ModInfo] (contains a list of units and their short names)

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

Development guidelines

2013-02-10T13:34:16Z

Hoijui: add engine branching model image (in a new section)

This page details some important things to take note of when doing Spring development.

===Spring runs synchronized on all computers===
Spring's networking is built upon the assumption that all player's simulations are in sync and only send their (or their AI's) input over the network. This mean that you will have to be very careful to keep the simulation deterministic. Here is a few pointers to think about.

* There are essentially two sorts of code in spring, synced and unsynced. Which code is what is not as clear as one could wish but essentially the synced code is anything that is reached through CGame::Simframe or handlers of some network msgs, unsynced is everything else (graphic, input, sound etc). Synced code can write anything but should only read synced data. Unsynced code can read anything but must not write synced data. The rest of the points here is essentially about synced code.
* Always make sure to initialize variables. Even if the value doesnt seem to matter it might unsync the simulation.
* Be paranoid about array boundaries, reading one byte beyond an array might not crash but it will probably cause sync problems at some point.
* For random numbers use the CGlobalStuff::RandFloat etc functions (but never use these from unsynced code)
* Never compare memory block locations other than for equality. This mean for example that you shouldn't create a std::set or std::map with a pointer as index if the order might matter.

===Adding your own stuff===
We welcome anyone to make changes to Spring but in order to get them accepted into our distribution the following can be worth thinking about.

* Spring is a game and different people might want different things from it. So if your changes change gameplay it might be a good idea to make it optional.
* Resources (esp. CPU time) is always in short supply for spring so make sure that you dont waste them needlessly and that your resource usage is in proportion to the impact of your changes.
* Ask around before starting on a change. Not only might you get tips about how to implement it in the best way but also if anyone else is working on something similar.
* Comment your code to make it more readable. In particular use [[Doxygen style comments]] so that header comments for classes/methods/functions/fields etc. automatically get pulled into the source code [http://taspring.clan-sy.com/doxygen/ documentation].

===Engine Branching Model===
The version currently in use:
[[File:EngineBranchingModel.png|640px]]

[[Category:Source development]]

File:EngineBranchingModel.png

2013-02-10T13:31:26Z

Hoijui: engine (git-)branching model, release candidate 13, currently in use see doc/engineBranchingModel.dia in the engine source code repo.

engine (git-)branching model, release candidate 13, currently in use
see doc/engineBranchingModel.dia in the engine source code repo.

AI:Development:Lang:Java

2012-07-07T08:40:21Z

Hoijui: small corrections at the start of the text

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

== Getting Started on your own Java AI ==

''Note:'' This tutorial assumes you have Spring working on your machine. The Spring directory will be referred to as 'Spring' from here on.

You will also need to make sure that Java AI's run properly on your machine. This is most easily done by running a Spring game with the ''NullOOJavaAI'' that comes with the engine. You will need the JRE 1.5 or greater, and to set the ''JAVA_HOME'' environment variable on your system to point to the correct location.

''Note:'' if you're using a ''64 bit'' version of ''Windows'', you will need a 32 bit Java Runtime Environment/Java Development Kit anyway, because Spring is (as of July 2012) not yet available as a 64bit version for Windows.

=== Setting up a Java Project ===

To start working on your own Java AI, you should first set up a project in your favorite Java IDE. You need to import the Spring Java AI Interface libraries, and then create an AI class and an AI Factory.

If you are using '''Netbeans IDE''', you can find a detailed tutorial [http://springrts.com/phpbb/download/file.php?id=4970 here] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread]). Otherwise, please continue reading this page.

==== Importing the interface libraries ====

In order to use the Java Interface, you will need to import the Java Interface libraries, located in ''Spring/AI/Interfaces/Java/[version]/''. Replace ''[version]'' with the number of the latest Java Interface version. As of this writing, only ''0.1'' is available.

The file you need is ''AIInterface.jar''. You also need the additional library ''vecmath.jar'', located in the ''jlib/'' subfolder. Optionally, you can attach the file ''AIInterface-src.jar'' as source to the ''AIInterface.jar'' file for JavaDoc support in your editor.

Your project should now contain the following libraries:

* <code>Spring/AI/Interfaces/Java/[version]/AIInterface.jar</code>
* <code>Spring/AI/Interfaces/Java/[version]/jlib/AIInterface-src.jar</code> (optional)
* <code>Spring/AI/Interfaces/Java/[version]/jlib/vecmath.jar</code>

==== Creating the required classes ====

Now that you have the libraries, the next step is to create your AI's main class. Firstly, you may want to create a package to put your classes in, for example, ''myjavaai''. Create a new class, named MyJavaAI (or whatever you would like your AI to be called). MyJavaAI should extend com.springrts.ai.oo.AbstractOOAI. After that you'll need another class, named ''MyJavaAIFactory''. This class should extend ''com.springrts.ai.oo.OOAIFactory''.
The class MyJavaAIFactory only has to implement a single method: ''public OOAI createAI(int teamId, OOAICallback callback)''. This is the method that the Java interface calls to get an instance of your AI. If you wanted to, you could create a different AI depending on circumstances, but for now it is probably easiest to simply return a new MyJavaAI(), until you decide you require something more elaborate.
You should now have two classes, ''myjavaai.MyJavaAI'' and ''myjavaai.MyJavaAIFactory''.

=== Adding your AI to Spring ===

Your AI needs to have its own folder, and the engine will need to know your AI's attributes.

==== Creating an AI folder ====

Every Spring AI is stored in ''Spring/AI/Skirmish''. You will have to create a folder for your AI as well. It is easiest to go to the directory ''Spring/AI/Skirmish'', make a copy of the folder ''NullOOJavaAI'', and rename the copy to ''MyJavaAI''.

==== Telling the Engine about your AI ====

The ''MyJavaAI'' folder you created contains the different versions of your AI. As of this writing, the ''NullOOJavaAI'' only has a version ''0.1'', so there should be a folder ''0.1'' inside the ''MyJavaAI'' folder. Inside you will find a number of files.
These files are:
* ''SkirmishAI.jar'': the jar file that contains the AI code.
* ''AIInfo.lua'': contains information about the AI.
* ''AIOptions.lua'': you can specify your AI's options in here.
* Possibly some text files: these are log files generated by the ''NullOOJavaAI''. If you don't plan on using the same files, you may as well delete these.

Additionally, there is a folder named ''jlib''. This is where you should place any additional libraries you use in your AI.

In order to let Spring recognize your AI, you will have to edit ''AIInfo.lua''. You can do this with any regular text editor.
When you open it, the file will look something like this:

<code><pre>
local infos = {
{
key = 'shortName',
value = 'NullOOJavaAI',
desc = 'machine conform name.',
},
{
key = 'version',
value = '0.1', -- AI version - !This comment is used for parsing!
},
{
key = 'className',
value = 'nulloojavaai.NullOOJavaAIFactory',
desc = 'fully qualified name of a class that implements interface com.springrts.ai.AI',
},
{
key = 'name',
value = 'high-level Java stub Skirmish AI',
desc = 'human readable name.',
},
{
key = 'loadSupported',
value = 'no',
desc = 'whether this AI supports loading or not',
},
{
key = 'interfaceShortName',
value = 'Java', -- AI Interface name - !This comment is used for parsing!
desc = 'the shortName of the AI interface this AI needs',
},
{
key = 'interfaceVersion',
value = '0.1', -- AI Interface version - !This comment is used for parsing!
desc = 'the minimum version of the AI interface required by this AI',
},
}

return infos
</pre></code>

The file describes a number of attributes. Each attribute has a key, a value and a desc(ription). The key is the name of the attribute, the description tells you what the attribute is used for, and the value is what you will want to edit.

The shortName attribute is the name used for your AI internally. It's most logical to change this into to the same name you gave your AI class. (MyJavaAI.)

'version' tells the engine which version of your AI this is. If you're in the 0.1 folder, make this 0.1. Your AI should be located at AI/Skirmish/''shortName''/''version''/.

'classname' tells the interface which class is your AIFactory class. Take care that you use the fully qualified class name, or it won't work. In this example, this should be myjavaai.MyJavaAIFactory.

'name' describes your AI to the user. In this example, you might put 'A simple Java AI to learn about AI programming in Spring.'

'loadSupported' is rather self-explanatory. Since you have just started working on your AI, you may not get around to implementing loading support for some time, so it's best to put 'no,' for now.

'interfaceShortName' and 'interfaceversion' tell the engine about the interface your AI uses. Since MyJavaAI uses the same interface as the NullOOJavaAI, leave these as they are.

Finally, the last thing you should do is exporting your AI to SkirmishAI.jar. The way to do this varies depending on your Java editor.

=== Test your AI ===

After following all the above steps, you should be able to run your AI. Either use SpringLobby to start a new game and see if you can add your AI as a bot, or run ''spring.exe'' to see if you can start the script MyJavaAI Test.
Of course, since you haven't told the AI what to do, your starting unit(s) will sit there doing nothing.

== Getting your AI to Do Something ==

After getting your AI running, you will want to make it do something. Traditionally, the first thing to get your AI to is to build a solar plant, assuming you want it to play BA. If not, it is quite straightforward to build other units once you have the general idea.
You will need four things to get your AI to build a solar plant:
* A reference to the callback
* A reference to the commander (your starting unit in BA)
* A reference to the solar plant definition object
* To tell the commander to build the solar plant

However, before we go about building solar plants, first you should know about events. We will use these to get the required object references.

=== Events ===

Nearly everything that happens in the game is an event. When a unit is created, this is an event. Enemy spotted? Also an event. A player sends your AI a message? You got it, this is an event as well.

Every event is made known to your AI. Have a look at the <code>MyJavaAI</code> class again. <code>MyJavaAI</code> extends <code>AbstractOOA</code>. <code>AbstractOOAI</code> implements a number of methods like <code>unitCreated()</code>, <code>enemyEnterRadar()</code> and <code>message()</code>.
Sound familiar? The method <code>unitCreated(Unit unit, Unit builder)</code> is called every time a unit is created, and tells you the unit that was created and the unit that built it. Similarly, enemyEnterRadar(Unit enemy) and message(int player, String message) tell you about an enemy unit entering radar range and receiving a message from another player respectively.
There are many other events that all have corresponding methods. To have your AI respond to these events, simply override the method in your <code>MyJavaAI</code> class.
The return type of these methods is an integer. The return value can be used for debugging. 0 means that no errors occurred, while any other value is threated as an error. This system can be used for debugging, but is it much easier to implement proper logging.

In the sections below you will see an example of the use of these events.

=== Getting a reference to the callback ===

The callback is the object through which the AI communicates with the engine. All information that does not change the state of the engine can be retrieved through individual methods in the callback, and state changing commands (eg to units) will go through a single, specialized method, which is in the callback as well.
Getting a reference to the callback is easy.
First create a class field <code>OOAICallback callback</code> to put the reference in, then overwrite the method <code>init(int teamId, OOAICallback callback)</code>. The init method is called at the start of every game (right at the end of the countdown).
As you can see, all that you need to do is set the parameter value callback to the field callback:

<code><pre>
@Override
public int init(int teamId, OOAICallback callback)
{
this.callback = callback;
return 0;
}
</pre></code>

=== Getting a reference to the commander ===

In order to have your AI build a solar plant, the first thing you need is a reference to your commander. You first need an instance field 'Unit commander' to put the reference in, then we need to get the reference itself.
A UnitFinished event is triggered whenever a unit has been built. (This may sound similar to <code>unitCreated()</code>. For a quick explanation of the difference, see the FAQ below.)
At the start of the game, the engine will send a UnitFinished event for every starting unit. When playing BA, this means you will get a UnitFinished event for the commander. Therefore, the most straightforward way of finding the reference to the commander is overriding the <code>unitFinished()</code> method.

To get a reference to the commander, you need to check if the unit is indeed the command, and if so, assign the value of the unit parameter to the commander field:

<code><pre>
@Override
public int unitFinished(Unit unit)
{
if (unit.getDef().getName().equals("armcom"))
this.commander = unit;

return 0;
}
</pre></code>

=== Getting a reference to the solar plant definition ===

Every unit in Spring has a UnitDef (a 'unit defintion'). This object tells you all there is to know about the properties of the unit type, such as maximum speed, turn rate and what weapons it carries.
One way to get the reference to the definition of a solar plant is to use <code>callback.getUnitDefs()</code>. This will give you a list of all the available unit types in the game that is currently being played.
The name of the unit def we are looking for is 'armsolar', so we can just iterate through the list and find the one named armsolar, like this:

<code><pre>
List<UnitDef> unitDefs = this.callback.getUnitDefs();
UnitDef solarPlant = null;
for (UnitDef def : unitDefs)
if (def.getName().equals("armsolar"))
{
solarPlant = def;
break;
}
</pre></code>

=== Telling the commander to build the solar plant ===

Now, the only thing left to do is to tell the commander that we want it to build the solar plant, and where to place it. In short, we need to give the commander a build command.

We want to give this command only once at the first frame of the game. For this we can use the <code>update()</code> method, which is called at every frame of the game. All we need to do is overwrite the <code>update(int frame)</code> method and give the command if the frame is 1. This results in the following code:

<code><pre>
@Override
public int update(int frame)
{
if (frame == 0)
{
// give command here
}

return 0;
}
</pre></code>

Giving a command is straightforward. All we need to do is to create the appropriate command object and pass it through the callback to the engine.

The command we need to tell commander to build a solar plant is a <code>BuildUnitAICommand</code>. This command takes a number of arguments:

; Unit unit : the unit we want to give to order to
; int groupId : the group we want to give the order to
; List<AICommand.Option> optionsList : a list addional options. See the values of AICommand.Option for details
; int timeOut : the number of frames after which the command times out
; UnitDef toBuildUnitDef : the UnitDef of the unit we want to build
; AIFloat3 buildPos : the position to build the unit at
; int facing : the direction the new unit should face

As you can see above, we can give a command to either a single unit or a group of units. In this example we only have a single unit. This means that unit should be a reference to our commander, and <code>groupId</code> should be -1.
To keep things simple, we will not use any options, set the timeout to a large number, and set facing to 0.
The value of <code>toBuildUnitDef</code> should be the object reference stored int UnitDef solarPlant.
That only leaves <code>buildPos</code>, for which we will just use the current position of our commander. This means that our <code>BuildUnitAICommand</code> looks like this:

<code><pre>
@Override
public int update(int frame)
{
if (frame == 0)
{
AICommand command = new BuildUnitAICommand(this.commander, -1,
new ArrayList<AICommand.Option>(), 10000, solarPlant,
this.commander.getPos(), 0);
}

return 0;
}
</pre></code>

Next, we should give the command to the engine. We do this through the method <code>callback.getEngine().handleCommand()</code>. This method takes three arguments: the id of the recipient of the command, a <code>commandID</code> and the command itself.
The command should be sent to the engine, and for now we will use a <code>commandID</code> of <code>-1</code>, as this is a feature which is not yet supported by spring (asynchronous command tracking).
Our code will look like this:

<code><pre>
@Override
public int update(int frame)
{
if (frame == 0)
{
AICommand command = new BuildUnitAICommand(this.commander, -1,
new ArrayList<AICommand.Option>(), 10000, solarPlant,
this.commander.getPos(), 0);

this.callback.getEngine().handleCommand(AICommandWrapper.COMMAND_TO_ID_ENGINE,
-1, command);
}

return 0;
}
</pre></code>

At this point you will want to see if your AI actually works. Export your code to ''Spring/AI/Skirmish/MyJavaAI/SkirmishAI.jar'' and start up a game. Your AI should now build a solar plant at its start position.

===Building a metal extractor===
Building a metal extractor is slightly more complicated. Assuming you're not on a metal map, you will need to find a suitable site to place the extractor. Generally, it's preferable to select a site closest to wherever your construction unit (commander) is located.

Modify your code that got a reference to the solar plant by making the following changes:

<code><pre>
List<UnitDef> unitDefs = this.callback.getUnitDefs(); UnitDef solarPlant = null; for (UnitDef def : unitDefs)

if (def.getName().equals("armsolar"))
{
solarPlant = def;
}
else if (def.getName().equals("armmex"))
{
metalExtractor=def;
}
</pre></code>

Again, you will need to create a Unitdef metalExtractor field by where you declared your solarPlant field.

Next, you need a method for determining the distance between two 3D coordinates (since Spring locations are three dimensional). A slightly modified version of a distance function is found below.

<code><pre>
public float calculateDistance(AIFloat3 a, AIFloat3 b)
{
float xDistance = a.x - b.x;
float yDistance = a.y - b.y;
float zDistance = a.z - b.z;
float totalDistanceSquared = xDistance*xDistance + yDistance*yDistance + zDistance*zDistance;
return totalDistanceSquared;
}
</pre></code>

The above code actually returns the distance squared, but it will work for our purposes. In your init function, you will want to add the following code above the return statement but below the line defining the callback:

<code><pre>
checkForMetal();
</pre></code>

This will call the following function you need to place in your code:

<code><pre>
public void checkForMetal()
{
Resource metal=Resource.getInstance(clb, 0);
availablemetalspots=clb.getMap().getResourceMapSpotsPositions(metal);
if(availablemetalspots.isEmpty())
{
sendTextMsg("This is a map with no metal spots");
metalmap=false;
}
else
{metalmap=true;
sendTextMsg("This is a map with metal spots. Listing Values...");
for (AIFloat3 metalspot : availablemetalspots) {
sendTextMsg("Metal Spot at X: "+metalspot.x + ", Y: "+metalspot.y +", Z: "+metalspot.z);
}
}
}
</pre></code>

For the above code to function properly, you will need to create a Boolean named metalmap and a List<AIFloat3> availablemetalspots. You will now have a function set up for calculating distance between two points, and a data structure holding a list of positions of metal spots. The next step is to tie these two together:

<code><pre>
public AIFloat3 closestMetalSpot(AIFloat3 unitposition)
{
AIFloat3 closestspot=null;
for (AIFloat3 metalspot : availablemetalspots) {
if (closestspot==null)
{
closestspot=metalspot;
}
else if(calculateDistance(metalspot, unitposition) < calculateDistance(closestspot, unitposition) && metalspot.hashCode()!=unitposition.hashCode())
{
closestspot=metalspot;
}
}
availablemetalspots.remove(closestspot);
return closestspot;

}
</pre></code>

The above function accepts an AIFloat3 containing the location of your construction unit (commander). It will then find the closest metal spot and return that location. The next step is to have your commander make use of this.

<code><pre>
if (frame == 600)
{
if(metalmap){ sendTextMsg("About to build mex at frame " + frame);
AIFloat3 closestspot=closestMetalSpot(commander.getPos());
BuildUnitAICommand command2=new BuildUnitAICommand(this.commander, -1,
new ArrayList<AICommand.Option>(), 10000,
metalExtractor,closestspot, 0);
handleEngineCommand(command2);}
}
</pre></code>

Place the above code in your update() method. When the frame count reaches 600, your commander will start to build a metal extractor at the closest metal spot. The extractor may not be right on top of where the metal spot appears to be, but you can mouse over the extractor to make sure it's drawing the metal properly.

== Frequently Asked Questions ==

'''Q:''' What is the difference between <code>unitCreated()</code> and <code>unitFinished()</code>?

'''A:''' The difference is that <code>unitCreated()</code> is called when construction of a unit starts, while <code>unitFinished()</code> when construction on the unit has been completed. Any number of things may happen in-between, including the unit under construction being destroyed, so it is important to remember this distinction.

'''Q:''' Do I have to copy and paste my jar file to the directory in Spring/AI/Skirmish/MyAI/0.1 each time I want to test my AI out?

'''A:''' Yes, but it is much easier if you automate the process. In Windows, a simple batch file can be created to move the files over for you. For example

<code><pre>
copy C:\Users\msm8bball\Documents\NetBeansProjects\MyAI\dist\MyAI.jar "C:\Program Files (x86)\Spring\AI\Skirmish\MyAI\0.1"

del "C:\Program Files (x86)\Spring\AI\Skirmish\MyAI\0.1\SkirmishAI.jar"
rename "C:\Program Files (x86)\Spring\AI\Skirmish\MyAI\0.1\MyAI.jar" SkirmishAI.jar
</pre></code>

Modify the above code to match your computer's directories. Place it in a text file and save it as MoveAI.bat. This will create a batch file that you can double click and it will automatically move your AI to the proper location and rename it. You might wish to put a shortcut to this in your Start menu or taskbar.

'''Q:''' I have problems with the class-loader in my AI, any idea?

'''A:''' Each Java AI implementation is loaded by a separate class loader. This is used to load all the AI's class files and dependency libraries (in the ''jlib'' dir). Some libraries though, use the Thread contexts class loader, instead of the one of the current class. Therefore, if you want to load something from the AI's own class-path, make sure to let these libraries use the class-path of your AI classes, eg:
<code><pre>
ClassLoader myClassLoader = AIFactory.class.getClassLoader();
MySpecialUtil msp = new MySpecialUtil();
msp.setClassLoader(myClassLoader);
</pre></code>
Please do not set this class-loader on the thread with <code>Thread.currentThread().setContextClassLoader(myClassLoader)</code>, because all AI's are run in the same Java thread, and therefore this will cause problems.

== Links ==
* [[AIInterface:Java|Java AI Interface]]
* [http://spring.abma.de/doc-Interface-JavaOO/ Javadoc of the Java AI OO Wrapper] (generated daily from source by [[User:Abma|abma]])
* [http://springrts.com/phpbb/download/file.php?id=4970 Netbeans Java Skirmish AI Tutorial] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread])
* [http://modinfo.adune.nl/index.php?MOD=ba712 ModInfo] (contains a list of units and their short names)

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

AI:Development:Lang:Java

2012-07-07T08:28:58Z

Hoijui: fixed code block tags

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

== Getting Started on your own Java AI ==

Note: This tutorial assumes you have Spring working on your machine. The Spring directory will be referred to as 'Spring' from here on out.

You will also need to make sure that Java AI's run properly on your machine. It's easiest to test the NullOOJavaAI that comes with spring. You will need the JRE 1.6 or greater, and to set the JAVA_HOME environment variable on your system to point to the correct location.

Note: if you're using a 64 bit version of Windows, you will need a 32 bit Java Runtime Environment/ Java Development Kit.

=== Setting up a Java Project ===

To start working on your own Java AI you should first set up a project in your favorite Java editor. You need to import the Java Interface libraries, then create an AI class and an AI Factory.

If you are using '''Netbeans IDE''', you can find a detailed tutorial [http://springrts.com/phpbb/download/file.php?id=4970 here] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread]). Otherwise, please continue reading this page.

==== Importing the interface libraries ====

In order to use the Java Interface, you will need to import the Java Interface libraries, located in ''Spring/AI/Interfaces/Java/[version]/''. Replace ''[version]'' with the number of the latest Java Interface version. As of this writing, only ''0.1'' is available.

The file you need is ''AIInterface.jar''. You also need the additional libraries ''vecmath.jar'', located in the ''jlib/'' subfolder, as well as ''jna.jar'' in ''jlib/jna/''. Optionally, you can attach the file ''AIInterface-src.jar'' as source to the ''AIInterface.jar'' file for javadoc support in your editor.

Your project should now contain the following libraries:

* <code>Spring/AI/Interfaces/Java/[version]/AIInterface.jar</code>
* <code>Spring/AI/Interfaces/Java/[version]/jlib/AIInterface-src.jar</code> (optional)
* <code>Spring/AI/Interfaces/Java/[version]/jlib/vecmath.jar</code>
* <code>Spring/AI/Interfaces/Java/[version]/jlib/jna/jna.jar</code>

==== Creating the required classes ====

Now that you have the libraries, next step is to create your AI's main class. Firstly, you may want to create a package to put your classes in, for example, ''myjavaai''. Create a new class, named MyJavaAI (or whatever you would like your AI to be called). MyJavaAI should extend com.springrts.ai.oo.AbstractOOAI. After that you'll need another class, named ''MyJavaAIFactory''. This class should extend ''com.springrts.ai.oo.OOAIFactory''.
The class MyJavaAIFactory only has to implement a single method: ''public OOAI createAI(int teamId, OOAICallback callback)''. This is the method that the Java interface calls to get an instance of your AI. If you wanted to, you could create a different AI depending on circumstances, but for now it is probably easiest to simply return a new MyJavaAI(), until you decide you require something more elaborate.
You should now have two classes, ''myjavaai.MyJavaAI'' and ''myjavaai.MyJavaAIFactory''.

=== Adding your AI to Spring ===

Your AI needs to have its own folder, and the engine will need to know your AI's attributes.

==== Creating an AI folder ====

Every Spring AI is stored in ''Spring/AI/Skirmish''. You will have to create a folder for your AI as well. It is easiest to go to the directory ''Spring/AI/Skirmish'', make a copy of the folder ''NullOOJavaAI'', and rename the copy to ''MyJavaAI''.

==== Telling the Engine about your AI ====

The ''MyJavaAI'' folder you created contains the different versions of your AI. As of this writing, the ''NullOOJavaAI'' only has a version ''0.1'', so there should be a folder ''0.1'' inside the ''MyJavaAI'' folder. Inside you will find a number of files.
These files are:
* ''SkirmishAI.jar'': the jar file that contains the AI code.
* ''AIInfo.lua'': contains information about the AI.
* ''AIOptions.lua'': you can specify your AI's options in here.
* Possibly some text files: these are log files generated by the ''NullOOJavaAI''. If you don't plan on using the same files, you may as well delete these.

Additionally, there is a folder named ''jlib''. This is where you should place any additional libraries you use in your AI.

In order to let Spring recognize your AI, you will have to edit ''AIInfo.lua''. You can do this with any regular text editor.
When you open it, the file will look something like this:

<code><pre>
local infos = {
{
key = 'shortName',
value = 'NullOOJavaAI',
desc = 'machine conform name.',
},
{
key = 'version',
value = '0.1', -- AI version - !This comment is used for parsing!
},
{
key = 'className',
value = 'nulloojavaai.NullOOJavaAIFactory',
desc = 'fully qualified name of a class that implements interface com.springrts.ai.AI',
},
{
key = 'name',
value = 'high-level Java stub Skirmish AI',
desc = 'human readable name.',
},
{
key = 'loadSupported',
value = 'no',
desc = 'whether this AI supports loading or not',
},
{
key = 'interfaceShortName',
value = 'Java', -- AI Interface name - !This comment is used for parsing!
desc = 'the shortName of the AI interface this AI needs',
},
{
key = 'interfaceVersion',
value = '0.1', -- AI Interface version - !This comment is used for parsing!
desc = 'the minimum version of the AI interface required by this AI',
},
}

return infos
</pre></code>

The file describes a number of attributes. Each attribute has a key, a value and a desc(ription). The key is the name of the attribute, the description tells you what the attribute is used for, and the value is what you will want to edit.

The shortName attribute is the name used for your AI internally. It's most logical to change this into to the same name you gave your AI class. (MyJavaAI.)

'version' tells the engine which version of your AI this is. If you're in the 0.1 folder, make this 0.1. Your AI should be located at AI/Skirmish/''shortName''/''version''/.

'classname' tells the interface which class is your AIFactory class. Take care that you use the fully qualified class name, or it won't work. In this example, this should be myjavaai.MyJavaAIFactory.

'name' describes your AI to the user. In this example, you might put 'A simple Java AI to learn about AI programming in Spring.'

'loadSupported' is rather self-explanatory. Since you have just started working on your AI, you may not get around to implementing loading support for some time, so it's best to put 'no,' for now.

'interfaceShortName' and 'interfaceversion' tell the engine about the interface your AI uses. Since MyJavaAI uses the same interface as the NullOOJavaAI, leave these as they are.

Finally, the last thing you should do is exporting your AI to SkirmishAI.jar. The way to do this varies depending on your Java editor.

=== Test your AI ===

After following all the above steps, you should be able to run your AI. Either use SpringLobby to start a new game and see if you can add your AI as a bot, or run ''spring.exe'' to see if you can start the script MyJavaAI Test.
Of course, since you haven't told the AI what to do, your starting unit(s) will sit there doing nothing.

== Getting your AI to Do Something ==

After getting your AI running, you will want to make it do something. Traditionally, the first thing to get your AI to is to build a solar plant, assuming you want it to play BA. If not, it is quite straightforward to build other units once you have the general idea.
You will need four things to get your AI to build a solar plant:
* A reference to the callback
* A reference to the commander (your starting unit in BA)
* A reference to the solar plant definition object
* To tell the commander to build the solar plant

However, before we go about building solar plants, first you should know about events. We will use these to get the required object references.

=== Events ===

Nearly everything that happens in the game is an event. When a unit is created, this is an event. Enemy spotted? Also an event. A player sends your AI a message? You got it, this is an event as well.

Every event is made known to your AI. Have a look at the <code>MyJavaAI</code> class again. <code>MyJavaAI</code> extends <code>AbstractOOA</code>. <code>AbstractOOAI</code> implements a number of methods like <code>unitCreated()</code>, <code>enemyEnterRadar()</code> and <code>message()</code>.
Sound familiar? The method <code>unitCreated(Unit unit, Unit builder)</code> is called every time a unit is created, and tells you the unit that was created and the unit that built it. Similarly, enemyEnterRadar(Unit enemy) and message(int player, String message) tell you about an enemy unit entering radar range and receiving a message from another player respectively.
There are many other events that all have corresponding methods. To have your AI respond to these events, simply override the method in your <code>MyJavaAI</code> class.
The return type of these methods is an integer. The return value can be used for debugging. 0 means that no errors occurred, while any other value is threated as an error. This system can be used for debugging, but is it much easier to implement proper logging.

In the sections below you will see an example of the use of these events.

=== Getting a reference to the callback ===

The callback is the object through which the AI communicates with the engine. All information that does not change the state of the engine can be retrieved through individual methods in the callback, and state changing commands (eg to units) will go through a single, specialized method, which is in the callback as well.
Getting a reference to the callback is easy.
First create a class field <code>OOAICallback callback</code> to put the reference in, then overwrite the method <code>init(int teamId, OOAICallback callback)</code>. The init method is called at the start of every game (right at the end of the countdown).
As you can see, all that you need to do is set the parameter value callback to the field callback:

<code><pre>
@Override
public int init(int teamId, OOAICallback callback)
{
this.callback = callback;
return 0;
}
</pre></code>

=== Getting a reference to the commander ===

In order to have your AI build a solar plant, the first thing you need is a reference to your commander. You first need an instance field 'Unit commander' to put the reference in, then we need to get the reference itself.
A UnitFinished event is triggered whenever a unit has been built. (This may sound similar to <code>unitCreated()</code>. For a quick explanation of the difference, see the FAQ below.)
At the start of the game, the engine will send a UnitFinished event for every starting unit. When playing BA, this means you will get a UnitFinished event for the commander. Therefore, the most straightforward way of finding the reference to the commander is overriding the <code>unitFinished()</code> method.

To get a reference to the commander, you need to check if the unit is indeed the command, and if so, assign the value of the unit parameter to the commander field:

<code><pre>
@Override
public int unitFinished(Unit unit)
{
if (unit.getDef().getName().equals("armcom"))
this.commander = unit;

return 0;
}
</pre></code>

=== Getting a reference to the solar plant definition ===

Every unit in Spring has a UnitDef (a 'unit defintion'). This object tells you all there is to know about the properties of the unit type, such as maximum speed, turn rate and what weapons it carries.
One way to get the reference to the definition of a solar plant is to use <code>callback.getUnitDefs()</code>. This will give you a list of all the available unit types in the game that is currently being played.
The name of the unit def we are looking for is 'armsolar', so we can just iterate through the list and find the one named armsolar, like this:

<code><pre>
List<UnitDef> unitDefs = this.callback.getUnitDefs();
UnitDef solarPlant = null;
for (UnitDef def : unitDefs)
if (def.getName().equals("armsolar"))
{
solarPlant = def;
break;
}
</pre></code>

=== Telling the commander to build the solar plant ===

Now, the only thing left to do is to tell the commander that we want it to build the solar plant, and where to place it. In short, we need to give the commander a build command.

We want to give this command only once at the first frame of the game. For this we can use the <code>update()</code> method, which is called at every frame of the game. All we need to do is overwrite the <code>update(int frame)</code> method and give the command if the frame is 1. This results in the following code:

<code><pre>
@Override
public int update(int frame)
{
if (frame == 0)
{
// give command here
}

return 0;
}
</pre></code>

Giving a command is straightforward. All we need to do is to create the appropriate command object and pass it through the callback to the engine.

The command we need to tell commander to build a solar plant is a <code>BuildUnitAICommand</code>. This command takes a number of arguments:

; Unit unit : the unit we want to give to order to
; int groupId : the group we want to give the order to
; List<AICommand.Option> optionsList : a list addional options. See the values of AICommand.Option for details
; int timeOut : the number of frames after which the command times out
; UnitDef toBuildUnitDef : the UnitDef of the unit we want to build
; AIFloat3 buildPos : the position to build the unit at
; int facing : the direction the new unit should face

As you can see above, we can give a command to either a single unit or a group of units. In this example we only have a single unit. This means that unit should be a reference to our commander, and <code>groupId</code> should be -1.
To keep things simple, we will not use any options, set the timeout to a large number, and set facing to 0.
The value of <code>toBuildUnitDef</code> should be the object reference stored int UnitDef solarPlant.
That only leaves <code>buildPos</code>, for which we will just use the current position of our commander. This means that our <code>BuildUnitAICommand</code> looks like this:

<code><pre>
@Override
public int update(int frame)
{
if (frame == 0)
{
AICommand command = new BuildUnitAICommand(this.commander, -1,
new ArrayList<AICommand.Option>(), 10000, solarPlant,
this.commander.getPos(), 0);
}

return 0;
}
</pre></code>

Next, we should give the command to the engine. We do this through the method <code>callback.getEngine().handleCommand()</code>. This method takes three arguments: the id of the recipient of the command, a <code>commandID</code> and the command itself.
The command should be sent to the engine, and for now we will use a <code>commandID</code> of <code>-1</code>, as this is a feature which is not yet supported by spring (asynchronous command tracking).
Our code will look like this:

<code><pre>
@Override
public int update(int frame)
{
if (frame == 0)
{
AICommand command = new BuildUnitAICommand(this.commander, -1,
new ArrayList<AICommand.Option>(), 10000, solarPlant,
this.commander.getPos(), 0);

this.callback.getEngine().handleCommand(AICommandWrapper.COMMAND_TO_ID_ENGINE,
-1, command);
}

return 0;
}
</pre></code>

At this point you will want to see if your AI actually works. Export your code to ''Spring/AI/Skirmish/MyJavaAI/SkirmishAI.jar'' and start up a game. Your AI should now build a solar plant at its start position.

===Building a metal extractor===
Building a metal extractor is slightly more complicated. Assuming you're not on a metal map, you will need to find a suitable site to place the extractor. Generally, it's preferable to select a site closest to wherever your construction unit (commander) is located.

Modify your code that got a reference to the solar plant by making the following changes:

<code><pre>
List<UnitDef> unitDefs = this.callback.getUnitDefs(); UnitDef solarPlant = null; for (UnitDef def : unitDefs)

if (def.getName().equals("armsolar"))
{
solarPlant = def;
}
else if (def.getName().equals("armmex"))
{
metalExtractor=def;
}
</pre></code>

Again, you will need to create a Unitdef metalExtractor field by where you declared your solarPlant field.

Next, you need a method for determining the distance between two 3D coordinates (since Spring locations are three dimensional). A slightly modified version of a distance function is found below.

<code><pre>
public float calculateDistance(AIFloat3 a, AIFloat3 b)
{
float xDistance = a.x - b.x;
float yDistance = a.y - b.y;
float zDistance = a.z - b.z;
float totalDistanceSquared = xDistance*xDistance + yDistance*yDistance + zDistance*zDistance;
return totalDistanceSquared;
}
</pre></code>

The above code actually returns the distance squared, but it will work for our purposes. In your init function, you will want to add the following code above the return statement but below the line defining the callback:

<code><pre>
checkForMetal();
</pre></code>

This will call the following function you need to place in your code:

<code><pre>
public void checkForMetal()
{
Resource metal=Resource.getInstance(clb, 0);
availablemetalspots=clb.getMap().getResourceMapSpotsPositions(metal);
if(availablemetalspots.isEmpty())
{
sendTextMsg("This is a map with no metal spots");
metalmap=false;
}
else
{metalmap=true;
sendTextMsg("This is a map with metal spots. Listing Values...");
for (AIFloat3 metalspot : availablemetalspots) {
sendTextMsg("Metal Spot at X: "+metalspot.x + ", Y: "+metalspot.y +", Z: "+metalspot.z);
}
}
}
</pre></code>

For the above code to function properly, you will need to create a Boolean named metalmap and a List<AIFloat3> availablemetalspots. You will now have a function set up for calculating distance between two points, and a data structure holding a list of positions of metal spots. The next step is to tie these two together:

<code><pre>
public AIFloat3 closestMetalSpot(AIFloat3 unitposition)
{
AIFloat3 closestspot=null;
for (AIFloat3 metalspot : availablemetalspots) {
if (closestspot==null)
{
closestspot=metalspot;
}
else if(calculateDistance(metalspot, unitposition) < calculateDistance(closestspot, unitposition) && metalspot.hashCode()!=unitposition.hashCode())
{
closestspot=metalspot;
}
}
availablemetalspots.remove(closestspot);
return closestspot;

}
</pre></code>

The above function accepts an AIFloat3 containing the location of your construction unit (commander). It will then find the closest metal spot and return that location. The next step is to have your commander make use of this.

<code><pre>
if (frame == 600)
{
if(metalmap){ sendTextMsg("About to build mex at frame " + frame);
AIFloat3 closestspot=closestMetalSpot(commander.getPos());
BuildUnitAICommand command2=new BuildUnitAICommand(this.commander, -1,
new ArrayList<AICommand.Option>(), 10000,
metalExtractor,closestspot, 0);
handleEngineCommand(command2);}
}
</pre></code>

Place the above code in your update() method. When the frame count reaches 600, your commander will start to build a metal extractor at the closest metal spot. The extractor may not be right on top of where the metal spot appears to be, but you can mouse over the extractor to make sure it's drawing the metal properly.

== Frequently Asked Questions ==

'''Q:''' What is the difference between <code>unitCreated()</code> and <code>unitFinished()</code>?

'''A:''' The difference is that <code>unitCreated()</code> is called when construction of a unit starts, while <code>unitFinished()</code> when construction on the unit has been completed. Any number of things may happen in-between, including the unit under construction being destroyed, so it is important to remember this distinction.

'''Q:''' Do I have to copy and paste my jar file to the directory in Spring/AI/Skirmish/MyAI/0.1 each time I want to test my AI out?

'''A:''' Yes, but it is much easier if you automate the process. In Windows, a simple batch file can be created to move the files over for you. For example

<code><pre>
copy C:\Users\msm8bball\Documents\NetBeansProjects\MyAI\dist\MyAI.jar "C:\Program Files (x86)\Spring\AI\Skirmish\MyAI\0.1"

del "C:\Program Files (x86)\Spring\AI\Skirmish\MyAI\0.1\SkirmishAI.jar"
rename "C:\Program Files (x86)\Spring\AI\Skirmish\MyAI\0.1\MyAI.jar" SkirmishAI.jar
</pre></code>

Modify the above code to match your computer's directories. Place it in a text file and save it as MoveAI.bat. This will create a batch file that you can double click and it will automatically move your AI to the proper location and rename it. You might wish to put a shortcut to this in your Start menu or taskbar.

'''Q:''' I have problems with the class-loader in my AI, any idea?

'''A:''' Each Java AI implementation is loaded by a separate class loader. This is used to load all the AI's class files and dependency libraries (in the ''jlib'' dir). Some libraries though, use the Thread contexts class loader, instead of the one of the current class. Therefore, if you want to load something from the AI's own class-path, make sure to let these libraries use the class-path of your AI classes, eg:
<code><pre>
ClassLoader myClassLoader = AIFactory.class.getClassLoader();
MySpecialUtil msp = new MySpecialUtil();
msp.setClassLoader(myClassLoader);
</pre></code>
Please do not set this class-loader on the thread with <code>Thread.currentThread().setContextClassLoader(myClassLoader)</code>, because all AI's are run in the same Java thread, and therefore this will cause problems.

== Links ==
* [[AIInterface:Java|Java AI Interface]]
* [http://spring.abma.de/doc-Interface-JavaOO/ Javadoc of the Java AI OO Wrapper] (generated daily from source by [[User:Abma|abma]])
* [http://springrts.com/phpbb/download/file.php?id=4970 Netbeans Java Skirmish AI Tutorial] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread])
* [http://modinfo.adune.nl/index.php?MOD=ba712 ModInfo] (contains a list of units and their short names)

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

Download

2012-04-15T08:31:12Z

Hoijui: /* TASClient */ fixed link

{{#css:
#content * {font-family: 'Bitstream Vera Sans', 'Trebuchet MS', 'Arial', 'Myriad Pro', 'FreeSans';}
}}
= Downloads =
<center>
{|style="margin-top: 15px; padding: 10px; background:rgba(45,180,19,0.5); border: 1px solid rgba(0,0,0,0.5); border-radius: 6px 6px 6px 6px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.5), inset 0 10px 8px rgba(255,255,255,0.3);" |
| If you just want to get ready to play, you want this:
|-
| style="margin-top: 15px; text-align: center" | [[GamesDownloads|Games Downloads]]
|}
</center>

= Spring Engine (no games included) =
Latest stable version: '''{{EngineVersion:Stable}}''' ({{EngineVersion:Stable:ReleaseDate}})

{|
| style="padding-right:10px"| [[Image:Window.png]]
| '''Installer: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}.exe/download spring_{{StableEngineVersion}}.exe ~25MB]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}.exe {mirror}]''' 
'''Portable: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_portable.7z/download spring_{{StableEngineVersion}}_portable.7z ~25MB]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_portable.7z {mirror}]
|}

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
| follow the '''[[SetupGuide|Linux Setup guide]]'''
|}

{|
| style="padding-right:10px"| [[Image:Apple.png]]
|
'''.app-Bundle: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip/download spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip ~50MB]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip {mirror}]''' 
The Mac OS X port is experimental. Help with its development would be greatly appreciated. Check our forum '''[http://springrts.com/phpbb/viewforum.php?f=65 here]'''.
|}

= Testing/Nightly Builds =
Used for testing latest engine developments.
[http://springrts.com/dl/buildbot/ list of all test builds]

= Source Code =
== git ==
'''[http://github.com/spring/spring Spring project page at github]''' [http://status.github.com (status page)]
=== Getting the Source ===
latest stable:
<code><pre>git clone -b master git://github.com/spring/spring.git</pre></code>
development branch (won't work for online gaming):
<code><pre>git clone git://github.com/spring/spring.git</pre></code>

=== Alternate git url ===
<code><pre>git://springrts.git.sourceforge.net/gitroot/springrts/springrts</pre></code>

== Latest Stable Snapshot ==
This tarball is the same as that used to build the last public release. See [[Building spring]] for build instructions.

The packages below target Linux only and do not contain certain files required to compile using CMake on Windows.

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_src.tar.lzma/download spring_{{StableEngineVersion}}_src.tar.lzma]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_src.tar.lzma {mirror}]

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_src.tar.gz/download spring_{{StableEngineVersion}}_src.tar.gz]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_src.tar.gz {mirror}]

= Other springrts.com hosted projects =
== TASClient ==
An alternative windows only lobby client.

[http://springfiles.com/downloadmain/15995 Download '''TASClient''']

== Lobby server ==
If you do not want (or are unable) to use the public lobby server, you can run a lobby server yourself.
See the [https://github.com/spring/SpringLS/blob/springls-0.37/README.markdown README] for more info.

[https://github.com/downloads/spring/SpringLS/springls-{{SpringLSVersion:Latest}}-stand-alone.jar Download '''SpringLS {{SpringLSVersion:Latest}}''' ~ 5.6MB] (requires Java 5+)
__NOTOC__

FAQ:technical

2012-04-14T12:28:38Z

Hoijui: /* Is there any documentation for the source code? */

[[Category:FAQ]]

=Technical FAQ=

==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?==
Spring uses OpenGL for graphics and OpenAL for sound. Also SDL is used for input and some other stuff.

==What language is Spring written in?==
The Spring game engine is mostly written in C++. TASClient is written in Delphi, SpringLS in Java, SpringLobby in C++. Widgets and Gadgets are written in Lua. Skirmish AIs can be written in Lua, C, C++, Java VM languages and Python.

==Is Spring open source?==
Yes, it is. Go to the [[Download|downloads]] section of the site to download the source code.

==Is there any documentation for the source code?==
Doxygen is used to generate the documentation of springs' source code. An [http://springrts.com/doxygen/ up to date documentation] is generated from the ''develop'' branch. To generate the documentation yourself, install DoxyGen and run "doxygen" from within the spring source directory.

==Is Spring a Portable Application?==

Yes, spring can be run from any big-enough portable storage device.
Sometimes config files and content files are saved god knows where ie in "my documents"

==Is there an alternative way to connect to the lobby server?==

Yes, using the [[IrcBridge | IRC-Bridge]] through an [http://en.wikipedia.org/wiki/Internet_Relay_Chat#Clients IRC client]. Keep in mind though, that this is not officially supported, and no guarantee is given for the reliability of this service.

==What do the spring version parts mean?==

See [[EngineVersion#Parts]].

FAQ:trouble

2012-04-14T12:26:59Z

Hoijui: /* I see the complete screen full of red/green/yellow or giant dots on minimap */

[[Category:FAQ]]

=Troubleshooting=

==Network==

===My buddy can not connect to a game I've opened. What can we do?===
The engine uses UDP port 8452 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. If you do not know what a port or a firewall is, use a relay host instead: when hosting a game, tick the check-box labeled "Use relayhost".

===I can not connect to the online lobby server?===
See in the [http://springrts.com/phpbb/index.php forum] if others have the same problem.

The server might be temporary down for maintenance.
Most lobbies should allow you to connect to a "backup server" or just try again after some time.

==Graphics==
===Low fps that get better in metalview (F4)===
Try typing into ingame chat:

''/advmapshading 0

/advmodelshading 0''

And/Or add to springsettings.cfg:

''AdvMapShading = 0

AdvUnitShading = 0''

(usually the AdvMapShading part is enough)

===I am having really bad framerates (fps) on my dual core! What am I doing wrong?===
Some of this helped other users:

* This error is sometimes reported by people having multicore-CPUs. To solve this, you could try to restrict it to run on one core. Enable "SetCoreAffinity=1" in your [[springrc]].
* Installing the latest processor drivers and Windows hotfixes for your system may also help.
* Also you may try multithreaded version of Spring, which comes with the installation pack labeled as 'Multi-threaded executable' option. WARNING: `multithreaded` means something different in this context than 99.9% of the ppl think!!! Also this engine version is LESS STABLE and is known to not work with most Lua widgets!!!
* Also try to disabling the "Exhaust" effect on planes could help: Press f11 while ingame, disable LUPS and Lups manager (by clicking on them to make them turn red)

===How to Alt-Tab out of full-screen on Linux?===
Play windowed with ''/grabinput'', or [http://springrts.com/phpbb/viewtopic.php?p=449972#p449972 use devilspie].

===I use Linux with Open-Source Gfx drivers, and the map is all white!===
[[File:Whitemap.png|200px]]

Due to patents S3TC texture support is disabled by default. To enable it you need the tool driconf (note, you no longer require libdxtn):

<code><pre>
$ sudo apt-get install libgl1-mesa-dev driconf
$ driconf
</pre></code>

On the "Image Quality" tab activate "Enable S3TC texture compression even if software support is not available".

Related forum threads:
* [http://springrts.com/phpbb/viewtopic.php?f=20&t=20809 Spring on Intel or ATI 'open-source' drivers]

===It crashes, hangs, ...===
Possible fixes are:
* updating your graphics driver
* lowering the graphic-settings at SpringSettings
* disabling graphics effects at SpringSettings

=== Spring crashes on my notebook but it has a really nice graphic card! (or some effects are messed up) ===
eg air plane trails look like: [http://img805.imageshack.us/img805/8881/screen00000.png]

Some notebooks have two graphic cards: One for 3D and a small integrated one to save power while on facebook.
Setting it to use the correct 3D card has helped some players.
Use the internet to find out how to do that.
Screenhot of such controll panel, though it might look different on different computers:
http://rog.asus.com/forum/attachment.php?attachmentid=2492&d=1323213638

===Nvidia===

====I am having really bad framerates (FPS)!====
Turn off 'threaded optimizations' for Spring in the nVidia control panel, enable "Compress textures" in SpringSettings.

[[File:MToptimizations.png|200px]]

====After playing Spring, in background running firefox window is white or gray. ====

Disable Anti-Aliasing / decrease graphic-quality (<=high) in SpringSettings.

====Shadows on Units doesn't work====
[[File:Shadows_fail.jpg|200px]]

Check if Shadows and AdvUnitShading is enabled, update your graphics driver.

====It crashes/hangs====

* try disabling shadows (SpringSettings)
* try disabling advanced map shading (AdvMapShading=0)

===Intel===

====Why does spring hang for a few seconds?====
This bug occurs on maps like FolsomDamDeluxeV2, Tangerline. FPS suddenly drops to 1 and game runs very slowly. This seems to be an Intel driver bug. For Windows Vista/7 try updating driver up to 8.15.10.2246 or newer. For Windows XP there is no solution yet.

Related forum threads:
* [http://springrts.com/phpbb/viewtopic.php?f=11&t=23541 Intel HD Graphics Driver issue?]
* [http://springrts.com/phpbb/viewtopic.php?f=11&t=23081 Performance issues on Intel X4500]

====Fonts are unreadable====
[[File:IntelBorkedFonts.png|200px]]

This is a driver bug, try to update/downgrade your driver.

====It crashes, hangs etc...====
Possible fixes are:
* disabling texture-compression at SpringSettings
* disabling reflective units at SpringSettings
* disable ReflectiveWater
* [http://downloadcenter.intel.com/ updating your driver]
* use linux! (yes, this hint sucks, but the open-source-drivers seems to work better...)

===ATI/AMD===
First of all, if you encourage a graphics related problem on ATI/AMD graphic device update your drivers to the latest version [http://support.amd.com/us/gpudownload/Pages/index.aspx ATI/AMD dowload].

==== I've got the most recent drivers and the game crashes in atioglxx.dll====
As of Spring 0.80.5, use only basic or dynamic water. Bump water with disabled shore waves should also work. Reflective or refractive water will make the game crash after 15-20 minutes due to a memory leak.

Spring 0.81.2 and/or Catalyst 10.2 drivers or newer should fix this problem.

if the game crashes immediatly after the loading screen is finished ("Finalizing") in the Zero-K or Gundam mods and the video card is based on the RV670 GPU (some models of: 3690, 3850, 3870, 4570, 4730, 3730, 3610, 4580, 4750, 3750, 2600 XT/PRO, 3830) Catalyst 8.12 drivers may fix it (windows xp 32-bit, possibly other NT5-based 32-bit platforms), however even with that driver there may still be a crash (not immediatly after the loading screen, as soon as the simulations starts) in Annihilation-based mods that use RED UI, the same lua-based atioglxx.dll crash also happens with the 1944 mod.

also note that later versions of Catalyst drivers for these cards reduce performance in OpenGL applications (windows xp 32-bit, possibly other NT5-based 32-bit platforms) (found at least in: spring, quake3 and Nexuiz), for spring the most significant drop (by ~15%) appears in 9.10 and higher Catalyst versions (more than 15%), if you have one of the lower-performing models of these and don't use shadows you may want to try the Catalyst 8.3 and 8.4 drivers (they do not support shadows but should work ~5% faster compared to 8.12) but those drivers may be less stable

====I've got a notebook and official ATI/AMD drivers refuse to install, what to do?====
First of all, make sure you're installing the 'AMD Mobility Radeon' driver pack branch.
Use [http://www.driverheaven.net/modtool.php ATI Mobility Modder] or unofficial drivers - DNA or Omega. Use [http://google.com Google] or get them from [http://downloads.guru3d.com/Videocards----ATI-Catalyst-(Modified)_c24.html guru3d].

====UI disapears after 5-10 mins of play on old ATI videocards====
In cmdcolors.txt, simply comment out or remove the following lines:
stipplePattern 0xffcc
stippleFactor 1
stippleSpeed 1.0
The problem detected on:
* ATI Radeon X3200 with latest drivers ([http://springrts.com/phpbb/viewtopic.php?f=11&t=20817 ref])
* ATI Radeon 9500 with Omega drivers 3.8.442 ([http://springrts.com/phpbb/viewtopic.php?f=11&t=23526 ref])

====I see the complete screen full of red/green/yellow or giant dots on minimap====

[[File:Redui-minimap-bug.pngâ€Ž|200px]]

This is a bug somewhere in LUA drawing with ATI/AMD. Disable widgets that draw via F11 menu to find the one. There is no real fix. A Widget causing this is "Red UI Minimap", "Highlight Units" or "Chili Minimap". Setting "Max nano simultaneous particles" (SpringSettings) seems to help, too.

====The textures looks scary====
[[File:Ati-drawing-issues.jpg|200px]]

This is a known ATI/AMD-bug. Try using different driver, preferably other than 10.5, 10.6, 10.7 -> newer driver pack with fixed OpenGL driver should be fine.

====It crashes always at start, hangs etc...====
Possible fixes are:
* using basic water ([[SpringSettings]])
* disabling vsync (SpringSettings)
* disabling Pixelbuffer objects (SpringSettings)
* disabling Anti-Aliasing (SpringSettings)
* set Shadows to "off" (SpringSettings)
* updating or even downgrading [http://support.amd.com/ ATI driver]: ATI/AMD OpenGL drivers are very buggy, blame ATI/AMD for that!
* set AtiHacks=1 ([[springrc]])

==Sound==

===The Sound is crackling/pausing in Windows, what can i do?===
Try:
* Update the sounds driver
* Enable SystemSoundsService in Vista/Seven

===I am having sound problems under Linux! What can i do?===
In more then 90% of the cases, this is caused by PulseAudio. If this is the problem, there are three known solutions to solve it. Use one of them.

====disable sound effects====
Make sure you have the OpenAL-Soft configuration utility. You might want to run:

<code><pre>
# install
sudo apt-get install alsoft-conf
# run
alsoft-conf
</pre></code>

If you're not on a debian-based distribution, you can download the source from the project's homepage: http://www.anduin.net/~angasule/?x=entry:entry091211-133213. You can also check if there's a newer version.
<code><pre>
#download
wget http://www.anduin.net/~angasule/fp-content/attachs/alsoft-conf_1.4.3.tar.gz
#extract
tar xvf alsoft-conf_1.4.3.tar.gz
cd alsoft-conf-1.4.3
#compile
cmake .
make
#run
./alsoft-conf
</pre></code>

In the "Effects" tab remove everything from "Allowed effects".

====disable non-ALSA (preferred)====
run alsoft-conf (for installation see above)

In the "backend" tab, keep only "ALSA" on the left column, then save. Done!

''Side Note:'' ALSA is redirected to the PulseAudio layer when installed.

==Misc==

===Middle mouse button does not work ingame===

If you use Logitech Setpoint be aware that it sets your middle mouse button by default to 'Autoscroll'. It should be set to 'Middle button' instead. Change the setting in Setpoint.

===Spring crashes after Error opening cache\ ... in infolog.txt===

[f=0000000] Reading Estimate PathCosts [8]
[f=0000000] Error opening cache\paths\...

this is a known bug in 0.82.7.1. Your cpu also has many cores?
Then try to set HardwareThreadCount=2" in [[springrc]]. Spring tries to create the PathCache with to many threads in parallel and crashes because out of memory.

===I have a problem that is not described here! What can i do?===
There is a number of things you can do, among these are:
* Search in the [http://springrts.com/phpbb/viewforum.php?f=11 Help & Bugs Forum], and ask if you can not find a suiting topic.
* Check the games forum or homepage.
* Look at the [[Gentoo_install#Linux_specific_Troubleshooting|Linux only FAQ]].
* Ask for help in the lobby in a suiting channel, eg: #springlobby, #de, #fr, #ai, #main
* Ask the FAQ-Bot in the lobby in channel #springlobby. To get a list of topics, write ''!faqlist'' and then use ''!faq <topic-name>'' to get the help text. For example, try ''!faq rename''.

===The ingame chat spams a lot of cryptic error messages===
This is most likely a problem with the game's Lua scripting.
Report it in the games forum or its bug tracker.
[[Bugs|Here]] are some hints how to so.

Download

2012-01-17T10:30:47Z

Hoijui: /* Spring Engine (no games included) */ indicate that the OS X build is missing

{{#css:
#content * {font-family: 'Bitstream Vera Sans', 'Trebuchet MS', 'Arial', 'Myriad Pro', 'FreeSans';}
}}
= Downloads =
<center>
{|style="margin-top: 15px; padding: 10px; background:rgba(45,180,19,0.5); border: 1px solid rgba(0,0,0,0.5); border-radius: 6px 6px 6px 6px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.5), inset 0 10px 8px rgba(255,255,255,0.3);" |
| If you just want to get ready to play, you want this:
|-
| style="margin-top: 15px; text-align: center" | [[GamesDownloads|Games Downloads]]
|}
</center>

= Spring Engine (no games included) =
Latest stable version: '''{{EngineVersion:Stable}}''' ({{EngineVersion:Stable:ReleaseDate}})

{|
| style="padding-right:10px"| [[Image:Window.png]]
| '''Installer: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}.exe/download spring_{{StableEngineVersion}}.exe ~25MB]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}.exe {mirror}]''' 
'''Portable: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_portable.7z/download spring_{{StableEngineVersion}}_portable.7z ~25MB]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_portable.7z {mirror}]
|}

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
| follow the '''[[SetupGuide|Linux Setup guide]]'''
|}

{|
| style="padding-right:10px"| [[Image:Apple.png]]
| Not yet available due to hardware problems.
We are working on it, but can not give a due date.
Sorry!

<s>'''.app-Bundle: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip/download spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip ~34MB]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip {mirror}]''' </s>
The Mac OS X port is experimental. Help with its development would be greatly appreciated. Check our forum '''[http://springrts.com/phpbb/viewforum.php?f=65 here]'''.
|}

= Testing/Nightly Builds =
Used for testing latest engine developments.
[http://springrts.com/dl/buildbot/ list of all test builds]

= Source Code =
== git ==
'''[http://github.com/spring/spring Spring project page at github]''' [http://status.github.com (status page)]
=== Getting the Source ===
latest stable:
<code><pre>git clone -b master git://github.com/spring/spring.git</pre></code>
development branch (won't work for online gaming):
<code><pre>git clone git://github.com/spring/spring.git</pre></code>

=== Alternate git url ===
<code><pre>git://springrts.git.sourceforge.net/gitroot/springrts/springrts</pre></code>

== Latest Stable Snapshot ==
This tarball is the same as that used to build the last public release. See [[Building spring]] for build instructions.

The packages below target Linux only and do not contain certain files required to compile using CMake on Windows.

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_src.tar.lzma/download spring_{{StableEngineVersion}}_src.tar.lzma]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_src.tar.lzma {mirror}]

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_src.tar.gz/download spring_{{StableEngineVersion}}_src.tar.gz]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_src.tar.gz {mirror}]

= Other springrts.com hosted projects =
== TASClient ==
An alternative windows only lobby client.

[http://springrts.com/dl/tasclient/TASClientLatest.7z Download '''TASClient''']

== Lobby server ==
If you do not want (or are unable) to use the public lobby server, you can run a lobby server yourself.
See the [https://github.com/spring/SpringLS/blob/springls-0.37/README.markdown README] for more info.

[https://github.com/downloads/spring/SpringLS/springls-{{SpringLSVersion:Latest}}-stand-alone.jar Download '''SpringLS {{SpringLSVersion:Latest}}''' ~ 5.6MB] (requires Java 5+)
__NOTOC__

Gamedev:Sidepics

2012-01-14T09:43:12Z

Hoijui: add PNG support to the specs

Sidepics are the faction icons which display in the Multiplayer Lobbies.
They have to follow these simple rules:

* be 16x16 pixels
* be in either ''PNG'' (preferred) or ''BMP'' format (where white=(RGB: 255,255,255) is transparent)
* be located in the [[Mod_Development:Archives|''sidepics'']] directory (see below)
* be named the same as the ''name'' field in ''sidedata.tdf'' (see below)

===Directory===
The "sidepics" directory goes in your game's root. Please see [[Mod_Development:Archives]] for more details on the directories Spring reads.

===Filename===
The filename must be the same as the name field in [[Sidedata.lua]] file.

[[Category:Game development]]

Lobby Development

2011-12-20T13:07:50Z

Hoijui: /* UberServer */

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

=Documentation=

==Protocol==
* [http://springrts.com/dl/tasclient/ProtocolDescription.xml HTML] (may be out of date)
* [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=
There are currently four working public lobby clients available.

==SpringLobby==
cross-platform,
C++,
by BrainDamage &
koshi

SpringLobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It uses the ''wxWidgets'' library. You can browse the sources and submit issues on its [http://springlobby.info/ website].

==Zero-K==
Windows,
C#,
by Licho & quantum

[https://code.google.com/p/zero-k/ Zero-K project page]

==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].

==TASClient==
Windows,
Delphi,
by Satirik

You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here:
http://springrts.com/dl/tasclient/TASClientLatest.7z

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

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

[http://code.google.com/p/qtlobby/ project page]

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

==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].

==UberServer==
cross-platform,
Python,
by aegis

The primary lobby server currently running on springrts.com. All protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and SpringLS. You can get more information and download uberserver at the [https://github.com/lunixbochs/uberserver github page]

[[Category: Lobbies]]

Lobby Development

2011-12-20T13:06:49Z

Hoijui: /* TASServer */

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

=Documentation=

==Protocol==
* [http://springrts.com/dl/tasclient/ProtocolDescription.xml HTML] (may be out of date)
* [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=
There are currently four working public lobby clients available.

==SpringLobby==
cross-platform,
C++,
by BrainDamage &
koshi

SpringLobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It uses the ''wxWidgets'' library. You can browse the sources and submit issues on its [http://springlobby.info/ website].

==Zero-K==
Windows,
C#,
by Licho & quantum

[https://code.google.com/p/zero-k/ Zero-K project page]

==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].

==TASClient==
Windows,
Delphi,
by Satirik

You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here:
http://springrts.com/dl/tasclient/TASClientLatest.7z

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

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

[http://code.google.com/p/qtlobby/ project page]

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

==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].

==UberServer==
cross-platform,
Python,
by aegis

The primary lobby server currently running on springrts.com. All protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and TASServer. You can get more information and download uberserver at the [https://github.com/lunixbochs/uberserver github page]

[[Category: Lobbies]]

FAQ:technical

2011-12-20T13:03:28Z

Hoijui: /* What language is Spring written in? */

[[Category:FAQ]]

=Technical FAQ=

==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?==
Spring uses OpenGL for graphics and OpenAL for sound. Also SDL is used for input and some other stuff.

==What language is Spring written in?==
The Spring game engine is mostly written in C++. TASClient is written in Delphi, SpringLS in Java, SpringLobby in C++. Widgets and Gadgets are written in Lua. Skirmish AIs can be written in Lua, C, C++, Java VM languages and Python.

==Is Spring open source?==
Yes, it is. Go to the [[Download|downloads]] section of the site to download the source code.

==Is there any documentation for the source code?==
Yes, doxygen can be used to produce documentation. Unfortunately, there is no webserver running the docu at the moment, you will need to generate your own. To do so, install doxygen and run "doxygen" from in spring source directory.

==Is Spring a Portable Application?==

Yes, spring can be run from any big-enough portable storage device.
Sometimes config files and content files are saved god knows where ie in "my documents"

==Is there an alternative way to connect to the lobby server?==

Yes, using the [[IrcBridge | IRC-Bridge]] through an [http://en.wikipedia.org/wiki/Internet_Relay_Chat#Clients IRC client]. Keep in mind though, that this is not officially supported, and no guarantee is given for the reliability of this service.

==What do the spring version parts mean?==

See [[EngineVersion#Parts]].

Download

2011-12-20T13:01:36Z

Hoijui: /* Other springrts.com hosted projects */ fix formatting

{{#css:
#content * {font-family: 'Bitstream Vera Sans', 'Trebuchet MS', 'Arial', 'Myriad Pro', 'FreeSans';}
}}
= Downloads =
<center>
{|style="margin-top: 15px; padding: 10px; background:rgba(45,180,19,0.5); border: 1px solid rgba(0,0,0,0.5); border-radius: 6px 6px 6px 6px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.5), inset 0 10px 8px rgba(255,255,255,0.3);" |
| If you just want to get ready to play, you want this:
|-
| style="margin-top: 15px; text-align: center" | [[GamesDownloads|Games Downloads]]
|}
</center>

= Spring Engine (no games included) =
Latest stable version: '''{{EngineVersion:Stable}}''' ({{EngineVersion:Stable:ReleaseDate}})

{|
| style="padding-right:10px"| [[Image:Window.png]]
| '''Installer: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}.exe/download spring_{{StableEngineVersion}}.exe ~25MB]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}.exe {mirror}]''' 
'''Portable: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_portable.7z/download spring_{{StableEngineVersion}}_portable.7z ~25MB]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_portable.7z {mirror}]
|}

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
| follow the '''[[SetupGuide|Linux Setup guide]]'''
|}

{|
| style="padding-right:10px"| [[Image:Apple.png]]
| '''.app-Bundle: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip/download spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip ~34MB]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip {mirror}]''' 
The Mac OS X port is experimental. Help with its development would be greatly appreciated. Check our forum '''[http://springrts.com/phpbb/viewforum.php?f=65 here]'''.
|}

= Testing/Nightly Builds =
Used for testing latest engine developments.
[http://springrts.com/dl/buildbot/ list of all test builds]

= Source Code =
== git ==
'''[http://github.com/spring/spring Spring project page at github]''' [http://status.github.com (status page)]
=== Getting the Source ===
latest stable:
<code><pre>git clone -b master git://github.com/spring/spring.git</pre></code>
development branch (won't work for online gaming):
<code><pre>git clone git://github.com/spring/spring.git</pre></code>

=== Alternate git url ===
<code><pre>git://springrts.git.sourceforge.net/gitroot/springrts/springrts</pre></code>

== Latest Stable Snapshot ==
This tarball is the same as that used to build the last public release. See [[Building spring]] for build instructions.

The packages below target Linux only and do not contain certain files required to compile using CMake on Windows.

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_src.tar.lzma/download spring_{{StableEngineVersion}}_src.tar.lzma]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_src.tar.lzma {mirror}]

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_src.tar.gz/download spring_{{StableEngineVersion}}_src.tar.gz]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_src.tar.gz {mirror}]

= Other springrts.com hosted projects =
== TASClient ==
An alternative windows only lobby client.

[http://springrts.com/dl/tasclient/TASClientLatest.7z Download '''TASClient''']

== Lobby server ==
If you do not want (or are unable) to use the public lobby server, you can run a lobby server yourself.
See the [https://github.com/spring/SpringLS/blob/springls-0.37/README.markdown README] for more info.

[https://github.com/downloads/spring/SpringLS/springls-{{SpringLSVersion:Latest}}-stand-alone.jar Download '''SpringLS {{SpringLSVersion:Latest}}''' ~ 5.6MB] (requires Java 5+)
__NOTOC__

Download

2011-12-20T12:57:23Z

Hoijui: /* Lobby server */ TASServer -> SpringLS

{{#css:
#content * {font-family: 'Bitstream Vera Sans', 'Trebuchet MS', 'Arial', 'Myriad Pro', 'FreeSans';}
}}
= Downloads =
<center>
{|style="margin-top: 15px; padding: 10px; background:rgba(45,180,19,0.5); border: 1px solid rgba(0,0,0,0.5); border-radius: 6px 6px 6px 6px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.5), inset 0 10px 8px rgba(255,255,255,0.3);" |
| If you just want to get ready to play, you want this:
|-
| style="margin-top: 15px; text-align: center" | [[GamesDownloads|Games Downloads]]
|}
</center>

= Spring Engine (no games included) =
Latest stable version: '''{{EngineVersion:Stable}}''' ({{EngineVersion:Stable:ReleaseDate}})

{|
| style="padding-right:10px"| [[Image:Window.png]]
| '''Installer: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}.exe/download spring_{{StableEngineVersion}}.exe ~25MB]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}.exe {mirror}]''' 
'''Portable: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_portable.7z/download spring_{{StableEngineVersion}}_portable.7z ~25MB]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_portable.7z {mirror}]
|}

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
| follow the '''[[SetupGuide|Linux Setup guide]]'''
|}

{|
| style="padding-right:10px"| [[Image:Apple.png]]
| '''.app-Bundle: [http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip/download spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip ~34MB]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_MacOSX-10.6-SnowLeopard.zip {mirror}]''' 
The Mac OS X port is experimental. Help with its development would be greatly appreciated. Check our forum '''[http://springrts.com/phpbb/viewforum.php?f=65 here]'''.
|}

= Testing/Nightly Builds =
Used for testing latest engine developments.
[http://springrts.com/dl/buildbot/ list of all test builds]

= Source Code =
== git ==
'''[http://github.com/spring/spring Spring project page at github]''' [http://status.github.com (status page)]
=== Getting the Source ===
latest stable:
<code><pre>git clone -b master git://github.com/spring/spring.git</pre></code>
development branch (won't work for online gaming):
<code><pre>git clone git://github.com/spring/spring.git</pre></code>

=== Alternate git url ===
<code><pre>git://springrts.git.sourceforge.net/gitroot/springrts/springrts</pre></code>

== Latest Stable Snapshot ==
This tarball is the same as that used to build the last public release. See [[Building spring]] for build instructions.

The packages below target Linux only and do not contain certain files required to compile using CMake on Windows.

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_src.tar.lzma/download spring_{{StableEngineVersion}}_src.tar.lzma]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_src.tar.lzma {mirror}]

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-{{StableEngineVersion}}/spring_{{StableEngineVersion}}_src.tar.gz/download spring_{{StableEngineVersion}}_src.tar.gz]''' - [http://springrts.com/dl/spring_{{StableEngineVersion}}_src.tar.gz {mirror}]

= Other springrts.com hosted projects =
== TASClient ==
An alternative windows only lobby client.

'''[http://springrts.com/dl/tasclient/TASClientLatest.7z Download TASClient]'''

== Lobby server (SpringLS {{SpringLSVersion:Latest}}) ==
If you do not want (or are unable) to use the public lobby server, you can run a lobby server yourself.
See the '''[https://github.com/spring/SpringLS/blob/springls-0.37/README.markdown README]''' for more info.

'''[https://github.com/downloads/spring/SpringLS/springls-{{SpringLSVersion:Latest}}-stand-alone.jar Download SpringLS {{SpringLSVersion:Latest}}]''' ~ 5.6MB (requires Java 1.5+)
__NOTOC__

Template:SpringLSVersion:Latest

2011-12-20T12:50:22Z

Hoijui: init page

0.37

Download Testing

2011-10-13T07:12:55Z

Hoijui: /* Mac OS X */ fixed OS X App bundle link

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|{{EngineVersion:Stable}}]] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|{{EngineVersion:Testing}}]] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/develop/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/develop/{{EngineVersion:Testing}}/spring_{develop}{{EngineVersion:Testing}}_minimal-portable.7z portable] (Lobby not included)
<li> [http://springrts.com/dl/buildbot/default/develop/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/develop/{{EngineVersion:Testing}}/Spring_{develop}{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers (recommended):
* ''springlobby.info:8200''
* ''tizbac.dyndns.org:8200''

Or alternatively, configure your lobby so it does not insist using the release version of the engine:
* SpringLobby: set <code>DisableVersionCheck=1</code> in ''springlobby.conf''
* TASClient: press F6 (TODO check if correct (maybe F10?))

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}}), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

===Upcoming release===
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...develop in detail]):

* '''development switched to branch ''develop''!'''
to check on which branch you are, type: <code><pre>git branch</pre></code>
if you are on ''master'' type: <code><pre>git checkout -b develop origin/develop</pre></code>
* move not essential Lua widgets to cont/examples (#2537)
* allow to override the default data-dir locations with env vars USERPROFILE and PROGRAMDATA on windows
* add MoveCtrl.SetGunshipMoveTypeData control over airStrafe
* fix Skirmish AIs saturate command/sec limit of player (#2541)
* fix wake-projectiles after /water 2
* fix Repeat commands involving IDs remain after the objet destroyed (#2620)
* fix make air-absorption runtime configurable again
* disable console logging for unitsync
* git: "develop" is now the developing branch, master will contain releases from now
* adjust log-levels for some messages
* added http://springrts.com/dl/buildbot/default/develop/LATEST + http://springrts.com/dl/buildbot/default/master/LATEST

===12. October 2011===
==== 82.8.1-30-g5dbb98b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...82.8.1-30-g5dbb98b in detail]):

* new versioning scheme RC12 (see [http://springrts.com/phpbb/viewtopic.php?p=501948#p501948 the related forum thread])
* fixed logging on windows
* record WARNING and higher log levels to stderr, normal log to stdout
* fixed some pathfinder issues
* many bug-fixes

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26745 Feedback forum thread]

===6. September 2011===
==== 0.82.3-3386-gefb020b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3295-g000fac6...0.82.3-3386-gefb020b in detail]):

* fixed win32 installer (it installed always in non-portable mode)
* fix memory corruption in stacked transports
* Fix SetUnitWeaponState "range" fails for Cannon
* fix bumpmapped water on ATI-cards
* fixed possible lua-errors ([http://springrts.com/mantis/view.php?id=2511 #2511])
* allow resources_map to specify groundFX textures for CEGs using CSimpleGroundFlash ([http://springrts.com/mantis/view.php?id=2632 #2632])
* added a [https://github.com/spring/spring/commit/fd7eb8dde6289394bd69ccae4709c01629461d27 validation test]

[http://springrts.com/phpbb/viewtopic.php?p=502559#p502559 Feedback forum thread]

=== 21. August 2011 ===
==== 0.82.3-3295-g000fac6 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
* sync error fixed, thanks to abma
* first test release that comes with a MacOS X App Bundle, thanks to daftalx

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26656 Feedback forum thread]

=== 29. June 2011 ===
==== 0.82.3-2365-g82c3187 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
* Fixes an issue in engine supplied Lua code plus other random bug fixes.

=== 1. June 2011 ===
==== 0.82.3-2297-g26b01f8 ====

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
* [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
* [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
* [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)

[[Category: Development]]

Download Testing

2011-10-12T21:56:05Z

Hoijui: /* Windows */ fix portable dl link

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|{{EngineVersion:Stable}}]] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|{{EngineVersion:Testing}}]] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/develop/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/develop/{{EngineVersion:Testing}}/spring_{develop}{{EngineVersion:Testing}}_minimal-portable.7z portable] (Lobby not included)
<li> [http://springrts.com/dl/buildbot/default/develop/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/develop/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers (recommended):
* ''springlobby.info:8200''
* ''tizbac.dyndns.org:8200''

Or alternatively, configure your lobby so it does not insist using the release version of the engine:
* SpringLobby: set <code>DisableVersionCheck=1</code> in ''springlobby.conf''
* TASClient: press F6 (TODO check if correct (maybe F10?))

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}}), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

===Upcoming release===
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...develop in detail]):

* '''development switched to branch ''develop''!'''
to check on which branch you are, type: <code><pre>git branch</pre></code>
if you are on ''master'' type: <code><pre>git checkout -b develop origin/develop</pre></code>
* move not essential Lua widgets to cont/examples (#2537)
* allow to override the default data-dir locations with env vars USERPROFILE and PROGRAMDATA on windows
* add MoveCtrl.SetGunshipMoveTypeData control over airStrafe
* fix Skirmish AIs saturate command/sec limit of player (#2541)
* fix wake-projectiles after /water 2
* fix Repeat commands involving IDs remain after the objet destroyed (#2620)
* fix make air-absorption runtime configurable again
* disable console logging for unitsync
* git: "develop" is now the developing branch, master will contain releases from now
* adjust log-levels for some messages
* added http://springrts.com/dl/buildbot/default/develop/LATEST + http://springrts.com/dl/buildbot/default/master/LATEST

===12. October 2011===
==== 82.8.1-30-g5dbb98b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...82.8.1-30-g5dbb98b in detail]):

* new versioning scheme RC12 (see [http://springrts.com/phpbb/viewtopic.php?p=501948#p501948 the related forum thread])
* fixed logging on windows
* record WARNING and higher log levels to stderr, normal log to stdout
* fixed some pathfinder issues
* many bug-fixes

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26745 Feedback forum thread]

===6. September 2011===
==== 0.82.3-3386-gefb020b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3295-g000fac6...0.82.3-3386-gefb020b in detail]):

* fixed win32 installer (it installed always in non-portable mode)
* fix memory corruption in stacked transports
* Fix SetUnitWeaponState "range" fails for Cannon
* fix bumpmapped water on ATI-cards
* fixed possible lua-errors ([http://springrts.com/mantis/view.php?id=2511 #2511])
* allow resources_map to specify groundFX textures for CEGs using CSimpleGroundFlash ([http://springrts.com/mantis/view.php?id=2632 #2632])
* added a [https://github.com/spring/spring/commit/fd7eb8dde6289394bd69ccae4709c01629461d27 validation test]

[http://springrts.com/phpbb/viewtopic.php?p=502559#p502559 Feedback forum thread]

=== 21. August 2011 ===
==== 0.82.3-3295-g000fac6 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
* sync error fixed, thanks to abma
* first test release that comes with a MacOS X App Bundle, thanks to daftalx

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26656 Feedback forum thread]

=== 29. June 2011 ===
==== 0.82.3-2365-g82c3187 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
* Fixes an issue in engine supplied Lua code plus other random bug fixes.

=== 1. June 2011 ===
==== 0.82.3-2297-g26b01f8 ====

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
* [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
* [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
* [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)

[[Category: Development]]

Download Testing

2011-10-12T21:53:12Z

Hoijui: /* Spring Engine Testing Release */ master -> develop in links

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|{{EngineVersion:Stable}}]] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|{{EngineVersion:Testing}}]] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/develop/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/develop/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}_minimal-portable.7z portable] (Lobby not included)
<li> [http://springrts.com/dl/buildbot/default/develop/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/develop/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers (recommended):
* ''springlobby.info:8200''
* ''tizbac.dyndns.org:8200''

Or alternatively, configure your lobby so it does not insist using the release version of the engine:
* SpringLobby: set <code>DisableVersionCheck=1</code> in ''springlobby.conf''
* TASClient: press F6 (TODO check if correct (maybe F10?))

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}}), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

===Upcoming release===
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...develop in detail]):

* '''development switched to branch ''develop''!'''
to check on which branch you are, type: <code><pre>git branch</pre></code>
if you are on ''master'' type: <code><pre>git checkout -b develop origin/develop</pre></code>
* move not essential Lua widgets to cont/examples (#2537)
* allow to override the default data-dir locations with env vars USERPROFILE and PROGRAMDATA on windows
* add MoveCtrl.SetGunshipMoveTypeData control over airStrafe
* fix Skirmish AIs saturate command/sec limit of player (#2541)
* fix wake-projectiles after /water 2
* fix Repeat commands involving IDs remain after the objet destroyed (#2620)
* fix make air-absorption runtime configurable again
* disable console logging for unitsync
* git: "develop" is now the developing branch, master will contain releases from now
* adjust log-levels for some messages
* added http://springrts.com/dl/buildbot/default/develop/LATEST + http://springrts.com/dl/buildbot/default/master/LATEST

===12. October 2011===
==== 82.8.1-30-g5dbb98b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...82.8.1-30-g5dbb98b in detail]):

* new versioning scheme RC12 (see [http://springrts.com/phpbb/viewtopic.php?p=501948#p501948 the related forum thread])
* fixed logging on windows
* record WARNING and higher log levels to stderr, normal log to stdout
* fixed some pathfinder issues
* many bug-fixes

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26745 Feedback forum thread]

===6. September 2011===
==== 0.82.3-3386-gefb020b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3295-g000fac6...0.82.3-3386-gefb020b in detail]):

* fixed win32 installer (it installed always in non-portable mode)
* fix memory corruption in stacked transports
* Fix SetUnitWeaponState "range" fails for Cannon
* fix bumpmapped water on ATI-cards
* fixed possible lua-errors ([http://springrts.com/mantis/view.php?id=2511 #2511])
* allow resources_map to specify groundFX textures for CEGs using CSimpleGroundFlash ([http://springrts.com/mantis/view.php?id=2632 #2632])
* added a [https://github.com/spring/spring/commit/fd7eb8dde6289394bd69ccae4709c01629461d27 validation test]

[http://springrts.com/phpbb/viewtopic.php?p=502559#p502559 Feedback forum thread]

=== 21. August 2011 ===
==== 0.82.3-3295-g000fac6 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
* sync error fixed, thanks to abma
* first test release that comes with a MacOS X App Bundle, thanks to daftalx

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26656 Feedback forum thread]

=== 29. June 2011 ===
==== 0.82.3-2365-g82c3187 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
* Fixes an issue in engine supplied Lua code plus other random bug fixes.

=== 1. June 2011 ===
==== 0.82.3-2297-g26b01f8 ====

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
* [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
* [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
* [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)

[[Category: Development]]

Download Testing

2011-10-12T18:18:58Z

Hoijui: /* Upcoming release */ yet more minor fixes (preview different then rela page, ARG!)

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|{{EngineVersion:Stable}}]] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|{{EngineVersion:Testing}}]] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}_minimal-portable.7z portable] (Lobby not included)
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers (recommended):
* ''springlobby.info:8200''
* ''tizbac.dyndns.org:8200''

Or alternatively, configure your lobby so it does not insist using the release version of the engine:
* SpringLobby: set <code>DisableVersionCheck=1</code> in ''springlobby.conf''
* TASClient: press F6 (TODO check if correct (maybe F10?))

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}}), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

===Upcoming release===
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...develop in detail]):

* '''development switched to branch ''develop''!'''
to check on which branch you are, type: <code><pre>git branch</pre></code>
if you are on ''master'' type: <code><pre>git checkout -b develop origin/develop</pre></code>
* move not essential Lua widgets to cont/examples (#2537)
* allow to override the default data-dir locations with env vars USERPROFILE and PROGRAMDATA on windows
* add MoveCtrl.SetGunshipMoveTypeData control over airStrafe
* fix Skirmish AIs saturate command/sec limit of player (#2541)
* fix wake-projectiles after /water 2
* fix Repeat commands involving IDs remain after the objet destroyed (#2620)
* fix make air-absorption runtime configurable again
* disable console logging for unitsync
* git: "develop" is now the developing branch, master will contain releases from now
* adjust log-levels for some messages
* added http://springrts.com/dl/buildbot/default/develop/LATEST + http://springrts.com/dl/buildbot/default/master/LATEST

===12. October 2011===
==== 82.8.1-30-g5dbb98b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...82.8.1-30-g5dbb98b in detail]):

* new versioning scheme RC12 (see [http://springrts.com/phpbb/viewtopic.php?p=501948#p501948 the related forum thread])
* fixed logging on windows
* record WARNING and higher log levels to stderr, normal log to stdout
* fixed some pathfinder issues
* many bug-fixes

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26745 Feedback forum thread]

===6. September 2011===
==== 0.82.3-3386-gefb020b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3295-g000fac6...0.82.3-3386-gefb020b in detail]):

* fixed win32 installer (it installed always in non-portable mode)
* fix memory corruption in stacked transports
* Fix SetUnitWeaponState "range" fails for Cannon
* fix bumpmapped water on ATI-cards
* fixed possible lua-errors ([http://springrts.com/mantis/view.php?id=2511 #2511])
* allow resources_map to specify groundFX textures for CEGs using CSimpleGroundFlash ([http://springrts.com/mantis/view.php?id=2632 #2632])
* added a [https://github.com/spring/spring/commit/fd7eb8dde6289394bd69ccae4709c01629461d27 validation test]

[http://springrts.com/phpbb/viewtopic.php?p=502559#p502559 Feedback forum thread]

=== 21. August 2011 ===
==== 0.82.3-3295-g000fac6 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
* sync error fixed, thanks to abma
* first test release that comes with a MacOS X App Bundle, thanks to daftalx

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26656 Feedback forum thread]

=== 29. June 2011 ===
==== 0.82.3-2365-g82c3187 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
* Fixes an issue in engine supplied Lua code plus other random bug fixes.

=== 1. June 2011 ===
==== 0.82.3-2297-g26b01f8 ====

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
* [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
* [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
* [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)

[[Category: Development]]

Download Testing

2011-10-12T18:15:48Z

Hoijui: /* Upcoming release */ minor formatting fixes

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|{{EngineVersion:Stable}}]] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|{{EngineVersion:Testing}}]] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}_minimal-portable.7z portable] (Lobby not included)
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers (recommended):
* ''springlobby.info:8200''
* ''tizbac.dyndns.org:8200''

Or alternatively, configure your lobby so it does not insist using the release version of the engine:
* SpringLobby: set <code>DisableVersionCheck=1</code> in ''springlobby.conf''
* TASClient: press F6 (TODO check if correct (maybe F10?))

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}}), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

===Upcoming release===
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...develop in detail]):

'''development switched to branch ''develop''!'''

to check on which branch you are, type:
<code><pre>git branch</pre></code>
if you are on "master" type:
<code><pre>git checkout origin/development -b development</pre></code>
* move not essential Lua widgets to cont/examples (#2537)
* allow to override the default data-dir locations with env vars USERPROFILE and PROGRAMDATA on windows
* add MoveCtrl.SetGunshipMoveTypeData control over airStrafe
* fix Skirmish AIs saturate command/sec limit of player (#2541)
* fix wake-projectiles after /water 2
* fix Repeat commands involving IDs remain after the objet destroyed (#2620)
* fix make air-absorption runtime configurable again
* disable console logging for unitsync
* git: "develop" is now the developing branch, master will contain releases from now
* adjust log-levels for some messages
* added http://springrts.com/dl/buildbot/default/develop/LATEST + http://springrts.com/dl/buildbot/default/master/LATEST

===12. October 2011===
==== 82.8.1-30-g5dbb98b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...82.8.1-30-g5dbb98b in detail]):

* new versioning scheme RC12 (see [http://springrts.com/phpbb/viewtopic.php?p=501948#p501948 the related forum thread])
* fixed logging on windows
* record WARNING and higher log levels to stderr, normal log to stdout
* fixed some pathfinder issues
* many bug-fixes

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26745 Feedback forum thread]

===6. September 2011===
==== 0.82.3-3386-gefb020b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3295-g000fac6...0.82.3-3386-gefb020b in detail]):

* fixed win32 installer (it installed always in non-portable mode)
* fix memory corruption in stacked transports
* Fix SetUnitWeaponState "range" fails for Cannon
* fix bumpmapped water on ATI-cards
* fixed possible lua-errors ([http://springrts.com/mantis/view.php?id=2511 #2511])
* allow resources_map to specify groundFX textures for CEGs using CSimpleGroundFlash ([http://springrts.com/mantis/view.php?id=2632 #2632])
* added a [https://github.com/spring/spring/commit/fd7eb8dde6289394bd69ccae4709c01629461d27 validation test]

[http://springrts.com/phpbb/viewtopic.php?p=502559#p502559 Feedback forum thread]

=== 21. August 2011 ===
==== 0.82.3-3295-g000fac6 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
* sync error fixed, thanks to abma
* first test release that comes with a MacOS X App Bundle, thanks to daftalx

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26656 Feedback forum thread]

=== 29. June 2011 ===
==== 0.82.3-2365-g82c3187 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
* Fixes an issue in engine supplied Lua code plus other random bug fixes.

=== 1. June 2011 ===
==== 0.82.3-2297-g26b01f8 ====

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
* [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
* [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
* [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)

[[Category: Development]]

Template:EngineVersion:Testing

2011-10-12T18:13:23Z

Hoijui:

82.8.1-30-g5dbb98b

Template:EngineVersion:Testing:ReleaseDate

2011-10-12T18:13:19Z

Hoijui:

12. October 2011

Download Testing

2011-10-12T18:12:49Z

Hoijui: new testing release 12. October 2011

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|{{EngineVersion:Stable}}]] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|{{EngineVersion:Testing}}]] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}_minimal-portable.7z portable] (Lobby not included)
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers (recommended):
* ''springlobby.info:8200''
* ''tizbac.dyndns.org:8200''

Or alternatively, configure your lobby so it does not insist using the release version of the engine:
* SpringLobby: set <code>DisableVersionCheck=1</code> in ''springlobby.conf''
* TASClient: press F6 (TODO check if correct (maybe F10?))

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}}), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

===Upcoming release===
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...develop in detail]):

'''development switched to develop branch!''' when using git, to check on which branch you are, type <code><pre>git branch</pre></code>
if you're on "master" type:
<code><pre>git checkout origin/development -b development</pre></code>

* move not essential lua widgets to cont/examples (#2537)
* allow to override the default data-dir locations with env vars USERPROFILE and PROGRAMDATA on windows
* add MoveCtrl.SetGunshipMoveTypeData control over airStrafe
* fix Skirmish AIs saturate command/sec limit of player (#2541)
* fix wake-projectiles after /water 2
* fix Repeat commands involving IDs remain after the objet destroyed (#2620)
* fix make air-absorption runtime configurable again
* disable console logging for unitsync
* git: "develop" is now the developing branch, master will contain releases from now
* adjust log-levels for some messages
* added http://springrts.com/dl/buildbot/default/develop/LATEST + http://springrts.com/dl/buildbot/default/master/LATEST

===12. October 2011===
==== 82.8.1-30-g5dbb98b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...82.8.1-30-g5dbb98b in detail]):

* new versioning scheme RC12 (see [http://springrts.com/phpbb/viewtopic.php?p=501948#p501948 the related forum thread])
* fixed logging on windows
* record WARNING and higher log levels to stderr, normal log to stdout
* fixed some pathfinder issues
* many bug-fixes

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26745 Feedback forum thread]

===6. September 2011===
==== 0.82.3-3386-gefb020b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3295-g000fac6...0.82.3-3386-gefb020b in detail]):

* fixed win32 installer (it installed always in non-portable mode)
* fix memory corruption in stacked transports
* Fix SetUnitWeaponState "range" fails for Cannon
* fix bumpmapped water on ATI-cards
* fixed possible lua-errors ([http://springrts.com/mantis/view.php?id=2511 #2511])
* allow resources_map to specify groundFX textures for CEGs using CSimpleGroundFlash ([http://springrts.com/mantis/view.php?id=2632 #2632])
* added a [https://github.com/spring/spring/commit/fd7eb8dde6289394bd69ccae4709c01629461d27 validation test]

[http://springrts.com/phpbb/viewtopic.php?p=502559#p502559 Feedback forum thread]

=== 21. August 2011 ===
==== 0.82.3-3295-g000fac6 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
* sync error fixed, thanks to abma
* first test release that comes with a MacOS X App Bundle, thanks to daftalx

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26656 Feedback forum thread]

=== 29. June 2011 ===
==== 0.82.3-2365-g82c3187 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
* Fixes an issue in engine supplied Lua code plus other random bug fixes.

=== 1. June 2011 ===
==== 0.82.3-2297-g26b01f8 ====

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
* [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
* [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
* [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)

[[Category: Development]]

Download Testing

2011-10-11T21:14:03Z

Hoijui: /* Spring Engine Testing Release */ moved the tech and license logos to the About page

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|{{EngineVersion:Stable}}]] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|{{EngineVersion:Testing}}]] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}_minimal-portable.7z portable] (Lobby not included)
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers (recommended):
* ''springlobby.info:8200''
* ''tizbac.dyndns.org:8200''

Or alternatively, configure your lobby so it does not insist using the release version of the engine:
* SpringLobby: set <code>DisableVersionCheck=1</code> in ''springlobby.conf''
* TASClient: press F6 (TODO check if correct (maybe F10?))

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}}), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

===Upcoming release===
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...develop in detail]):

'''development switched to develop branch!''' when using git, to check on which branch you are, type <code><pre>git branch</pre></code>
if you're on "master" type:
<code><pre>git checkout origin/development -b development</pre></code>

* move not essential lua widgets to cont/examples (#2537)
* allow to override the default data-dir locations with env vars USERPROFILE and PROGRAMDATA on windows
* add MoveCtrl.SetGunshipMoveTypeData control over airStrafe
* fix Skirmish AIs saturate command/sec limit of player (#2541)
* fix wake-projectiles after /water 2
* fix Repeat commands involving IDs remain after the objet destroyed (#2620)
* fix make air-absorption runtime configurable again
* disable console logging for unitsync
* git: "develop" is now the developing branch, master will contain releases from now
* adjust log-levels for some messages
* added http://springrts.com/dl/buildbot/default/develop/LATEST + http://springrts.com/dl/buildbot/default/master/LATEST

===6. September 2011===
==== 0.82.3-3386-gefb020b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3295-g000fac6...0.82.3-3386-gefb020b in detail]):

* fixed win32 installer (it installed always in non-portable mode)
* fix memory corruption in stacked transports
* Fix SetUnitWeaponState "range" fails for Cannon
* fix bumpmapped water on ATI-cards
* fixed possible lua-errors ([http://springrts.com/mantis/view.php?id=2511 #2511])
* allow resources_map to specify groundFX textures for CEGs using CSimpleGroundFlash ([http://springrts.com/mantis/view.php?id=2632 #2632])
* added a [https://github.com/spring/spring/commit/fd7eb8dde6289394bd69ccae4709c01629461d27 validation test]

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26745 Feedback forum thread]

=== 21. August 2011 ===
==== 0.82.3-3295-g000fac6 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
* sync error fixed, thanks to abma
* first test release that comes with a MacOS X App Bundle, thanks to daftalx

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26656 Feedback forum thread]

=== 29. June 2011 ===
==== 0.82.3-2365-g82c3187 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
* Fixes an issue in engine supplied Lua code plus other random bug fixes.

=== 1. June 2011 ===
==== 0.82.3-2297-g26b01f8 ====

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
* [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
* [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
* [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)

[[Category: Development]]

About

2011-10-11T21:13:16Z

Hoijui: /* Features */ added Logos of used licenses and tech, as discussed in engine dev the meeting of 10. October 2011

=About=
Spring is a project aiming to create a new and versatile RTS Engine.

= System requirements =
=== Minimum ===
* 1.6 GHz single core CPU with SSE
* 512 MB of RAM
* 128 MB Nvidia Geforce 6xxx graphics card
* Roughly 200 MB of hard drive space, depending on how many maps and games you download with the installer.

=== Recommended ===
* 2 GHz single core CPU or better
* 2 GB of RAM or more
* 512 MB Geforce 8xxx Series graphics card or greater
* 4 GB of hard drive space to accommodate more maps and games

For more information on system requirements see [[Requirements]] or for help see [[FAQ]].

= Features =
* Many different [[Games]], made just for Spring.
* Play online, on a LAN or offline Single Player.
* Large battles limited only by the power of your computer; support for up to 5000 units.
* Large, highly detailed maps in which to wage those battles, fully 3D with deformable terrain, forest fires, dynamic and reflective water, and custom skyboxes.
* Several camera modes, allowing for anything to be viewed from almost any angle.
* Fully 3D combat in land, sea, and air, with realistic weapon trajectories (physics engine).
* Complex 3rd party AIs, some of which are quite good.
* An extremely powerful UI, designed to minimize unnecessary micromanagement.
* Frequent additions and bugfixes.
{|style="margin-top:15px; background:rgb(255,255,255); border: 1px solid rgba(0,0,0,0.5); border-radius: 12px 12px 12px 12px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.5), inset 0 10px 8px rgba(255,255,255,0.3);" |
|
[[Image:Logo_GPL_gplv3-127x51.png|127px|GPL Logo]]
[[Image:Logo_OpenSource_Osi_standard_logo.png|85px|OpenSource Logo]]
[[Image:Logo_Ogl.jpg|170px|OpenGL Logo]]
[[Image:Logo_OpenAL_Openal_c.png|140px|OpenAL Logo]]
[[Image:Logo_SDL_Sdl_powered.png|110px|SDL Logo]]
|}

= Development =
* Open source (GPLv2).
* Multi-plattform (Windows & Linux, MacOSX in progress).
* Written in C++, using OpenGL, Lua, Assimp, streflop, OpenAL, FreeType2, DevIL, SDL, GLEW, boost, 7zip, zlib, libVorbis, libOgg.

= Content Creation =
Thanks to the ability of the Spring engine to run lots of different content, it is possible to
* [http://springrts.com/wiki/Game_and_Unit_development Build your own games.]
* [http://springrts.com/wiki/Map_development Create your own maps.]
* [http://springrts.com/wiki/AI:Development Program AI players] in several languages.

=Authors=
A list of the Spring developers can be found on the [[Authors]] page.

=Press=
[[Press|History of Spring and its games in the press]]

File:Logo Ogl.jpg

2011-10-11T21:07:04Z

Hoijui: OpenGL logo from http://www.opengl.org/about/logos/ download from: http://www.opengl.org//about/logos/download login: springrts passwd: /\ (not literally these two chars, stupid!)

OpenGL logo from http://www.opengl.org/about/logos/
download from: http://www.opengl.org//about/logos/download
login: springrts
passwd: /\ (not literally these two chars, stupid!)

File:Distributions-freebsd.png

2011-10-08T15:52:01Z

Hoijui: http://openiconlibrary.sourceforge.net Free/Open Source Icons: All these are icons are free and open source. That means they are free to use, modify, and redistribute, without any cost. They can be used for commercial and non-commercial projects or produ

http://openiconlibrary.sourceforge.net

Free/Open Source Icons: All these are icons are free and open source. That means they are free to use, modify, and redistribute, without any cost. They can be used for commercial and non-commercial projects or products, royalty free. The only requirement is that they remain free and open source, and you have to give credit where credit is due. So if you use the icons in your project, you have to offer the icons or any derivatives of the icons with the same free/open license.

Download Testing

2011-10-04T10:12:44Z

Hoijui: added OpenSource-Initiative, GPL, OpenAL & SDL logos

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|{{EngineVersion:Stable}}]] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|{{EngineVersion:Testing}}]] ({{EngineVersion:Testing:ReleaseDate}})
</ul>
{|style="margin-top:15px; background:rgb(255,255,255); border: 1px solid rgba(0,0,0,0.5); border-radius: 12px 12px 12px 12px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.5), inset 0 10px 8px rgba(255,255,255,0.3);" |
|
[[Image:Logo_GPL_gplv3-127x51.png|100px|GPL Logo]]
[[Image:Logo_OpenSource_Osi_standard_logo.png|75px|OpenSource Logo]]
[[Image:Logo_OpenAL_Openal_c.png|100px|OpenAL Logo]]
[[Image:Logo_SDL_Sdl_powered.png|90px|SDL Logo]]
|}

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}_minimal-portable.7z portable] (Lobby not included)
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers (recommended):
* ''springlobby.info:8200''
* ''tizbac.dyndns.org:8200''

Or alternatively, configure your lobby so it does not insist using the release version of the engine:
* SpringLobby: set <code>DisableVersionCheck=1</code> in ''springlobby.conf''
* TASClient: press F6 (TODO check if correct (maybe F10?))

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}}), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

===Upcoming release===
Changes ([http://github.com/spring/spring/compare/0.82.3-3386-gefb020b...develop in detail]):

'''development switched to develop branch!''' when using git, to check on which branch you are, type <code><pre>git branch</pre></code>
if you're on "master" type:
<code><pre>git checkout origin/development -b development</pre></code>

* move not essential lua widgets to cont/examples (#2537)
* allow to override the default data-dir locations with env vars USERPROFILE and PROGRAMDATA on windows
* add MoveCtrl.SetGunshipMoveTypeData control over airStrafe
* fix Skirmish AIs saturate command/sec limit of player (#2541)
* fix wake-projectiles after /water 2
* fix Repeat commands involving IDs remain after the objet destroyed (#2620)
* fix make air-absorption runtime configurable again
* disable console logging for unitsync
* git: "develop" is now the developing branch, master will contain releases from now
* adjust log-levels for some messages
* added http://springrts.com/dl/buildbot/default/develop/LATEST + http://springrts.com/dl/buildbot/default/master/LATEST

===6. September 2011===
==== 0.82.3-3386-gefb020b ====
Changes ([http://github.com/spring/spring/compare/0.82.3-3295-g000fac6...0.82.3-3386-gefb020b in detail]):

* fixed win32 installer (it installed always in non-portable mode)
* fix memory corruption in stacked transports
* Fix SetUnitWeaponState "range" fails for Cannon
* fix bumpmapped water on ATI-cards
* fixed possible lua-errors ([http://springrts.com/mantis/view.php?id=2511 #2511])
* allow resources_map to specify groundFX textures for CEGs using CSimpleGroundFlash ([http://springrts.com/mantis/view.php?id=2632 #2632])
* added a [https://github.com/spring/spring/commit/fd7eb8dde6289394bd69ccae4709c01629461d27 validation test]

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26745 Feedback forum thread]

=== 21. August 2011 ===
==== 0.82.3-3295-g000fac6 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
* sync error fixed, thanks to abma
* first test release that comes with a MacOS X App Bundle, thanks to daftalx

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26656 Feedback forum thread]

=== 29. June 2011 ===
==== 0.82.3-2365-g82c3187 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
* Fixes an issue in engine supplied Lua code plus other random bug fixes.

=== 1. June 2011 ===
==== 0.82.3-2297-g26b01f8 ====

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
* [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
* [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
* [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)

[[Category: Development]]

Main Page

2011-10-04T10:09:21Z

Hoijui: fox border

{|border="0" cellpadding="4" cellspacing="1"
| width="50%" valign="top" style="background: #41545c; border: 1px solid rgba(0,0,0,0.5); border-radius: 12px 0px 0px 12px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.3), inset 0 10px 8px rgba(255,255,255,0.1);" |
== 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...

'''[[Spreading Spring]]''' Read before advertising.

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

'''[[The Lighter Side Of Spring]]''' Humour, comics and quotations.
| width="50%" valign="top" style="background: #41545c; border: 1px solid rgba(0,0,0,0.5); border-radius: 0px 12px 12px 0px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.3), inset 0 10px 8px rgba(255,255,255,0.1);" |
== Development ==
'''[[Game_and_Unit_development#Mod_development|Game Development]]''' Lots of links to valuable Articles and forum threads regarding Game/Unit Development.

'''[[Map_development|Map Development]]''' Tutorials and other useful information for creating maps.

'''[[Development:Getting_Started|Engine Development]]''' Starting point for engine 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.

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

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

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

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

{|style="margin-top:15px; background:rgba(180,45,19,0.5); border: 1px solid rgba(0,0,0,0.5); border-radius: 12px 12px 12px 12px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.5), inset 0 10px 8px rgba(255,255,255,0.3);" |
|
<center>'''This wiki needs your help!'''</center>

''"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. If you see anything here where a change would be helpful, please put it in. We are currently working together at the [[Spring:WikiToDo|Wiki ToDo]] page to help coordinate improvements.

Any contributions you make to this Wiki are in the public domain. If you need help with the wiki markup, the [[Help:Editing|help page]] is an excellent resource.

You need to log in to edit a page.
|}

__NOTOC__
__NOEDITSECTION__
[[Category:Spring]]

Main Page

2011-10-04T10:09:21Z

Hoijui: fox border

File:Logo SDL Sdl powered.png

2011-10-04T09:39:00Z

Hoijui: source: http://www.libsdl.de/logo/

source: http://www.libsdl.de/logo/

File:Logo OpenSource Osi standard logo.png

2011-10-04T09:37:58Z

Hoijui: source: http://opensource.org/trademark

source: http://opensource.org/trademark

File:Logo OpenAL Openal c.png

2011-10-04T09:36:58Z

Hoijui: source: http://connect.creativelabs.com/openal/Logos/Forms/AllItems.aspx

source: http://connect.creativelabs.com/openal/Logos/Forms/AllItems.aspx

File:Logo GPL gplv3-127x51.png

2011-10-04T09:35:40Z

Hoijui: source: http://www.gnu.org/graphics/license-logos.html

source: http://www.gnu.org/graphics/license-logos.html

Building Spring on Windows

2011-09-24T13:59:32Z

Hoijui: /* Install MinGW */

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

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

Template:Obtaining The Source Code

2011-09-20T12:18:37Z

Hoijui: /* Optional AI's */ language

=== Current ===
'''(For playing online)'''

{{Tarballs}}

=== Development Sources from Git ===
'''(Bleeding-edge, unstable code for development and testing)'''

'''[http://github.com/spring/spring Spring project page at github]'''
[http://status.github.com (status page)]

Git clone URL for the master repo:

'''git://github.com/spring/spring.git'''

This will also allow you to make a patch out of the changes you make to the code, and send it to one of the developers with repository access. If you are new to git and github, you may want to have a look at [http://help.github.com/ this guide] to get you started.

Assuming the GIT command line client is installed, you can clone the repository with

<code><pre>git clone git://github.com/spring/spring.git</pre></code>

and update it with:

<code><pre>git pull --rebase</pre></code>

If github is unavailable or slow, there is a mirror:

<code>git://springrts.git.sourceforge.net/gitroot/springrts/springrts</code>

==Optional AI's==
If you want to also compile the AI's, you have to type
<code><pre>
git submodule sync
git submodule update --init
</pre></code>

to update the submodules, you have to execute the same commands again.

Development:Getting Started

2011-09-20T12:14:38Z

Hoijui: /* Keep track what others do */ master -> develop

[[Engine_Development|Development]] < Getting Started

=Starting Spring Development=
'''NOTE: Outlined below is information on assisting with the development of the Spring source itself. For information about developing a mod (units, widgets, maps, etc.) see the [[Mod_and_Unit_development]] page.'''

'''Even if you are developing a mod, it is highly recommended that you get the engine source. Engine source + full text search: DO IT.'''

==Overview==
To start development, you will need:
#To read the [[Coding_Standards]]
#The latest version of the source
#A good code manipulation program: [[Development_IDEs]]
#Compiling your modified source (see instructions above)

==Learning C++==
You will need to know C++ to modify or understand Spring's source code. If you are interested in learning C++, see [[Learning_CPP]]

However please note that badly designed code (code created by a C++ novice for example), even if working will likely not be included in the spring code. Spring is a large project, and therefore it is necessary to stay away from hack jobs and create general solutions to problems.

=Source Code Documentation=
The [http://springrts.com/doxygen/ doxygen documentation] can provide an overview about the source, directory structure and its dependencies. Unfortunately, there is no server running it, so you need to make them on your own, to do this, install doxygen and run "doxygen" in spring source directory (will take some time).

An explanation on how the code is executed in game can be found in the [[Spring Engine Code]]
page.

==Development Guidelines==
Before starting to make modifications to the source, take a look at the [[development guidelines]] which outlines some important things to think about. To find something interesting to work on, look for todos in the [http://springrts.com/phpbb/viewforum.php?f=60 forum]. You can also check in the forums to see what others are doing. If you do edit the code, please add [[Doxygen style comments]] to the code, which will then enhance the source code documentation.

==Keep track what others do==
If you develop with others, you need to know what they do. You can browse the source [http://github.com/spring/spring/tree/develop at our github-page], and there is a [http://github.com/feeds/spring/commits/spring/develop commit newsfeed].

==Buildbot and Stacktrace translator==
A buildbot server is [http://springrts.com:7778/waterfall?reload=60 here] available to automatically compile Spring, the default AIs and make the installer. It can also translate stacktraces directly from uploaded infolog.txt files.

=Important Developer Tasks=
==[[Engine_Profiling|Profiling]]==
==[[Debugging_sync_errors|How to debug SyncErrors]]==

=How to get your code included=
If you create something that you think should be included in the official source tree: make a fork on github.com of spring (master branch) and ask in the [http://springrts.com/phpbb/viewforum.php?f=12 development forum] to get it included / feedback.

'''When developing, use the master branch!'''

=Spring Engine TODO list=
If you want to code something, look into the [http://springrts.com/phpbb/viewforum.php?f=60 New Developers Forum] for TODOs.
There is also a [http://spring.clan-sy.com/phpbb/viewforum.php?f=21 feature request forum], which may give you some ideas. Don't be overwhelmed by the sheer number of (silly) requests though!

Alternatively, you may just search the code for the [http://en.wikipedia.org/wiki/Comment_%28computer_programming%29#Tags famous comment tags],
for example on linux: <code>grep -r "TODO" rts</code>

=Development links=
* [http://github.com/spring/spring/ View the latest source in a web browser]
* [http://springrts.com/doxygen/ Doxygen documentation]
* [http://springrts.com/mantis/ Bug Tracking System]
* [http://springrts.com:7778/waterfall?reload=60 buildbot]
* [http://springrts.com/dl/buildbot/ buildbot builds]
* [http://springrts.com/dl/docs/unitsync/group__unitsync__api.html Unitsync API docs]
* [[Development:Minutes|Developer Meetings]]

Old:
* [http://springrts.com/dl/spring-vc8libs.exe Development libraries for Visual Studio 2005]
* [http://spring.jobjol.nl/show_file.php?id=860 Spring base content files]
* [http://developer.berlios.de/projects/taspring-linux BerliOS project page]
* [https://lists.berlios.de/mailman/listinfo/taspring-linux-commit Commit mailing list]
* [http://sourceforge.net/projects/springrts SourceForge project page]
* [http://springrts.com/svn/spring/ TASServer, TASClient and Web site Subversion repository]
* [http://springrts.com/websvn/ TASServer, TASClient and Web site WebSVN]

[[Category: Development]]

Lobby Development

2011-09-06T08:15:38Z

Hoijui: /* TASServer */

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

=Documentation=

==Protocol==
* [http://springrts.com/dl/tasclient/ProtocolDescription.xml HTML] (may be out of date)
* [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=
There are currently four working public lobby clients available.

==SpringLobby==
cross-platform,
C++,
by BrainDamage &
koshi

SpringLobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It uses the ''wxWidgets'' library. You can browse the sources and submit issues on its [http://springlobby.info/ website].

==Zero-K==
Windows,
C#,
by Licho & quantum

[https://code.google.com/p/zero-k/ Zero-K project page]

==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].

==TASClient==
Windows,
Delphi,
by Satirik

You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here:
http://springrts.com/dl/tasclient/TASClientLatest.7z

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

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

[http://code.google.com/p/qtlobby/ project page]

=Libraries and frameworks=

==Spring-PythonBotFramework==
cross-platform,
Python,
unmaintained

A bot framework written in python

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

==TASServer==
cross-platform,
Java,
hoijui

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

==UberServer==
cross-platform,
Python,
by aegis

The primary lobby server currently running on springrts.com. All protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and TASServer. You can get more information and download uberserver at the [https://github.com/lunixbochs/uberserver github page]

[[Category: Lobbies]]

Download Testing

2011-08-31T05:47:21Z

Hoijui: /* Lobby */ explain how to disable version-check

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|'''{{EngineVersion:Stable}}''']] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|'''{{EngineVersion:Testing}}''']] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}_minimal-portable.7z portable] (Lobby not included)
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers (recommended):
* ''springlobby.info:8200''
* ''tizbac.dyndns.org:8200''

Or alternatively, configure your lobby so it does not insist using the release version of the engine:
* SpringLobby: set <code>DisableVersionCheck=1</code> in ''springlobby.conf''
* TASClient: press F6 (TODO check if correct (maybe F10?))

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}}), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

=== 21. August 2011 ===
==== 0.82.3-3295-g000fac6 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
* sync error fixed, thanks to abma
* first test release that comes with a MacOS X App Bundle, thanks to daftalx

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26656 Feedback forum thread]

=== 29. June 2011 ===
==== 0.82.3-2365-g82c3187 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
* Fixes an issue in engine supplied Lua code plus other random bug fixes.

=== 1. June 2011 ===
==== 0.82.3-2297-g26b01f8 ====

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
* [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
* [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
* [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)

Lua SyncedRead

2011-08-30T08:35:32Z

Hoijui: /* Test Building */ add Pos2BuildPos param facing

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

== Game ==

=== Special TeamID Variables ===
(those special TeamIDs are not supported by all functions) 
'''Spring.ALL_UNITS''' 
'''Spring.MY_UNITS''' 
'''Spring.ALLY_UNITS''' 
'''Spring.ENEMY_UNITS'''

'''Spring.GetGaiaTeamID'''
( ) -> number teamID

=== GameStates ===
'''Spring.IsGodModeEnabled'''
( ) -> boolean
'''Spring.IsCheatingEnabled'''
( ) -> boolean
'''Spring.IsDevLuaEnabled'''
( ) -> boolean
'''Spring.IsEditDefsEnabled'''
( ) -> boolean
'''Spring.AreHelperAIsEnabled'''
( ) -> boolean
'''Spring.FixedAllies'''
( ) -> nil | boolean

'''Spring.IsGameOver'''
( ) -> boolean

=== Rules ===
Those functions allow to save data per Game,Team and Unit. The advantage of it is that it can be read from anywhere (even from LuaUI and AIs!) 
'''Spring.GetRulesInfoMap''' REMOVED in 0.82!
( ) -> { [key1] = string value1, [key2] = string value2, ... }
( string "key" ) -> string

'''Spring.GetGameRulesParam'''
( number ruleIndex | string ruleName ) -> number value
'''Spring.GetGameRulesParams'''
( ) -> nil | { [ruleIndex1] = {[ruleName1] = number value1}, [ruleIndex2] = {[ruleName2] = number value2}, ... }

'''Spring.GetTeamRulesParam'''
( number teamID, number index | string ruleName ) -> nil | number value
'''Spring.GetTeamRulesParams'''
( number teamID ) -> nil | { [ruleIndex1] = {[ruleName1] = number value1}, [ruleIndex2] = {[ruleName2] = number value2}, ... }

'''Spring.GetUnitRulesParam'''
( number unitID, number index | string ruleName ) -> nil | number value
'''Spring.GetUnitRulesParams'''
( number unitID ) -> nil | { [ruleIndex1] = {[ruleName1] = number value1}, [ruleIndex2] = {[ruleName2] = number value2}, ... }

=== Mod-/Map-Options ===
'''Spring.GetModOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }
'''Spring.GetMapOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }

=== Speed/Time ===
'''Spring.GetGameSpeed'''
( ) -> number userSpeedFactor, number speedFactor, boolean paused
'''Spring.GetGameFrame'''
( ) -> number frameNum%dayFrames, number frameNum/dayFrames
'''Spring.GetGameSeconds'''
( ) -> number seconds

=== Vectors ===
'''Spring.GetWind'''
( ) -> number dirX, number dirY, number dirZ,
number strength, number normDirX, number normDirY, number normDirZ

'''Spring.GetHeadingFromVector'''
( number x, number z ) -> number heading
'''Spring.GetVectorFromHeading'''
( number heading ) -> number x, number z

== Sides/Factions ==
'''Spring.GetSideData'''
( string sideName ) -> nil | string startUnit, string caseSensitiveSideName
( number sideID ) -> nil | string sideName, string startUnit, string caseSensitiveSideName
( ) -> { [1] = { sideName=string,caseName=string,startUnit=string}, [2] = .., .. }

== Teams ==
=== StartBoxes/StartPositions ===
'''Spring.GetAllyTeamStartBox'''
( number allyID ) -> nil | number xmin, number zmin, number xmax, number zmax
'''Spring.GetTeamStartPosition'''
( number teamID ) -> nil | number x, number y, number z

=== Player,Team,Ally Lists/Info ===
'''Spring.GetPlayerList'''
( [number teamID = -1 | boolean onlyActive = false] [, number teamID | boolean onlyActive])
-> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID = -1] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

'''Spring.GetPlayerInfo'''
( number playerID ) ->
nil | string "name", (PRE-0.83: in synced code this is "SYNCED_NONAME"!)
boolean active,
boolean spectator,
number teamID,
number allyTeamID,
number pingTime,
number cpuUsage,
string country,
number rank
table customPlayerKeys
'''Spring.GetPlayerControlledUnit'''
( number playerID ) -> nil | number unitID

'''Spring.GetAIInfo'''
( number teamID ) ->
number skirmishAIID,
string name,
number hostingPlayerID,
string shortName, (synced => "SYNCED_NOSHORTNAME"; non-local => "UNKNOWN")
string version, (synced => "SYNCED_NOVERSION"; non-local => "UNKNOWN")
table options (synced & non-local => empty-table)
Note: Before 0.82, the first argument was teamID, and then every other argument with a shifted position.

'''Spring.GetAllyTeamInfo'''
( number allyteamID ) -> nil | table customTeamKeys

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamID,
number leader, (:= a player id)
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam,
table customTeamKeys,
number incomeMultiplier
'''Spring.GetTeamResources'''
( number teamID, string "metal" | "energy" ) ->
nil | number currentLevel,
number storage,
number pull,
number income,
number expense,
number share,
number sent,
number received
'''Spring.GetTeamUnitStats'''
( number teamID ) ->
nil | number killed,
number died,
number capturedBy,
number capturedFrom,
number received,
number sent
'''Spring.GetTeamResourceStats''' 0.82 and later
( number teamID, string "metal" | "energy" ) ->
nil | number used,
number produced,
number excessed,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID [, number startIndex [, number endIndex = startIndex ]]) ->
nil |
number cur_max_index |
{
[1] = {
"time" = number,
"frame" = number,
"metalUsed" = number,
"metalProduced" = number,
"metalExcess" = number,
"metalReceived" = number,
"metalSent" = number,
"energyUsed" = number,
"energyProduced" = number,
"energyExcess" = number,
"energyReceived" = number,
"energySent" = number,
"damageDealt" = number,
"damageReceived" = number,
"unitsProduced" = number,
"unitsDied" = number,
"unitsReceived" = number,
"unitsSent" = number,
"unitsCaptured" = number,
"unitsOutCaptured" = number,
"unitsKilled" = number
}, ...
}
if called with just teamID as argument it returns the current possible range for startIndex/endIndex :={1..cur_max_index}

'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

=== Teams/PlayersAllied ===
'''Spring.AreTeamsAllied'''
( number teamID1, number teamID2 ) -> nil | boolean
'''Spring.ArePlayersAllied'''
( number playerID1, number playerID2 ) -> nil | boolean

== Units ==
=== GetUnits ===
'''Spring.GetAllUnits'''
( ) -> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetTeamUnits'''
( number teamID ) -> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitsSorted'''
( number teamID ) -> nil |
unitDefTable = {
[number unitDefID] = { [1] = [number unitID], etc... },
etc...
}
'''Spring.GetTeamUnitsCounts'''
( number teamID ) -> nil | countTable = { [number unitDefID] = count, etc... }
'''Spring.GetTeamUnitsByDefs'''
( number teamID, number unitDefID | { number unitDefID1, ... } )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitDefCount'''
( number teamID, number unitDefID ) -> nil | number count
'''Spring.GetTeamUnitCount'''
( number teamID ) -> nil | number count

'''Spring.GetUnitsInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInBox'''
( number xmin, number ymin, number zmin,
number xmax, number ymax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInSphere'''
( number x, number y, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInCylinder'''
( number x, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInPlanes'''
( planes = { [1] = { number nx, number ny, number nz, number d }, etc... } )
-> nil | unitTable = { [1] = number unitID, etc... }

plane normals point towards accepted space,
so the acceptance criteria for each plane is:
radius = unit radius
px, py, pz = unit position
[(nx * px) + (ny * py) + (nz * pz) + (d - radius)] <= 0


'''Spring.GetUnitNearestAlly'''
( number unitID [, number range ] ) -> nil | number unitID
'''Spring.GetUnitNearestEnemy'''
( number unitID [, number range [, bool useLOS]] ) -> nil | number unitID

=== Unit Informations ===
'''Spring.ValidUnitID'''
( number unitID ) -> boolean
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitTooltip'''
( number unitID ) -> nil | string tooltip
'''Spring.GetUnitDefID'''
( number unitID ) -> nil | number unitDefID
'''Spring.GetUnitTeam'''
( number unitID ) -> nil | number teamID
'''Spring.GetUnitAllyTeam'''
( number unitID ) -> nil | number allyID
'''Spring.GetUnitLineage''' Removed from version 0.83.x 
( number unitID ) -> nil | number lineage | number lineage, boolean lineageIsRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
'''Spring.GetUnitArmored''' armorMultiple new in version 0.83.x
( number unitID ) -> nil | boolean armored, number armorMultiple
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitMetalExtraction''' 0.82+ and later
( number unitID ) -> nil | number
'''Spring.GetUnitExperience'''
( number unitID ) -> nil | number experience
'''Spring.GetUnitStates'''
( number unitID ) -> nil | {
"firestate" = number,
"movestate" = number,
"repeat" = boolean,
"cloak" = boolean,
"active" = boolean,
"trajectory" = boolean,
["autoland" = boolean,]
["autorepairlevel" = number,]
["loopbackattack" = boolean]
}
'''Spring.GetUnitIsActive'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitIsCloaked'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitSelfDTime'''
( number unitID ) -> nil | number
'''Spring.GetUnitStockpile'''
( number unitID ) -> nil | number numStockpiled, number numStockpileQued,
number buildPercent
'''Spring.GetUnitHeight'''
( number unitID ) -> nil | number
'''Spring.GetUnitRadius'''
( number unitID ) -> nil | number
'''Spring.GetUnitPosition'''
( number unitID ) -> nil | number x, number y, number z
returns the center position of the unit (midpos).

'''Spring.GetUnitBasePosition'''
( number unitID ) -> nil | number x, number y, number z
returns the bottom of the unit.

'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
'''Spring.GetUnitVelocity'''
( number unitID ) -> nil | number velx, number vely, number velz
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding''' returns what unit a constructor/factory is currently building
( number unitID ) -> nil | number unitID
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID [, number weaponID = -1] ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitFuel'''
( number unitID ) -> nil | number
'''Spring.GetUnitFlanking'''
( number unitID, string "dir" ) -> nil | number x, number y, number z
( number unitID, string "mode" | "moveFactor" | "minDamage" | "maxDamage" ) -> nil | number
( number unitID ) -> nil | number mode, number modilityAdd,
number minDamage, number maxDamage, number dirX, number dirY, number dirZ
'''Spring.GetUnitSensorRadius'''
( number unitID, string type ) -> nil | number radius
possible types are: airLos, radar, sonar, seismic, radarJammer & sonarJammer
'''Spring.GetUnitLosState''' raw is only available in gadgets
( number unitID [, number allyTeamID [, boolean raw] ] ) -> nil |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' (returns the distance of 2 units)
( number unitID1, number unitID2 [, boolean 2D ] ) -> nil | number distance
'''Spring.GetUnitDefDimensions'''
( number unitDefID ) -> nil |
{
"height" = number,
"radius" = number,
"midx" = number,
"minx" = number,
"maxx" = number,
"midy" = number,
"miny" = number,
"maxy" = number,
"midz" = number,
"minz" = number,
"maxz" = number
}
'''Spring.GetUnitWeaponVectors'''
( number unitID, number weaponNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirY, number dirZ
'''Spring.GetUnitWeaponState'''
( number unitID, number weaponNum ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame, number salvoLeft, number numStockpiled
( number unitID, number weaponNum, string tag ) -> nil | number
`tag` can be:
"reloadState" == "reloadFrame"
"reloadTime"
"accuracy"
"sprayAngle"
"range"
"projectileSpeed"
"burst"
"burstRate"
"projectiles"
'''Spring.GetUnitLastAttacker'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitLastAttackedPiece''''
( number unitID ) -> nil | string pieceName, number gameframe
'''Spring.GetUnitMoveTypeData''' new in version 0.80+
( number unitID ) -> nil | { movetype data }
'''Spring.GetUnitCollisionVolumeData'''
( number unitID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled
'''Spring.GetUnitPieceCollisionVolumeData'''
( number unitID, number pieceID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled

=== Unit Pieces ===
'''Spring.GetUnitVectors'''
( number unitID ) -> nil | {frontX,frontY,frontZ}, {upX,upY,upZ}, {rightX,rightY,rightZ}
'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
Returns piece position in unit space

'''Spring.GetUnitPieceDirection'''
( number unitID, number piece ) -> number dirx, number diry, number dirz
Consider this broken. It returns reverse direction in piece space (i.e. vertex(0)-vertex(1)) for pieces with >= 2 vertices and (1,1,1) for pieces with < 2 vertices)

'''Spring.GetUnitPieceMatrix'''
( number unitID, number piece ) -> { [1] = number, ... , [16] = number }
'''Spring.GetUnitPieceList'''
( number unitID ) -> { [1] = string "piecename", ... , [pieceNumN] = string "piecename" }
'''Spring.GetUnitPieceMap'''
( number unitID ) -> { "piecename1" = pieceNum1, ... , "piecenameN" = pieceNumN }
'''Spring.GetUnitPieceInfo'''
( number unitID, number piece ) -> {
"name" = string "piecename",
"isEmpty" = boolean,
"children" = { [1] = string "piecename", ... },
"min" = { [1] = number x, [2] = number y, [3] = number z },
"max" = { [1] = number x, [2] = number y, [3] = number z },
"offset" = { [1] = number x, [2] = number y, [3] = number z },
}
'''Spring.GetUnitScriptPiece'''
( number unitID [, number scriptPiece ] )
-> nil | { scriptPieceNum = number modelPieceNum } | number modelPieceNum

This functions translate the COB ScriptPiece numbers into the ModelPiece numbers (the set of ScriptPieces is a subset of the ModelPieces, means #ScriptPieces <= #ModelPieces), which is used in all other functions (the "number piece" means always the modelpiece). So if you get via Cob2Lua a pieceID you have to translate it with this function. Btw the COB ScriptPiece number is equal with the piece position in the piece definition in your cob/bos.

'''Spring.GetUnitScriptNames'''
( number unitID )
-> { "cobpiecename1" = ScriptPieceNum1, ... , "cobpiecenameN" = ScriptPieceNumN }
'''Spring.GetUnitPiecePosDir'''
( number unitID, number pieceNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirZ, number dirY
Returns piece position and direction in world space. The direction (dirX, dirY, dirZ) is not necessarily normalized. The position is defined as the position of the first vertex of the piece and it defines direction as the direction in which the line from the first vertex to the second vertex points.

=== CommandQueues ===

'''Spring.GetUnitCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}

'''Spring.GetCommandQueue''' (same as Spring.GetUnitCommands)
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}
'''Spring.GetFullBuildQueue'''
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetRealBuildQueue''' (cleans the buildqueue of things the unit can't build itself)
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetFactoryCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}
'''Spring.GetFactoryCounts''' (used to get the buildqueue of a factory, seems screwed o_O)
( number unitID [, number count [, boolean addCMDs ] ] ) -> nil | commandQueueTable = {
[2] = { [number unitDefID | number -cmdID] = number count }, ...
}

=== Command Descriptions/Buttons ===
'''Spring.GetUnitCmdDescs'''
( number unitID [, number startIndex [, number endIndex ] ] ) -> nil | {
[1] = {
"id" = number,
"type" = number,
"name" = string,
"action" = string,
"tooltip" = string,
"texture" = string,
"cursor" = string,
"hidden" = boolean,
"disabled" = boolean,
"showUnique" = boolean,
"onlyTexture" = boolean,

"params" = { [1] = string, ... }
}, ...
}
'''Spring.FindUnitCmdDesc'''
( number unitID, number cmdID ) -> nil | number index

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetFeaturesInSphere'''
( number x, number y, number z, number radius )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetFeaturesInCylinder'''
( number x, number z, number radius )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> nil | { [1] = number featureID, ... }

=== Feature Informations ===
'''Spring.ValidFeatureID'''
( number featureID ) -> boolean
'''Spring.GetFeatureDefID'''
( number featureID ) -> nil | number featureDefID
'''Spring.GetFeatureTeam'''
( number featureID ) -> nil | number teamID
'''Spring.GetFeatureAllyTeam'''
( number featureID ) -> nil | number allyID
'''Spring.GetFeatureHealth'''
( number featureID ) -> nil | number health, number maxHealth, number resurrectProgress
'''Spring.GetFeatureHeight'''
( number featureID ) -> nil | number
'''Spring.GetFeatureRadius'''
( number featureID ) -> nil | number
'''Spring.GetFeaturePosition'''
( number featureID ) -> nil | number x, number y, number z
'''Spring.GetFeatureDirection'''
( number featureID ) -> nil | number dirx, number diry, number dirz
'''Spring.GetFeatureHeading'''
( number featureID ) -> nil | number heading
'''Spring.GetFeatureResources'''
( number featureID ) -> nil | number RemainingMetal, number maxMetal,
number RemainingEnergy, number maxEnergy, number reclaimLeft
'''Spring.GetFeatureNoSelect'''
( number featureID ) -> nil | boolean noSelect
'''Spring.GetFeatureResurrect'''
( number featureID ) -> nil | string UnitDefName, number buildFacing

== COB ==
'''Spring.GetCOBUnitVar'''
( number unitID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBTeamVar'''
( number teamID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBAllyTeamVar'''
( number allyID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBGlobalVar'''
( integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY

== Ground ==
=== Ground Informations ===
Elevation is y. Water level is always at y=0. Ground height can be changed during play (terraform or deformation).

'''Spring.GetGroundHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundOrigHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundNormal'''
( number x, number z ) -> number x, number y, number z
'''Spring.GetGroundInfo'''
( number x, number z ) -> string "Type", number metal, number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed,
number shipSpeed, boolean receiveTracks
'''Spring.GetGroundBlocked'''
( number x, number z |
number x1, number z1, number x2, number z2 )
-> nil | string "feature", number featureID | string "unit", number unitID
'''Spring.GetGroundExtremes'''
( ) -> nil | number minHeight, number maxHeight

'''Spring.GetSmoothMeshHeight'''
( number x, number z ) -> number y

=== Test Building ===
'''Spring.TestBuildOrder'''
( number unitDefID, number x, number y, number z, number facing)
-> number blocking [,number featureID]

blocking can be:
0 - blocked
1 - mobile unit in the way
2 - free (or if featureID is != 0 then with a blocking feature that can be reclaimed)
facing can be:
0, "s", "south"
1, "e", "east"
2, "n", "north"
3, "w", "west"
'''Spring.Pos2BuildPos''' optional param ''facing'' supported in 0.83 and later
( number unitDefID, number x, number y, number z[, number facing] ) -> nil | number x, number y, number z

=== PathFinding ===
'''Spring.GetUnitEstimatedPath'''
( number unitID ) -> nil | {
[1] = { x,y,z }, ...
},{
[1] = startIdxOfDetailedPath,
[2] = startIdxOfDetailedEstimatedPath1,
[3] = startIdxOfDetailedEstimatedPath2,
}
GetUnitEstimatedPath() returns 2 tables:
1 table the waypoints and 1 table with indices (in the waypoint table)
when a new (more lazy) pathfinding algorithm begins.
So the waypoint table contains 3 different levels of details.

=== LOS ===
'''Spring.IsPosInLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInRadar'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInAirLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.GetPositionLosState'''
( number x, number y, number z [, number allyID] )
-> boolean LosOrRadar, boolean inLos, boolean inRadar
'''Spring.GetClosestValidPosition''' //NOT FINISHED YET
( number unitDefID, number x, number z, number r ) -> nil

== Projectiles ==

'''Spring.GetProjectilesInRectangle'''

( number xmin, number zmin, number xmax, number zmax
[, boolean excludeWeaponProjectiles
[, boolean excludePieceProjectiles] ] )
-> nil | projectileTable = { [1] = number projectileID, etc... }

'''Spring.GetProjectileName'''
( number projectileID ) -> nil | string name
'''Spring.GetProjectileType'''
( number projectileID ) -> nil | boolean weapon, boolean piece
'''Spring.GetProjectilePosition'''
( number projectileID ) -> nil | number px, number py, number pz
'''Spring.GetProjectileVelocity'''
( number projectileID ) -> nil | number vx, number vy, number vz
'''Spring.GetProjectileGravity'''
( number projectileID ) -> nil | number gravity
'''Spring.GetProjectileSpinAngle'''
( number projectileID ) -> nil | number angle
'''Spring.GetProjectileSpinSpeed'''
( number projectileID ) -> nil | number spinSpeed
'''Spring.GetProjectileSpinVec'''
( number projectileID ) -> nil | number x, number y, number z

[[category: Lua]]

VirtualFileSystem

2011-08-26T12:46:58Z

Hoijui: /* Archive Hierarchy */ make list ordered

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

=VFS=
The Virtual File System is an unified layer to access the different archives used at runtime. So you can access map, game & config files via the same interface.

==Archive Hierarchy==
When loading a new archive (sdz, sd7, sdd) it overrides existing file references in the VFS, so the order archives are loaded is very important. So here it is (in reverse):

# raw file system (only for unsynced data)
# map
## map archive itself
## map dependencies
## maphelper.sdz (engine supplied)
# game
## game archive itself
## game dependencies
## springcontent.sdz (engine supplied)
### bitmaps.sdz (engine supplied)

(top most are checked first when accessing a file -> map overrides game files!)

==Extra Informations==
Spring's VFS is '''lowercase''' only.
Also it is '''extremely''' recommended to use linux style path separators, e.g. "foo/bar.txt" and not "foo\bar.txt".

=Engine Read Files=
The engine access a few files directly, most of them are lua files which access other files themselves.
Here the list of files that must exist in the VFS (some of them don't have to be in the game/map archive cause there are fallback solutions in springcontent.sdz & maphelper.sdz):

* ./
** anims/
*** [[MouseCursors|cursornormal.bmp/png]]
** gamedata/
*** [[defs.lua|defs.lua]]
*** [[Explosions.lua|explosions.lua]]
*** [[Explosion_alias.lua|explosion_alias.lua]]
*** [[Icontypes.lua|icontypes.lua]]
*** [[Messages.lua|messages.lua]]
*** [[Modrules.lua|modrules.lua]]
*** [[Resources.lua|resources.lua]]
*** [[Resources.lua|resources_map.lua]]
*** [[Sidedata.lua|sidedata.lua]]
*** [[Sounds.lua|sounds.lua]]
** luagaia/
*** main.lua
*** draw.lua
** luarules/
*** main.lua
*** draw.lua
** luaui/
*** main.lua
** shaders/
*** ?
** [[LuaAI.lua|luaai.lua]]
** [[Mapinfo.lua|mapinfo.lua]]
** [[Mapoptions.lua|mapoptions.lua]]
** [[Modinfo.lua|modinfo.lua]]
** [[Modoptions.lua|modoptions.lua]]
** [[Validmaps.lua|validmaps.lua]]

[[Category:gamedata]]

Download Testing

2011-08-24T08:21:19Z

Hoijui: /* Testing Version Archive */ allow to link to testing releases per date and git-describe, and allwo multiple testing releases on a single day

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|'''{{EngineVersion:Stable}}''']] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|'''{{EngineVersion:Testing}}''']] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}_minimal-portable.7z portable] (Lobby not included)
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers:
<ul>
<li> ''springlobby.info:8200''
<li> ''tizbac.dyndns.org:8200''
</ul>

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}}), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

=== 21. August 2011 ===
==== 0.82.3-3295-g000fac6 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
* sync error fixed, thanks to abma
* first test release that comes with a MacOS X App Bundle, thanks to daftalx

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].

[http://springrts.com/phpbb/viewtopic.php?f=12&t=26656 Feedback forum thread]

=== 29. June 2011 ===
==== 0.82.3-2365-g82c3187 ====

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
* Fixes an issue in engine supplied Lua code plus other random bug fixes.

=== 1. June 2011 ===
==== 0.82.3-2297-g26b01f8 ====

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
* [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
* [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
* [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)

Download Testing

2011-08-21T11:37:12Z

Hoijui: /* Windows */ fix portable link for real

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|'''{{EngineVersion:Stable}}''']] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|'''{{EngineVersion:Testing}}''']] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}_minimal-portable.7z portable] (Lobby not included)
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers:
<ul>
<li> ''springlobby.info:8200''
<li> ''tizbac.dyndns.org:8200''
</ul>

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}} ), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

=== 21. August 2011 ===
{|
| style="padding-right:60px"|
|
'''0.82.3-3295-g000fac6'''

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
<ul>
<li> sync error fixed, thanks to abma
<li> first test release that comes with a MacOS X App Bundle, thanks to daftalx
</ul>

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].
|}

=== 29. June 2011 ===
{|
| style="padding-right:60px"|
|
'''0.82.3-2365-g82c3187'''

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
<ul>
<li> Fixes an issue in engine supplied Lua code plus other random bug fixes.
</ul>
|}

=== 21. June 2011 ===
{|
| style="padding-right:60px"|
|
'''0.82.3-2297-g26b01f8'''

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
<ul>
<li> [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
<li> [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
<li> [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
</ul>

This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)
|}

Download Testing

2011-08-21T11:32:30Z

Hoijui: /* Windows */ fix portable link

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|'''{{EngineVersion:Stable}}''']] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|'''{{EngineVersion:Testing}}''']] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}_minimal_portable.7z portable]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers:
<ul>
<li> ''springlobby.info:8200''
<li> ''tizbac.dyndns.org:8200''
</ul>

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}} ), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

=== 21. August 2011 ===
{|
| style="padding-right:60px"|
|
'''0.82.3-3295-g000fac6'''

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
<ul>
<li> sync error fixed, thanks to abma
<li> first test release that comes with a MacOS X App Bundle, thanks to daftalx
</ul>

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].
|}

=== 29. June 2011 ===
{|
| style="padding-right:60px"|
|
'''0.82.3-2365-g82c3187'''

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
<ul>
<li> Fixes an issue in engine supplied Lua code plus other random bug fixes.
</ul>
|}

=== 21. June 2011 ===
{|
| style="padding-right:60px"|
|
'''0.82.3-2297-g26b01f8'''

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
<ul>
<li> [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
<li> [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
<li> [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
</ul>

This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)
|}

Download Testing

2011-08-21T11:02:50Z

Hoijui: Protected "Download Testing": prevent malware link infection ([edit=sysop] (indefinite) [move=sysop] (indefinite))

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|'''{{EngineVersion:Stable}}''']] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|'''{{EngineVersion:Testing}}''']] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}_portable.7z portable]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers:
<ul>
<li> ''springlobby.info:8200''
<li> ''tizbac.dyndns.org:8200''
</ul>

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}} ), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

=== 21. August 2011 ===
{|
| style="padding-right:60px"|
|
'''0.82.3-3295-g000fac6'''

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
<ul>
<li> sync error fixed, thanks to abma
<li> first test release that comes with a MacOS X App Bundle, thanks to daftalx
</ul>

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].
|}

=== 29. June 2011 ===
{|
| style="padding-right:60px"|
|
'''0.82.3-2365-g82c3187'''

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
<ul>
<li> Fixes an issue in engine supplied Lua code plus other random bug fixes.
</ul>
|}

=== 21. June 2011 ===
{|
| style="padding-right:60px"|
|
'''0.82.3-2297-g26b01f8'''

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
<ul>
<li> [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
<li> [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
<li> [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
</ul>

This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)
|}

Download Testing

2011-08-21T10:54:23Z

Hoijui: /* Testing Version Archive */ reverse archive entry order

= Spring Engine Testing Release =

<ul>
<li> stable: [[Download|'''{{EngineVersion:Stable}}''']] ({{EngineVersion:Stable:ReleaseDate}})
<li> testing: [[#{{EngineVersion:Testing:ReleaseDate}}|'''{{EngineVersion:Testing}}''']] ({{EngineVersion:Testing:ReleaseDate}})
</ul>

== Get It ==

=== Windows ===

{|
| style="padding-right:10px"| [[Image:Distributions-windows.png]]
|
<ul>
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}.exe installer]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/spring_{{EngineVersion:Testing}}_portable.7z portable]
<li> [http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/ whole build]
</ul>
|}

=== Linux ===

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
|
<ol>
<li> '''get the source'''
<ol>
<li> creating the repo (first time only): 
<code>git clone git://github.com/spring/spring.git spring_src</code>
<li> update to latest sources: 
<code>cd spring_src && git fetch && git checkout {{EngineVersion:Testing}}</code>
</ol>
<li> '''build''' by following the [http://springrts.com/wiki/Building_Spring_on_Linux build from source] guide, or in short: 
<code>cmake -G "Unix Makefiles" . && make spring && sudo make install-spring</code>
</ol>
|}

=== Mac OS X ===

{|
| style="padding-right:10px"| [[Image:Distributions-mac-2.png]]
|
[http://springrts.com/dl/buildbot/default/master/{{EngineVersion:Testing}}/Spring_{{EngineVersion:Testing}}-MacOSX-10.6-SnowLeopard.zip '''App Bundle'''] (tested on 10.6 Snow-Leopard only)

In case the above fails, check out [[Spring_on_MacOSX|alternative ways]].
|}

== Lobby ==

Make sure your lobby client is configured to use the correct spring binary & unitsync!
On Linux, this will usually be ''/usr/local/bin/spring'' & ''/usr/local/lib/libunitsync.so''.

Use one of the test lobby servers:
<ul>
<li> ''springlobby.info:8200''
<li> ''tizbac.dyndns.org:8200''
</ul>

== Bugs and issues ==

Report in the [http://springrts.com/phpbb/viewforum.php?f=11 Help and Bugs] forum or on [http://springrts.com/mantis/main_page.php Mantis].
Remember to upload ''infolog.txt'' if you crash!

== Testing Version Archive ==

This is a list of all testing releases since the last stable release ({{EngineVersion:Stable}} ), and it represents all changes since then ([http://github.com/spring/spring/compare/{{EngineVersion:Stable}}...{{EngineVersion:Testing}} in detail]).

=== 21. August 2011 ===
{|
| style="padding-right:60px"|
|
'''0.82.3-3295-g000fac6'''

Changes ([http://github.com/spring/spring/compare/0.82.3-2365-g82c3187...0.82.3-3295-g000fac6 in detail]):
<ul>
<li> sync error fixed, thanks to abma
<li> first test release that comes with a MacOS X App Bundle, thanks to daftalx
</ul>

Game devs might be interested in [http://springrts.com/phpbb/viewtopic.php?f=14&t=26358 Make your game ready for the next release! (0.83)].
|}

=== 29. June 2011 ===
{|
| style="padding-right:60px"|
|
'''0.82.3-2365-g82c3187'''

Changes ([http://github.com/spring/spring/compare/0.82.3-2297-g26b01f8...0.82.3-2365-g82c3187 in detail]):
<ul>
<li> Fixes an issue in engine supplied Lua code plus other random bug fixes.
</ul>
|}

=== 21. June 2011 ===
{|
| style="padding-right:60px"|
|
'''0.82.3-2297-g26b01f8'''

Changes ([http://github.com/spring/spring/compare/0.82.6.1-119-g172334e...0.82.3-2297-g26b01f8 in detail]):
<ul>
<li> [http://springrts.com/phpbb/viewtopic.php?p=492411#p492411 removed n's in array-like Lua tables]
<li> [http://springrts.com/phpbb/viewtopic.php?f=14&t=23992 game end condition moved to Lua]
<li> [http://springrts.com/mantis/view.php?id=2477#bugnotes 3do solid colors appear as black (see Kloot's comment)]
</ul>

This test release is mainly intended for Game developers to make their game roughly compatible with the upcoming release.
There are still many, many known and unknown bugs in there.

''TODO'' add more docu here (other spring devs, please PM me!)
|}