Spring - User contributions [en]

Building Spring on Buildbot

2011-11-13T15:51:42Z

Tobi: /* New (since 0.82) */

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

==New (since 0.82)==

Watch progress and errors of builds:

http://buildbot.springrts.com/waterfall

The outcome of builds can be found here:

http://springrts.com/dl/buildbot/default/

==Old (until 0.81)==

The spring build-bot is a server that is setup to compile spring automatically, and is usable by everyone.
It currently supports compiling for:
* Windows 32bit with TDM-MinGW (default)
* Windows 32bit with MinGW
* Windows 64bit with MinGW
* Linux with GCC

You may use the build-bot from within your Spring lobby client. Join channel '''#buildserv''', type ''!help'' and follow the instructions. Most useful commands are ''!rebuild'' and ''!translate''.

It is maintained by bibim and mainly used by devs for testing if their changes would compile on other systems too, but as it also generates windows installers, that can be downloaded by everyone, it can be also useful for casual users willing to try the latest changes to spring.

The outcome of builds can be found here:
[http://buildbot.eat-peet.net/spring/ http://buildbot.eat-peet.net/spring/]

Lua SyncedCtrl

2011-10-31T20:00:11Z

Tobi: typo

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

= Game End =
'''Spring.KillTeam''' New in version 0.83.x 
( number teamID ) -> nil
 will declare a team to be dead ( no further orders can be assigned to such teams's units )

'''Spring.GameOver''' New in version 0.83.x 
( {number allyTeamID1, number allyTeamID2, ...} ) -> nil
 will declare game over, a list of winning allyteams can be passed, if undecided ( like when dropped from the host ) it should be empty ( no winner ), in the case of a draw with multiple winners, all should be listed

= Resources =
'''Spring.AddTeamResource'''
( number teamID, string "metal" | "energy", number amount ) -> nil
'''Spring.UseTeamResource'''
( number teamID,
string "metal" | "energy",number amount |
{ metal = number amount, energy = 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 "metal" | "energy", number amount ) -> nil

'''Spring.ShareTeamResource''' 0.82 and later
( number teamID_src, number teamID_recv, string "metal" | "energy", 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,
[boolean build = false] ) -> number unitID

possible values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3
if build is true the unit is created in "being built" state, with buildProgress = 0


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

selfd := makes the unit act like it self-destructed
reclaimed := don't show any DeathSequences, don't leave a wreckage.
NOTE this does _not_ give back the resources to the team!


'''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''' Removed from version 0.83.x 
( 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 blocking [, 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''' armorMultiple new in version 0.83.x
( number unitID, boolean armored [, number armorMultiple] ) -> nil

'''Spring.SetUnitShieldState'''
( number unitID [, number weaponID = -1] [, 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
( number unitID, number weaponNum, string key, number value ) -> nil
format of the states table:
{
["reloadState" = number value,]
["reloadFrame" = number value,] (synonym for reloadState!)
["reloadTime" = number value,]
["accuracy" = number value,]
["sprayAngle" = number value,]
["range" = number value,]
["projectileSpeed" = number value,]
["burst" = number value,]
["burstRate" = number value,]
["projectiles" = number value,]
["aimReady" = number value,] (<>0.0f := true)
}

'''Spring.SetUnitCollisionVolumeData'''
( number unitID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil
enum COLVOL_TYPES {
COLVOL_TYPE_DISABLED = -1,
COLVOL_TYPE_ELLIPSOID = 0,
COLVOL_TYPE_CYLINDER,
COLVOL_TYPE_BOX,
COLVOL_TYPE_SPHERE,
COLVOL_TYPE_FOOTPRINT, // intersection of sphere and footprint-prism
COLVOL_NUM_TYPES // number of non-disabled collision volume types
};
enum COLVOL_TESTS {
COLVOL_TEST_DISC = 0,
COLVOL_TEST_CONT = 1,
COLVOL_NUM_TESTS = 2 // number of tests
};
enum COLVOL_AXES {
COLVOL_AXIS_X = 0,
COLVOL_AXIS_Y = 1,
COLVOL_AXIS_Z = 2,
COLVOL_NUM_AXES = 3 // number of collision volume axes
};


'''Spring.SetUnitPieceCollisionVolumeData'''
( number unitID, number pieceIndex, boolean affectLocal, boolean affectGlobal,
boolean enableLocal, boolean enableGlobal, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number vType, 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

'''Spring.RemoveBuildingDecal'''
( number unitID ) -> 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 Resourcing ==
'''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 | boolean okay
( number unitID, { ["m" | "metal" | "e" | "energy"] = amount, ... } ) -> nil | boolean okay

= 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 teamID ) -> 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 [, boolean snapToGround]) -> nil

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

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

'''Spring.SetFeatureAlwaysVisible'''
( number featureID, boolean enable ) -> nil

'''Spring.SetFeatureCollisionVolumeData'''
( number featureID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil
check Spring.SetUnitCollisionVolumeData for further explanation of the arguments

= 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

Note: Don't use Spring.[Get|Set]UnitCOBValue in LUS just because you are familar with it since bos/cob, use the mighty LuaSpringAPI instead!

'''Spring.GetUnitCOBValue'''
( number unitID [, boolean splitData=false], number COBValue
[, number param1 [,number param2 [, number param3 [, number param4 ] ] ] ] )
-> number result | number result1, number result2
you find the possible values for `COBValue` in [[Lua_ConstCOB#Get.2FSet|Lua_ConstCOB]]
 also see [[Animation-CobConstants#Custom_Variables|Custom_Variables]]

'''Spring.SetUnitCOBValue'''
( number unitID, number COBValue, number param1 [,number param2] ) -> nil
you find the possible values for `COBValue` in [[Lua_ConstCOB#Get.2FSet|Lua_ConstCOB]]
 also see [[Animation-CobConstants#Custom_Variables|Custom_Variables]]

= 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

=Ground=
== Grass ==
'''Spring.AddGrass'''
( number x, number y, number z ) -> nil

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

== Heightmap ==
Note that x & z coords are in worldspace (Game.mapSizeX/Z), still the heightmap resolution is Game.squareSize.

'''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
Example code:<code><pre>
Spring.SetHeightMapFunc(function()
for z=0,Game.mapSizeZ, Game.squareSize do
for x=0,Game.mapSizeX, Game.squareSize do
Spring.SetHeightMap( x, z, 200 + 20 * math.cos((x + z) / 90) )
end
end
end)
</pre></code>
'''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.

'''Spring.LevelSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil
'''Spring.AdjustSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil
'''Spring.RevertSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number origFactor ) -> nil

'''Spring.SetSmoothMeshFunc'''
( lua_function [, arg1 ,[ arg2 [, ... ] ] ) -> nil | number absTotalHeightMapAmountChanged
'''Spring.AddSmoothMesh''' can only be called in SetSmoothMeshFunc()
( number x, number z, number height ) -> nil | number newHeight
'''Spring.SetSmoothMesh''' can only be called in SetSmoothMeshFunc()
( number x, number z, number height [,number terraform = 1] ) -> nil | number absHeightDiff

== TerrainTypes ==
'''Spring.SetMapSquareTerrainType'''
( number x, number z, int newType ) -> nil | int oldType
'''Spring.SetTerrainTypeData'''
( int typeIndex
[, number speedTanks = nil ]
[, number speedKBOTs = nil ]
[, number speedHovers = nil ]
[, number speedShips = nil ] ) -> nil | boolean true

= 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

an ugly global switch that can be used to block units turning into features when they finish being built (like *A DT's do, which have the isFeature tag)
[http://springrts.com/phpbb/viewtopic.php?f=14&p=481521 thread]


'''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.SetProjectileMoveControl''' (disables engine movecontrol, so lua can fully control the physics)
( number projID, boolean enable ) -> nil
'''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
'''Spring.SetProjectileGravity'''
( number projID [, number grav = 0] ) -> nil
'''Spring.SetProjectileSpinAngle'''
( number projID [, number spinAngle = 0] ) -> nil
'''Spring.SetProjectileSpinSpeed'''
( number projID [, number speed = 0] ) -> nil
'''Spring.SetProjectileSpinVec'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0]]] ) -> nil
'''Spring.SetProjectileCEG'''
( number projID, string ceg_name ) -> nil

[[category: Lua]]

Building Spring on Linux

2011-08-03T21:29:46Z

Tobi: /* Fedora */

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

= Build From Source on Linux =
If you prefer to use your distributions package system (release versions only), refer to the Linux [[SetupGuide]].

If there is no package tailored for your distribution, you have to install from sources manually. Doing this for distributions where packages are available is not recommended.

'''Warning:''' 
'''Be careful when building from source.''' 
You might encounter sync errors in online play if:
* you are using an untested compiler (''gcc'' from the 4.x serie should be safe)
* you use non-standard compiler settings (be careful about ''-march'')!


== Obtaining the Source ==
{{Obtaining_The_Source_Code}}

= Get Dependencies =

To compile, you will have to install some development packages Spring depends on. These vary from distro to distro and may also depend on your specific configuration.

If your distributions is not listed below, you should be able to figure out the correct package names from this.

== Full list ==
* Programs necessary to build
** ''cmake''
** ''7zip'' (aka ''p7zip'' or ''7z'')
** The usual build toolchain
*** ''gcc''
*** ''make''
* Libraries
** SDL
** ''boost'' (version 1.35 or later)
*** ''threads''
*** ''regex''
*** ''signals''
*** ''system''
*** ''program-options''
** ''libdeviL'' (IL)
** OpenAL (openal-soft, older openal-0.0.8 does not work)
** OpenGL headers (mesa, GLEW, etc.)
** ''zlib''
** ''freetype'' (2)
** ''ogg'', ''vorbis'' and ''vorbisfile''
* Optional (for AI Interfaces and Skirmish AIs)
** ''python'' (2.5+)
** ''jdk'' (1.5+)

== Debian ==

For Etch (debian 4.0 stable) and Sid (debian unstable), I've confirmed the
following to be the minimal set that is necessary to get. This works with Ubuntu 8.10, too.
As of ~ July 2009, spring depends on boost 1.35+ (if your distro is behind, you can try [https://launchpad.net/~pgquiles/+archive/ppa some unofficial backports]).

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

<code><pre>
sudo aptitude install build-essential zlib1g-dev libfreetype6-dev
sudo aptitude install libsdl1.2-dev libopenal-dev libglew-dev zip
sudo aptitude install libvorbis-dev libxcursor-dev libdevil-dev
sudo aptitude install libboost-system1.37-dev libboost-system1.37-thread-dev
sudo aptitude install libboost-system1.37-regex-dev
sudo aptitude install libboost-system1.37-serialization-dev
sudo aptitude install libboost-system1.37-program-options-dev
</pre></code>

and cmake, depending on what you use for building (I advise to use cmake). On debian 5.0 (lenny), libglew1.5-dev is required as well.

=== Ubuntu ===
<code><pre>
# compiler and build tools
sudo apt-get install build-essential cmake cmake-gui git

# spring dependencies
sudo apt-get install libglew-dev libsdl-dev libdevil-dev libopenal-dev \
libogg-dev libvorbis-dev libfreetype6-dev p7zip-full libxcursor-dev \
libboost-thread1.42-dev libboost-regex1.42-dev libboost-system1.42-dev \
libboost-program-options1.42-dev libboost-signals1.42-dev

# alternatively, you can try ...
sudo apt-get build-dep spring
</pre></code>

... and that should install all the required dependencies (''it should but it appears to be broken - SpliFF 2011-02-21'').

NOTE: On Ubuntu the CMake scripts currently don't detect FREETYPE_INCLUDE_DIR. You will need to set this by hand (using -DFREETYPE_INCLUDE_DIR="/usr/include/freetype2/freetype" or by adding an 'advanced' entry in cmake-gui).
(this problem is either not reproducible with Ubuntu 10.10, or not present in spring master anymore)

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

<code><pre>
emerge cmake \>=media-libs/freetype-2.0.0 \>=media-libs/libsdl-1.2.0
emerge media-libs/openal media-libs/glew dev-libs/boost
emerge app-arch/zip media-libs/libogg
USE="png jpg tiff opengl" emerge media-libs/devil
</pre></code>

== Fedora ==

On Fedora 8:

<code><pre>
yum install cmake boost-devel openal-devel SDL-devel \
DevIL-devel glew-devel libvorbis-devel
</pre></code>

On Fedora 12-15:

<code><pre>
yum install gcc-c++ cmake boost-devel DevIL-devel freetype-devel \
glew-devel libvorbis-devel libXcursor-devel openal-devel SDL-devel p7zip
</pre></code>

== Slackware ==

On Slackware 13, cmake, ogg & vorbis, boost, glew and SDL already come with the full regular install, both libs and headers. You can find helper scripts to easily compile and package DevIL, OpenAL and spring itself [http://slackbuilds.org/ here].

= Build And Install =

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

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

Install:

<code><pre>
make install-spring
</pre></code>

Default install paths are:

<code>/usr/local/bin/spring</code> Spring executable

<code>/usr/local/share/games/spring</code> read-only data

If you want <code>/usr</code> prefix instead of <code>/usr/local</code>, configure like this:

<code><pre>
cmake -DCMAKE_INSTALL_PREFIX=/usr .
</pre></code>
For further ways of customizing your build, have a look at the variables shown with:
<code><pre>
cmake -LH .
</pre></code>

Ububtu 9.10 - if it cannot locate freetype include dir, then use:
<code><pre>
cmake -DFREETYPE_INCLUDE_DIR=/usr .
</pre></code>

If you experience performance problems on multi-core systems, you may additionally build the MT version of spring:

<code><pre>
make spring-multithreaded
</pre></code>

And install with:
<code><pre>
make install-spring-multithreaded
</pre></code>

Other targets are: <code>spring-headless</code> and <code>spring-dedicated</code>.

{{Troubleshooting_linux}}

[[Category:Compiling]]
[[Category:Linux]]

Building Spring on Linux

2011-08-03T21:29:29Z

Tobi: /* Fedora */

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

= Build From Source on Linux =
If you prefer to use your distributions package system (release versions only), refer to the Linux [[SetupGuide]].

If there is no package tailored for your distribution, you have to install from sources manually. Doing this for distributions where packages are available is not recommended.

'''Warning:''' 
'''Be careful when building from source.''' 
You might encounter sync errors in online play if:
* you are using an untested compiler (''gcc'' from the 4.x serie should be safe)
* you use non-standard compiler settings (be careful about ''-march'')!


== Obtaining the Source ==
{{Obtaining_The_Source_Code}}

= Get Dependencies =

To compile, you will have to install some development packages Spring depends on. These vary from distro to distro and may also depend on your specific configuration.

If your distributions is not listed below, you should be able to figure out the correct package names from this.

== Full list ==
* Programs necessary to build
** ''cmake''
** ''7zip'' (aka ''p7zip'' or ''7z'')
** The usual build toolchain
*** ''gcc''
*** ''make''
* Libraries
** SDL
** ''boost'' (version 1.35 or later)
*** ''threads''
*** ''regex''
*** ''signals''
*** ''system''
*** ''program-options''
** ''libdeviL'' (IL)
** OpenAL (openal-soft, older openal-0.0.8 does not work)
** OpenGL headers (mesa, GLEW, etc.)
** ''zlib''
** ''freetype'' (2)
** ''ogg'', ''vorbis'' and ''vorbisfile''
* Optional (for AI Interfaces and Skirmish AIs)
** ''python'' (2.5+)
** ''jdk'' (1.5+)

== Debian ==

For Etch (debian 4.0 stable) and Sid (debian unstable), I've confirmed the
following to be the minimal set that is necessary to get. This works with Ubuntu 8.10, too.
As of ~ July 2009, spring depends on boost 1.35+ (if your distro is behind, you can try [https://launchpad.net/~pgquiles/+archive/ppa some unofficial backports]).

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

<code><pre>
sudo aptitude install build-essential zlib1g-dev libfreetype6-dev
sudo aptitude install libsdl1.2-dev libopenal-dev libglew-dev zip
sudo aptitude install libvorbis-dev libxcursor-dev libdevil-dev
sudo aptitude install libboost-system1.37-dev libboost-system1.37-thread-dev
sudo aptitude install libboost-system1.37-regex-dev
sudo aptitude install libboost-system1.37-serialization-dev
sudo aptitude install libboost-system1.37-program-options-dev
</pre></code>

and cmake, depending on what you use for building (I advise to use cmake). On debian 5.0 (lenny), libglew1.5-dev is required as well.

=== Ubuntu ===
<code><pre>
# compiler and build tools
sudo apt-get install build-essential cmake cmake-gui git

# spring dependencies
sudo apt-get install libglew-dev libsdl-dev libdevil-dev libopenal-dev \
libogg-dev libvorbis-dev libfreetype6-dev p7zip-full libxcursor-dev \
libboost-thread1.42-dev libboost-regex1.42-dev libboost-system1.42-dev \
libboost-program-options1.42-dev libboost-signals1.42-dev

# alternatively, you can try ...
sudo apt-get build-dep spring
</pre></code>

... and that should install all the required dependencies (''it should but it appears to be broken - SpliFF 2011-02-21'').

NOTE: On Ubuntu the CMake scripts currently don't detect FREETYPE_INCLUDE_DIR. You will need to set this by hand (using -DFREETYPE_INCLUDE_DIR="/usr/include/freetype2/freetype" or by adding an 'advanced' entry in cmake-gui).
(this problem is either not reproducible with Ubuntu 10.10, or not present in spring master anymore)

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

<code><pre>
emerge cmake \>=media-libs/freetype-2.0.0 \>=media-libs/libsdl-1.2.0
emerge media-libs/openal media-libs/glew dev-libs/boost
emerge app-arch/zip media-libs/libogg
USE="png jpg tiff opengl" emerge media-libs/devil
</pre></code>

== Fedora ==

On Fedora 8:

<code><pre>
yum install cmake boost-devel openal-devel SDL-devel \
DevIL-devel glew-devel libvorbis-devel
</pre></code>

On Fedora 12-14:

<code><pre>
yum install gcc-c++ cmake boost-devel DevIL-devel freetype-devel \
glew-devel libvorbis-devel libXcursor-devel openal-devel SDL-devel p7zip
</pre></code>

== Slackware ==

On Slackware 13, cmake, ogg & vorbis, boost, glew and SDL already come with the full regular install, both libs and headers. You can find helper scripts to easily compile and package DevIL, OpenAL and spring itself [http://slackbuilds.org/ here].

= Build And Install =

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

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

Install:

<code><pre>
make install-spring
</pre></code>

Default install paths are:

<code>/usr/local/bin/spring</code> Spring executable

<code>/usr/local/share/games/spring</code> read-only data

If you want <code>/usr</code> prefix instead of <code>/usr/local</code>, configure like this:

<code><pre>
cmake -DCMAKE_INSTALL_PREFIX=/usr .
</pre></code>
For further ways of customizing your build, have a look at the variables shown with:
<code><pre>
cmake -LH .
</pre></code>

Ububtu 9.10 - if it cannot locate freetype include dir, then use:
<code><pre>
cmake -DFREETYPE_INCLUDE_DIR=/usr .
</pre></code>

If you experience performance problems on multi-core systems, you may additionally build the MT version of spring:

<code><pre>
make spring-multithreaded
</pre></code>

And install with:
<code><pre>
make install-spring-multithreaded
</pre></code>

Other targets are: <code>spring-headless</code> and <code>spring-dedicated</code>.

{{Troubleshooting_linux}}

[[Category:Compiling]]
[[Category:Linux]]

Download

2010-09-03T20:32:07Z

Tobi: /* Latest Stable Snapshot */ update to 0.82.5

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

= Spring Engine Updates =
Latest stable version is: '''0.82'''

{|
| style="padding-right:10px"| [[Image:Window.png]]
| '''Installer: [http://sourceforge.net/projects/springrts/files/springrts/spring-0.82.5/spring_0.82.5.exe/download spring_0.82.5.exe ~18MB]''' - [http://springrts.com/dl/spring_0.82.5.exe {mirror}]''' 

|}

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

{|
| style="padding-right:10px"| [[Image:Apple.png]]
| ''' ''No download yet'' '''
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]]'''.
|}

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

= Source Code =
== git ==
'''[http://github.com/spring/spring Spring project page at github]''' [http://status.github.com (status page)]
=== Getting the Source ===
<code><pre>git clone git://github.com/spring/spring.git</pre></code>
This however gives you the bleeding edge, if you want to play online then run:
<code><pre>git checkout 0.82.3</pre></code>
from within the source directory. This will provide the correct source code
=== Alternate git url ===
<code><pre>git://springrts.git.sourceforge.net/gitroot/springrts/springrts</pre></code>

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

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

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.82.5/spring_0.82.5_src.tar.lzma/download Source .tar.lzma]''' - [http://springrts.com/dl/spring_0.82.5_src.tar.lzma {mirror}]

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.82.5/spring_0.82.5_src.tar.gz/download Source .tar.gz]''' - [http://springrts.com/dl/spring_0.82.5_src.tar.gz {mirror}]

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

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

== Lobby server==
If you do not want (or are unable) to use the public lobby server, you can download the server software here to run your own. See the readme '''[http://springrts.com/dl/tasserver_readme.txt here]'''.

'''[http://springrts.com/dl/TASServer.jar Click here to download]''' 100.7kb, added 2008-03-02 (requires Java Runtime Environment)

== SelectionEditor ==
Sources are in the [[#git|main git tree]] under "/tools/SelectionEditor/".

'''[http://springrts.com/dl/SelectionEditor.zip Click here to download (windows only)]'''
__NOTOC__

Download

2010-08-13T21:01:55Z

2010-05-30T20:05:11Z

Tobi:

=Spring RTS Engine=

==Windows==
The files listed here do not contain any game content like maps or playable games. If you want playable out-of-the-box installers, go to the [[GamesDownloads|Games Downloads page]].

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.81.2.1/spring_0.81.2.1.exe/download Click here to download ]''' version 0.81.2.1 ~18MB

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.81.2.1/spring_0.81.2.1_portable.7z/download Portable archive]''' version 0.81.2.1 ~15MB

Backup in case the above doesn't work

'''[http://springrts.com/dl/spring_0.81.2.1.exe Click here to download ]''' version 0.81.2.1 ~18MB

'''[http://springrts.com/dl/spring_0.81.2.1_portable.7z Portable archive ]''' version 0.81.2.1 ~15MB

=== Testing/Nightly Builds ===
See [[OtherDownloads|other downloads]]

==[[image:200px-Tux.svg.png|Linux|30px]] Linux==

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

==Mac OS X==

Sorry no download yet.
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 ==
{{Tarballs}}

= Alternative lobby client =

There is one actively developed alternative lobby client, called ''TASClient''. This lobby client is for Windows only.

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

= Lobby server=

If you do not want (or are unable) to use the public lobby server, you can download the server software here to run your own. See the readme '''[http://springrts.com/dl/tasserver_readme.txt here]'''.

'''[http://springrts.com/dl/TASServer.jar Click here to download]''' 100.7kb, added 2008-03-02 (requires Java Runtime Environment)

= SelectionEditor =

'''[http://springrts.com/dl/SelectionEditor.zip Click here to download]''' all required binaries to run the latest SelectionEditor. Sources are in [http://github.com/spring/spring/tree/master/tools/SelectionEditor/ git].

Download

2010-05-30T20:04:41Z

Tobi: added SelectionEditor

=Spring RTS Engine=

==Windows==
The files listed here do not contain any game content like maps or playable games. If you want playable out-of-the-box installers, go to the [[GamesDownloads|Games Downloads page]].

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.81.2.1/spring_0.81.2.1.exe/download Click here to download ]''' version 0.81.2.1 ~18MB

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.81.2.1/spring_0.81.2.1_portable.7z/download Portable archive]''' version 0.81.2.1 ~15MB

Backup in case the above doesn't work

'''[http://springrts.com/dl/spring_0.81.2.1.exe Click here to download ]''' version 0.81.2.1 ~18MB

'''[http://springrts.com/dl/spring_0.81.2.1_portable.7z Portable archive ]''' version 0.81.2.1 ~15MB

=== Testing/Nightly Builds ===
See [[OtherDownloads|other downloads]]

==[[image:200px-Tux.svg.png|Linux|30px]] Linux==

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

==Mac OS X==

Sorry no download yet.
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 ==
{{Tarballs}}

= Alternative lobby client =

There is one actively developed alternative lobby client, called ''TASClient''. This lobby client is for Windows only.

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

= Lobby server=

If you do not want (or are unable) to use the public lobby server, you can download the server software here to run your own. See the readme '''[http://springrts.com/dl/tasserver_readme.txt here]'''.

'''[http://springrts.com/dl/TASServer.jar Click here to download]''' 100.7kb, added 2008-03-02 (requires Java Runtime Environment)

= SelectionEditor =

'''[http://springrts.com/dl/SelectionEditor.zip Click here to download]''' all required binaries to run the latest SelectionEditor. Sources are in [http://github.com/spring/spring/tree/master/tools/SelectionEditor/ git].

Animation-LuaScripting

2010-04-19T21:55:30Z

Tobi:

== Getting started ==

=== Setup ===

Lua unit animation is implemented partially in the engine, and partially in a Lua gadget which is shipped with Spring in springcontent.sdz. By default, this gadget is not loaded, so a bit of setup is required to enable Lua unit scripts.

To enable Lua unit scripts, create a file ''LuaRules/Gadgets/unit_script.lua'', and paste the following into it:

{|border="0" cellpadding="4"
|style="background: #41545c; border: 1px #aaa solid;"|

-- Enables Lua unit scripts by including the gadget from springcontent.sdz

-- Uncomment to override the directory which is scanned for *.lua unit scripts.
--UNITSCRIPT_DIR = "scripts/"

return include("LuaGadgets/Gadgets/unit_script.lua")

|}

Also, do check whether your [http://github.com/spring/spring/blob/master/installer/builddata/springcontent/LuaGadgets/system.lua ''LuaRules/system.lua''] is up to date, if you copied this verbatim into your game. (Must be from a later date than 5 september 2009)

Now this is done, you can start putting *.lua files in your ''scripts/'' folder.

=== Workflow ===

Lua has the major advantage over BOS/COB that you do not need to compile it, which can reduce the time to develop scripts quite a bit.

To save further time, do not restart Spring for each small change. Simply run Spring in an window so you can easily switch between your editor and Spring, and use ''/luarules reload'' to reload all Lua unit scripts.

== Further reading ==

* [http://tvo.github.com/spring/2010/04/19/lus-stumpy.html Stumpy tutorial]
* [[Animation-LuaCallins]]
* [[Animation-LuaCallouts]]

== TODO ==

* Conversion tool
* Performance measurements
* Advantages
* Link to article in piro's magazine
* Coordinate system (axis, direction of rotation, picture)

[[Category:Animation]]

Tobi: Protected "GSoC More AI interfaces": protecting during application period [edit=sysop:move=sysop] (expires 22:00, 10 April 2010 (UTC))

= GSoC idea: More AI interfaces =

== Why ==
The Spring engine is already a popular engine for academic projects to study Artificial Intelligence. This project could enhance Spring's attractiveness to developers and teachers wanting to explore or teach about AI research.

== What ==
The Spring engine's AI interface supports bindings for multiple languages, currently C++, C and java are supported.

Bindings for more languages and/or virtual machines should be added to allow broader AI developing audience (for example: Ruby, Perl, JavaScript, Python, D, Go, Mono, LLVM, Parrot).

== Required skills ==
* Understanding of the Spring AI interface
* Knowledge of C
* Understanding of the target language/virtual machine

== Difficulty ==
Estimated: medium

== Technical details ==

The current C AI interface has been structured so it acts as a bridge between the engine and the various AI language wrappers, since automatic wrapper generators have been tried in the past and found infeasible, manual creation is necessary.

== Possible Mentor(s) ==

[[Google_Summer_of_Code_2010]]