Spring - User contributions [en]

Game and Unit development

2010-09-11T15:48:33Z

Mrz: /* .s3o */

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

=Game development=
This information is meant to help newcomers learn how to develop their own games for the Spring Engine.
==General==
*[[Mod specification|Game specification]] 
*[http://springrts.com/phpbb/viewtopic.php?t=6015 What do I need to create a game?]
*[[Simple Mod Tutorial|Simple Game Tutorial]]
*[[Freely available and reusable content|Freely available and reusable content for maps and games]]

==Unit Development==
===Units - Modeling===
Spring supports different 3d representations: '.s3o' and '.3do'. The biggest difference between both formats is the workflow to create a new unit. There are exporter plugins for 'blender' and '3ds-max' so that texturing and modeling can be done using these.
In contrast: when you model an '.3do' you have to use 'UpSpring' currently.

The animation with can either be done using 'lua' or 'COB/BOS' is does not depend on either, see rigging/animation. For new units use 'lua' scripting.

====.s3o====
Extends 3do with various new features (Use this for new units).

====.3do====
3do (implemented for compatibility to ta based game, old)

====s3o modeling====
* [[Basic s3o unit making guide]] (using UpSpring)
* [[s3o using blender]] (not using UpSpring)
* [[Trouble-shooting s3o units]]

====Models - Modeling, UV Mapping====
* [http://springrts.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]

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

====Models - 3do Files====
'''NOTE:''' 3do is an outdated model format used by OTA models (Balanced Annihilation, NOTA, etc.). 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://springrts.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://springfiles.com/1755 3doBuilder] to edit those files
*[http://user.supradigital.org/jcnossen/UpspringInstaller-1.54-EulerAngles.exe Click here to download UpSpring, our content support tool.]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=15106 Argh's UpSpring Easy Workflow Guide]
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures- very outdated].

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - LUA Files]===
To edit .lua files you need a text editor.
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
**[[Animation-CobLuaDifferences]]
**[[lua-animation-basic-tutorial]] to clean
**[[lua-animation-synthax-usage]] to develop and clean

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - COB/BOS Files]===
The binary '.cob' file format is obsolete and some '.cob' files might be copyrighed by cavedog. A '.cob' file can be decompiled to see what it is doing or if you have the source, that is a '.bos' file, you can compile it into a '.cob' file.

To edit .bos files you need a program/compiler. The most famous one is [http://jobjol.nl/1384 Scriptor]
*[[Animation-CobLuaDifferences]]
*[[Animation-CobOverview]]
**[[Animation-CobExamples]]
**[[Animation-CobAnimation]]
**[[Animation-CobCallins]]
**[[Animation-CobConstants]]
**[[Animation-CobThreads]]
**[[Animation-CobHitByWeaponID]]
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Game Development:Calling basic CEGs from COB]]
* [http://springrts.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

===Units - FBI Files===
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Unit_Categories]]

===Units - MoveTypes===
*[[Units:MoveTypes]]

===Weapons - TDF Files===
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.
*[[Weapons:Antinukes]]: All about antinukes.

===Explosions===
*[[CEG]]
**[[CEG-Calls]]
**[[CEG-Format]]
**[[CEG-Classes]]
**[[CEG-Operators]]
**[[CEG-Miscellaneous]]
**[[CEG-OldInfo]]

===Misc===
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor|Game Development:Armor]]
*[[Mod Development:Cursors|Game Development:Cursors]]
*[[Mod Development:Archives|Game Development:Archives]]
*[[Mod Development:Sidepics|Game Development:Sidepics]]
*[[CustomUnitIcons|Game Development:Custom unit icons]]

===Legacy Porting Tools===
====Automated Game Creation====
* [[TA2Spring]] - Automatically adds and converts Total Annihilation unit packs (.ufo files, etc..) into Spring games (requires a base game for the game rules, XTA is recommended, it is probably not properly supported by current Spring)

[[Category: Unit_development]]
[[Category: Mod_development]]

Game and Unit development

2010-09-11T11:02:58Z

Mrz: /* s3o modeling */

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

=Game development=
This information is meant to help newcomers learn how to develop their own games for the Spring Engine.
==General==
*[[Mod specification|Game specification]] 
*[http://springrts.com/phpbb/viewtopic.php?t=6015 What do I need to create a game?]
*[[Simple Mod Tutorial|Simple Game Tutorial]]
*[[Freely available and reusable content|Freely available and reusable content for maps and games]]

==Unit Development==
===Units - Modeling===
Spring supports different 3d representations: '.s3o' and '.3do'. The biggest difference between both formats is the workflow to create a new unit. There are exporter plugins for 'blender' and '3ds-max' so that texturing and modeling can be done using these.
In contrast: when you model an '.3do' you have to use 'UpSpring' currently.

The animation with can either be done using 'lua' or 'COB/BOS' is does not depend on either, see rigging/animation. For new units use 'lua' scripting.

====.s3o====
Extends 3do with various new features. Use this for new units

====.3do====
3do (implemented for compatibility to ta based game, old)

====s3o modeling====
* [[Basic s3o unit making guide]] (using UpSpring)
* [[s3o using blender]] (not using UpSpring)
* [[Trouble-shooting s3o units]]

====Models - Modeling, UV Mapping====
* [http://springrts.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]

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

====Models - 3do Files====
'''NOTE:''' 3do is an outdated model format used by OTA models (Balanced Annihilation, NOTA, etc.). 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://springrts.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://springfiles.com/1755 3doBuilder] to edit those files
*[http://user.supradigital.org/jcnossen/UpspringInstaller-1.54-EulerAngles.exe Click here to download UpSpring, our content support tool.]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=15106 Argh's UpSpring Easy Workflow Guide]
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures- very outdated].

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - LUA Files]===
To edit .lua files you need a text editor.
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
**[[Animation-CobLuaDifferences]]
**[[lua-animation-basic-tutorial]] to clean
**[[lua-animation-synthax-usage]] to develop and clean

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - COB/BOS Files]===
The binary '.cob' file format is obsolete and some '.cob' files might be copyrighed by cavedog. A '.cob' file can be decompiled to see what it is doing or if you have the source, that is a '.bos' file, you can compile it into a '.cob' file.

To edit .bos files you need a program/compiler. The most famous one is [http://jobjol.nl/1384 Scriptor]
*[[Animation-CobLuaDifferences]]
*[[Animation-CobOverview]]
**[[Animation-CobExamples]]
**[[Animation-CobAnimation]]
**[[Animation-CobCallins]]
**[[Animation-CobConstants]]
**[[Animation-CobThreads]]
**[[Animation-CobHitByWeaponID]]
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Game Development:Calling basic CEGs from COB]]
* [http://springrts.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

===Units - FBI Files===
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Unit_Categories]]

===Units - MoveTypes===
*[[Units:MoveTypes]]

===Weapons - TDF Files===
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.
*[[Weapons:Antinukes]]: All about antinukes.

===Explosions===
*[[CEG]]
**[[CEG-Calls]]
**[[CEG-Format]]
**[[CEG-Classes]]
**[[CEG-Operators]]
**[[CEG-Miscellaneous]]
**[[CEG-OldInfo]]

===Misc===
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor|Game Development:Armor]]
*[[Mod Development:Cursors|Game Development:Cursors]]
*[[Mod Development:Archives|Game Development:Archives]]
*[[Mod Development:Sidepics|Game Development:Sidepics]]
*[[CustomUnitIcons|Game Development:Custom unit icons]]

===Legacy Porting Tools===
====Automated Game Creation====
* [[TA2Spring]] - Automatically adds and converts Total Annihilation unit packs (.ufo files, etc..) into Spring games (requires a base game for the game rules, XTA is recommended, it is probably not properly supported by current Spring)

[[Category: Unit_development]]
[[Category: Mod_development]]

S3o using blender

2010-09-11T10:58:59Z

Mrz: /* Links */

