Spring - User contributions [en]

Lua SyncedCtrl

2009-05-15T00:18:34Z

Lurker:

= Resources =
'''Spring.AddTeamResource'''
( number teamID, string "m" | "e", number amount ) -> nil
'''Spring.UseTeamResource'''
( number teamID,
string "m" | "e", number amount |
{ m = number amount, e = number amount}
) -> nil | boolean hadEnough

'''Spring.SetTeamResource'''
( number teamID, string res, number amount ) -> nil

possible values for res are:
"m" = metal
"e" = energy
"ms" = metal storage
"es" = energy storage


'''Spring.SetTeamShareLevel'''
( number teamID, string "m" | "e", number amount ) -> nil

= Unit Handling =
'''Spring.CreateUnit''' note: offmap positions are clamped! (you still can use MoveCtrl todo so)
( string "defName" | number unitDefID,
number x, number y, number z,
(number facing | string "facing"),
number teamID ) -> number unitID

possible values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3


'''Spring.DestroyUnit'''
( number unitID,
[boolean selfd = false,]
[boolean reclaimed = false,]
[number attackerID] ) -> nil

selfd makes the unit act like it self-destructed
reclaimed makes the unit act like it was reclaimed


'''Spring.TransferUnit'''
( number unitID,
numer newTeamID,
[boolean given = true] ) -> nil
if given=false, the unit is captured

== Unit Control ==
'''Spring.SetUnitCosts'''
( number unitID, {
[ buildTime = number amount ],
[ metalCost = number amount ],
[ energyCost = number amount ]
} ) -> nil

'''Spring.SetUnitTooltip'''
( number unitID, string "tooltip" ) -> nil

'''Spring.SetUnitHealth'''
( number unitID,
number health |
{ [ health = number health ],
[ capture = number capture ],
[ paralyze = number paralyze ],
[ build = number build ] }
) -> nil

'''Spring.SetUnitMaxHealth'''
( number unitID, number maxHealth ) -> nil

'''Spring.AddUnitDamage'''
( number unitID, number damage
[, number paralyze = 0 [, number attackerID = -1 [, number weaponID = -1
[, number impulse_x [, number impulse_y [, number impulse_z ]]] ]]] ) -> nil

'''Spring.SetUnitStockpile'''
( number unitID [, number stockpile [, number buildPercent ]]) -> nil

'''Spring.SetUnitExperience'''
( number unitID, number experience ) -> nil

'''Spring.SetUnitFuel'''
( number unitID, number fuel ) -> nil

'''Spring.SetUnitLineage'''
( number unitID, number teamID [, boolean isRoot] ) -> nil

'''Spring.SetUnitNeutral'''
( number unitID, boolean neutral ) -> nil

'''Spring.SetUnitTarget'''
( number unitID,
number enemyUnitID | number x, number y, number z,
[ boolean dgun = false ] ) -> nil

'''Spring.SetUnitBlocking'''
( number unitID, boolean noBlock [, boolean collide ] ) -> nil

'''Spring.SetUnitMetalExtraction'''
( number unitID, number depth [,number range] ) -> nil

'''Spring.SetUnitBuildSpeed'''
( number builderID,
number buildSpeed, [ number repairSpeed [, number reclaimSpeed
[,number resurrectSpeed [, number captureSpeed [, number terraformSpeed ]] ]]] ) -> nil

'''Spring.SetUnitArmored'''
( number unitID, boolean armored ) -> nil

'''Spring.SetUnitShieldState'''
( number unitID, boolean enabled [, number power] ) -> nil

'''Spring.SetUnitFlanking'''
( number unitID, string "mode", number mode ) -> nil
( number unitID, string "moveFactor", number factor) -> nil
( number unitID, string "minDamage", number minDamage ) -> nil
( number unitID, string "mazDamage", number maxDamage ) -> nil
( number unitID, string "dir", number x, number y, number z) -> nil

'''Spring.SetUnitWeaponState'''
( number unitID, number weaponNum, table states ) -> nil
format of the states table:
{
["reloadState" = number value,]
["reloadTime" = number value,]
["accuracy" = number value,]
["sprayAngle" = number value,]
["range" = number value,]
["projectileSpeed" = number value,]
["burst" = number value,]
["burstRate" = number value,]
["projectiles" = number value,]
}

