Spring - User contributions [en]

Games

2016-11-30T22:42:45Z

8611z:

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

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

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

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

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

{|
|-
| <h2> [https://springrts.com/phpbb/viewforum.php?f=46 Star Wars: Imperial Winter] </h2>
|-
| [[Image:Imperial Winter assault.jpg|300px|link=https://springrts.com/phpbb/viewforum.php?f=46]]
| valign="top" | A Star Wars themed game set in the troubled post-Return of the Jedi era.
|-
| <h2> [https://springrts.com/phpbb/viewforum.php?f=69 Journeywar] </h2>
|-
| [[Image:JwLogo.jpg|300px|link=https://springrts.com/phpbb/viewtopic.php?f=69&t=23275&start=1180]]
| valign="top" | Journeywar is the final battle between Combine and Exobiotics. Join the fight and rediscover the HL- Universe from a new, strategic perspective. Download in Springlogbby as jw:test archive.
|}

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

{|
|-
|<h2> [http://springrts.com/wiki/Balanced_Annihilation Balanced Annihilation] </h2>
|-
| [[Image:BAScreenShot.jpg|300px|link=http://springrts.com/phpbb/viewforum.php?f=44]]
| valign="top" | Balanced Annihilation (BA) is an outdate cancer game and new versions feature random changes.

BA gameplay develops in stages of progressively heavier units with a growing economy. Many strategies are viable in BA, including focusing on control, aggression, defense, and other forms of insults.
|-
| <h2> [http://springfiles.com/spring/games/tech-annihilation-8 Tech Annihilation] </h2>
|-
| [[Image:Tech_Annihilation.png|300px|link=http://springfiles.com/spring/games/tech-annihilation-8]]
| valign="top" |This Game is bigger, greater and more epic! Tech your Commander from a tiny Commander to a Galactic Commander! (by ''[BoS]Senna'', currently no homepage)
|-
|<h2>[http://nota.machys.net/downloads NOTA]</h2>
|-
| [[Image:notAgame02.jpg|300px|link=http://nota.machys.net/downloads]]
| valign="top" | Not Original Total Annihilation is a rethink of the Total Annihilation universe with a focus on strategic, base oriented gameplay. With its revised unit scale, huge battles erupt engaging hundreds of units and scores of unit types. NOTA's completely rethought air and sea gameplay forces participation in all elements and places the tide of conflict in your hands.
|-
| <h2> [[XTA]] </h2>
|-
| [[Image:Screen508_s.jpg|300px|link=XTA]]
| valign="top" | Originally developed as a Total Annihilation game by the Swedish Yankspankers, XTA is the Original Public Game released with first versions of Spring. Development of this game by the SYs has stopped a while ago, but it is still played and actively developed by the community.
|
|}

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

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

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

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

[[Category: Games]]

SpringTutorialGame

2016-11-30T22:40:01Z

8611z: /* Spring Tutorial Game */

__notoc__
= Spring Tutorial Game =
[[File:SpringTutorialGame.jpg|thumb|256px|right|Spring Tutorial Game in action]]
Despite the name, this '''not''' an "official" project but was created by forum member [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=1561 knorke] until others forked it.

And despite being called "game" it is '''not''' meant to be a game that is made to be fun to play, nor is it a technical or graphics demo. If you are looking for those sort of things, check out the available [[Games]] or [[Gamedev:PublicRepos]].

== Purpose ==
This is basically a "Hello World" Spring game.

The idea is that most potential game devs will hopefully understand the examples and with the help of this wiki can build on them.

== Why not just use stuff from other games? ==
Most Spring games consist of hundreds of files, with scripts that can have thousands of lines of code. Furthermore some files are just ''wrong'' or outdated, comments are sparse etc.

That does not stop the games from working but clearly they are not the best examples to learn from;
The idea of this project is to have a basic game with some simple examples.

== There are just files! Why is there no guide to go along with this? ==
A good guide is [[The_Complete_Guide_To_Making_A_Spring_Game|this one by Ptsnoop]]

His "Empty Game" was also the base for this, see {{forumlink|topic=25831|title= original forum thread}}.

== Where can I get it? ==
[https://github.com/spring-archive/springtutorialgame Github repository] - unofficial fork after project was mothballed

[[Category:Game Dev]]

Talk:Building Spring on Linux

2016-05-28T11:47:00Z

8611z: test talk

==boost?==
Seems to me you also need boost filesystem and chrono given via libboost-filesystem-dev and libboost-chrono-dev on ubuntu-like systems. Can anyone else confirm this?

:gajop, you should sign your your posts on talker pages. also i have no about the question lol. [[User:8611z|8611z]] ([[User talk:8611z|talk]]) 13:47, 28 May 2016 (CEST)

Talk:Bugs

2016-05-28T11:45:01Z

8611z: /* why removed link to FAQ? */

==why removed link to FAQ?==
In last edit https://springrts.com/mediawiki/index.php?title=Bugs&curid=3038&diff=29679&oldid=28643 the link to [[FAQ]] on the [[Bugs]] page was removed because "outdated" and instead players are now supposed to look for solutions "near the top of the relevent bugtrackers." The problemsin FAQ, especially [[FAQ:trouble]] are still relevant.
Imo a FAQ is way better so find solutions to known problems, some are "impossible" to find in bugtrackers.
Also lists to project pages (like here the list of bugtrackers) always go out of date.
[[User:8611z|8611z]] ([[User talk:8611z|talk]]) 18:01, 28 October 2015 (CET)

:re-added the link to enigne trouble faq [[User:8611z|8611z]] ([[User talk:8611z|talk]]) 13:45, 28 May 2016 (CEST)

Bugs

2016-05-28T11:42:31Z

8611z: /* See if the bug and a solution are already known */ FAQ back in

== See if the bug and a solution are already known ==
Check that it isn't already visible in the FAQ of the project or somewhere near the top of the relevent bugtracker:

[[FAQ:trouble|Spring Engine trouble shooting FAQ]] & [https://springrts.com/mantis Spring Engine bugtracker (mantis)]

[https://github.com/springlobby/springlobby/issues Spring Lobby (github)]

[https://github.com/dansan/spring-replay-site/issues Replay Site (github)]

Or see the relevent project pages for links to other bug trackers. There is also a [https://springrts.com/phpbb/viewforum.php?f=11 helps and bugs forum].

== How to report bugs==
To report a bug, please give a description, what is going wrong and '''how it can be reproduced'''. what steps are required to reproduce it? If required to reproduce the bug add a script or/and a link to the Game/Map.

==Logfiles, screenshots, replays==
* Always attach [[infolog.txt]], as it contains system/driver/version info and if spring crashed. Click the link to see what it is and how to share it.

* Attach a replay: often Bugs can't be reproduced, its often better to see something than to only read about that.

* Screenshots are taken with the F12 key and saved in the \screenshots\ folder. You can attach them to postings or upload on site such as: [http://www.imgur.com imgur.com] , [http://www.abload.de abload.de]

* If a dev asks you for more information, please answer his questions.

* Try to avoid endless discussions why a bug was introduced, be polite!

* If you want more tips for a good bug-report, please read "[http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to Report Bugs Effectively]"

'''The better the bug-report, the better the chances, that it will be fixed!'''

== Where to report bugs==

Bugs in individual games should be reported to the game developers - contact the game developer first if you are unsure.

===As a player who needs help or thinks they found a bug===
Do not be afraid to ask for help [http://springrts.com/phpbb/viewforum.php?f=11 in the forum.] Read the guidelines above so people can help you as good as possible.

===As a developer who found a bug===
If you found a bug in the Spring Engine, please report it to the [http://springrts.com/mantis bug tracker].
Before [http://springrts.com/mantis/bug_report_page.php filling a bug], please look if someone else [http://springrts.com/mantis/view_all_bug_page.php already has reported] this issue.

Bugs should be reported for latest release version and latest develop version.

[[Category:Engine Dev]]

Lua SyncedRead

2016-05-25T07:36:41Z

8611z: Undo revision 29987 by Forboding angel (talk)

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

== Game ==

=== Special TeamID Variables ===
<font color="red" style="font-weight:600">(those special TeamIDs are not supported by all functions)</font><br>
'''Spring.ALL_UNITS'''<br>
'''Spring.MY_UNITS'''<br>
'''Spring.ALLY_UNITS'''<br>
'''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

=== RulesParams ===
<span class=note>Those functions allow to save data per Game,Team and Unit.<br>The advantage of it is that it can be read from anywhere (even from LuaUI and AIs!)</span><br>
<span class=warning>string values are new since 95.0</span>

'''Spring.GetRulesInfoMap''' <span class=warning>REMOVED in 0.82!</span>
( ) -> { [key1] = string value1, [key2] = string value2, ... }
( string "key" ) -> string

'''Spring.GetGameRulesParam'''
( number ruleIndex | string ruleName ) -> nil | number value | string value
'''Spring.GetGameRulesParams'''
( ) -> nil | { [ruleIndex1] = {[ruleName1] = number | string value1}, ... }

'''Spring.GetTeamRulesParam'''
( number teamID, number index | string ruleName ) -> nil | number value | string value
'''Spring.GetTeamRulesParams'''
( number teamID ) -> nil | { [ruleIndex1] = {[ruleName1] = number | string value1}, ... }

'''Spring.GetUnitRulesParam'''
( number unitID, number index | string ruleName ) -> nil | number value | string value
'''Spring.GetUnitRulesParams'''
( number unitID ) -> nil | { [ruleIndex1] = {[ruleName1] = number | string value1}, ... }

=== Mod-/Map-Options ===
'''Spring.GetModOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }
'''Spring.GetMapOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }

! bool values are not transfered from C to Lua correctly, so in IF theres needed to use this condition:<br><br>
<font color="#55ee99">"if (tonumber(Spring.GetModOptions.exampleOption) == 1) then...end"</font><br>
not only:<br>
<span class="warning">"if (Spring.GetModOptions.exampleOption) then...end"</span>

=== Speed/Time ===
'''Spring.GetGameSpeed''' <span class="warning">As of 98.0 moved to [[Lua_UnsyncedRead]] due to desyncs in replays/demos</span>
( ) -> 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", <span class="note">(PRE-83.0: in synced code this is "SYNCED_NONAME"!)</span>
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, <span class="note">(synced => "SYNCED_NOSHORTNAME"; non-local => "UNKNOWN")</span>
string version, <span class="note">(synced => "SYNCED_NOVERSION"; non-local => "UNKNOWN")</span>
table options <span class="note">(synced & non-local => empty-table)</span>
<span class="warning">Note: Before 0.82, the first argument was teamID, and then every other argument with a shifted position.</span>

'''Spring.GetAllyTeamInfo'''
( number allyteamID ) -> nil | table customTeamKeys

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamID,
number leader, <span class=note>(:= a player id)</span>
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''' <span class="note">0.82 and later</span>
( 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
}, ...
}
<span class="note">if called with just teamID as argument it returns the current possible range for startIndex/endIndex :={1..cur_max_index}</span>

'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

Returns string containing name of AI defined in file LuaAI.lua as name="<AI name>". Maybe it returns whole table with all values there, so maybe depends, but in my LuaAI.lua name is on first position...

=== 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... }
<font color="#55ee99">
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
</font>

'''Spring.GetUnitNearestAlly'''
( number unitID [, number range ] ) -> nil | number unitID
'''Spring.GetUnitNearestEnemy'''
( number unitID [, number range [, bool useLOS]] ) -> nil | number unitID

<span class="note">Post 95.0 this no longer returns neutral units</span>

=== Unit Informations ===
'''Spring.ValidUnitID'''
( number unitID ) -> boolean
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean
<span class="note">Returns false if unit exists and is alive, true for a brief period of time after unit dies, nil otherwise<br/>
keep this in mind when using (not Spring.GetUnitIsDead())</span>

'''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''' <span class="warning"> Removed from version 0.83.x</span> <br>
( 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
build Progress is returned as floating Point between 0.0 and 1.0

'''Spring.GetUnitArmored''' <span class="warning">armorMultiple new in version 0.83.x</span>
( number unitID ) -> nil | boolean armored, number armorMultiple
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitMaxRange'''
( number unitID ) -> nil | number maxEngagementRange
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitHarvestStorage'''
( number unitID ) -> nil | number metal
<span class = "note">See also {{xtaglink|Gamedev:UnitDefs|harvestStorage}} UnitDef tag.</span>

'''Spring.GetUnitMetalExtraction''' <span class="note">0.82+ and later</span>
( 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.GetUnitBlocking''' {{new|85.0}}
( number unitID ) -> nil | boolean blocking, boolean crushable
{{new|95.0}} Now return values are:
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

'''Spring.GetUnitPosition'''
( number unitID, [, boolean midPos [, boolean aimPos ] ] ) ->
nil |
number bpx, number bpy, number bpz
[, number mpx, number mpy, number mpz ]
[, number apx, number apy, number apz ]
<span class="note">since 89.0, returns the base (default), middle or aim position of the unit.</span>

'''Spring.GetUnitBasePosition''' <span class="warning">Deprecated in 89.0, use GetUnitPosition</span>
( number unitID ) -> nil | number x, number y, number z
<font color="#55ee99">returns the bottom of the unit.</font>

'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
<span class="note">returns the direction vector</span>

'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
<span class="note">returns heading directions used in COB scripts</span>

'''Spring.GetUnitRotation''' {{New|95.0}}
(number unitID) --> nil | number pitch, number yaw, number roll
<span class="note">Marked as (WIP) in changelog</span>

'''Spring.GetUnitVelocity''' <span class="warning">velw new in 95.0</span>
( number unitID ) -> nil | number velx, number vely, number velz, number velLength
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding''' <font color="#55ee99">returns what unit a constructor/factory is currently building</font>
( number unitID ) -> nil | number unitID
'''Spring.GetUnitCurrentBuildPower''' {{new|92.0}}
( number unitID ) -> nil | number buildPower
'''Spring.GetUnitNanoPieces'''
( number unitID ) -> nil | { [1] = number piece1, etc ... }
'''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
<font color="#55ee99">possible types are:<br>los, airLos, radar, sonar, seismic, radarJammer & sonarJammer</font>

'''Spring.GetUnitLosState''' <font color="red">raw is only available in gadgets</font>
( number unitID [, number allyTeamID [, boolean raw] ] ) -> nil | number raw |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' <span class="warning">surfaceDist new in 95.0</span>
( number unitID1, number unitID2 [, boolean 2D] [, boolean surfaceDist] ) -> nil | number distance
<font color="#55ee99">returns the distance of 2 units, surfaceDist calculates the distance between the unitsphere surfaces instead of their midpos</font>

'''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.GetUnitLastAttacker'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitLastAttackedPiece''''
( number unitID ) -> nil | string pieceName, number gameframe
'''Spring.GetUnitMoveTypeData''' <span class="note">new in version 0.80+</span>
( 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 Weapon Informations ====
'''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
<span class=note>`tag` can be:
"reloadState" == "reloadFrame"
"reloadTime"
"accuracy"
"sprayAngle"
"range"
"projectileSpeed"
"burst"
"burstRate"
"projectiles"</span>

'''Spring.GetUnitWeaponDamages''' {{new|101.0}}
( number unitID, number weaponNum | "selfDestruct" | "explode", string tag ) -> nil | number
<span class=note>`tag` can be:
"paralyzeDamageTime"
"impulseFactor"
"impulseBoost"
"craterMult"
"craterBoost"
"dynDamageExp"
"dynDamageMin"
"dynDamageRange"
"dynDamageInverted"
"craterAreaOfEffect"
"damageAreaOfEffect"
"edgeEffectiveness"
"explosionSpeed"
- or -
an armor type index to get the damage against it.</span>

'''Spring.GetUnitWeaponVectors'''
( number unitID, number weaponNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirY, number dirZ

'''Spring.GetUnitWeaponTryTarget''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponTestTarget''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponTestRange''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponHaveFreeLineOfFire''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponCanFire''' {{new|95.0}}
( number unitID, number weaponNum ) -> nil | boolean canFire

'''Spring.GetUnitWeaponTarget''' {{new|95.0}}
( number unitID, number weaponNum ) -> nil |
number 0 | number 1, bool isUserTarget, number unitID |
number 2, bool isUserTarget, { number posX, number posY, number posZ } |
number 3, bool isUserTarget, number ProjectileID

'''Spring.GetRadarErrorParams''' {{new|95.0}}
(number allyTeamID) --> nil |
number allyteamErrorSize, number baseErrorSize, number baseErrorMult

'''Spring.GetUnitPosErrorParams''' {{new|95.0}}
(number unitID) --> nil |
number posErrorVector.x, number posErrorVector.y, number posErrorVector.z,
number posErrorDelta.x, number posErrorDelta.y, number posErrorDelta.z,
number nextPosErrorUpdate

=== 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
<font color="#55ee99">Returns piece position in unit space. Also remember to multiply the x-axis value with -1 if you want move a piece to another piece.</font>

'''Spring.GetUnitPieceDirection''' <font color="red">Fixed since 101. Now returns the same direction as Spring.GetUnitPiecePosDir</font>
( number unitID, number piece ) -> number dirx, number diry, number dirz
'''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 },
"parent" = string "parentpiecename",
}
"parent" field {{New|95.0}}

'''Spring.GetUnitScriptPiece'''
( number unitID [, number scriptPiece ] )
-> nil | { scriptPieceNum = number modelPieceNum } | number modelPieceNum

<font color="#55ee99">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 <i>piece</i> definition in your cob/bos.</font>

'''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
<font color="#55ee99">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.</font>

=== CommandQueues ===
'''Spring.GetUnitCommands''' <br/>
'''Spring.GetCommandQueue''' <span class="note">(Alias)</span>
( number unitID, number count = 0 ) -> nil | number commandQueueSize {{new|96}}
( number unitID [, number count = -1] )
-> nil | table commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}

<font color="#55ee99">This function can trigger an error if called too often without passing a second parameter. Refer to [https://github.com/spring/spring/blob/92c54d5b15775c39a8c67b203c28fe9b9db51cea/rts/Lua/LuaSyncedRead.cpp#L3983-L3996 LuaSyncedRead.cpp#L3983-L3996]</font>

'''Spring.GetFullBuildQueue'''
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetRealBuildQueue''' <font color="#55ee99">(cleans the buildqueue of things the unit can't build itself)</font>
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetFactoryCommands'''
( number unitID, number count = 0 ) -> nil | number commandQueueSize {{new|96}}
( number unitID [, number count = -1 ] )
-> nil | table 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 )
-> featureTable = { [1] = number featureID, etc... }
'''Spring.GetFeaturesInSphere'''
( number x, number y, number z, number radius )
-> featureTable = { [1] = number featureID, etc... }
'''Spring.GetFeaturesInCylinder'''
( number x, number z, number radius )
-> featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> { [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, [, boolean midPos [, boolean aimPos ] ] ) ->
nil |
number bpx, number bpy, number bpz [,
number mpx, number mpy, number mpz [,
number apx, number apy, number apz ]]
<span class="note">since 89.0, returns the base (default), middle or aim position of the feature.</span>

'''Spring.GetFeatureVelocity''' {{new|95.0}}
( number featureID [, boolean norm] )
-> nil | number velx, number vely, number velz, number velLength

'''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
'''Spring.GetFeatureCollisionVolumeData'''
( number featureID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled

'''Spring.GetFeatureBlocking'''
(number featureID) --> boolean collidable, boolean crushable, boolean blocking
{{new|95.0}} Now return values are:
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

== 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 ===
<font color="#55ee99">Elevation is y. Water level is always at y=0. Ground height can be changed during play (terraform or deformation).</font>

'''Spring.GetGroundHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundOrigHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundNormal'''
( number x, number z [, smoothedNormal] ) -> number x, number y, number z, number slope
{{new|100.0}}<span class="warning">: smoothedNormal and slope</span>

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

'''Spring.GetMetalMapSize'''
( ) -> number sizeX, number sizeY

'''Spring.GetMetalAmount'''
( number x, number z ) -> number metalAmount
<span class="note">where x & z are in metal map coordinates (worldspace/16)</span>

'''Spring.GetMetalExtraction'''
( number x, number z ) -> number extractionAmount
<span class="note">where x & z are in metal map coordinates (worldspace/16)</span>

'''Spring.GetTerrainTypeData''' {{new|92.0}}
( number i )
-> nil | string "name", number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed, number shipSpeed,
boolean receiveTracks

=== Test Orders ===
'''Spring.TestMoveOrder'''
( number unitDefID, number x, number y, number z) -> boolean validMove
{{New|95.0}} parameters now are:
number unitDefID,
number pos.x, number pos.y, number pos.z
[, number dir.x
[, number dir.y
[, number dir.z
[, boolean testTerrain
[, boolean testObjects
[, boolean centerOnly ]]]]]]
) --> boolean

'''Spring.TestBuildOrder'''
( number unitDefID, number x, number y, number z, number facing)
-> number blocking [,number featureID]

<font color="#55ee99">blocking can be:
0 - blocked
1 - mobile unit in the way
2 - free (or if featureID is != nil then with a blocking feature that can be reclaimed)
facing can be:
0, "s", "south"
1, "e", "east"
2, "n", "north"
3, "w", "west"</font>
'''Spring.Pos2BuildPos''' <font color="#FF0000">optional param ''facing'' supported in 0.83 and later</font>
( 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,
}
<font color="#55ee99">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.</font>

=== 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''' <span class="warning">jammed new in 95.0</span>
( number x, number y, number z [, number allyID] )
-> boolean LosOrRadar, boolean inLos, boolean inRadar, boolean jammed
<span class="note">jammed indicates if a position is actively being radar- or sonar-jammed by '''any''' allyteam</span>

'''Spring.GetClosestValidPosition''' <span class="warning">//NOT FINISHED YET</span>
( 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.GetProjectileOwnerID''' {{new|99.0}}
(number projectileID) -> nil | number unitID

'''Spring.GetProjectileTeamID''' {{new|99.0}}
(number projectileID) -> nil | number teamID

'''Spring.GetProjectileDefID'''
(number projectileID) -> nil | number weaponDefID
<span class=note>using this to get a weaponDefID is HIGHLY preferred <br/> to indexing WeaponDefNames via GetProjectileName<span>

'''Spring.GetProjectileName'''
( number projectileID ) -> nil | string name
'''Spring.GetProjectileType'''
( number projectileID ) -> nil | boolean weapon, boolean piece

'''Spring.GetProjectileTarget'''
( number projectileID )
<span class="warning">Pre 95.0:</span> -> nil | number targetID, string <span class=note>targetTypeStr</span>
<span class="warning">Post 95.0:</span> -> nil | [number <span class=note>targetTypeInt</span>, number targetID | table targetPos = {x, y, z}]

<span class=note>targetTypeStr can be one of:
'u' - unit
'f' - feature
'p' - projectile
while targetTypeInt is one of:
string.byte('g') := GROUND
string.byte('u') := UNIT
string.byte('f') := FEATURE
string.byte('p') := PROJECTILE
</span>
'''Spring.GetProjectileIntercepted''' {{new|99.0}}
( number projectileID ) -> nil | boolean isBeingIntercepted

'''Spring.GetProjectilePosition'''
( number projectileID ) -> nil | number px, number py, number pz
'''Spring.GetProjectileVelocity'''
( number projectileID ) -> nil | number vx, number vy, number vz
{{new|95.0}}: returns (targetPos - startPos) for Beamlasers and similar weapons

'''Spring.GetProjectileGravity'''
( number projectileID ) -> nil | number gravity

'''Spring.GetPieceProjectileParams''' {{new|95.0}}
( number projectileID ) -> nil | number explosionFlags, number spinAngle,
number spinSpeed, number spinVector.x, number spinVector.y, number spinVector.z
<span class=note>Where explosionFlags use binary flags with the following integer equivalents:
more info [http://springrts.com/wiki/Animation-CobConstants#explode here]
SHATTER = 1, EXPLODE = 2, EXPLODE_ON_HIT = 2, FALL = 4, SMOKE = 8, FIRE = 16
NONE = 32, NO_CEG_TRAIL = 64, NO_HEATCLOUD = 128 </span>

'''Spring.GetProjectileTimeToLive''' {{new|99.0}}
( number projectileID ) -> nil | number ttl

'''Spring.GetProjectileDirection''' {{new|95.0}}
( number projectileID ) -> nil | number dir.x, number dir.y, number dir.z

'''Spring.GetProjectileSpinAngle''' <span class="warning">Deprecated in 95.0</span>
( number projectileID ) -> nil | number angle
'''Spring.GetProjectileSpinSpeed''' <span class="warning">Deprecated in 95.0</span>
( number projectileID ) -> nil | number spinSpeed
'''Spring.GetProjectileSpinVec''' <span class="warning">Deprecated in 95.0</span>
( number projectileID ) -> nil | number x, number y, number z

'''Spring.GetProjectileDamages''' {{new|101.0}}
( number unitID, number weaponNum, string tag ) -> nil | number
<span class=note>`tag` can be:
"paralyzeDamageTime"
"impulseFactor"
"impulseBoost"
"craterMult"
"craterBoost"
"dynDamageExp"
"dynDamageMin"
"dynDamageRange"
"dynDamageInverted"
"craterAreaOfEffect"
"damageAreaOfEffect"
"edgeEffectiveness"
"explosionSpeed"
- or -
an armor type index to get the damage against it.</span>

[[category: Lua]]

Gamedev:Main

2016-03-04T17:59:08Z

8611z: /* Technical Documentation */ bold text to == headings

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

= Game Development =
This information is meant to help newcomers learn how to develop their own games for the Spring Engine. If you are interested in creating maps for Spring, see [[Mapdev:Main]].

= Templates & Examples =
* [[Gamedev:SpringABC|SpringABC]] - A hierarchical set of empty template games, without examples
* [[SpringTutorialGame|Spring Tutorial Game]] - A tutorial template game with full examples
* [[Gamedev:PublicRepos|Public Repos]] - Publicly readable Spring game code repositories

= Technical Documentation =
== GameData ==
* [[Armordefs.lua]] - armor classes
* [[Icontypes.lua]] - strategic unit icons
* [[Modinfo.lua]] - game identifier file (name, version,...)
* [[Modrules.lua]] - Global game variables
* [[Movedefs.lua]] - MoveClasses for pathfinding
* [[Resources.lua]] - index file for textures
* [[Sidedata.lua]] - playable factions/races/sides
* [[Sounds.lua]] - index file for sounds
* [[Messages.lua]] - Team death messages {{new|95.0}}:deprecated

== Definition Files ==
* [[Gamedev:UnitDefs]] - define the attributes of units
* [[Gamedev:WeaponDefs]] - define the attributes of weapons/projectiles
* [[Gamedev:FeatureDefs]] - define the attributes of static map features and wrecks
* [[CEG:Main]] Particle effects (explosions etc)

== Lua API & Libraries (excerpt) ==
* [[Lua_Scripting|Lua API Documentation]]
* [[LUPS]] - Lua Particle System
* [[Chili]] - A GUI Framework
* {{forumlink|topic=28341|title=ChangePiece}} - Switch piece geometry

== Animation of units ==
Lua Animations
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
**[[Animation-CobLuaDifferences]]

COB Animations (Antiquated)
*[[Animation-CobOverview]]
**[[Animation-CobAnimation]]
**[[Animation-CobCallins]]
**[[Animation-CobConstants]]
**[[Animation-CobThreads]]
**[[Animation-CobHitByWeaponID]]
**[[Lua-LuaCOB]] - how to interface COB with LUA
**[[CEG_For_Units|Game Development:Calling basic CEGs from COB]]
**{{forumlink|topic=7457|title=GPL COB Examples}}

== Models & Textures ==
* [[About_s3o|.s3o]]
* [[Assimp]]
* [[3DModels:Textures]]

== Misc ==
* [[Gamedev:DebugDrawModes]]
* [[Gamedev:Archives]] - packing game/map
* [[Gamedev:Buildpics]]
* [[Gamedev:CollisionVolumes]]
* [[Gamedev:Glossary]]
* [[Gamedev:MouseCursors]]
* [[Gamedev:Sidepics]]
* [[Gamedev:Structure]]
* [[VirtualFileSystem]]

= Tools =
== In-Game Tools ==
*[[ToolBox]] - A Collection of Game Development Tools
*[[Map Making: Feature Placer|Feature Placer]] - A Map Feature & NPC Unit Placement Tool
== External Tools ==
* [[Upspring]]
* [[Map,_Mod,_And_Unit_Development_Programs|Development Tools]]

= Engine Related =
* [[Download_Testing]] - Test the compatibility of your game on upcoming versions of the Spring engine.

* [[EngineChangelogForContentDevs]] - New engine versions sometimes require games to adjust. A list of common problems.

* [[EngineSource_for_GameDevs]] - Notes about the engine source, from modding point of view.

= Tutorials =
== Tips, Tricks & Testing ==
[[TestingYourGame|These tricks and commands]] are useful for testing or debugging.

== Game Development Tutorials ==
*[[The Complete Guide To Making A Spring Game]] - A fairly comprehensive getting started tutorial.
*[http://springrts.com/phpbb/viewtopic.php?f=14&t=26409| Porting TA content to Spring]
*<strike>[[Simple Mod Tutorial|Simple Game Tutorial]]</strike> - needs to be updated

==Modelling Tutorials==
'''Wings3D'''
* [[3DModels:Wings3DTutorial]]
* [http://springrts.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]

'''Blender'''
* [[TutorialBlenderWorkFlow|Blender Workflow Tutorial]]

'''3DS Max'''
* [http://springrts.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]

==Texturing Tutorials==
* [http://springrts.com/phpbb/viewtopic.php?f=57&t=22392 DDS Textures: How To]
* [http://springrts.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]

=Misc=
* [[Ren'Py]]: a visual novel engine that can be used with Spring
* <strike>[http://answers.springlobby.info/ Q&A Site for the Spring Engine]</strike> Currently down.

[[Category:Game Dev]]

FAQ:trouble

2015-12-09T08:42:26Z

8611z: /* Spring crashes on my notebook but it has a really nice graphic card! (or some effects are messed up) */ fix pictures

[[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 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) ===
for example air plane trails might look like:

[[File: Bugged_plane_trails_graphics.jpg]]

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:

[[File: Graphic_cards_selection.png]]

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

====Units are almost invisible, except for same black pieces====
For example on Radeon X1300/X1550 Series.

[[File:InvisibleUnitBug_Radeon_X1300X1550AdvUnitShading.jpg]]

Set [[Springsettings.cfg#AdvUnitShading]] = 0

====It crashes always at start, hangs etc...====
Check [[infolog.txt]], as it mostly contains hints whats the cause for the crash.
Possible fixes are:
* try the [[springsettings.cfg#Safemode|safemode]] / set [[springsettings.cfg]] safemode values.
* updating or even downgrading [http://support.amd.com/ ATI driver]

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

File:Graphic cards selection.png

2015-12-09T08:41:16Z

8611z: laptop with low & high performace gfx cards

laptop with low & high performace gfx cards

File:Bugged plane trails graphics.jpg

2015-12-09T08:37:07Z

8611z: graphic errors as they can be result of laptop being set to wrong graphic cards

graphic errors as they can be result of laptop being set to wrong graphic cards

GamesDownloads

2015-11-07T09:51:03Z

8611z: /* Game installers (for players) */ notes about: zK=seperate server, nota-lobby=nota only

{{#css:
table.glossy {
width: 200px;
margin: 9px; padding:3px;
border: 1px solid rgba(0,0,0,0.5);
border-radius: 10px 10px 10px 10px;
box-shadow: 0 2px 6px rgba(0,0,0,0.5), inset 0 1px rgba(255,255,255,0.3), inset 0 10px rgba(255,255,255,0.2), inset 0 10px 20px rgba(255,255,255,0.25), inset 0 -15px 30px rgba(0,0,0,0.3);
text-align: center;
}

/*#installers img {
border: 1px solid rgba(0,0,0,0.5);
box-shadow: 0px -1px 3px rgba(0,0,0,0.8), 0px 1px 3px rgba(255,255,255,0.5);
}*/

/*table.glossy:hover {
background: rgba(160,160,220,0.4);
}*/
}}
[[Download]] < {{FULLPAGENAME}}

= Game installers (for players) =
Below are three Spring games that comes with complete installer (containing all the files you need to play those games):
<div id="installers" style="padding-left:7px">
{{Template:GamesDownload|name=Kernel Panic|image=Kernel_Panic_3.4.jpg|url=http://springfiles.com/spring/game-installers/kernel-panic-installer}} <span class="warning">(!)</span> Old engine version included. Experience of online play might be hampered.

{{Template:GamesDownload|name=Zero-K lobby|image=eclipse.jpg|url=http://zero-k.info/Wiki/Download}}
(Windows & Linux (mono))
<span class="warning">(!)</span> Can not connect to spring multiplayer server. zero-K uses a seperate server and the lobby does not fully support other games.

{{Template:GamesDownload|name=NOTA|image=Nota2nukes.jpg|url=http://nota.machys.net/lobby/download_lobby.php}}
(Windows)

<span class="warning">(!)</span> This lobby is limited to playing NOTA content.

</div>

For more Spring games, check out the [[Games]] page. Please note that some of them will require you to have the engine installed in order to work, as well as some maps, as they don't come with their own installer.

= Universal Downloaders =
As Spring itself is just an engine and does not contain game content.<br/>
There are several options for getting games/maps though, one is using the internal downloaders of the lobbies:

<div style="padding-left:7px">
{{Template:GamesDownload|name=SpringLobby|image=Springlobby_64.png|url=https://github.com/springlobby/springlobby/wiki/Install}}
(Multiplatform)

{{Template:GamesDownload|name=Spring Web Lobby|image=Blobby.png|url=http://weblobby.springrts.com}}
(Windows & Linux)

{{Template:GamesDownload|name=pr-downloader (command-line)|url=http://springrts.com/wiki/Pr-downloader}}

</div>

<span class=note>Notes: The above mentioned tools are included in the [[Download#Spring_Engine_Updates|Spring installer]]. </span>

[[Category:Spring]]

Talk:Bugs

2015-10-28T17:01:36Z

8611z: why removed link to FAQ?

XTA

2015-07-08T18:43:27Z

8611z:

[[category:Xta]]
'''[[Games|<--Back to Games]]'''

[[Image:Xta_logo_white.jpg]]

== What is XTA? ==

XTA is one of the original games for Spring, and the one many players feel is "more OTA than OTA itself" due to the authentic feel combined with the Spring Engine's capabilities.

XTA tests a player's tactical, teamwork and micro abilities whilst also fostering diverse playstyles giving many ways in which one action can change the outcome of battle.

'''But the best reciew for any player is to experience it for themselves.'''

== Download ==
The easiest way to download latest XTA is via the the automatic download system of your favorite multiplayer lobby.

== Gameplay ==

Here are just some of the many good aspects XTA has to offer.

*Perhaps XTA's greatest strength is that players must keep the balance of keeping their own units alive through repairing and avoiding projectiles, while still doing maximum damage to the enemy. Amongst this they also have to keep their economy on track and try guess their opponent's next move. Sound easy? Give it to a go!

*XTA is more micro than macro, although the latter is a vital feature. Units have more health than other games enabling players to keep units alive. Spamming is done less as units are more expensive and too many units means you will lose your units to the a few well microed enemies. It's not how many you build but how you use them.

*At the advanced levels of the tech tree, both factions really come into their own. Whereas Core may get the power of flame, Arm get the power of lightning, offering the quick and light to the strong and slow. Will you go for brute force and economical superiority or hit and run stealth tactics?

*XTA prides itself on being a mod of team play allowing teams to play strategically and work together to achieve goals as a simple macro victory is rare. The small community makes players able to have a greater understanding of each other giving the game a more rewarding victory.

*One of XTA's best selling points is the '''Commander'''. The versatility of this unit allows it to be used for aggressive, tactical, defensive and economical purposes as well as having the ability to Morph to be stronger.

*Very much similar to Spring itself, XTA has a friendly community and although it being relatively small, balance discussions are often held within the group. However, this also allows all players to know each other making games more between friends than foes. It also has one of the most active clan systems.

*XTA has a tough learning curve, however an intelligent player will quickly learn when to build and what, may it be lab or unit. This makes XTA a mod constantly keeping the player entertained and challenged. With different tactics being discovered all the time users have many ideas to choose from of how to start their game. XTA is renowned for players making comebacks by rebuilding their base.

----

== So where can I find out more? ==

'''XTA is proud to be a community-run development program.'''

The XTA community is always willing to listen to suggestions. The current forum can be found [http://springrts.com/phpbb/viewforum.php?f=48 here]. From there you will be able to read on the latest plans of XTA here, read the change log, and contribute your own ideas on the mod itself.

Something not to your liking about the current XTA? Talk about, maybe have it changed! Many balance issues are discussed from the introduction of new units to the changing of a single unit's DP

You can join the '''#xta channel''' to find other XTA players and see if anyone wishes for a game. There is nearly always a game of the most uptodate XTA being hosted.

Newer versions will continue to be released to incorporate more detailed visual effects/or models as the Spring Engine develops.

If you wish to learn the basics of XTA, you can read guides such as:

*[http://springrts.com/wiki/New_to_xta XTA Basics]
*[http://springrts.com/wiki/Xta_units XTA unit guide]
*[http://springrts.com/wiki/Xta_commander XTA Commander guide]

For some commented XTA games please feel free to visit [http://www.youtube.com/user/xtareplay here] to get a feel of the game.

----

==History==

XTA was a balance mod for TA, developed by the [[SY]] clan.

For Spring, it was the first mod available to the public for online play, the first that was ported and for a long time came bundled with the installation of the Spring engine, ready to play.

The mod has gone through many developers, starting with the [SY] clan with the most ancient and famous to the oldest of players, SJ; and then moving onto other users.

One of the most notable players has been Noize, a founder of BA. Noize started XTA's modern look, with updated graphics and flash explosions (XTA Pimped Edition), which would later be seen as unnecessary and extremely laggy.

A short time afterwards the [KnoX] clan, the leading XTA clan ran by '''Myg''' and Gizmo starting to develop the mod. For a brief time a major debate became visible that XTA was KnoX's mod now, this would be shortly dismissed.

After [KnoX] disbanded due to them feeling the time was right for the members to go their separate ways, they still maintained XTA until Noruas began upkeep of the mod. With XTA 7.1 being seen as a watershed moment due to the peak of XTA's player base due to the decline of AA and rise of BA, so too can XTA 8.1. With some debate to whether the current XTA is the best, the two main contenders would be 7.1 and 8.1. With 8.1 came updated graphics and what many players remember as "The golden days" whereas 7.1 can be called the heyday of XTA itself.

Noruas has introduced more units than any other developer of XTA, improved graphics and dragged XTA through the new Spring versions. With the community split about where they stand on many of his somewhat radical ideas, Noruas has certainly added to XTA.

Noruas maintained XTA for some time. Players contribute and offer help on a multitude of scales. The current XTA balance offers something new and dynamic whilst still maintaining the roots of OTA and the older XTA versions giving a blend of classic and modern.

Recently Deadnight Warrior has taken over development, fixing bugs, optimizing scripts and tweaking balance. [http://code.google.com/p/xta-springrts/ A SVN with bugtracker] was also set up.

----

== Eye Candy ==

XTA is arguably the best-looking mod in terms of graphics. With new unit models and new explosion/smoke effects being released with every update, the XTA mod keeps up to date with the Spring Engine and what it has to offer.

Here are some pictures of what XTA has to offer:

[[image:Screen508.jpg|800px|Core Commander]]
[[image:Screen511.jpg|800px|Arm Commander]]
[[image:Screen620.jpg|800px|A Land boat]]

Alternatively, you can view some clips of XTA in action as well as commentaries of XTA replays [http://www.youtube.com//XtaReplay here] or [http://www.youtube.com/xtaboi here].

== Important Autohost Commands ==
Official XTA autohosts are:
<pre>
[semprini]Autohost - for all
[loganberry]Autohost - for beginners
[durian]Autohost - for fleabowl
[elderberry]Autohost - for testing new xta versions
</pre>

Of course you can also use either of these hosts for other purposes.

== Managing the autohosts ==

To start up one of these hosts, if it is not running but another host is running, you can use the command:

<code>!spawn <autohost></code> - where <autohost> is one of semprini, logan, elder or durian.

In elderberry autohost you can also set another spring engine with the command:

<code>!setengine <engine name or latest></code> - for example !setengine 98.0 to set engine to Spring 98.0

To get a long, complete list type of commands: <code>!help</code>

Below are some often used commands for quicker looking:
===Maps===
Pick a random "good" map: <code>!map</code>

Download a map: <code>!dlmap <mapname or url></code> After this wait 30 seconds or issue the command <code>!reloadarchives</code>

===King of the Hill===
Add an one more startbox than they are teams.

<code>!koth 1</code> - enable King of the Hill mode.

<code>!koth 0</code> - disable King of the Hill mode.

<code>!hilltime X</code> - team has to control hill for X minutes to win.

<code>!gracetime Z</code> - at game start hill stays neutral for Z minutes.

===Game options===
<code>!mode killall</code> - destroy all enemy units to win

<code>!mode comends</code> - destroy enemy Commanders to win

<code>!spidertortoise 0</code> - Turn spiders & turtle units off.



==Clarification==
The text below was deleted twice in "Clarification" thread https://springrts.com/phpbb/viewtopic.php?f=48&t=33615 by moderation.

Note that right the mentioned "Anyone want to play?" thread got now unlocked but also the replies silently got merged into one thread. Instead of service or fixing mistake, this seems like a cover-up attempt because now all traces of what happend are gone.

----

Realistically XTA has too few players for even one forum.

On subforums:
Many games with a forum on springrts.com have/had a second forum on external sites.
The reasons were manifold, but only games maintainers and players needed to know them.
No matter how it was worded, that was never interpreted in a way to close threads in any subforum.
Even if one might assume something, acting on it is something entirely different.
Unless explicit ordered, these subforums were simply left alone.
This is new behaviour.

When the "Anyone want to play?" thread was locked, I had used report-function to make a (1) report on it.
Reply was a "warning for troll reports."
Thread stayed locked.
I used contact-admin function.
Reply was IP-ban.
Moderation continued to play clueless in this thread and in viewtopic.php?f=48&t=33609
Misunderstanding seems unlikely, by then they were aware.

Moderation on springrts.com has never worked because the wiggle-room of rules was used too freely.
Too often moderators point to their right to interpret rules, but it was too one-sided and it became an excuse for power abuse or looking away.
Any critique and attempt at discussion was brushed aside as "backseat moderation."
The option to take a problem to different or higher staff member does not exist: The remaining few are Yes-men to each other, the 30+ moderators plus fancy titles like "Community Leaders" are inactive hulls.
= The effect on forum by this moderation style is that to me the forum is unusable.

With the recent "Changes to Project Subforums Groups & Permissions" too many people can alter other people posts.
For normal posters there is no way to trace this.
Moderation has their own history of anonymously (& without any notes) altering posts themselves, and not paying attention to forum log.
= I do not trust this.

Allegedly spring developers plan to eventually ban any content related "Total Annhilation", which of course would affect XTA.
I never believed such rumors, seemed like people using TA-mods as scapegoats for their own frustration..
But maybe....maybe not bad idea to bookmark both forums. Just in case, to have a backup plan.

Until then, just play the game.
[[User:8611z|8611z]] ([[User talk:8611z|talk]]) 20:43, 8 July 2015 (CEST) aka knorke
----

[[Category:Games]]