== motivation ==
This guide helps you to create a '.s3o' unit for spring using:
* 'blender' - for 3d moddeling
* 'gimp' - for texturing (or similar tools for 2d art)

== The Tools ==
First download/install blender, then install a blender-compatible python version. The command shell window for blender will tell you which version of python it was compiled with, get specifically that version of python. Finally download the exporter for blender, found at [1].

Once all is installed you can either work from scratch or start working based on a template [2]. If you start from scratch, have a look at [1] to meet all requirements for the exporter script, such as naming conventions and necessary empties.

== Editing and Exporting ==
The parenting system of blender is used to find the chain of children for exporting. Each child must have a unique name which can later be used for rigging.

Important: the model MUST have exactly two textures:
* 1. texture RGBA32 where:
**RGB is used for coloring and A is used for team-coloring

* 2. texture RGBA32 where:
**R for glow
**G for reflectivity
**B 'unassigned' (mod dependent)
**A for transparency (standard ARB shader supports only 1 bit that is: either render the pixel, or not)

=== Notes on working with the Template ===
Everything should be properly configured for export, with necessary empties etc present. If objects are hidden from view for better editing, press ALT+H to unhide all objects.

When you start working on the base mesh, remember not to delete the object itself. Go into Edit Mode, select all vertices and delete them. Then add primitives/vertices/... to your empty mesh of the still-valid base object.

After meshing out your model, remember to check whether you need to move/scale the empties that you see in the node viewer. The cubic empty sets the ground midpoint of the object, the arrow empty is used for height purposes and the spheric empty defines the model's boundary box.

== Notes on the export step ==
The active selection does not influence the exporter therefore you don't need to select any object (still you can) to make a valid export.
The exporter will loop over all objects in the scene automatically.

Please note that the template you can download from [2] also includes a modified exporter script for blender that allows it to export the objects even while cameras and light setups are present in the scene for preview-rendering.

== Deployment & Testing==
Copy the '.s3o' in the folder:
* /mods/modname/objects3d/

While textures go into:
* /mods/modname/unittextures/

As your first model is a unit replacement, don't forget to modify the unitname.fbi (in case of the 'armsolar' replacement: use armsolar.fbi) and add your model there.
* /mods/modname/units/armsolar.fbi

WARNING: '''when using .s3o you have to add a suffix, else spring will crash!'''