'''Spring.SetUnitCollisionVolumeData'''
( number unitID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil

'''Spring.SetUnitTravel'''
( number unitID, number travel [, number travelPeriod] ) -> nil

'''Spring.SetUnitMoveGoal''' used by default commands to get in build-,attackrange etc.
( number unitID, number x, number y, number z,
[, number radius = 0 [, number speed = unit->maxSpeed * 2 ] ] ) -> nil

'''Spring.SetUnitPhysics'''
( number unitID,
number posx, number posy, number posz,
number velx, number vely, number velz,
number rotx, number roty, number rotz,
) -> nil

'''Spring.SetUnitPosition'''
( number unitID, number x, number z [, boolean alwaysAboveSea] ) -> nil

'''Spring.SetUnitVelocity'''
( number unitID, number velx, number vely, number velz ) -> nil

'''Spring.SetUnitRotation'''
( number unitID, number rotx, number roty, number rotz ) -> nil

'''Spring.AddUnitImpulse'''
( number unitID, number x, number y, number z ) -> nil

'''Spring.AddUnitSeismicPing'''
( number unitID, number pingSize ) -> nil

== Unit LOS ==
'''Spring.SetUnitCloak'''
( number unitID,
boolean cloaked | number scriptCloak,
[ number decloakDistance | boolean decloakAbs ] ) -> nil


If the 2nd argument is a number, the value works like this:
1:=normal cloak
2:=for free cloak (cost no E)
3:=for free + no decloaking (except the unit is stunned)
4>=ultimative cloak (no ecost, no decloaking, no stunned decloak)

The decloak distance is only changed if the 3th argument is a number or a boolean.
If the boolean is false it takes the default decloak distance for that unitdef,
if the boolean is true it takes the absolute value of it.

'''Spring.SetUnitSonarStealth'''
( number unitID, boolean sonarStealth ) -> nil

'''Spring.SetUnitStealth'''
( number unitID, boolean stealth ) -> nil

'''Spring.SetUnitAlwaysVisible'''
( number unitID, boolean alwaysVisible ) -> nil

'''Spring.SetUnitLosMask'''
( number unitID, number allyTeam, number los | table losTypes ) -> nil
the 3th argument is either the bit-and combination of the following numbers:
LOS_INLOS = 1
LOS_INRADAR = 2
LOS_PREVLOS = 4
LOS_CONTRADAR = 8
or a table of the following form:
losTypes = {
[los = boolean,]
[radar = boolean,]
[prevLos = boolean,]
[contRadar = boolean,]
}

'''Spring.SetUnitLosState'''
( number unitID, number allyTeam, number los | table losTypes ) -> nil
see above for more info on the arguments

'''Spring.SetUnitSensorRadius'''
( number unitID, string type, number radius ) -> nil | number newRadius
type can be:
"los","airLos","radar","sonar","seismic","radarJammer","sonarJammer"

== Unit Ressourcing ==
'''Spring.SetUnitResourcing'''
( number unitID,
string res, number amount |
{ res = number amount, ... }
) -> nil

possible values for res are: "[u|c][u|m][m|e]"
unconditional | conditional
use | make
metal | energy


'''Spring.AddUnitResource'''
( number unitID, string "m" | "e", number amount ) -> nil

'''Spring.UseUnitResource'''
( number unitID, string "m" | "e", number amount ) -> nil

= Feature Handling =
'''Spring.CreateFeature'''
( string "defName" | number featureID, number x, number y, number z
[,number heading [, number AllyTeamID ]] ) -> number featureID

'''Spring.DestroyFeature'''
( number featureID ) -> nil

'''Spring.TransferFeature'''
( number featureID, number AllyTeamID ) -> nil

== Feature Control ==
'''Spring.SetFeatureHealth'''
( number featureID, number health) -> nil

'''Spring.SetFeatureReclaim'''
( number featureID, number reclaimLeft) -> nil

'''Spring.SetFeatureResurrect'''
( number featureID, string "UnitDefName?" [, number facing | string "facing" ] ) -> nil

possible values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3


'''Spring.SetFeaturePosition'''
( number featureID, number x, number y, number z ) -> nil

'''Spring.SetFeatureDirection'''
( number featureID, number x, number y, number z ) -> nil

'''Spring.SetFeatureNoSelect'''
( number featureID, boolean noSelect ) -> nil

'''Spring.SetFeatureCollisionVolumeData'''
( number featureID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil

'''Spring.RemoveBuildingDecal'''
( number unitID ) -> nil

= Lua to COB =
'''Spring.CallCOBScript'''
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number retArg1, number retArg2, ...

'''Spring.CallCOBScriptCB''' 
broken in 0.78.2.1; will be removed with the introduction of Lua as COB replacement
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number CallbackData, number retArg1, number retArg2, ...

'''Spring.GetCOBScriptID'''
( number unitID, string funcName ) -> nil | number funcID

'''Spring.GetUnitCOBValue'''
( number unitID [, boolean splitData=false], number COBValue
[, number param1 [,number param2 [, number param3 [, number param4 ] ] ] ] )
-> number result | number result1, number result2
'''Spring.SetUnitCOBValue'''
( number unitID, number COBValue, number param1 [,number param2] ) -> nil

= Give Order =
'''Spring.GiveOrderToUnit'''
( number unitID,
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderToUnitMap'''
( unitMap = { [unitID] = dontCare, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderToUnitArray'''
( unitArray = { [1] = unitID, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderArrayToUnitMap'''
( unitMap = { [number unitID] = dontCare, etc... },
orderArray = {
{ number cmdID,
{number, etc...}, params
{"alt", "ctrl", "shift", "right"} options
}, ..
}
) -> nil

'''Spring.GiveOrderArrayToUnitArray'''
( unitArray = { [1] = number unitID, etc... },
orderArray = {
{ number cmdID,
{number, etc...}, params
{"alt", "ctrl", "shift", "right"} options
}, ..
}
) -> nil

= Heightmap =
'''Spring.LevelHeightMap'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil

'''Spring.AdjustHeightMap''' (heightmap[x][z] += height;)
( number x1, number z1 [, number x2, number z2], number height ) -> nil

'''Spring.RevertHeightMap'''
( number x1, number z1 [, number x2, number z2], number origFactor ) -> nil

'''Spring.SetHeightMapFunc'''
( lua_function [, arg1 ,[ arg2 [, ... ] ] ) -> nil | number absTotalHeightMapAmountChanged
'''Spring.AddHeightMap''' can only be called in SetHeightMapFunc()
( number x, number z, number height ) -> nil | number newHeight
'''Spring.SetHeightMap''' can only be called in SetHeightMapFunc()
( number x, number z, number height [,number terraform = 1] ) -> nil | number absHeightDiff
the terraform argument is a scaling factor:
so if 0 nothing will be changed (the terraform starts) and if it is 1 the terraform will be finished.

= Command Descriptions =
Doesn't work in unsynced code! 

'''Spring.EditUnitCmdDesc'''
( number unitID, number cmdDescID, table cmdArray ) -> nil

structure of cmdArray:
{
[ id = int ],
[ type = int ],
[ name = string ],
[ action = string ],
[ tooltip = string ],
[ texture = string ],
[ cursor = string ],
[ hidden = boolean ],
[ disabled = boolean ],
[ showUnique = boolean ],
[ onlyTexture = boolean ],
[ params = { string = string, ... } ]
}


'''Spring.InsertUnitCmdDesc'''
( number unitID [, number cmdDescID ] , table cmdArray ) -> nil

'''Spring.RemoveUnitCmdDesc'''
( number unitID [, number cmdDescID ] ) -> nil

= Other =
'''Spring.SetNoPause'''
( boolean noPause ) -> nil

'''Spring.SetUnitToFeature'''
( boolean tofeature ) -> nil

'''Spring.SetExperienceGrade'''
( number expGrade
[, number ExpPowerScale [, number ExpHealthScale [, number ExpReloadScale ]]] ) -> nil

expGrade defines how often UnitExperience() will be called,
it is based on the following equation:
(int) [exp/(exp+1)] / expGrade
If this integer differs from the one before the experience change
it will call UnitExperience().
Also those 3 last params are only available in .cheat


'''Spring.SpawnCEG'''
( string "cegname",
[, number posX = 0 [, number posY = 0 [, number posZ = 0
[, number dirX = 0 [, number dirY = 0 [, number dirZ = 0
[, number radius = 0 [, number damage = 0 ]] ]]] ]]]
) -> nil

= Projectiles =
'''Spring.SetProjectilePosition'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0 ]]] ) -> nil
'''Spring.SetProjectileVelocity'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0 ]]] ) -> nil
'''Spring.SetProjectileCollision'''
( number projID ) -> nil

LuaCallinReturn

2009-04-23T03:58:35Z

Lurker:

Lua Call-Ins, with parameters 

''Here are the known reserved parameter values for all Lua Call-Ins. If you add new Call-Ins to Spring, please document them here.''

==Commands, general-purpose:==

Shutdown() --> none.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button"

MouseRelease() --> "x, y, button"

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

==Unit-Specific:==

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitCreated() --> "unitID, unitDefID, teamID" ... I hope that's self-explanatory

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam"

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam"

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> unknown, please document.

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"

UnitEnteredAir() --> "unitID, unitDefID, teamID"

UnitLeftWater() --> "unitID, unitDefID, teamID"

UnitLeftAir() --> "unitID, unitDefID, teamID"

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

==Drawing:==

* DrawGenesis() --> none. Don't render here.

* Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

* Spring draws units, features, some water types, cloaked units, and the sun.

* DrawWorld() --> none.

* Spring draws command queues, 'map stuff', and map marks.

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode { 
notDrawing = 0, 
normalDraw = 1, 
shadowDraw = 2, 
reflectionDraw = 3, 
refractionDraw = 4 
};

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

==Game Events:==

Explosion() --> "weaponID, px, py, pz, ownerID"

ShockFront() --> "power, dx, dy, dz"

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail.

GameStart() --> unknown, but probably nil.

GameOver() --> none.

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

LuaCallinReturn

2009-04-23T03:56:38Z

Lurker: Start of info about the rendering process.

Lua Call-Ins, with parameters 

''Here are the known reserved parameter values for all Lua Call-Ins. If you add new Call-Ins to Spring, please document them here.''

==Commands, general-purpose:==

Shutdown() --> none.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button"

MouseRelease() --> "x, y, button"

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

==Unit-Specific:==

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitCreated() --> "unitID, unitDefID, teamID" ... I hope that's self-explanatory

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam"

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam"

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> unknown, please document.

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"

UnitEnteredAir() --> "unitID, unitDefID, teamID"

UnitLeftWater() --> "unitID, unitDefID, teamID"

UnitLeftAir() --> "unitID, unitDefID, teamID"

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

==Drawing:==

* DrawGenesis() --> none. Don't render here.

* Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

* Spring draws units, features, some water types, cloaked units, and the sun.

* DrawWorld() --> none.

* Spring draws command queues, 'map stuff', and map marks.

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode {

notDrawing = 0,

normalDraw = 1,

shadowDraw = 2,

reflectionDraw = 3,

refractionDraw = 4

};

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

==Game Events:==

Explosion() --> "weaponID, px, py, pz, ownerID"

ShockFront() --> "power, dx, dy, dz"

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail.

GameStart() --> unknown, but probably nil.

GameOver() --> none.

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

Balanced Annihilation:Chat

2009-02-14T18:55:47Z

Lurker: w: LIES

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

==Chat, Cheats, and Text Commands==

Pressing ENTER will bring up a "say:" prompt which you can use to communicate with other players or issue "Text Commands". 
-To send a message to all who are connected, type your message and press ENTER. 
-To send a message only to your allies, preface your message with "a:". 
-To send a message to any spectators, type "s:" 
-To send a message to a certain player, type "/w <playername>" 
Press ENTER to send it. There are also keybindings for all/ally/spec chat messaging:

Enter -> send to <send type>

Ctrl+Enter -> send to All (and sets <send type> to all)

Alt+Enter -> send to Allies (and sets <send type> to allies)

Shift+Enter -> send to Spectators (and sets <send type> to spectators)

<nowiki> To enter a Text Command, simply type the command and press ENTER.</nowiki>

===Basic Text Commands===

<table border="3" cellpadding="2" cellspacing="0">
<tr>
<th>Command</th><th>Effect</th>
</tr>
<tr>
<td>/info #</td>
<td>Shows you what colour each player is, its CPU usage percentage and their ping delay in the bottom right corner of the screen. This is on by default. Arguments:<ol>
<li>Sorts by allies</li>
<li>Sorts by TeamID</li>
<li>Sorts by name</li>
<li>Sorts by CPU Usage</li>
<li>Sorts by Ping</li>
</ol>
</td>
</tr>
<tr>
<td>/clock</td><td>Shows you the elapsed game time in minutes and seconds in the upper right corner of the screen. This is on by default.</td>
</tr>
<tr>
<td>/fps</td><td>Shows FPS counter in the upper right corner of the screen.</td>
</tr>
<tr>
<td>/gameinfo</td><td>Shows game information. Game version, actual game speed, commander ends, gravity, tidal, min wind, max wind, map size, map name and mod name.</td>
</tr>
<tr>
<td>/kick <name></td><td>Kicks a player, only works for hosts.</td>
</tr>
<tr>
<td>/kickbynum #</td><td>Kicks a player, only works for hosts.</td>
</tr>
<tr>
<td>/take</td><td>Places all allied units that are owned by players who have lost connection to the server under your control. It is generally considered polite to consult with any still-connected allies before doing this. In a Commander Dies, Game Ends game, a player only loses once they have lost ''all'' their Commanders, and this mechanism will give them a second one.</td>
</tr>
<tr>
<td>/setmaxspeed #</td><td>Changes the maximum speed multiplier (default is 3.0)</td>
</tr>
<tr>
<td>/setminspeed #</td><td>Changes the minimum speed multiplier (default is 0.3)</td>
</tr>
<tr>
<td>/nospectatorchat [0|1]</td><td>Toggles spectator chat on/off, optional true/false parameters can be put in the end, for example: ".nospectatorchat 1", otherwise it will toggle it on/off. Only works for hosts.</td>
</tr>
</table>

===Cheat Codes===

<table border="3" cellpadding="2" cellspacing="0">
<tr>
<th>Cheat Command</th><th>Effect</th></tr>
<tr>
<td>'''/cheat'''</td><td>'''enable cheats - Cheats don't work in multiplayer until the host types this'''</td>
</tr>
<tr>
<td>/nocost</td><td>Insta-build; everything is built immediatly. (doesn't work on things already under construction, only on new ones)</td>
</tr>
<tr>
<td>/spectator</td><td>Allows you to see the entire map... but you lose control of your units</td>
</tr>
<tr>
<td>/team #</td><td>Change player</td>
</tr>
<tr>
<td>/give [amount] <unitName> [team] @x,y,z</td>
<td>Place 1 or specified number of specified unit. Valid units are the internal names of units as specified in the unit definition. Use the "all" switch to get ALL the units in the current mod. Putting a number after the unit name will give those units to the specified team. some examples:
<ul><li>/give ARMCOM - gives you one ARMCOM</li> <li>/give 10 CORKROG 3 - gives team 3 10 CORKROGs</li> <li>/give all - gives one of every unit available</li></ul></td>

</tr>
<tr>
<td>/atm</td><td>gain 1000 extra energy and metal.</td>
</tr>
<tr>
<td>/godmode [0|1]</td><td>If set to 1, everybody (including specs) can control and view all units.</td>
</tr>
</table>

===Graphic Settings===

<table border="3" cellpadding="2" cellspacing="0">
<tr>
<th>Command</th><th>Effect</th>
</tr>
<tr>
<td>/advshading [0|1]</td><td>Disables/enables advanced shading (reflective units, more?).</td>
</tr>
<tr>
<td>/grounddecals [0|1]</td><td>Disables/enables ground decals (immune to tab complete?).</td>
</tr>
<tr>
<td>/maxparticles #</td><td>Sets maximum amount of particles. Accepted values are between 1000 and 20000.</td>
</tr>
<tr>
<td>/shadows [0|1] #</td><td>Sets shadows to on or off, supports a second argument for shadow quality (1024, 2048, 4096 or 8192). Note that shadows are a massive performance hit</td>
</tr>
<tr>
<td>/vsync [0|1]</td><td>Disables/enables vsync.</td>
</tr>
<tr>
<td>/water #</td>
<td>Sets water quality:<ol start=0>
<li>Basic water, no performance hit.</li>
<li>Reflective, Pretty, not a too large performance hit.</li>
<li>Dynamic, Very pretty, MASSIVE performance hit and buggy on some hardware.</li>
<li>Reflective + Refractive, Prettier than reflective and pretty much the same performance hit, slightly buggy on some hardware.</li>
<li>Bump-mapped water, very low impact like basic water, very pretty and realistic at average ranges. Has shore waves and some basic effects for impacts/movement through the water.
</ol>
</td>
</tr>
</table>

===Misc===

<table border="3" cellpadding="2" cellspacing="0">
<tr>
<th>Command</th><th>Effect</th>
</tr>
<tr>
<td>/cmdcolors <filename></td><td>Loads specified cmdcolors.txt.</td>
</tr>
<tr>
<td>/ctrlpanel <filename></td><td>Loads specified ctrlpanel.txt</td>
</tr>
<tr>
<td>/luaui</td><td>Access LuaUI commands provided by widgets. Use /luaui reload if LuaUI crashes. You can also use disable/enable arguments.</td>
</tr>
<tr>
<td>/echo <text></td><td>Prints a message to the console.</td>
</tr>
<tr>
<td>/say <text></td><td>Specifies that you want to say something to the other players, useful for telling them how to do something with a / command without running it yourself. For example /say /luaui reload.</td>
</tr>
<tr>
<td>/specfullview #</td>
<td>Sets spectator viewing and selection options:<ol start=0>
<li>No special abilities.</li>
<li>view-all.</li>
<li>select-all.</li>
<li>view-all and select-all.</li>
</ol>
</td>
</tr>
<tr>
<td>/volume #</td><td>Sets volume, accepted values are between 0 and 1.</td>
</tr>
</table>

===Keybindings===

<table border="3" cellpadding="2" cellspacing="0">
<tr>
<th>Command</th><th>Effect</th>
</tr>
<tr>
<td>/bind <keyset> <action></td><td>Binds a key or key combination.</td>
</tr>
<tr>
<td>/unbind <keyset> <action></td><td>Unbinds a key or key combination.</td>
</tr>
<tr>
<td>/unbindaction <action></td><td>Unbinds all keybinds that uses <action>.</td>
</tr>
<tr>
<td>/unbindkeyset <keyset></td><td>Unbinds all bindings that uses <keyset>.</td>
</tr>
<tr>
<td>/unbindall</td><td>Unbinds all keys except the chat keybinding.</td>
</tr>
<tr>
<td>/keysym <name> <keycode></td><td>Adds a custom key symbol, The defaults can not be overridden. Name must start with a letter, and only contain letters, numbers, and '_'</td>
</tr>
<tr>
<td>/keyset <name> <keyset></td><td>Specifies a named keyset. Name must start with a letter, and only contain letters, numbers, and '_'. Named keysets may be accessed by prepending the '&' character to the name.</td>
</tr>
<tr>
<td>/fakemeta <keysym></td><td>Assigns an auxiliary key for the meta modifier ("space" is a good choice. Use fakemeta none to disable this feature</td>
</tr>
</table>

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

[[category:Using Spring]]

Debugging sync errors

2009-01-15T17:31:09Z

Lurker:

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

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

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

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

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

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

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

Download

2009-01-13T13:36:19Z

Lurker:

==Spring Downloads==

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

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

==Spring RTS Engine + Mods/Games==

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

===Windows===

'''[http://lrad.de/spring_0.78.1.1.exe Click here to download]''' 15.0MB, added 2009-01-12

'''[http://www.springlobby.info/windows/spring_0.78.1.1.exe Mirror #1]'''

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

===Linux===

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

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

===Mac OS X===

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

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

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

==Lobby server==

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

===Windows===

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

===Linux===

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

===Mac OS X===

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

Gamedev:WeaponMainDir

2008-11-22T00:53:11Z

Lurker:

==WeaponMainDir: The Simple Way==
WeaponMainDirX is a vector showing the direction of the weapon's aiming cone.
MaxAngleDifX is the size of the aiming cone.

For instance, if you want your Primary Weapon to have a 90Ã‚Â° fire arc forward, you'd write: 
'''WeaponMainDir1=0 0 1;''' //x:0 y:0 z:1 => that's forward!
'''MaxAngleDif1=90;''' //90Ã‚Â° from side to side, or 45Ã‚Â° from center to each direction

If you want to precisely choose the WeaponMainDir, you could run UpSpring, create a new piece, move it around until the line, from the origin, to your piece, is along the line you want your weapon to fire, then write down the coordinate in WeaponMainDir. Keep in mind UpSpring invert the sign of the axis x and z.

--old confusing explanation removed; if you want it see history--

[[Category:Unit development]]

Lua VFS

2008-05-30T22:54:52Z

Lurker: /* Modes */

== Modes ==
'''VFS.RAW''' 
'''VFS.MOD''' 
'''VFS.MAP''' 
'''VFS.BASE''' 
'''VFS.ZIP''' 
'''VFS.RAW_FIRST''' 
'''VFS.ZIP_FIRST''' 
'''VFS.RAW_ONLY''' 
'''VFS.ZIP_ONLY''' 

Note that RAW_ONLY and ZIP_ONLY are merely backwards-compatible names for RAW and ZIP.

Currently, MOD, MAP, and BASE are unimplemented, and all act like ZIP.

== Files ==
'''VFS.Include'''
( string "filename" [, table enviroment [, number mode ] ] ) ->
'''VFS.LoadFile'''
( string "filename" [, number mode ] ) -> nil | lstring data
'''VFS.FileExists'''
( string "filename" [, number mode ] ) -> boolean
'''VFS.DirList'''
( string "directory" [, string "pattern" [, number mode [, string "optstr" ] ] ] )
-> { [1] = string filename, ... }
 optstr can contain:
"r" = recursive
"d" = include dirs

== Packing ==
The Pack- and Unpack-functions are used to convert numbers->strings and strings->numbers.
So you can read a binary file and then convert the received strings back to numbers and the other way around. Also you can use it in combination with the SendLuaXYZMsg-functions.

'''VFS.PackU8'''

'''VFS.PackU16'''

'''VFS.PackU32'''

'''VFS.PackS8'''

'''VFS.PackS16'''

'''VFS.PackS32'''

'''VFS.PackF32'''

arguments are:

'''VFS.PackX( number arg1, number arg2, number arg3, ... )''' -> string

'''VFS.PackX( {[1]=number,[2]=number,..} )''' -> string

'''VFS.UnpackU8'''

'''VFS.UnpackU16'''

'''VFS.UnpackU32'''

'''VFS.UnpackS8'''

'''VFS.UnpackS16'''

'''VFS.UnpackS32'''

'''VFS.UnpackF32'''

arguments are:

'''VFS.UnpackX( string "binary" [, number offset ] [, number count] )'''
-> number | table { [1]=number,[2]=number,.. }

Lua VFS

2008-05-30T22:54:06Z

Lurker: /* Modes */

== Modes ==
'''VFS.RAW''' 
'''VFS.MOD''' 
'''VFS.MAP''' 
'''VFS.BASE''' 
'''VFS.ZIP''' 
'''VFS.RAW_FIRST''' 
'''VFS.ZIP_FIRST''' 
'''VFS.RAW_ONLY''' 
'''VFS.ZIP_ONLY'''
Note that RAW_ONLY and ZIP_ONLY are merely backwards-compatible names for RAW and ZIP.

Currently, MOD, MAP, and BASE are unimplemented, and all act like ZIP.

== Files ==
'''VFS.Include'''
( string "filename" [, table enviroment [, number mode ] ] ) ->
'''VFS.LoadFile'''
( string "filename" [, number mode ] ) -> nil | lstring data
'''VFS.FileExists'''
( string "filename" [, number mode ] ) -> boolean
'''VFS.DirList'''
( string "directory" [, string "pattern" [, number mode [, string "optstr" ] ] ] )
-> { [1] = string filename, ... }
 optstr can contain:
"r" = recursive
"d" = include dirs

== Packing ==
The Pack- and Unpack-functions are used to convert numbers->strings and strings->numbers.
So you can read a binary file and then convert the received strings back to numbers and the other way around. Also you can use it in combination with the SendLuaXYZMsg-functions.

'''VFS.PackU8'''

'''VFS.PackU16'''

'''VFS.PackU32'''

'''VFS.PackS8'''

'''VFS.PackS16'''

'''VFS.PackS32'''

'''VFS.PackF32'''

arguments are:

'''VFS.PackX( number arg1, number arg2, number arg3, ... )''' -> string

'''VFS.PackX( {[1]=number,[2]=number,..} )''' -> string

'''VFS.UnpackU8'''

'''VFS.UnpackU16'''

'''VFS.UnpackU32'''

'''VFS.UnpackS8'''

'''VFS.UnpackS16'''

'''VFS.UnpackS32'''

'''VFS.UnpackF32'''

arguments are:

'''VFS.UnpackX( string "binary" [, number offset ] [, number count] )'''
-> number | table { [1]=number,[2]=number,.. }

Units:FlankingBonus

2007-11-24T06:01:18Z

Lurker:

=FlankingBonus=

==History==

FlankingBonus is a quick, integrated way to give units a resistance to damage from certain directions. It started life long ago, in the dark ages of spring, under the name of BonusShield. In its default form it hid there, secretly manipulating the damage dealt to units in an attempt to encourage flanking. And there it worked its special little magic, known to very few, until July of 2007, when the great lurking presence felt it brush by, and exposed bonusShield to the world.

This mysterious code had few parameters at the time, and each one of them was hardcoded. There was the direction it was facing, that would determine where there would be minimum damage, which started at south. But it was more complicated than that. You see, bonusShield could move, and did so by building up a reserve of mobility as time ticked by. When an attack would hit, it would use this reserve to swing and face the attacker, buying a precious bit of extra health as long as no units could sneak by to the other direction. But bonusShield had its flaws. It completely ignored the way a unit was facing, so a unit spinning in place while being shot from the West could recieve minimum damage from each shot. It was also 'mandatory hardcoded crap', completely unchangeable by any unit settings.

But lo, the lurking presence had a plan: a plan to not only rid the world of the scourge of hardcoded bonusShield, but dreams of something better, something usefull, something that could make a tank's armor realistic, give units the ability to have variable armor layout at the push of a button, not merely a 'bonusShield', but a flankingBonus, a fully configurable system built out of the ashes of the old. And so it set to work, making an extensive patch to be applied to spring's core.

This patch held the ability to banish bonusShield at a modder's whim, but held so much more for those willing to dig deeper. Suddenly, direction, mobility, damage levels, and more were all configurable. A tank could have extra armor in its front, or following the main turret, and click this power on and off in a second. Rejoicing was farspread, and history books were filled with the inspiring tale.

==Specifics==

flankingBonus takes the following tags: 
====int flankingBonusMode;====
0: no flanking bonus 
1: global coords, mobile 
2: unit coords, mobile 
3: unit coords, locked 
====float3 flankingBonusDir;====
units takes less damage when attacked from this dir (encourage flanking fire)
====float flankingBonusMax;====
damage factor for the least protected direction
====float flankingBonusMin;====
damage factor for the most protected direction
====float flankingBonusMobilityAdd;====
how much the ability of the flanking bonus direction to move builds up each frame

===flankingBonusMode===
Defaults to what is set in modrules, which itself defaults to 1, the old way.
Mode 0 is self explanitory. 
Mode 1 builds up the ability to move over time, and swings to face attacks, but does not respect the way the unit is facing. 
Mode 2 also can swing, but moves with the unit as it turns. 
Mode 3 stays with the unit as it turns and otherwise doesn't move, the ideal mode to simulate something such as tank armor. 
To set the default in modrules.tdf, use the following code:

[flankingBonus]
{
defaultMode=1; // defaults to 1
}

===flankingBonusDir===
This is the direction where the armor is facing; where damage is least. It is in the form of a standard spring vector. In global coordinates mode, <x,y,z> = East, Up, South. In unit coordinates mode, <x,y,z> = Left, Up, Front.

===flankingBonusMax===
the maximum damage, when hit from the oppisite direction from flankingBonusDir

===flankingBonusMin===
the minimum damage, when hit from the same direction as flankingBonusDir

===flankingBonusMobilityAdd===
This defines the ability of flankingBonusDir to move over time. Its value is added to the mobility every slowupdate. When the unit is attacked, the build up mobility value is multiplied by a vector facing the attack, which is added to flankingBonusDir to find the new direction of flankingBonusDir. As an example, if flankingBonusMobilityAdd is .1, after 20 seconds the mobility will have added up to 2, meaning that the added direction has 2x the influence as the previous, and the new direction will roughly match the attack.

===How damage is calculated===
It uses the dot product of the attack direction and flankingBonusDir to find where the damage falls between max and min. If you don't know what that is, it doesn't matter. Basically, this is equivalent to taking the cosine of the angle between the two directions, and dealing minimum damage at 1, and maximum damage at -1. flankingBonusDir points in the direction that is best defended, and attacks from there will do a default of 90% damage, and attacks hitting the exact opposite direction do a default of 190% damage. Attacks in the middle will do 140% damage, and it scales smoothly between all these values.

Currently flankingBonus only uses the direction of the attacker, not the actual projectile, because of the innacuracy of projectiles moving through the hitsphere, something I am working on rectifying.

coming soon: how to set per-unit in cob

Units:FlankingBonus

2007-11-24T05:45:29Z

Lurker: New page: =FlankingBonus= ==History== FlankingBonus is a quick, integrated way to give units a resistance to damage from certain directions. It started life long ago, in the dark ages of spring, ...

Game and Unit development

2007-11-24T05:45:23Z

Lurker: adding a link to flankingbonus

=Mod development=
Mods, next to Maps, is the content used in Spring. 
A mod is simply a combined file containing a small structure of files and directories holding all the data required. 

[[Mod_Development | Mod Development]] wiki is a starting page, linking to very useful information on the files included in a mod, their hierarchy and more.
 

Almost the entire mod developing is the creation of units. Which isn't an easy job. 
Information about the creation of units are everywere, but not combined. 
This is a gathered list of all Tutorials and helpfull forums threads I could find: 

===General===
*http://taspring.clan-sy.com/wiki/Create_units - old Wiki 
*[[Mod Development]]
*[[Mod specification]] 
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]

===Unit Development===
*[http://taspring.clan-sy.com/wiki/Unit_Development Global informations about units]
*[http://taspring.clan-sy.com/wiki/all units compatible released]

====s3o units====
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Texturing Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [[Trouble-shooting s3o units]]

====Scripting and Animation====
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]
* GET/SET MAX_SPEED works once again. GET/SET ACTIVATION also works (which means you can turn radar jamming, energy production, radar, metal proudction, energy/metal use as defined in the fbi off and on via script)

====FBI Files====
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variables)]]

====TDF Files====
*[[Units:Download TDF]]
*[[Units:Weapons]] : Various informations about weapons
*[[All_Weapons_variable_values:_min,_max,_default,_type|Units:Weapons (variables)]]
*[[Weapon Variables]] : This is the most up to date

====Lua====
*[[Units:LuaCOB]] - how to interface COB with LUA

====Misc====
*[[Units:WeaponMainDir]]
*[[Units:Design]]
*[[Units:Buildpics]]
*[[Units:High-poly]]
*[[Units:Textures]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor]]
*[[Mod Development:Spawn]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomExplosionGenerators|Mod Development:Custom explosions]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

====3do units====
* [http://www.tauniverse.com/forum/forumdisplay.php?s=

Development:Main

2007-08-03T00:29:19Z

Lurker: update, clarification

Outlined below is information on assisting with the development of the Spring source itself.

::NOTE: For information about developing a mod (units, maps, etc.) see the [[Mod Development]] page.

Below you can find information on how to work with the Spring source in the current mainline (Windows platform) if you like to work on another platform (Linux & Mac) please look at the bottem of this page under "Multiplatform development"

==Starting Development==
To start development, you will need
#The latest version of the source
#A good code manipulation program
#Compiling your modified source

== Keep track what others do ==
If you develop with others, you need to know what they do. Fisheye is a very handy svn helper, we currently use:
http://spring.clan-sy.com/fisheye

===Source Code Documentation===
A good place to start is the source code documentation, which can be found here: [http://taspring.clan-sy.com/doxygen/ doxygen]

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

===Obtaining the Source===

Update: the latest SVN is at: [https://taspring.clan-sy.com/svn/spring https://taspring.clan-sy.com/svn/spring]

Another option is to manually download it along with the latest released version of the game. However, for serious developers, a better way would be to download the source straight from the subversion (SVN) repository. 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 SVN access.

windows SVN clients : [http://subversion.tigris.org Subversion] (Win32-Console),
[http://www.syntevo.com/smartsvn/index.jsp SmartSVN] (Java) and [http://tortoisesvn.tigris.org TortoiseSVN] (MSI).

assuming that you are using the Subversion svn client you can download the latest SVN source with

<code>svn.exe checkout https://taspring.clan-sy.com/svn/spring/trunk</code>

it will create a trunk subdirectory in the directory from where you ran it, which will contain the source code root directory which will be later referred to as /taspring

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

===Modifying and Compiling the Source===

The build environment on Windows changed a few releases ago to SCONS/mingw

If you will be developing on Windows you are recommended to use SCONS/mingw, using the SVN version.

See [[Development_IDEs]]. You have either to use the SCons build system that is multi platform, or use the vcproj for building spring in Visual Studio 2003 or Visual Studio 2005.
A list of required libraries as well as pre-built packages of these follows.

*[http://www.boost.org Boost C++ library]
*[http://www.openal.org OpenAL Audio library]
*[http://glew.sf.net GLEW (OpenGL extension loading)]
*[http://www.winimage.com/zLibDll/ zlib + minizip]
*[http://www.libsdl.org SDL]
*[http://openil.sf.net DevIL (Image loading)]
*[http://www.freetype.org Freetype font rendering]

*[http://taspring.clan-sy.com/phpbb/viewtopic.php?p=49257#49257 Pre-Built packages of most of the dependencies].
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?p=56846#56846 Pre-Built boost for VS8]. *note - probably not needed

*[http://msdn.microsoft.com/directx/sdk/ DirectX SDK] (Windows, Visual Studio C++ only)
*PlatformSDK (Windows, Visual Studio C++ Only)

The following are for building with SCONS/MinGW

*[http://prdownloads.sourceforge.net/dev-cpp/devcpp-4.9.9.2_setup.exe Dev-Cpp installer] / [MinGW] Though I would not advise mingw because you have to set it up your self, and this is harder than it sounds. Note that Code:Blocks mingw setup is not sufficient. *note - dev-cpp seems to have been abandoned
*[http://www.python.org/ftp/python/2.4.2/python-2.4.2.msi Python 2.4 installer]
*[http://prdownloads.sourceforge.net/pywin32/pywin32-208.win32-py2.4.exe?download Python win32 extensions installer]
*[http://prdownloads.sourceforge.net/scons/scons-0.96.1.win32.exe Scons installer]

====Development System Setup====

See [http://spring.clan-sy.com/phpbb/viewtopic.php?p=49257 Compiling spring (mingw and visual studio 7/8)] and [[Installing Visual C plus plus]] for instructions.

*Make sure C:\Python24 and C:\Dev-Cpp\bin are in your PATH environment variable.
*Make sure a MINGDIR environment variable with value C:\Dev-Cpp exists. (Change paths where appropriate.)
**Set environment variables by: Start -> Settings -> Control Panel -> System -> Advanced -> Environment variables (for Windows XP).
*Checkout the TA Spring SVN repository into your working area.
*You will also need the [http://spring.clan-sy.com/dl/spring-mingwlibs.exe MinGW/DevCPP libs] extracted to your source directory obtained from SVN. ie your-working-path/source/trunk/mingwlibs. Therefore mingwlibs is at the same directory level as AI, lua and the omni directories.

====Running SCONS Configure====

*Open a console (Start -> Run -> cmd.exe -> Run)
*cd /where you checked it out in the previous step, if you use checked it out on a different drive make sure to change drives with DriveLetter:<enter> first
*type "scons configure"<enter>

Gotchas:
*if you get an error message starting with "EOFError: : env = Environement...", try deleting the file build/scons_signatures.dblite
*if you get an error message stating "ImportError: No module named win32file:", you have probably not installed the python-win32-extensions.

If all proceeds as intended you will see a message similar to:
"Everything seems OK. Run `scons' now to build."

====Compiling Spring====

* Open a console (Start -> Run -> cmd.exe -> Run)
* cd /path-to-where you checked it out in the previous step, if you use checked it out on a different drive make sure to change drives with DriveLetter:<enter> first
* type '''scons configure'''<enter>, followed by '''scons'''<enter>
** Refer to '''scons --help''' for options that can be passed to scons configure
* Wait, this will take a while
* Copy over data files and stuff from official spring to the game dir (where spring.exe is created)
* Copy missing DLLs from mingwlibs/dll
* Start developing

If you are using Linux, refer to the [[SetupGuide]] to build Spring and get it running.

==Development Suggestions==

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 at the list of [[example projects]]. You can also check the list of [[whois doing what]] 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.

===How to get your code included===
If you create something that you think should be included in the official source tree, you can send an email to the development mailing list shown at [[Linux]] page. Sending your code in the form of a patch (also known as a .diff file), will make the chances of including it in the main code. Many patches are submitted to [http://spring.clan-sy.com/mantis Mantis].
It's also considered standard practice to post one's modifications in the [http://taspring.clan-sy.com/phpbb/viewforum.php?f=12 development forum] and get feedback.

==Spring Engine TODO list==
There is a TODO list for developers who want to contribute to the engine itself:
[[SpringEngineTODO]]

See [[Glossary]]

[[Category:Development]] [[Category:Source development]]

Installing Visual C plus plus

2007-08-02T23:36:52Z

Lurker:

Ok getting the free Microsoft IDE to run is not the easiest task, if you donÃ‚Â´t know what your doing. If you do though its easy easy :D .
First of all your going to need quite a bit of free Hard drive memory, about 2 gigabytes. Roughly one Gigabyte needs to be free on your windows drive (usually C:).

What I say after this can basically be found on the microsoft page [http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/ here] with links included, so you might as well go there, and just check here if your having problems.
You first need to install the "Visual Studio C++ 2005 Express edition" . Long name ey? Anyway there are two ways to install:
#The [http://go.microsoft.com/fwlink/?LinkId=51410&clcid=0x409 online installation], where you download a small installer, which then downloads the files as you install. I advise against this, as it was always moaning about not having this or that windows update. I do run on a Windows 2000 Machine though, so maybe its no problem with XP.
# Anyway the other (in my opinion: better) way is to download the [http://go.microsoft.com/fwlink/?linkid=54766 Image file] (.img), extract this with an image reader (you can get one free, just google for it). Than all you need to do is run setup/install, and presto ! You donÃ‚Â´t need to install the frills by the way (the Visual Studio Library or the SQL something).

Okay, that was step one.
Now you need to install the "Windows Platform SDK (Software Developer Kit)".
Again there are two ways of installation, same as before. This time though IÃ‚Â´d advise using the [http://www.microsoft.com/downloads/info.aspx?na=46&p=3&SrcDisplayLang=en&SrcCategoryId=&SrcFamilyId=A55B6B43-E24F-4EA3-A93E-40C0EC4F68E5&u=http%3a%2f%2fdownload.microsoft.com%2fdownload%2fa%2f5%2ff%2fa5f0d781-e201-4ab6-8c6a-9bb4efed1e1a%2fPSDK-x86.exe&oRef=http%3a%2f%2fmsdn.microsoft.com%2fvstudio%2fexpress%2fvisualc%2fusingpsdk%2f online installer], as the [http://www.microsoft.com/downloads/details.aspx?familyid=D8EECD75-1FC4-49E5-BC66-9DA2B03D9B92&displaylang=en Image file] was broken (for me anyway).

OK if youÃ‚Â´ve got that done, your almost ready.
Next you need to follow the [http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/ instructions on the Windows page], manually changing some of the VS C++ 2005 Settings.

After that you need to install the vclibs package and (if you want to compile the source, and not only AIÃ‚Â´s) the directx SDK.
Also, the VC8 Project file isn't updated as much as the source code changes, so you might have to look through the SVN log and manually tell it about files added since the last update.

[[Category:Source development]]

Installing Visual C plus plus

2007-08-02T23:34:00Z

Lurker: revert

Ok getting the free Microsoft IDE to run is not the easiest task, if you donÃ‚Â´t know what your doing. If you do though its easy peasy :D .
First of all your going to need quite a bit of free Hard drive memory, about 2 gigabytes. Roughly one Gigabyte needs to be free on your windows drive (usually C:).

What I say after this can basicly be found on the microsoft page [http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/ here] with links included, so you might as well go there, and just check here if your having problems.
You first need to install the "Visual Studio C++ 2005 Express edition" . Long name ey? Anyway there are two ways to install:
#The [http://go.microsoft.com/fwlink/?LinkId=51410&clcid=0x409 online installation], where you download a small installer, which then downloads the files as you install. I advise against this, as it was always moaning about not having this or that windows update. I do run on a Windows 2000 Machine though, so maybe its no problem with XP.
# Anyway the other (in my opinion: better) way is to download the [http://go.microsoft.com/fwlink/?linkid=54766 Image file] (.img), extract this with an image reader (you can get one free, just google for it). Than all you need to do is run setup/install, and presto ! You donÃ‚Â´t need to install the frills by the way (the Visual Studio Library or the SQL something).

Okay, that was step one.
Now you need to install the "Windows Platform SDK (Software Developer Kit)".
Again there are two ways of installation, same as before. This time though IÃ‚Â´d advise using the [http://www.microsoft.com/downloads/info.aspx?na=46&p=3&SrcDisplayLang=en&SrcCategoryId=&SrcFamilyId=A55B6B43-E24F-4EA3-A93E-40C0EC4F68E5&u=http%3a%2f%2fdownload.microsoft.com%2fdownload%2fa%2f5%2ff%2fa5f0d781-e201-4ab6-8c6a-9bb4efed1e1a%2fPSDK-x86.exe&oRef=http%3a%2f%2fmsdn.microsoft.com%2fvstudio%2fexpress%2fvisualc%2fusingpsdk%2f online installer], as the [http://www.microsoft.com/downloads/details.aspx?familyid=D8EECD75-1FC4-49E5-BC66-9DA2B03D9B92&displaylang=en Image file] was broken (for me anyway).

OK if youÃ‚Â´ve got that done, your almost ready.
Next you need to follow the [http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/ instructions on the Windows page], manually changing some of the VS C++ 2005 Settings.

After that you need to install the vclibs package and (if you want to compile the source, and not only AIÃ‚Â´s) the directx SDK.
Also, the VC8 Project file has some outdated include and link directories that your going to have to change.

[[Category:Source development]]