Open the '/mods/modname/units/armsolar.fbi' and you will see:
=== units/armsolar.fbi: Valid for 3do ===
[UNITINFO] {
unitname=armsolar;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

we have to modify this in order to make it s3o aware with:

=== units/armsolar.fbi: Valid for s3o ===
[UNITINFO] {
'''unitname=armsolar.s3o;'''
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

== Links ==
* [1] http://springrts.com/phpbb/viewtopic.php?f=9&t=17026
* [2] http://www.lastlog.de/misc/s3o-template.zip

[[Category: Unit_development]]

S3o using blender

2010-09-11T10:57:50Z

Mrz: /* units/armsolar.fbi: Valid for s3o */

S3o using blender

2010-09-11T10:48:31Z

Mrz: /* Valid for s3o */

== motivation ==
This guide helps you to create a '.s3o' unit for spring using:
* 'blender' - for 3d moddeling
* 'gimp' - for texturing (or similar tools for 2d art)

== The Tools ==
First download/install blender, then install a blender-compatible python version. The command shell window for blender will tell you which version of python it was compiled with, get specifically that version of python. Finally download the exporter for blender, found at [1].

Once all is installed you can either work from scratch or start working based on a template [2]. If you start from scratch, have a look at [1] to meet all requirements for the exporter script, such as naming conventions and necessary empties.

== Editing and Exporting ==
The parenting system of blender is used to find the chain of children for exporting. Each child must have a unique name which can later be used for rigging.

Important: the model MUST have exactly two textures:
* 1. texture RGBA32 where:
**RGB is used for coloring and A is used for team-coloring

* 2. texture RGBA32 where:
**R for glow
**G for reflectivity
**B 'unassigned' (mod dependent)
**A for transparency (standard ARB shader supports only 1 bit that is: either render the pixel, or not)

=== Notes on working with the Template ===
Everything should be properly configured for export, with necessary empties etc present. If objects are hidden from view for better editing, press ALT+H to unhide all objects.

When you start working on the base mesh, remember not to delete the object itself. Go into Edit Mode, select all vertices and delete them. Then add primitives/vertices/... to your empty mesh of the still-valid base object.

After meshing out your model, remember to check whether you need to move/scale the empties that you see in the node viewer. The cubic empty sets the ground midpoint of the object, the arrow empty is used for height purposes and the spheric empty defines the model's boundary box.

== Notes on the export step ==
The active selection does not influence the exporter therefore you don't need to select any object (still you can) to make a valid export.
The exporter will loop over all objects in the scene automatically.

Please note that the template you can download from [2] also includes a modified exporter script for blender that allows it to export the objects even while cameras and light setups are present in the scene for preview-rendering.

== Deployment & Testing==
Copy the '.s3o' in the folder:
* /mods/modname/objects3d/

While textures go into:
* /mods/modname/unittextures/

As your first model is a unit replacement, don't forget to modify the unitname.fbi (in case of the 'armsolar' replacement: use armsolar.fbi) and add your model there.
* /mods/modname/units/armsolar.fbi

WARNING: '''when using .s3o you have to add a suffix, else spring will crash!'''

Open the '/mods/modname/units/armsolar.fbi' and you will see:
=== units/armsolar.fbi: Valid for 3do ===
[UNITINFO] {
unitname=armsolar;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

we have to modify this in order to make it s3o aware with:

=== units/armsolar.fbi: Valid for s3o ===
[UNITINFO] {
unitname=armsolar.s3o;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

== Links ==
* [1] http://springrts.com/phpbb/viewtopic.php?f=9&t=17026
* [2] http://www.lastlog.de/misc/s3o-template.zip

S3o using blender

2010-09-11T10:48:19Z

Mrz: /* Valid for 3do */

== motivation ==
This guide helps you to create a '.s3o' unit for spring using:
* 'blender' - for 3d moddeling
* 'gimp' - for texturing (or similar tools for 2d art)

== The Tools ==
First download/install blender, then install a blender-compatible python version. The command shell window for blender will tell you which version of python it was compiled with, get specifically that version of python. Finally download the exporter for blender, found at [1].

Once all is installed you can either work from scratch or start working based on a template [2]. If you start from scratch, have a look at [1] to meet all requirements for the exporter script, such as naming conventions and necessary empties.

== Editing and Exporting ==
The parenting system of blender is used to find the chain of children for exporting. Each child must have a unique name which can later be used for rigging.

Important: the model MUST have exactly two textures:
* 1. texture RGBA32 where:
**RGB is used for coloring and A is used for team-coloring

* 2. texture RGBA32 where:
**R for glow
**G for reflectivity
**B 'unassigned' (mod dependent)
**A for transparency (standard ARB shader supports only 1 bit that is: either render the pixel, or not)

=== Notes on working with the Template ===
Everything should be properly configured for export, with necessary empties etc present. If objects are hidden from view for better editing, press ALT+H to unhide all objects.

When you start working on the base mesh, remember not to delete the object itself. Go into Edit Mode, select all vertices and delete them. Then add primitives/vertices/... to your empty mesh of the still-valid base object.

After meshing out your model, remember to check whether you need to move/scale the empties that you see in the node viewer. The cubic empty sets the ground midpoint of the object, the arrow empty is used for height purposes and the spheric empty defines the model's boundary box.

== Notes on the export step ==
The active selection does not influence the exporter therefore you don't need to select any object (still you can) to make a valid export.
The exporter will loop over all objects in the scene automatically.

Please note that the template you can download from [2] also includes a modified exporter script for blender that allows it to export the objects even while cameras and light setups are present in the scene for preview-rendering.

== Deployment & Testing==
Copy the '.s3o' in the folder:
* /mods/modname/objects3d/

While textures go into:
* /mods/modname/unittextures/

As your first model is a unit replacement, don't forget to modify the unitname.fbi (in case of the 'armsolar' replacement: use armsolar.fbi) and add your model there.
* /mods/modname/units/armsolar.fbi

WARNING: '''when using .s3o you have to add a suffix, else spring will crash!'''

Open the '/mods/modname/units/armsolar.fbi' and you will see:
=== units/armsolar.fbi: Valid for 3do ===
[UNITINFO] {
unitname=armsolar;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

we have to modify this in order to make it s3o aware with:

=== Valid for s3o ===
[UNITINFO] {
unitname=armsolar.s3o;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

== Links ==
* [1] http://springrts.com/phpbb/viewtopic.php?f=9&t=17026
* [2] http://www.lastlog.de/misc/s3o-template.zip

S3o using blender

2010-09-11T10:47:37Z

Mrz: /* Deployment & Testing */

== motivation ==
This guide helps you to create a '.s3o' unit for spring using:
* 'blender' - for 3d moddeling
* 'gimp' - for texturing (or similar tools for 2d art)

== The Tools ==
First download/install blender, then install a blender-compatible python version. The command shell window for blender will tell you which version of python it was compiled with, get specifically that version of python. Finally download the exporter for blender, found at [1].

Once all is installed you can either work from scratch or start working based on a template [2]. If you start from scratch, have a look at [1] to meet all requirements for the exporter script, such as naming conventions and necessary empties.

== Editing and Exporting ==
The parenting system of blender is used to find the chain of children for exporting. Each child must have a unique name which can later be used for rigging.

Important: the model MUST have exactly two textures:
* 1. texture RGBA32 where:
**RGB is used for coloring and A is used for team-coloring

* 2. texture RGBA32 where:
**R for glow
**G for reflectivity
**B 'unassigned' (mod dependent)
**A for transparency (standard ARB shader supports only 1 bit that is: either render the pixel, or not)

=== Notes on working with the Template ===
Everything should be properly configured for export, with necessary empties etc present. If objects are hidden from view for better editing, press ALT+H to unhide all objects.

When you start working on the base mesh, remember not to delete the object itself. Go into Edit Mode, select all vertices and delete them. Then add primitives/vertices/... to your empty mesh of the still-valid base object.

After meshing out your model, remember to check whether you need to move/scale the empties that you see in the node viewer. The cubic empty sets the ground midpoint of the object, the arrow empty is used for height purposes and the spheric empty defines the model's boundary box.

== Notes on the export step ==
The active selection does not influence the exporter therefore you don't need to select any object (still you can) to make a valid export.
The exporter will loop over all objects in the scene automatically.

Please note that the template you can download from [2] also includes a modified exporter script for blender that allows it to export the objects even while cameras and light setups are present in the scene for preview-rendering.

== Deployment & Testing==
Copy the '.s3o' in the folder:
* /mods/modname/objects3d/

While textures go into:
* /mods/modname/unittextures/

As your first model is a unit replacement, don't forget to modify the unitname.fbi (in case of the 'armsolar' replacement: use armsolar.fbi) and add your model there.
* /mods/modname/units/armsolar.fbi

WARNING: '''when using .s3o you have to add a suffix, else spring will crash!'''

Open the '/mods/modname/units/armsolar.fbi' and you will see:
=== Valid for 3do ===
[UNITINFO] {
unitname=armsolar;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

we have to modify this in order to make it s3o aware with:
=== Valid for s3o ===
[UNITINFO] {
unitname=armsolar.s3o;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

== Links ==
* [1] http://springrts.com/phpbb/viewtopic.php?f=9&t=17026
* [2] http://www.lastlog.de/misc/s3o-template.zip

Animation-LuaScripting

2010-09-11T10:41:57Z

Mrz: /* TODO */

== 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]
* [http://tvo.github.com/spring/2010/04/26/lus-stumpy-2.html Polishing the stumpy]
* [[Animation-LuaCallins]]
* [[Animation-LuaCallouts]]

== TODO ==

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

[[Category:Animation]]

S3o using blender

2010-09-11T10:38:19Z

Mrz: /* notes on the export step */

==motivation==
this guide helps you to create a '.s3o' unit for spring using:
* 'blender' - for 3d moddeling
* 'gimp' - for texturing

==the tools==
first download/install blender, then install a blender-compatible python version. finally download the exporter for blender, found at [1].

Once all is installed you can either work from scratch or start working based on a template [2]. if you start from scratch, have a look at [1] to met all requirements for the exporter script.

== editing and exporting ==
The parenting system of blender is used to find the chain of children for exporting. Each child must have a unique name which can later be used for rigging.

Important: the model MUST have exactly two textures:
* 1. texture RGBA32 where:
**RGB is used for coloring and A is used for team-coloring

* 2. texture RGBA32 where:
**R for glow
**G for reflectivity
**B 'unassigned' (mod dependent)
**A for transparency (standard ARB shader supports only 1 bit that is: either render the pixel, or not)

== notes on the export step ==
The active selection does not influence the exporter therefore you don't need to select any object (still you can) to make a valid export.
The exporter will loop over all objects in the scene automatically.

Please note that the template you can download from [2] also includes a modified exporter script for blender.

== deployment & testing==
Copy the '.s3o' in the folder:
* /mods/modname/objects3d/

While textures go into:
* /mods/modname/unittextures/

* As your first model is a unit replacement, don't forget to modify the unitname.fbi (in case of the 'armsolar' replacement: use armsolar.fbi) and add your model there.
* /mods/modname/units/armsolar.fbi

WARNING: '''when using .s3o you have to add a suffix, else spring will crash!'''

Open the '/mods/modname/units/armsolar.fbi' and you will see:
===valid for 3do ===
[UNITINFO] {
unitname=armsolar;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

we have to modify this in order to make it s3o aware with:
===valid for s3o ===
[UNITINFO] {
unitname=armsolar.s3o;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

== links ==
* [1] http://springrts.com/phpbb/viewtopic.php?f=9&t=17026
* [2] http://www.lastlog.de/misc/s3o-template.zip

S3o using blender

2010-09-11T10:35:53Z

Mrz:

==motivation==
this guide helps you to create a '.s3o' unit for spring using:
* 'blender' - for 3d moddeling
* 'gimp' - for texturing

==the tools==
first download/install blender, then install a blender-compatible python version. finally download the exporter for blender, found at [1].

Once all is installed you can either work from scratch or start working based on a template [2]. if you start from scratch, have a look at [1] to met all requirements for the exporter script.

== editing and exporting ==
The parenting system of blender is used to find the chain of children for exporting. Each child must have a unique name which can later be used for rigging.

Important: the model MUST have exactly two textures:
* 1. texture RGBA32 where:
**RGB is used for coloring and A is used for team-coloring

* 2. texture RGBA32 where:
**R for glow
**G for reflectivity
**B 'unassigned' (mod dependent)
**A for transparency (standard ARB shader supports only 1 bit that is: either render the pixel, or not)

== notes on the export step ==
The active selection does not influence the exporter therefore you don't need to select any object (still you can) to make a valid export.
The exporter will loop over all objects in the scene automatically.

== deployment & testing==
Copy the '.s3o' in the folder:
* /mods/modname/objects3d/

While textures go into:
* /mods/modname/unittextures/

* As your first model is a unit replacement, don't forget to modify the unitname.fbi (in case of the 'armsolar' replacement: use armsolar.fbi) and add your model there.
* /mods/modname/units/armsolar.fbi

WARNING: '''when using .s3o you have to add a suffix, else spring will crash!'''

Open the '/mods/modname/units/armsolar.fbi' and you will see:
===valid for 3do ===
[UNITINFO] {
unitname=armsolar;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

we have to modify this in order to make it s3o aware with:
===valid for s3o ===
[UNITINFO] {
unitname=armsolar.s3o;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

== links ==
* [1] http://springrts.com/phpbb/viewtopic.php?f=9&t=17026
* [2] http://www.lastlog.de/misc/s3o-template.zip

S3o using blender

2010-09-11T10:33:50Z

Mrz: /* motivation */

==motivation==
this guide helps you to create a '.s3o' unit for spring using:
* 'blender' - for 3d moddeling
* 'gimp' - for texturing

==the tools==
first download/install blender, then install a blender-compatible python version. finally download the exporter for blender, found at [1].

Once all is installed you can either work from scratch or start working based on a template [2]. if you start from scratch, have a look at [1] to met all requirements for the exporter script.

== editing and exporting ==
Edit the 'base' and extend it with childs. The parenting system of blender is used to find a chain of childs which get exported. Objects which are no childs of the base objects are NOT exported. Each child must have a unique name which can later be used for rigging.

Important: the model MUST have exactly two textures:
* 1. texture RGBA32 where:
**RGB is used for coloring and A is used for team-coloring

* 2. texture RGBA32 where:
**R for glow
**G for reflectivity
**B 'unassigned' (mod dependent)
**A for transparency (standard ARB shader supports only 1 bit that is: either render the pixel, or not)

== notes on the export step ==
The active selection does not influence the exporter therefore you don't need to select any object (still you can) to make a valid export.
The exporter will loop over all objects in the scene automatically.

== deployment & testing==
Copy the '.s3o' in the folder:
* /mods/modname/objects3d/

While textures go into:
* /mods/modname/unittextures/

* As your first model is a unit replacement, don't forget to modify the unitname.fbi (in case of the 'armsolar' replacement: use armsolar.fbi) and add your model there.
* /mods/modname/units/armsolar.fbi

WARNING: '''when using .s3o you have to add a suffix, else spring will crash!'''

Open the '/mods/modname/units/armsolar.fbi' and you will see:
===valid for 3do ===
[UNITINFO] {
unitname=armsolar;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

we have to modify this in order to make it s3o aware with:
===valid for s3o ===
[UNITINFO] {
unitname=armsolar.s3o;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

== links ==
* [1] http://springrts.com/phpbb/viewtopic.php?f=9&t=17026
* [2] http://www.lastlog.de/misc/s3o-template.zip

S3o using blender

2010-09-11T10:32:53Z

Mrz: New page: ==motivation== this guide helps you to create a '.s3o' unit for spring using: * 'blender' - for 3d moddeling * 'gimp' - for texturing * 'lua' - for animation ==the tools== first download/...

==motivation==
this guide helps you to create a '.s3o' unit for spring using:
* 'blender' - for 3d moddeling
* 'gimp' - for texturing
* 'lua' - for animation

==the tools==
first download/install blender, then install a blender-compatible python version. finally download the exporter for blender, found at [1].

Once all is installed you can either work from scratch or start working based on a template [2]. if you start from scratch, have a look at [1] to met all requirements for the exporter script.

== editing and exporting ==
Edit the 'base' and extend it with childs. The parenting system of blender is used to find a chain of childs which get exported. Objects which are no childs of the base objects are NOT exported. Each child must have a unique name which can later be used for rigging.

Important: the model MUST have exactly two textures:
* 1. texture RGBA32 where:
**RGB is used for coloring and A is used for team-coloring

* 2. texture RGBA32 where:
**R for glow
**G for reflectivity
**B 'unassigned' (mod dependent)
**A for transparency (standard ARB shader supports only 1 bit that is: either render the pixel, or not)

== notes on the export step ==
The active selection does not influence the exporter therefore you don't need to select any object (still you can) to make a valid export.
The exporter will loop over all objects in the scene automatically.

== deployment & testing==
Copy the '.s3o' in the folder:
* /mods/modname/objects3d/

While textures go into:
* /mods/modname/unittextures/

* As your first model is a unit replacement, don't forget to modify the unitname.fbi (in case of the 'armsolar' replacement: use armsolar.fbi) and add your model there.
* /mods/modname/units/armsolar.fbi

WARNING: '''when using .s3o you have to add a suffix, else spring will crash!'''

Open the '/mods/modname/units/armsolar.fbi' and you will see:
===valid for 3do ===
[UNITINFO] {
unitname=armsolar;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

we have to modify this in order to make it s3o aware with:
===valid for s3o ===
[UNITINFO] {
unitname=armsolar.s3o;
name=Solar Collector;
description=Produces Energy;
acceleration=0;
activateWhenBuilt=1;
...

== links ==
* [1] http://springrts.com/phpbb/viewtopic.php?f=9&t=17026
* [2] http://www.lastlog.de/misc/s3o-template.zip

Game and Unit development

2010-09-11T10:04:12Z

Mrz: /* s3o modeling */

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

=Game development=
This information is meant to help newcomers learn how to develop their own games for the Spring Engine.
==General==
*[[Mod specification|Game specification]] 
*[http://springrts.com/phpbb/viewtopic.php?t=6015 What do I need to create a game?]
*[[Simple Mod Tutorial|Simple Game Tutorial]]
*[[Freely available and reusable content|Freely available and reusable content for maps and games]]

==Unit Development==
===Units - Modeling===
Spring supports different 3d representations: '.s3o' and '.3do'. The biggest difference between both formats is the workflow to create a new unit. There are exporter plugins for 'blender' and '3ds-max' so that texturing and modeling can be done using these.
In contrast: when you model an '.3do' you have to use 'UpSpring' currently.

The animation with can either be done using 'lua' or 'COB/BOS' is does not depend on either, see rigging/animation. For new units use 'lua' scripting.

====.s3o====
Extends 3do with various new features. Use this for new units

====.3do====
3do (implemented for compatibility to ta based game, old)

====s3o modeling====
* [[Basic s3o unit making guide]] (using UpSpring)
* [[Trouble-shooting s3o units]]
* [[s3o using blender]] (not using UpSpring)

====Models - Modeling, UV Mapping====
* [http://springrts.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]

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

====Models - 3do Files====
'''NOTE:''' 3do is an outdated model format used by OTA models (Balanced Annihilation, NOTA, etc.). 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://springrts.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://springfiles.com/1755 3doBuilder] to edit those files
*[http://user.supradigital.org/jcnossen/UpspringInstaller-1.54-EulerAngles.exe Click here to download UpSpring, our content support tool.]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=15106 Argh's UpSpring Easy Workflow Guide]
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures- very outdated].

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - LUA Files]===
To edit .lua files you need a text editor.
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
**[[Animation-CobLuaDifferences]]
**[[lua-animation-basic-tutorial]] to clean
**[[lua-animation-synthax-usage]] to develop and clean

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - COB/BOS Files]===
The binary '.cob' file format is obsolete and some '.cob' files might be copyrighed by cavedog. A '.cob' file can be decompiled to see what it is doing or if you have the source, that is a '.bos' file, you can compile it into a '.cob' file.

To edit .bos files you need a program/compiler. The most famous one is [http://jobjol.nl/1384 Scriptor]
*[[Animation-CobLuaDifferences]]
*[[Animation-CobOverview]]
**[[Animation-CobExamples]]
**[[Animation-CobAnimation]]
**[[Animation-CobCallins]]
**[[Animation-CobConstants]]
**[[Animation-CobThreads]]
**[[Animation-CobHitByWeaponID]]
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Game Development:Calling basic CEGs from COB]]
* [http://springrts.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

===Units - FBI Files===
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Unit_Categories]]

===Units - MoveTypes===
*[[Units:MoveTypes]]

===Weapons - TDF Files===
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.
*[[Weapons:Antinukes]]: All about antinukes.

===Explosions===
*[[CEG]]
**[[CEG-Calls]]
**[[CEG-Format]]
**[[CEG-Classes]]
**[[CEG-Operators]]
**[[CEG-Miscellaneous]]
**[[CEG-OldInfo]]

===Misc===
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor|Game Development:Armor]]
*[[Mod Development:Cursors|Game Development:Cursors]]
*[[Mod Development:Archives|Game Development:Archives]]
*[[Mod Development:Sidepics|Game Development:Sidepics]]
*[[CustomUnitIcons|Game Development:Custom unit icons]]

===Legacy Porting Tools===
====Automated Game Creation====
* [[TA2Spring]] - Automatically adds and converts Total Annihilation unit packs (.ufo files, etc..) into Spring games (requires a base game for the game rules, XTA is recommended, it is probably not properly supported by current Spring)

[[Category: Unit_development]]
[[Category: Mod_development]]

Game and Unit development

2010-09-11T10:02:11Z

Mrz:

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

=Game development=
This information is meant to help newcomers learn how to develop their own games for the Spring Engine.
==General==
*[[Mod specification|Game specification]] 
*[http://springrts.com/phpbb/viewtopic.php?t=6015 What do I need to create a game?]
*[[Simple Mod Tutorial|Simple Game Tutorial]]
*[[Freely available and reusable content|Freely available and reusable content for maps and games]]

==Unit Development==
===Units - Modeling===
Spring supports different 3d representations: '.s3o' and '.3do'. The biggest difference between both formats is the workflow to create a new unit. There are exporter plugins for 'blender' and '3ds-max' so that texturing and modeling can be done using these.
In contrast: when you model an '.3do' you have to use 'UpSpring' currently.

The animation with can either be done using 'lua' or 'COB/BOS' is does not depend on either, see rigging/animation. For new units use 'lua' scripting.

====.s3o====
Extends 3do with various new features. Use this for new units

====.3do====
3do (implemented for compatibility to ta based game, old)

====s3o modeling====
* [[Basic s3o unit making guide]]
* [[Trouble-shooting s3o units]]

====Models - Modeling, UV Mapping====
* [http://springrts.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]

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

====Models - 3do Files====
'''NOTE:''' 3do is an outdated model format used by OTA models (Balanced Annihilation, NOTA, etc.). 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://springrts.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://springfiles.com/1755 3doBuilder] to edit those files
*[http://user.supradigital.org/jcnossen/UpspringInstaller-1.54-EulerAngles.exe Click here to download UpSpring, our content support tool.]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=15106 Argh's UpSpring Easy Workflow Guide]
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures- very outdated].

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - LUA Files]===
To edit .lua files you need a text editor.
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
**[[Animation-CobLuaDifferences]]
**[[lua-animation-basic-tutorial]] to clean
**[[lua-animation-synthax-usage]] to develop and clean

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - COB/BOS Files]===
The binary '.cob' file format is obsolete and some '.cob' files might be copyrighed by cavedog. A '.cob' file can be decompiled to see what it is doing or if you have the source, that is a '.bos' file, you can compile it into a '.cob' file.

To edit .bos files you need a program/compiler. The most famous one is [http://jobjol.nl/1384 Scriptor]
*[[Animation-CobLuaDifferences]]
*[[Animation-CobOverview]]
**[[Animation-CobExamples]]
**[[Animation-CobAnimation]]
**[[Animation-CobCallins]]
**[[Animation-CobConstants]]
**[[Animation-CobThreads]]
**[[Animation-CobHitByWeaponID]]
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Game Development:Calling basic CEGs from COB]]
* [http://springrts.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

===Units - FBI Files===
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Unit_Categories]]

===Units - MoveTypes===
*[[Units:MoveTypes]]

===Weapons - TDF Files===
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.
*[[Weapons:Antinukes]]: All about antinukes.

===Explosions===
*[[CEG]]
**[[CEG-Calls]]
**[[CEG-Format]]
**[[CEG-Classes]]
**[[CEG-Operators]]
**[[CEG-Miscellaneous]]
**[[CEG-OldInfo]]

===Misc===
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor|Game Development:Armor]]
*[[Mod Development:Cursors|Game Development:Cursors]]
*[[Mod Development:Archives|Game Development:Archives]]
*[[Mod Development:Sidepics|Game Development:Sidepics]]
*[[CustomUnitIcons|Game Development:Custom unit icons]]

===Legacy Porting Tools===
====Automated Game Creation====
* [[TA2Spring]] - Automatically adds and converts Total Annihilation unit packs (.ufo files, etc..) into Spring games (requires a base game for the game rules, XTA is recommended, it is probably not properly supported by current Spring)

[[Category: Unit_development]]
[[Category: Mod_development]]

Game and Unit development

2010-09-11T09:49:45Z

Mrz: /* Units - Modeling, Rigging */

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

=Game development=
This information is meant to help newcomers learn how to develop their own games for the Spring Engine.
==General==
*[[Mod specification|Game specification]] 
*[http://springrts.com/phpbb/viewtopic.php?t=6015 What do I need to create a game?]
*[[Simple Mod Tutorial|Simple Game Tutorial]]
*[[Freely available and reusable content|Freely available and reusable content for maps and games]]

==Unit Development==
===Units - Modeling===
*[http://user.supradigital.org/jcnossen/UpspringInstaller-1.54-EulerAngles.exe Click here to download UpSpring, our content support tool.]
* [[Basic s3o unit making guide]]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=15106 Argh's UpSpring Easy Workflow Guide]
* [[Trouble-shooting s3o units]]
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures- very outdated].

====Models - Modeling, UV Mapping====
* [http://springrts.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]

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

====Models - 3do Files====
-NOTE- this is an outdated model format used by OTA models (Balanced Annihilation, NOTA, etc.). 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://springrts.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://springfiles.com/1755 3doBuilder] to edit those files

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - LUA Files]===
To edit .lua files you need a text editor.
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
**[[Animation-CobLuaDifferences]]
**[[lua-animation-basic-tutorial]] to clean
**[[lua-animation-synthax-usage]] to develop and clean

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - COB/BOS Files]===
The binary '.cob' file format is obsolete and some '.cob' files might be copyrighed by cavedog. A '.cob' file can be decompiled to see what it is doing or if you have the source, that is a '.bos' file, you can compile it into a '.cob' file.

To edit .bos files you need a program/compiler. The most famous one is [http://jobjol.nl/1384 Scriptor]
*[[Animation-CobLuaDifferences]]
*[[Animation-CobOverview]]
**[[Animation-CobExamples]]
**[[Animation-CobAnimation]]
**[[Animation-CobCallins]]
**[[Animation-CobConstants]]
**[[Animation-CobThreads]]
**[[Animation-CobHitByWeaponID]]
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Game Development:Calling basic CEGs from COB]]
* [http://springrts.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

===Units - FBI Files===
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Unit_Categories]]

===Units - MoveTypes===
*[[Units:MoveTypes]]

===Weapons - TDF Files===
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.
*[[Weapons:Antinukes]]: All about antinukes.

===Explosions===
*[[CEG]]
**[[CEG-Calls]]
**[[CEG-Format]]
**[[CEG-Classes]]
**[[CEG-Operators]]
**[[CEG-Miscellaneous]]
**[[CEG-OldInfo]]

===Misc===
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor|Game Development:Armor]]
*[[Mod Development:Cursors|Game Development:Cursors]]
*[[Mod Development:Archives|Game Development:Archives]]
*[[Mod Development:Sidepics|Game Development:Sidepics]]
*[[CustomUnitIcons|Game Development:Custom unit icons]]

===Legacy Porting Tools===
====Automated Game Creation====
* [[TA2Spring]] - Automatically adds and converts Total Annihilation unit packs (.ufo files, etc..) into Spring games (requires a base game for the game rules, XTA is recommended, it is probably not properly supported by current Spring)

[[Category: Unit_development]]
[[Category: Mod_development]]

Game and Unit development

2010-09-11T09:45:17Z

Mrz: /* Units - Models */

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

=Game development=
This information is meant to help newcomers learn how to develop their own games for the Spring Engine.
==General==
*[[Mod specification|Game specification]] 
*[http://springrts.com/phpbb/viewtopic.php?t=6015 What do I need to create a game?]
*[[Simple Mod Tutorial|Simple Game Tutorial]]
*[[Freely available and reusable content|Freely available and reusable content for maps and games]]

==Unit Development==
===Units - Modeling, Rigging===
*[http://user.supradigital.org/jcnossen/UpspringInstaller-1.54-EulerAngles.exe Click here to download UpSpring, our content support tool.]
* [[Basic s3o unit making guide]]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=15106 Argh's UpSpring Easy Workflow Guide]
* [[Trouble-shooting s3o units]]
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures- very outdated].

====Models - Modeling, UV Mapping====
* [http://springrts.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]

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

====Models - 3do Files====
-NOTE- this is an outdated model format used by OTA models (Balanced Annihilation, NOTA, etc.). 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://springrts.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://springfiles.com/1755 3doBuilder] to edit those files

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - LUA Files]===
To edit .lua files you need a text editor.
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
**[[Animation-CobLuaDifferences]]
**[[lua-animation-basic-tutorial]] to clean
**[[lua-animation-synthax-usage]] to develop and clean

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - COB/BOS Files]===
The binary '.cob' file format is obsolete and some '.cob' files might be copyrighed by cavedog. A '.cob' file can be decompiled to see what it is doing or if you have the source, that is a '.bos' file, you can compile it into a '.cob' file.

To edit .bos files you need a program/compiler. The most famous one is [http://jobjol.nl/1384 Scriptor]
*[[Animation-CobLuaDifferences]]
*[[Animation-CobOverview]]
**[[Animation-CobExamples]]
**[[Animation-CobAnimation]]
**[[Animation-CobCallins]]
**[[Animation-CobConstants]]
**[[Animation-CobThreads]]
**[[Animation-CobHitByWeaponID]]
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Game Development:Calling basic CEGs from COB]]
* [http://springrts.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

===Units - FBI Files===
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Unit_Categories]]

===Units - MoveTypes===
*[[Units:MoveTypes]]

===Weapons - TDF Files===
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.
*[[Weapons:Antinukes]]: All about antinukes.

===Explosions===
*[[CEG]]
**[[CEG-Calls]]
**[[CEG-Format]]
**[[CEG-Classes]]
**[[CEG-Operators]]
**[[CEG-Miscellaneous]]
**[[CEG-OldInfo]]

===Misc===
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor|Game Development:Armor]]
*[[Mod Development:Cursors|Game Development:Cursors]]
*[[Mod Development:Archives|Game Development:Archives]]
*[[Mod Development:Sidepics|Game Development:Sidepics]]
*[[CustomUnitIcons|Game Development:Custom unit icons]]

===Legacy Porting Tools===
====Automated Game Creation====
* [[TA2Spring]] - Automatically adds and converts Total Annihilation unit packs (.ufo files, etc..) into Spring games (requires a base game for the game rules, XTA is recommended, it is probably not properly supported by current Spring)

[[Category: Unit_development]]
[[Category: Mod_development]]

Animation-CobLuaDifferences

2010-09-11T09:34:51Z

Mrz: /* Overview of differences between COB unit scripts and Lua unit scripts */

== Overview of differences between COB unit scripts and Lua unit scripts ==
* using Lua for scripting units, one can change the script while the game is running and reload it using '/luarules reload' when in cheat mode. Using COB/BOS one would have to restart the game
* Units of measurement: Lua uses elmos and radians consistently.
* Coordinate system: In Lua, coordinate system is same as world coordinate system, with all rotations right-handed. In COB, the moves along the x-axis and rotations around the z-axis have a different sign.
* In Lua, ''Killed'' gets recentDamage and maxHealth as separate arguments. In COB, you get only the ratio recentDamage/maxHealth*100.
* Where COB uses ''SetMaxReloadTime'', Lua uses ''GetMaxReloadTime''.
* Where COB uses ''QueryLandingPadCount'' and ''QueryLandingPad'', Lua uses ''QueryLandingPad'''s'''''
* The x and z arguments to ''HitByWeapon'', ''HitByWeaponId'' and ''RockUnit'' are given in (x, z) order in Lua, and the opposite order in COB.
* ''BeginTransport'' and ''EndTransport'' take the height of the unit in COB and the unitID in Lua. (Use 'local height = Spring.GetUnitHeight(unitID)' to get the height.)
* ''TransportDrop'' gets PACKXZ(x,z) in COB; in Lua, it gets the entire vector (x, y, z) as three arguments.
* Where COB uses ''SetSpeed'' and ''SetDirection'', Lua uses ''WindChanged'' and ''ExtractionRateChanged''.
* Lua does not have ''Go'' (this is called for activated extractors immediately after each ''SetSpeed'' call.)
[[Category:Unit_development]]
[[Category:Animation]]
[[Category:Lua]]

Game and Unit development

2010-09-11T09:32:18Z

Mrz: /* Scripting and Animation - COB/BOS Files */

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

=Game development=
This information is meant to help newcomers learn how to develop their own games for the Spring Engine.
==General==
*[[Mod specification|Game specification]] 
*[http://springrts.com/phpbb/viewtopic.php?t=6015 What do I need to create a game?]
*[[Simple Mod Tutorial|Simple Game Tutorial]]
*[[Freely available and reusable content|Freely available and reusable content for maps and games]]

==Unit Development==
===Units - Models===
*[http://user.supradigital.org/jcnossen/UpspringInstaller-1.54-EulerAngles.exe Click here to download UpSpring, our content support tool.]
* [[Basic s3o unit making guide]]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=15106 Argh's UpSpring Easy Workflow Guide]
* [[Trouble-shooting s3o units]]
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures- very outdated].

====Models - Modeling, UV Mapping====
* [http://springrts.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]

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

====Models - 3do Files====
-NOTE- this is an outdated model format used by OTA models (Balanced Annihilation, NOTA, etc.). 
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://springrts.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://springfiles.com/1755 3doBuilder] to edit those files

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - LUA Files]===
To edit .lua files you need a text editor.
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
**[[Animation-CobLuaDifferences]]
**[[lua-animation-basic-tutorial]] to clean
**[[lua-animation-synthax-usage]] to develop and clean

===[http://springrts.com/wiki/Category:Animation Scripting and Animation - COB/BOS Files]===
The binary '.cob' file format is obsolete and some '.cob' files might be copyrighed by cavedog. A '.cob' file can be decompiled to see what it is doing or if you have the source, that is a '.bos' file, you can compile it into a '.cob' file.

To edit .bos files you need a program/compiler. The most famous one is [http://jobjol.nl/1384 Scriptor]
*[[Animation-CobLuaDifferences]]
*[[Animation-CobOverview]]
**[[Animation-CobExamples]]
**[[Animation-CobAnimation]]
**[[Animation-CobCallins]]
**[[Animation-CobConstants]]
**[[Animation-CobThreads]]
**[[Animation-CobHitByWeaponID]]
*[http://www.planetannihilation.com/tadc/tut_unit_01_1.asp PlanetAnnihilation] has a nice tutorial
*[[Units:LuaCOB]] - how to interface COB with LUA
*[[CEG_For_Units|Game Development:Calling basic CEGs from COB]]
* [http://springrts.com/phpbb/viewtopic.php?p=132943#132943 GPL-compliant sourcecode, scripting code examples, and other things.]

===Units - FBI Files===
*[[Units:FBI]]
*[[All_FBI-variable_values:_min,_max,_default,_type|Units:FBI (variable datatype list)]]
*[[Unit_Categories]]

===Units - MoveTypes===
*[[Units:MoveTypes]]

===Weapons - TDF Files===
*[[Weapon Variables]] : This is the most up to date
*[[Units:WeaponMainDir]]
*[[Units:Weapons]] : Various informations about the weapontypes (uncompleted)
*[[All_Weapons_variable_values:_min%2C_max%2C_default%2C_type|Weapon datatype list]] : All weapon variables min/max/default values and datatypes listed.
*[[Weapons:Antinukes]]: All about antinukes.

===Explosions===
*[[CEG]]
**[[CEG-Calls]]
**[[CEG-Format]]
**[[CEG-Classes]]
**[[CEG-Operators]]
**[[CEG-Miscellaneous]]
**[[CEG-OldInfo]]

===Misc===
*[[Units:Design]]
*[[Units:Textures]]
*[[Units:Buildpics]]
*[[Units:SideData TDF]]
*[[Units:Download TDF]]
*[[Units:FlankingBonus]]
*[[Mod Development:Armor|Game Development:Armor]]
*[[Mod Development:Cursors|Game Development:Cursors]]
*[[Mod Development:Archives|Game Development:Archives]]
*[[Mod Development:Sidepics|Game Development:Sidepics]]
*[[CustomUnitIcons|Game Development:Custom unit icons]]

===Legacy Porting Tools===
====Automated Game Creation====
* [[TA2Spring]] - Automatically adds and converts Total Annihilation unit packs (.ufo files, etc..) into Spring games (requires a base game for the game rules, XTA is recommended, it is probably not properly supported by current Spring)

[[Category: Unit_development]]
[[Category: Mod_development]]

Animation-LuaScripting

2010-09-10T18:30:46Z

Mrz: /* Further reading */

== 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]
* [http://tvo.github.com/spring/2010/04/26/lus-stumpy-2.html Polishing the stumpy]
* [[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]]

Balanced Annihilation

2010-09-05T10:18:28Z

Mrz: /* Legal */

[[category:Mods]][[category:Balanced Annihilation]]
'''[[Games|<--Back to Games]]'''

Note: this wiki page sucks. Please help update it if you know what you're talking about. In the meantime please check the [http://springrts.com/phpbb/viewforum.php?f=44 forums].

===Overview===
BA has three basic principles:
* '''Refined Original Total Annihilation:''' BA's lineage traces back to fan mods of the original Total Annihilation. It feels similar, and play is more balanced for diverse multiplayer strategies.
* '''Stable gameplay:''' BA has matured through several years of playtesting. New versions don't drastically alter gameplay.
* '''Balance:''' Every unit has a role, and no unit has every role. Very few units get truly obsolete as a game progresses.

===Legal===
As parts of this mod originate from none-free sources there is an ongoing attempt to find and replace units with free models. See the forum discussion as:

http://springrts.com/phpbb/viewtopic.php?f=44&t=22234

=== Controls ===
'''[[Balanced_Annihilation:Using_Selections|Selections/Groups/Group Commands/Group AI]]'''

'''[[Balanced_Annihilation:Giving_Orders|Giving Units Orders]]'''

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

'''[http://sparcman.net/Documents/Spring_Control_Reference.pdf Printable Command Reference PDF download]

'''[[Balanced_Annihilation:Camera_Control | Using the Cameras]]'''

'''[[Balanced_Annihilation:Chat|Chat, Cheats, and Text Commands]]'''

'''[[Balanced_Annihilation:Doodles|Map drawing/doodles]]'''

'''[[Balanced_Annihilation:Custom_Keys| Customized key shortcuts/bindings and the key/selection editor]]'''

===Cooperative play===
BA includes a cooperative play mode for players to work as an even closer team. When the cooperative mod option is enabled, players who take the same team id will form a co-op. Players who are part of the same co-op completely share everything - all resources are pooled, and any unit within the co-op can be commanded by anyone within the co-op.

Each player within the co-op starts with their own commander, and must select their own start point before clicking ready - if the co-op readies before a player has selected a start location, then two commanders will spawn on the same spot.

Once the game has started, it is especially important for co-oping players to communicate their overall strategy so that units don't receive conflicting orders. It's also somewhat easier to overspend - in a co-op of three, players might feel like they have triple the normal amount of resources.

In practice, co-op mode tends to work best when done with friends, clanmates, or other (willing) strangers. However, even among voluntary participants experience has shown that large co-ops of 5 or more players tend to have at least one person getting upset due to their orders being canceled or similar (often unintentional) issues. Unless communication can be improved through [[mumble]], it is recommended to split large co-oping teams into multiple, smaller co-ops.

If cooperative mode is disabled, then players who share the same team id will instead share control of the same commander. This is called "comm-sharing" and is available in every mod.

===Chicken Defense===
Balanced Annihilation features a chicken defense subversion, designed as a BA version of tower defense.

===Strategy===
(sections to be filled in)
====Starting out====
Try to pick a start position near a good amount of metal patches. Most maps are designed to have 3 patches near designated starting points. You should build a few metal extractors ("mexes") and some energy (2 or 3 solar plants) before starting a factory. Afterwards, most players build a light laser tower or two to prevent early scouts from running behind the base and destroying the economy.
====Tier 1====
=====Vehicle lab=====
=====K-bot lab=====
=====Aircraft Plant=====
=====Shipyard=====
====Com Pushing====
Com pushing is the strategy of moving your commander towards the front lines after building your initial base. The advantage is that you can claim territory and metal patches early (by building light laser towers). Small groups of enemies can also be destroyed with the commander's D-gun. The commander also functions as an excellent repairman for damaged units and reclaimer of wrecks.
====Teching ("Going T2")====
====Managing units ("Micro")====
While BA is a largely strategic game, there is considerable value to managing your units tactics. Some things to consider:
*'''Repair damaged units''': Repairing is virtually free compared with building a new unit from scratch, so if you can keep a unit alive by moving it off the front line a bit once it becomes damaged you can get far more on the field.
*'''Surround the enemy''': Units in BA suffer extra damage if they are being attacked from multiple directions at once. At the extreme, two units standing opposite a tank will do 50% more damage than two units standing next to eachother.
*'''Use your range ("kiting")''': If you outrange the enemy and have some territory to maneuver in, you can gain a significant advantage by moving away while shooting.
*'''Cross the T''': One of the best positions to be in is where your units are all firing and only one of the enemies is. If you're enemy has lined up their units, for instance, you can attack one edge of the line at a time rather than hitting them all at once.
*'''Attack in waves''': One of the worst positions to be in is where the enemy is crossing your T. Implicitly, this can happen when you order units that are far apart into enemy territory and they arrive at different times. Similarly, setting a rally point of a factory into the enemy's defensive line will often result in your units dying one at a time. Instead, set a rally point a safe distance away, and once you have sufficient units attack in mass.

====Economy====
If you have more economy than the enemy, you can get more or better units. This is how, ultimately, you win.
*'''Reclaim wreckage and map features''': Unit wrecks are an excellent source of metal, and map-provided rocks and trees are free resources. In many cases it can be worth sacrificing a builder to claim wreckage in hostile territory - usually they pay for their own cost as well as deny the wreck to the enemy.
*'''Use (or share) your resources''': Resources kept in storage are essentially being wasted. They are a symptom of not having enough ''build-power'', or construction units. If you're not building more units, extra resources can instead be invested into even more economy. Many times your allies will have extra buildpower that you don't - in such cases it is often very efficient to simply give your resources away by lowering the share threshold (click in the middle of your metal or energy bar).
*'''Take advantage of metal patches and geothermal vents''': Metal extractors are much, much cheaper than powering metal makers. This remains true at tier 2, where moho mines become vastly cheaper than fusion plants and moho metal makers. Geothermal spots are similarly the cheapest source of energy in the game - a moho geo, for instance, produces energy at less than half the cost of a fusion plant. This means that, in most cases, it's worth walking a considerable distance to take advantage of metal/geo spots you control rather than building economy in your base.
*'''Use nano-turrets sparingly''': Nano-turrets can provide extra build power, however they themselves cost a considerable amount of metal and energy, especially in the early game. If you are already metal or energy stalling there is no point to building more of them - doing so will only slow down production of the units or economy you're ultimately trying to make with them.

===Main differences from Original Total Annihilation===
BA is similar to the Original Total Annihilation, and if you've played the original you should feel quite at home, however there are some important differences for OTA players to note:
* The guardian (tier 1 plasma turret) isn't a very useful defense unit for its cost; it's more of a forward artillery piece. It also has a high trajectory mode.
* Most of the AA units in the game shoot ''only'' at planes rather than both planes and ground.

===Links===
*[http://springrts.com/phpbb/viewforum.php?f=44 Balanced Annihilation Forum]
*(todo): latest download
*(todo): latest chicken download
*(todo): latest experimental download

===History===
Balanced Annihilation started as a fork of [[Absolute Annihilation]]. It is currently maintained by TheFatController, and was previously maintained by Noize. (this is a very incomplete history)

'''[[Games|<--Back to Games]]'''

Balanced Annihilation

2010-09-05T10:17:53Z

Mrz: legal discussion added

[[category:Mods]][[category:Balanced Annihilation]]
'''[[Games|<--Back to Games]]'''

Note: this wiki page sucks. Please help update it if you know what you're talking about. In the meantime please check the [http://springrts.com/phpbb/viewforum.php?f=44 forums].

===Overview===
BA has three basic principles:
* '''Refined Original Total Annihilation:''' BA's lineage traces back to fan mods of the original Total Annihilation. It feels similar, and play is more balanced for diverse multiplayer strategies.
* '''Stable gameplay:''' BA has matured through several years of playtesting. New versions don't drastically alter gameplay.
* '''Balance:''' Every unit has a role, and no unit has every role. Very few units get truly obsolete as a game progresses.

===Legal===
As parts of this mod originate from none-free sources there is an ongoing attempt to replace find and replace units with free models. See the forum discussion as:

http://springrts.com/phpbb/viewtopic.php?f=44&t=22234

=== Controls ===
'''[[Balanced_Annihilation:Using_Selections|Selections/Groups/Group Commands/Group AI]]'''

'''[[Balanced_Annihilation:Giving_Orders|Giving Units Orders]]'''

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

'''[http://sparcman.net/Documents/Spring_Control_Reference.pdf Printable Command Reference PDF download]

'''[[Balanced_Annihilation:Camera_Control | Using the Cameras]]'''

'''[[Balanced_Annihilation:Chat|Chat, Cheats, and Text Commands]]'''

'''[[Balanced_Annihilation:Doodles|Map drawing/doodles]]'''

'''[[Balanced_Annihilation:Custom_Keys| Customized key shortcuts/bindings and the key/selection editor]]'''

===Cooperative play===
BA includes a cooperative play mode for players to work as an even closer team. When the cooperative mod option is enabled, players who take the same team id will form a co-op. Players who are part of the same co-op completely share everything - all resources are pooled, and any unit within the co-op can be commanded by anyone within the co-op.

Each player within the co-op starts with their own commander, and must select their own start point before clicking ready - if the co-op readies before a player has selected a start location, then two commanders will spawn on the same spot.

Once the game has started, it is especially important for co-oping players to communicate their overall strategy so that units don't receive conflicting orders. It's also somewhat easier to overspend - in a co-op of three, players might feel like they have triple the normal amount of resources.

In practice, co-op mode tends to work best when done with friends, clanmates, or other (willing) strangers. However, even among voluntary participants experience has shown that large co-ops of 5 or more players tend to have at least one person getting upset due to their orders being canceled or similar (often unintentional) issues. Unless communication can be improved through [[mumble]], it is recommended to split large co-oping teams into multiple, smaller co-ops.

If cooperative mode is disabled, then players who share the same team id will instead share control of the same commander. This is called "comm-sharing" and is available in every mod.

===Chicken Defense===
Balanced Annihilation features a chicken defense subversion, designed as a BA version of tower defense.

===Strategy===
(sections to be filled in)
====Starting out====
Try to pick a start position near a good amount of metal patches. Most maps are designed to have 3 patches near designated starting points. You should build a few metal extractors ("mexes") and some energy (2 or 3 solar plants) before starting a factory. Afterwards, most players build a light laser tower or two to prevent early scouts from running behind the base and destroying the economy.
====Tier 1====
=====Vehicle lab=====
=====K-bot lab=====
=====Aircraft Plant=====
=====Shipyard=====
====Com Pushing====
Com pushing is the strategy of moving your commander towards the front lines after building your initial base. The advantage is that you can claim territory and metal patches early (by building light laser towers). Small groups of enemies can also be destroyed with the commander's D-gun. The commander also functions as an excellent repairman for damaged units and reclaimer of wrecks.
====Teching ("Going T2")====
====Managing units ("Micro")====
While BA is a largely strategic game, there is considerable value to managing your units tactics. Some things to consider:
*'''Repair damaged units''': Repairing is virtually free compared with building a new unit from scratch, so if you can keep a unit alive by moving it off the front line a bit once it becomes damaged you can get far more on the field.
*'''Surround the enemy''': Units in BA suffer extra damage if they are being attacked from multiple directions at once. At the extreme, two units standing opposite a tank will do 50% more damage than two units standing next to eachother.
*'''Use your range ("kiting")''': If you outrange the enemy and have some territory to maneuver in, you can gain a significant advantage by moving away while shooting.
*'''Cross the T''': One of the best positions to be in is where your units are all firing and only one of the enemies is. If you're enemy has lined up their units, for instance, you can attack one edge of the line at a time rather than hitting them all at once.
*'''Attack in waves''': One of the worst positions to be in is where the enemy is crossing your T. Implicitly, this can happen when you order units that are far apart into enemy territory and they arrive at different times. Similarly, setting a rally point of a factory into the enemy's defensive line will often result in your units dying one at a time. Instead, set a rally point a safe distance away, and once you have sufficient units attack in mass.

====Economy====
If you have more economy than the enemy, you can get more or better units. This is how, ultimately, you win.
*'''Reclaim wreckage and map features''': Unit wrecks are an excellent source of metal, and map-provided rocks and trees are free resources. In many cases it can be worth sacrificing a builder to claim wreckage in hostile territory - usually they pay for their own cost as well as deny the wreck to the enemy.
*'''Use (or share) your resources''': Resources kept in storage are essentially being wasted. They are a symptom of not having enough ''build-power'', or construction units. If you're not building more units, extra resources can instead be invested into even more economy. Many times your allies will have extra buildpower that you don't - in such cases it is often very efficient to simply give your resources away by lowering the share threshold (click in the middle of your metal or energy bar).
*'''Take advantage of metal patches and geothermal vents''': Metal extractors are much, much cheaper than powering metal makers. This remains true at tier 2, where moho mines become vastly cheaper than fusion plants and moho metal makers. Geothermal spots are similarly the cheapest source of energy in the game - a moho geo, for instance, produces energy at less than half the cost of a fusion plant. This means that, in most cases, it's worth walking a considerable distance to take advantage of metal/geo spots you control rather than building economy in your base.
*'''Use nano-turrets sparingly''': Nano-turrets can provide extra build power, however they themselves cost a considerable amount of metal and energy, especially in the early game. If you are already metal or energy stalling there is no point to building more of them - doing so will only slow down production of the units or economy you're ultimately trying to make with them.

===Main differences from Original Total Annihilation===
BA is similar to the Original Total Annihilation, and if you've played the original you should feel quite at home, however there are some important differences for OTA players to note:
* The guardian (tier 1 plasma turret) isn't a very useful defense unit for its cost; it's more of a forward artillery piece. It also has a high trajectory mode.
* Most of the AA units in the game shoot ''only'' at planes rather than both planes and ground.

===Links===
*[http://springrts.com/phpbb/viewforum.php?f=44 Balanced Annihilation Forum]
*(todo): latest download
*(todo): latest chicken download
*(todo): latest experimental download

===History===
Balanced Annihilation started as a fork of [[Absolute Annihilation]]. It is currently maintained by TheFatController, and was previously maintained by Noize. (this is a very incomplete history)

'''[[Games|<--Back to Games]]'''