Spring - User contributions [en]

Xect vs. Mynn

2006-10-04T22:05:47Z

FoeOfTheBee: /* Installation */

The '''Xect vs. Mynn''' Mod, aims to be a completely free (as in GNU [[GPL]]) data package for the Spring engine.

<div align="center">
http://www.ta-spring.com/mods/xectvsmynn/screen1.jpg
</div>

== History ==
This mod was initialy created by Chris Jorgensen http://www.xenoclone.com/ for the original Total Annihilation engine.
For the Spring engine Chris Jorgensen decided to release his work under the GNU GPL so others could port it. Michilus Nimbus made the first port that did not crash on startup. FoeOfTheBee has made it somewhat playable, and probably GPL.

== Screenshots ==
* Early screenshots of Xect-Mynn running on [[Linux]] by [[User:Tim_Blokdijk|Tim Blokdijk]]:
** [http://www.timblokdijk.nl/spring/Xect-Mynn/Screenshots/0.1.0b-screen000.jpg 0.1.0b-screen000.jpg]
** [http://www.timblokdijk.nl/spring/Xect-Mynn/Screenshots/0.1.0b-screen001.jpg 0.1.0b-screen001.jpg]
** [http://www.timblokdijk.nl/spring/Xect-Mynn/Screenshots/0.1.0b-screen002.jpg 0.1.0b-screen002.jpg]

== Links ==

=== Relevant Forum threads ===
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?t=3005 "Mods" -> "Xect vs. Mynn - 0.6 released, now 100% legal"]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?t=3005 "Mods" -> "Xect Vs. Mynn v .05 released"]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?t=2997 "Mods" -> "Xect Vs. Mynn To-do List"]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?t=2880 "Mods" -> "Xect vs. Mynn"]
* [http://taspring.clan-sy.com/phpbb/viewtopic.php?t=1293 "General discussion" -> "Free, licenseless mods?"]

=== Downloads ===
''Sorted from newer to older.''
* Get the '''most recent version''' from the [http://www.ta-spring.com/mods/xectvsmynn/ homepage] (0.6 as of ''2006-07-31'')
* [http://fileuniverse.com/?p=showitem&ID=2140 Xect vs. Mynn .5] - New load screens and balance by formula (by [[User:FoeOfTheBee|Foe OfTheBee]])
* [http://blancandrin.dyndns.org/~foe/xect_vs_mynn03.sd7 Xect vs. Mynn .3] - (by [[User:FoeOfTheBee|Foe OfTheBee]])
* [http://www.fileuniverse.com/?p=showitem&ID=2016 Xect vs. Mynn .2] - With updated cursors and trim FBI files. (by [[User:FoeOfTheBee|Foe OfTheBee]])
* [http://www.timblokdijk.nl/spring/Xect-Mynn/xect_vs_mynn_v0-1-1.sdz Xect vs. Mynn 0.1.1] - Version with custom cursors to replace the cursors from TA by [[User:Tim_Blokdijk|Tim Blokdijk]]
* [http://fileuniverse.com/?p=showitem&ID=1882 Xect vs. Mynn 0.1.0b]

=== Homepage ===
* [http://www.ta-spring.com/mods/xectvsmynn/ Xect vs. Mynn homepage]
* [http://www.ta-spring.com/mods/xectvsmynn/unitguide/ Xect vs. Mynn Unit Guide]
* [http://www.ta-spring.com/mods/xectvsmynn/xect_vs_mynn/ Browse the MOD-content]

{{Category:Mods}}
[[Category:Mods]]

Main Page

2006-09-27T18:23:45Z

FoeOfTheBee:

{|border="2" cellpadding="4" cellspacing="0" style="margin: 10px; border: 1px #aaa solid; border-collapse: collapse; background: #f9f9f9"
|<center>'''Other Languages'''</center>
|<center>'''[[Image:france_flag.gif]] [http://home.tele2.fr/flani/Tutoriaux.htm FranÃƒÂ§ais]'''</center>
|<center>'''[[Image:germany_flag.gif]] [[Uebersicht der Wiki|Deutsch]]'''</center>
|}
{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="50%" valign="top" style="background: #e6e6fa; border: 1px #aaa solid;"|
===General===
====[[Read Me First]]==== Answers to questions often asked by newcomers. Everyone should read this first.
====[[FAQ]]==== Has it been asked before?
====[[Using_Spring|Playing Spring]]==== How to play the game. Controls, issuing orders, and related topics.
====[[Spring Maps]]==== All about maps and where to get them.
====[[Mods]]==== Games that use the Spring engine.
====[[AIs]]==== Skirmish AIs, Helper AIs, Single player heaven.
====[[Strategy and Tactics]]==== Basic ideas how to stand your ground.
====[[Glossary]]==== What does "AA" or "XTA" mean? Explanations for common terms and shorthand.
====[[Monthly Topic Rotation]]==== Read before posting on the forums.
|width="50%" valign="top" style="background: #e6e6fa; border: 1px #aaa solid;"|

===Development===
====[[Engine Development]]==== Information regarding the source code of Spring. 
====[[Mod_and_Unit_development#Mod_development|Mod Development And Unit Creation]]==== Lots of links to valuable Articles and forum threads regarding Mod/Unit Development. 
=====[[Map, Mod, And Unit Development Programs|Map/Units Development Programs]]===== Links to all kind of useful programs.
====[[Map_development| Map creation]]==== Tutorials and other useful information for creating maps. 
====[[AI|AI Development]]==== Lots of information about developing AIs for Spring. 
'''[[Linux_Page |Linux]]''' - Mac OSX / NetBSD / Solaris / Linux / Crossplatform information 
|}

{|width="100%" style="margin:10px; background:#f9f9f9; padding:5px; border:1px #aaa solid;"
|
This site is put together by the community, which could (read as SHOULD) mean YOU! If you see information missing, or find out new information you think would be helpful, put it in. If you find a spelling mistake or phrase that could be clearer, fix it. If you find yourself doing repeated searches or going back to the [[Special:Allpages|Topic Index]] repeatedly when trying to find out about a particular feature, consider combining articles or linking them to one another. Any contributions you make to this Wiki are in the public domain. [[Help:Editing|Add to the Wiki]]

''"A wiki is a web application that allows users to add content, as on an Internet forum, but also allows anyone to edit the content."''
- [http://en.wikipedia.org/wiki/Wiki Wikipedia.org]
|}
__NOTOC__
__NOEDITSECTION__

If you wish to comment on this page (or the wiki) you need to login and then you can go [http://taspring.clan-sy.com/w/index.php?title=Talk:Main_Page&action=edit&section=new here], and post your thoughts.
[[Category:Spring]]

2006-09-18T18:55:22Z

FoeOfTheBee: /* Explosion script examples */

CEG-OldInfo

2006-09-18T18:50:42Z

FoeOfTheBee: /* Explosion script examples */

== Custom explosion generators ==

=== What are they? ===
Custom explosions are small explosion scripts read from gamedata/explosions/*.tdf.
The explosion script specifies which particles/projectiles have to be created when the explosion happens, and their initial properties (position,speed,...)

=== Explosion script definition ===

The explosion script directly specifies which C++ projectile classes have to be created, and also which properties the projectiles should have.

The explosion script is structured like this:

[ExplosionScriptName]
{
[projectile scriptname] // this specifies the class of the projectile
{
[properties]
{
size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60; // These codes are explained below
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
underwater=0; // should this projectile be created when underwater?
air=0; // should this projectile be created when in air?
water=1; // should this projectile be created on water?
ground=1; // should this projectile be created when on ground?
count=10; // number of projectiles of this type
}
.. other projectiles types can follow here ..
}

Defaults for air/underwater/ground/water are zero.
Default of count is 1.

=== Projectile properties ===

To begin, you should run
spring /p (or "spring -p" on linux)
to let spring export "projectiles.txt", which contains all the classes you can use in an explosion script. At the time of writing, this would contain [[projectiles.txt]]

The items listed in "properties" are directly mapped to the class properties in projectiles.txt
The properties are specified with a bit of a cryptic syntax. You can use extra commands in them (r,d,i). For example this:

pos = -30 r60, r30, -30 r60;

The x coordinate (specified with -30 r60) will be:

x = -30 + (Random value between 0 and 60);

Commands:
rX: add a number between 0 and X
iX: multiply the projectile index with X and add it. See the example for this below.
dX: multiply the damage with X and add it.

== Explosion script examples ==

This is an example of a script that makes 10 smoke projectiles (yeah they should have been called particles, but they are handled by spring using the projectile system)

[ARM_HLT_Expl]
{
[smoke]
{
[properties]
{
ageSpeed=0.04; // age increase per frame, when age >= 1 the particle is destroyed
size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60;
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
water=1;
ground=1;
count=10;
}
}

This particular script would be linked to with "explosiongenerator=custom:ARM_HLT_Expl;"

Here is an example that uses the index (i) command in the properties:

[heatcloud]
{
[properties]
{
pos = 0, i20, 0;
heat = 10;
maxheat=10;
heatFalloff=1;
size = 30;
}
ground=1;
count=10;
}

This script creates a tower of heatcloud projectile. The first projectile gets y=0, the second y=20, y=40, y=60, .. and finally y=180

=== How to link a custom explosion to a weapon ===

The weapon definitions needs to have this in it:
explosiongenerator = custom:ExplosionScriptName;

The explosion definition for ExplosionScriptName would be one of the TDF files in gamedata/explosions/

You can also link the weapons for self-destruct and normal destruct to an explosion script.

=== Adding ground flashes ===

The ground flash is currently not an actual projectile, so it's specified in a different way:
[ARM_HLT_Expl]
{
.. projectiles definitions ..

[groundflash]
{
flashSize = 100; // flash size
flashAlpha = 1; // initial alpha of the flash
circleGrowth = 60; // size increase/frame
circleAlpha = 1; // initial alpha of the ring
ttl = 10; // number of frames
color = 0,0,1; // color RGB
}
}

[[category:Mod Development]]
[[category:Explosions]]

CEG-OldInfo

2006-09-18T18:49:23Z

FoeOfTheBee:

== Custom explosion generators ==

=== What are they? ===
Custom explosions are small explosion scripts read from gamedata/explosions/*.tdf.
The explosion script specifies which particles/projectiles have to be created when the explosion happens, and their initial properties (position,speed,...)

=== Explosion script definition ===

The explosion script directly specifies which C++ projectile classes have to be created, and also which properties the projectiles should have.

The explosion script is structured like this:

[ExplosionScriptName]
{
[projectile scriptname] // this specifies the class of the projectile
{
[properties]
{
size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60; // These codes are explained below
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
underwater=0; // should this projectile be created when underwater?
air=0; // should this projectile be created when in air?
water=1; // should this projectile be created on water?
ground=1; // should this projectile be created when on ground?
count=10; // number of projectiles of this type
}
.. other projectiles types can follow here ..
}

Defaults for air/underwater/ground/water are zero.
Default of count is 1.

=== Projectile properties ===

To begin, you should run
spring /p (or "spring -p" on linux)
to let spring export "projectiles.txt", which contains all the classes you can use in an explosion script. At the time of writing, this would contain [[projectiles.txt]]

The items listed in "properties" are directly mapped to the class properties in projectiles.txt
The properties are specified with a bit of a cryptic syntax. You can use extra commands in them (r,d,i). For example this:

pos = -30 r60, r30, -30 r60;

The x coordinate (specified with -30 r60) will be:

x = -30 + (Random value between 0 and 60);

Commands:
rX: add a number between 0 and X
iX: multiply the projectile index with X and add it. See the example for this below.
dX: multiply the damage with X and add it.

== Explosion script examples ==

This is an example of a script that makes 10 smoke projectiles (yeah they should have been called particles, but they are handled by spring using the projectile system)

[ARM_HLT_Expl]
{
[smoke]
{
[properties]
{
ageSpeed=0.04; // age increase per frame, when age >= 1 the particle is destroyed
size = 40;
sizeGrowth = -2;
pos = -30 r60, r30, -30 r60;
speed=0.75 r-1.5, 1.7 r1.6, 0.75 r-1.5;
}
water=1;
ground=1;
count=10;
}
}

This particular script would be linked to with "explosiongenerator=custom:ARM_HLT_Expl;"

Here is an example that uses the index (i) command in the properties:

[heatcloud]
{
[properties]
{
pos = 0, i20, 0;
heat = 10;
maxheat=10;
heatFalloff=1;
size = 30;
}
ground=1;
count=10;
}

This script creates a tower of heatcloud projectile. The first projectile gets y=0, the second y=20, y=40, y=60, .. and finally y=180

=== How to link a custom explosion to a weapon ===

The weapon definitions needs to have this in it:
explosiongenerator = custom:ExplosionScriptName;

The explosion definition for ExplosionScriptName would be one of the TDF files in gamedata/explosions/

You can also link the weapons for self-destruct and normal destruct to an explosion script.

=== Adding ground flashes ===

The ground flash is currently not an actual projectile, so it's specified in a different way:
[ARM_HLT_Expl]
{
.. projectiles definitions ..

[groundflash]
{
flashSize = 100; // flash size
flashAlpha = 1; // initial alpha of the flash
circleGrowth = 60; // size increase/frame
circleAlpha = 1; // initial alpha of the ring
ttl = 10; // number of frames
color = 0,0,1; // color RGB
}
}

[[category:Mod Development]]
[[category:Explosions]]

CustomExplosionGenerators

2006-09-18T18:48:23Z

FoeOfTheBee: CustomExplosionGenerators moved to Custom Explosion Generators

#REDIRECT [[Custom Explosion Generators]]

2006-09-16T05:13:29Z

FoeOfTheBee: /* Map/Units Development Programs */

{|border="2" cellpadding="4" cellspacing="0" style="margin: 10px; border: 1px #aaa solid; border-collapse: collapse; background: #f9f9f9"
|<center>'''Other Languages'''</center>
|<center>'''[[Image:france_flag.gif]] [http://home.tele2.fr/flani/Tutoriaux.htm FranÃƒÂ§ais]'''</center>
|<center>'''[[Image:germany_flag.gif]] [[Uebersicht der Wiki|Deutsch]]'''</center>
|}
{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="50%" valign="top" style="background: #e6e6fa; border: 1px #aaa solid;"|
===General===
'''[[Read Me First]]''' - Answers to questions often asked by newcomers. Everyone should read this first. 
'''[[FAQ]]''' - Fatally Asked Questions. Solutions to common problems can be found here. 
'''[[Using_Spring|Playing Spring]]''' - How to play the game. Controls, issuing orders, and related topics. 
'''[[Spring Maps]]''' - General information about maps and where to download them 
'''[[Mods]]''' - Games that use the Spring engine. 
'''[[AIs]]''' - Skirmish AIs, Helper AIs, Single player heaven. 
'''[[Strategy and Tactics]]''' - Basic ideas how to stand your ground. 
'''[[Glossary]]''' - What does "AA" or "XTA" mean? Explanations for common terms and shorthand. 
'''[[Spring on a LAN]]''' - Private hosting. 

'''[[Monthly Topic Rotation]]''' - Read before posting on the forums. Especially before asking for or about features. 

'''[[Clans]]''' Clans tend to spring up like fresh grass. This is a list of them. Each Clan must maintain their own roster! 
'''[[King Titles]]''' Fight for the beloved crown. Fight with honour. 
|width="50%" valign="top" style="background: #e6e6fa; border: 1px #aaa solid;"|

===Development===

'''[[Spring Project]]''' Global information about Spring development. 
====[[Engine Development]]==== Information regarding the source code of Spring. 
=====[[New_GUI|GUI wishlist]]===== For GUI development: What most people want to see in it and what the current GUI hasn't got. 
====[[Mod_and_Unit_development#Mod_development|Mod Development And Unit Creation]]==== Lots of links to valuable Articles and forum threads regarding Mod/Unit Development. 
====[[Map_development| Map creation]]==== Tutorials and other useful information for creating maps. 
====[[AI|AI Development]]==== Lots of information about developing AIs for Spring. 
'''[[Linux]]''' - Basic information for getting Spring to run on Linux. 
====[[Map, Mod, And Unit Development Programs|Map/Units Development Programs]]==== Links to all kind of useful programs. 

|}

{|width="100%" style="margin:10px; background:#f9f9f9; padding:5px; border:1px #aaa solid;"
|
This site is put together by the community, which could (read as SHOULD) mean YOU! If you see information missing, or find out new information you think would be helpful, put it in. If you find a spelling mistake or phrase that could be clearer, fix it. If you find yourself doing repeated searches or going back to the [[Special:Allpages|Topic Index]] repeatedly when trying to find out about a particular feature, consider combining articles or linking them to one another. Any contributions you make to this Wiki are in the public domain. [[Help:Editing|Add to the Wiki]]

''"A wiki is a web application that allows users to add content, as on an Internet forum, but also allows anyone to edit the content."''
- [http://en.wikipedia.org/wiki/Wiki Wikipedia.org]
|}
__NOTOC__
__NOEDITSECTION__

If you wish to comment on this page (or the wiki) you need to login and then you can go [http://taspring.clan-sy.com/w/index.php?title=Talk:Main_Page&action=edit&section=new here], and post your thoughts.
[[Category:Spring]]

Development:Main

2006-09-16T05:11:52Z

FoeOfTheBee: /* Spring Engine TODO list */

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

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

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

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

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

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

===Obtaining the Source===

If you just want to look at the code, you can use [http://svn.berlios.de/viewcvs/taspring-linux/trunk/ HTTP based viewing of the repository]

Another option is to manually download it along with the latest released version of the game. However, for serious developers, a better way would be to download the source straight from the subversion (SVN) repository. This will also allow you to make a patch out of the changes you make to the code, and send it to one of the developers with SVN access.

More information about downloading from the svn repository is available at the
[http://developer.berlios.de/projects/taspring-linux BerliOS Project page]
Two good windows SVN clients are SmartSVN and TortoiseSVN.

Is this still any good: [[CVS tutorial]] ? --[[User:SeanHeron|SeanHeron]] 00:07, 17 Apr 2006 (W. Europe Daylight Time)

Almost certainly not if they're using SVN for version control now. --[[User:Egarwaen|Egarwaen]] 22:30, 22 Apr 2006 (W. Europe Daylight Time)

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

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

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

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

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

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

*[http://prdownloads.sourceforge.net/dev-cpp/devcpp-4.9.9.2_setup.exe Dev-Cpp installer] / [MinGW] Though I would not advise mingw because you have to set it up your self.

*[http://www.python.org/ftp/python/2.4.2/python-2.4.2.msi Python 2.4 installer]

*[http://prdownloads.sourceforge.net/pywin32/pywin32-208.win32-py2.4.exe?download Python win32 extensions installer]

*[http://prdownloads.sourceforge.net/scons/scons-0.96.1.win32.exe Scons installer]

Grab and install the above programs.

'''Set-Up'''

Make sure C:\Python2.4 and C:\Dev-Cpp\bin are in your PATH environment variable. Make sure a MINGDIR environment variable with value C:\Dev-Cpp exists. (Change paths where appropriate.) Set environment variables by: Start -> Settings -> Control Panel -> System -> Advanced -> Environment variables (for Windows XP), Checkout the TA Spring SVN repository. You will also need the [http://spring.clan-sy.com/dl/spring-mingwlibs.exe Mingw / DevCPP libs] extract to /taspring.

'''Compiling'''

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

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

==Development Suggestions==

Before starting to make modifications to the source, take a look at the [[development guidelines]] which outlines some important things to think about. To find something interesting to work on, look at the list of [[example projects]]. You can also check the list of [[whois doing what]] to see what others are doing. If you do edit the code, please add [[Doxygen style comments]] to the code, which will then enhance the source code documentation.

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

==Multiplatform development==
Current development is done on the portable code only, located at [http://developer.berlios.de/projects/taspring-linux Berlios]
All current and future releases will be based on this code.
The current spring code is being developed on Windows and linux. A mac port is being worked on, as well as other unixes.
Use the mailing list listed on the [[Linux]] page to reach all developers (windows and linux). However if you have a feature request or bug report, the mantis bugtracker is probably a better way.
Development information about the portable code can be found here: [[MultiplatformSpring]]

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

See [[Glossary]]

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

Development:Main

2006-09-16T05:10:45Z

FoeOfTheBee: /* Spring Engine TODO list */

Main Page

2006-09-16T05:10:08Z

FoeOfTheBee:

{|border="2" cellpadding="4" cellspacing="0" style="margin: 10px; border: 1px #aaa solid; border-collapse: collapse; background: #f9f9f9"
|<center>'''Other Languages'''</center>
|<center>'''[[Image:france_flag.gif]] [http://home.tele2.fr/flani/Tutoriaux.htm FranÃƒÂ§ais]'''</center>
|<center>'''[[Image:germany_flag.gif]] [[Uebersicht der Wiki|Deutsch]]'''</center>
|}
{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="50%" valign="top" style="background: #e6e6fa; border: 1px #aaa solid;"|
===General===
'''[[Read Me First]]''' - Answers to questions often asked by newcomers. Everyone should read this first. 
'''[[FAQ]]''' - Fatally Asked Questions. Solutions to common problems can be found here. 
'''[[Using_Spring|Playing Spring]]''' - How to play the game. Controls, issuing orders, and related topics. 
'''[[Spring Maps]]''' - General information about maps and where to download them 
'''[[Mods]]''' - Games that use the Spring engine. 
'''[[AIs]]''' - Skirmish AIs, Helper AIs, Single player heaven. 
'''[[Strategy and Tactics]]''' - Basic ideas how to stand your ground. 
'''[[Glossary]]''' - What does "AA" or "XTA" mean? Explanations for common terms and shorthand. 
'''[[Spring on a LAN]]''' - Private hosting. 

'''[[Monthly Topic Rotation]]''' - Read before posting on the forums. Especially before asking for or about features. 

'''[[Clans]]''' Clans tend to spring up like fresh grass. This is a list of them. Each Clan must maintain their own roster! 
'''[[King Titles]]''' Fight for the beloved crown. Fight with honour. 
|width="50%" valign="top" style="background: #e6e6fa; border: 1px #aaa solid;"|

===Development===

'''[[Spring Project]]''' Global information about Spring development. 
====[[Engine Development]]==== Information regarding the source code of Spring. 
=====[[New_GUI|GUI wishlist]]===== For GUI development: What most people want to see in it and what the current GUI hasn't got. 
====[[Mod_and_Unit_development#Mod_development|Mod Development And Unit Creation]]==== Lots of links to valuable Articles and forum threads regarding Mod/Unit Development. 
====[[Map_development| Map creation]]==== Tutorials and other useful information for creating maps. 
====[[AI|AI Development]]==== Lots of information about developing AIs for Spring. 
'''[[Linux]]''' - Basic information for getting Spring to run on Linux. 
====[[Map, Mod, And Unit Development Programs|Map/Units Development Programs]]==== Links to all kind of useful programs. 

|}

{|width="100%" style="margin:10px; background:#f9f9f9; padding:5px; border:1px #aaa solid;"
|
This site is put together by the community, which could (read as SHOULD) mean YOU! If you see information missing, or find out new information you think would be helpful, put it in. If you find a spelling mistake or phrase that could be clearer, fix it. If you find yourself doing repeated searches or going back to the [[Special:Allpages|Topic Index]] repeatedly when trying to find out about a particular feature, consider combining articles or linking them to one another. Any contributions you make to this Wiki are in the public domain. [[Help:Editing|Add to the Wiki]]

''"A wiki is a web application that allows users to add content, as on an Internet forum, but also allows anyone to edit the content."''
- [http://en.wikipedia.org/wiki/Wiki Wikipedia.org]
|}
__NOTOC__

If you wish to comment on this page (or the wiki) you need to login and then you can go [http://taspring.clan-sy.com/w/index.php?title=Talk:Main_Page&action=edit&section=new here], and post your thoughts.
[[Category:Spring]]

Main Page

2006-09-16T05:10:08Z

FoeOfTheBee:

{|border="2" cellpadding="4" cellspacing="0" style="margin: 10px; border: 1px #aaa solid; border-collapse: collapse; background: #f9f9f9"
|<center>'''Other Languages'''</center>
|<center>'''[[Image:france_flag.gif]] [http://home.tele2.fr/flani/Tutoriaux.htm FranÃƒÂ§ais]'''</center>
|<center>'''[[Image:germany_flag.gif]] [[Uebersicht der Wiki|Deutsch]]'''</center>
|}
{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="50%" valign="top" style="background: #e6e6fa; border: 1px #aaa solid;"|
===General===
'''[[Read Me First]]''' - Answers to questions often asked by newcomers. Everyone should read this first. 
'''[[FAQ]]''' - Fatally Asked Questions. Solutions to common problems can be found here. 
'''[[Using_Spring|Playing Spring]]''' - How to play the game. Controls, issuing orders, and related topics. 
'''[[Spring Maps]]''' - General information about maps and where to download them 
'''[[Mods]]''' - Games that use the Spring engine. 
'''[[AIs]]''' - Skirmish AIs, Helper AIs, Single player heaven. 
'''[[Strategy and Tactics]]''' - Basic ideas how to stand your ground. 
'''[[Glossary]]''' - What does "AA" or "XTA" mean? Explanations for common terms and shorthand. 
'''[[Spring on a LAN]]''' - Private hosting. 

'''[[Monthly Topic Rotation]]''' - Read before posting on the forums. Especially before asking for or about features. 

'''[[Clans]]''' Clans tend to spring up like fresh grass. This is a list of them. Each Clan must maintain their own roster! 
'''[[King Titles]]''' Fight for the beloved crown. Fight with honour. 
|width="50%" valign="top" style="background: #e6e6fa; border: 1px #aaa solid;"|

===Development===

'''[[Spring Project]]''' Global information about Spring development. 
====[[Engine Development]]==== Information regarding the source code of Spring. 
=====[[New_GUI|GUI wishlist]]===== For GUI development: What most people want to see in it and what the current GUI hasn't got. 
====[[Mod_and_Unit_development#Mod_development|Mod Development And Unit Creation]]==== Lots of links to valuable Articles and forum threads regarding Mod/Unit Development. 
====[[Map_development| Map creation]]==== Tutorials and other useful information for creating maps. 
====[[AI|AI Development]]==== Lots of information about developing AIs for Spring. 
'''[[Linux]]''' - Basic information for getting Spring to run on Linux. 
====[[Map, Mod, And Unit Development Programs|Map/Units Development Programs]]==== Links to all kind of useful programs. 

|}

{|width="100%" style="margin:10px; background:#f9f9f9; padding:5px; border:1px #aaa solid;"
|
This site is put together by the community, which could (read as SHOULD) mean YOU! If you see information missing, or find out new information you think would be helpful, put it in. If you find a spelling mistake or phrase that could be clearer, fix it. If you find yourself doing repeated searches or going back to the [[Special:Allpages|Topic Index]] repeatedly when trying to find out about a particular feature, consider combining articles or linking them to one another. Any contributions you make to this Wiki are in the public domain. [[Help:Editing|Add to the Wiki]]

''"A wiki is a web application that allows users to add content, as on an Internet forum, but also allows anyone to edit the content."''
- [http://en.wikipedia.org/wiki/Wiki Wikipedia.org]
|}
__NOTOC__

If you wish to comment on this page (or the wiki) you need to login and then you can go [http://taspring.clan-sy.com/w/index.php?title=Talk:Main_Page&action=edit&section=new here], and post your thoughts.
[[Category:Spring]]

AF

2006-09-16T02:50:53Z

FoeOfTheBee: AF moved to User:AF

#REDIRECT [[User:AF]]

Weapon Variables

2006-09-15T19:58:25Z

FoeOfTheBee: /* Shield/Repulsor Variable Descriptions */

<center>
=Weapon Variable Descriptions=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
</TR>
<TR>
<TD>Accuracy</TD>
<TD>How accurate a weapon is. A larger number is less accurate. If this tag is missing entirely, it has perfect accuracy unless its target moves unexpectedly. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high accuracy value will probably still hit. If a target is very far away, even a very low accuracy value will likely cause the weapon to miss. Can be any numeric value.</TD>
<TD>accuracy=400;</TD>
</TR>
<TR>
<TD>AreaOfEffect</TD>
<TD>How large the weapon's impact explosion is. This affects how powerful the weapon's default impulse strength will be. Currently, BeamLasers with an AreaOfEffect of 16 or above will deform the ground at their point of impact regardless of whether it has been told not to. Can be any numeric value, but should generally be at least 8, regardless of the type of weapon.</TD>
<TD>areaofeffect=192;</TD>
</TR>
<TR>
<TD>Ballistic</TD>
<TD>Set to 1 for the weapon to be subjected to gravity, travelling in an arc through the air, such as cannons. Ballistic is mutually exclusive to LineOfSight and Dropped. Can be 1 or 0.</TD>
<TD>ballistic=1;</TD>
</TR>
<TR>
<TD>BeamLaser</TD>
<TD>Whether this weapon is a beam laser or not. Beam lasers instantly hit their targets. Rendertype must be 0. Mutually exclusive to BeamWeapon. Can be 1 or 0.</TD>
<TD>beamlaser=1;</TD>
</TR>
<TR>
<TD>BeamTime</TD>
<TD>How long to fire the laser before waiting for ReloadTime to start. Can be any numeric value. Defaults to 1.</TD>
<TD>beamtime=0.5;</TD>
</TR>
<TR>
<TD>BeamWeapon</TD>
<TD>Whether this weapon is a regular laser or not. BeamWeapons (lasers) do not instantly hit their targets, and are affected by the weaponvelocity tag. Mutually exclusive to BeamLaser. Can be 1 or 0.</TD>
<TD>beamweapon=1;</TD>
</TR>
<TR>
<TD>BurnBlow</TD>
<TD>The weapon blows up at the end of its range, only works on plasma (rendertype=4) weapons last I checked. Can be 1 or 0. A common usage is on flak guns.</TD>
<TD>burnblow=1;</TD>
</TR>
<TR>
<TD>Burst</TD>
<TD>How many shots are in a burst. Must be accompanied by burstrate. Can be any numeric value.</TD>
<TD>burst=3;</TD>
</TR>
<TR>
<TD>BurstRate</TD>
<TD>How fast the Burst fires. If set much below 0.1, it stops having any discernable effect.</TD>
<TD>burstrate=0.1</TD>
</TR>
<TR>
<TD>Color</TD>
<TD>An obsolete tag only recognized for compatibility purposes.</TD>
<TD>color=1;</TD>
</TR>
<TR>
<TD>Color2</TD>
<TD>An obsolete tag only recognized for compatibility purposes.</TD>
<TD>color=2;</TD>
</TR>
<TR>
<TD>CommandFire</TD>
<TD>The weapon must be manually activated for each shot. There's some confusion about whether or not it works properly. Can be set to 1 or 0.</TD>
<TD>commandfire=1;</TD>
</TR>
<TR>
<TD>Coverage</TD>
<TD>The range for anti-weapon weapons, like antinukes. This will be shown on the minimap as a guide. Can be any numeric value.</TD>
<TD>coverage=1280;</TD>
</TR>
<TR>
<TD>Dropped</TD>
<TD>Sets the weapon to be dropped, like from a bomber. Must be RenderType=6 and needs the Model tag to be specified. Mutually exclusive to Ballistic and LineOfSight. Can be set to 1 or 0.</TD>
<TD>dropped=1;</TD>
</TR>
<TR>
<TD>EdgeEffectiveness</TD>
<TD>Determines what percent of a weapon's maximum damage value will be applied to units as they are closer to the outer edge of the weapon's AreaOfEffect. Must have a decimal value between 0 and 1. Default in OTA was 0, probably the same in Spring.</TD>
<TD>edgeeffectiveness=0.25;</TD>
</TR>
<TR>
<TD>EnergyPerShot</TD>
<TD>Energy used per shot. If the specified amount of energy is not available, the weapon will not be able to shoot. Can also be used to specify how much a Stockpile weapon wll cost to build. Can be any numeric value.</TD>
<TD>energypershot=5;</TD>
</TR>
<TR>
<TD>FireStarter</TD>
<TD>How likely the weapon will set trees on fire. High values make trees likey to be set on fire, low values make trees likely to just explode or tip over. Can be any numeric value between 0 and 100.</TD>
<TD>FireStarter=75;</TD>
</TR>
<TR>
<TD>Guidance</TD>
<TD>Specifies whether or not the weapon is capable of tracking a target, can be used only on missile and torpedo weapons. Can be set to 1 or 0. See TurnRate for information on specifying how well a weapon can track a target. Requires rendertype=1, lineofsight=1, and selfprop=1;</TD>
<TD>guidance=1;</TD>
</TR>
<TR>
<TD>ImpulseFactor</TD>
<TD>The multiplier on the weapon's default impulsefactor, which is determined based on a weapon's default damage and AreaOfEffect. The impulse of a weapon is how strong of a kinetic force will be applied to its target or anything near the point of impact. Can be any numeric value, including negative ones.</TD>
<TD>impulsefactor=2.5;</TD>
</TR>
<TR>
<TD>Intensity</TD>
<TD>Alpha (brighness and washout effect) of the weapon. Can be used on any rendertype 0, 3, or 4 weapon. Can be any numeric value.</TD>
<TD>intensity=1.5;</TD>
</TR>
<TR>
<TD>InterceptedByShieldType</TD>
<TD>Bitfield representing the types of shields that can intercept this weapon. The best way to think about this is to think of it as the resulting binary. Every digit of binary that is set to one means that a shield with that digit set to one will intercept this weapon, for instance, the example will result in the weapons being blocked by shields with types 1 and/or 3. Maxium of 32 unique types. See [[Shield Interception Tag Use]].</TD>
<TD>InterceptedByShieldType=5;</TD>
</TR>
<TR>
<TD>Interceptor</TD>
<TD>Can intercept missiles with the Cruise tag.</TD>
<TD>interceptor=1;</TD>
</TR>
<TR>
<TD>LineOfSight</TD>
<TD>LineOfSight weapons ignore gravity and must have a direct line from the firing point to the impact point in order to be fired. Can be set to 1 or 0. Mutually exclusive to Ballistic and Dropped.</TD>
<TD>lineofsight=1;</TD>
</TR>
<TR>
<TD>MetalPerShot</TD>
<TD>Metal used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a Stockpile weapon wll cost to build. Can be set to any numeric value.</TD>
<TD>metalpershot=500;</TD>
</TR>
<TR>
<TD>Model</TD>
<TD>The 3DO or S3O model to be used as this weapon's physical representation. 3DO modesl do not need a .3do extension, but S3O weapon do.</TD>
<TD>model=missile;</TD>
</TR>
<TR>
<TD>MovingAccuracy</TD>
<TD>A weapon's accuracy while moving. See Accuracy. Can be any numeric value.</TD>
<TD>movingaccuracy=1000;</TD>
</TR>
<TR>
<TD>NoExplode</TD>
<TD>Whether or not the weapon will explode on impact or continue on its path. An example is the d-gun. Can be set to 1 or 0.</TD>
<TD>noexplode=1;</TD>
</TR>
<TR>
<TD>NoSelfDamage</TD>
<TD>This weapon will not damage the unit that fired it. For instance, a nuke silo could shoot itself and not take any damage if this was active. Can be set to 1 or 0.</TD>
<TD>noselfdamage=1;</TD>
</TR>
<TR>
<TD>Paralyzer</TD>
<TD>If active, this weapon will not cause any damage to its target, but will instead paralyze (aka EMP). The default damage value of a weapon with this active will be applied to the target's HP; once the HP is overwhelmed, it will be paralyzed. Can be set to 1 or 0.</TD>
<TD>paralyzer=1;</TD>
</TR>
<TR>
<TD>Range</TD>
<TD>The maximum range of the weapon. If set to noexplode, the weapon will disappear after this range has been met. If set to burnblow, the weapon will explode after this range has been met. Can be set to any numerical value.</TD>
<TD>range=750;</TD>
</TR>
<TR>
<TD>ReloadTime</TD>
<TD>The amount of time between shots. If a unit is paralyzed, this stops counting down. Can be set to any numerical value.</TD>
<TD>reloadtime=3.5;</TD>
</TR>
<TR>
<TD>Rendertype</TD>
<TD>The way the weapon will be displayed. Certain rendertypes are incompatibile with other tags, but it's generally for a logical reason. The rendertypes are as follows: 0 - Laser, 1 - Model, 3 - Plasma, 4 - Unit explosion (usally), 5 - Flamethrower, 6 - Dropped, 7 - Lightning. There's no documented use of rendertype=2 in OTA, and it probably doesn't do anything in Spring. 3 and 4 are usually interchangeable, both can be used to render a plasma/EMG/whatever shot; this is probably for compatibility.</TD>
<TD>rendertype=1;</TD>
</TR>
<TR>
<TD>RGBColor</TD>
<TD>The color of the rendertype 0, 3, 4, 7 weapon, specified in RED_GREEN_BLUE format.</TD>
<TD>rgbcolor=1 0.3 1; - this would make evul-purple</TD>
</TR>
<TR>
<TR>
<TD>RGBColor2</TD>
<TD>The color at the core of a rendertype 0 (laser) weapon. Specified the same as above. Defaults to white.</TD>
<TD>RGBColor2=0 1 0; - this would make a weird green middle for the evul-purple laser</TD>
</TR>
<TR>
<TD>Selfprop</TD>
<TD>Required for Guidance tag. This weapon can propel itself and can have things like acceleration, rather than always travelling at one speed. See Guidance, StartVelocity, WeaponAcceleration, WeaponVelocity. Can be set to 1 or 0.</TD>
<TD>selfprop=1;</TD>
</TR>
<TR>
<TD>SmokeTrail</TD>
<TD>Does the projectile leave a smoke trail or not. Can be set to 1 or 0.</TD>
<TD>smoketrail=1;</TD>
</TR>
<TR>
<TD>SoundHit</TD>
<TD>The sound made whe the weapon hits. Must reference a .wav file in the .\Sounds directory.</TD>
<TD>soundhit=emghit;</TD>
</TR>
<TR>
<TD>SoundStart</TD>
<TD>The sound made when the weapon begins to fire. Will fire only once if the weapon is shot in a burst. Must reference a .wav file in the .\Sounds directory.</TD>
<TD>soundstart=emgfire;</TD>
</TR>
<TR>
<TD>SoundTrigger</TD>
<TD>If active, the weapon will sound every time a shot is fired in a burst sequence. Can be set to 1 or 0.</TD>
<TD>soundtrigger=1;</TD>
</TR>
<TR>
<TD>SprayAngle</TD>
<TD>How wide the the angle of a burst from a burst weapon can be. Very similar to Accuracy, except that if a weapon has no sprayangle, all the shots will be fired at the same spot, even if the weapon's aim is off.</TD>
<TD>sprayangle=1024;</TD>
</TR>
<TR>
<TD>StartVelocity</TD>
<TD>The starting speed of the weapon as it is first fired. Only applicable to weapons that can accelerate.</TD>
<TD>startvelocity=200;</TD>
</TR>
<TR>
<TD>Stockpile</TD>
<TD>Can this weapon be stockpiled, for instance like a nuke launcher. Can be set to 1 or 0.</TD>
<TD>stockpile=1;</TD>
</TR>
<TR>
<TD>Targetable</TD>
<TD>If active, the weapon will be automatically targeted by any Interceptor weapons.</TD>
<TD>targetable=1;</TD>
</TR>
<TR>
<TD>TargetMoveError</TD>
<TD>The degree to which a weapon's aiming will fail to keep up with its target's movement. If set very low or not set at all, a weapon will lead its target and almost always hit unless there's a lot of micromanagement on the part of the person controlling the target. If set too high (about 0.3 or above), the weapon will have a lot of difficulty even tracking its target enough to get a shot off. Can probably only be set between 0 and 1. Beyond 1, the weapon would be virtually useless.</TD>
<TD>targetmoveerror=0.15;</TD>
</TR>
<TR>
<TD>Thickness</TD>
<TD>Thickness of a beamweapon or beamlaser, default is 2. Can be set to any numerical value.</TD>
<TD>thickness=4;</TD>
</TR>
<TR>
<TD>ToAirWeapon</TD>
<TD>If active, the weapon will only be capable of targetting units which are flying, or are capable of flying. Can be set to 0 or 1.</TD>
<TD>toairweapon=1;</TD>
</TR>
<TR>
<TD>Tolerance</TD>
<TD>The amount to which the weapon's "real" aim can be off while the weapon will still be able to fire accurately at the target. This worked in OTA, but I'm not 100% sure if it works in Spring. Can be set to any numerical value.</TD>
<TD>tolerance=1500;</TD>
</TR>
<TR>
<TD>Tracks</TD>
<TD>Is the missile capable of tracking a target after it has completed its transition - for use with vertical-launch missiles. Can be set to 1 or 0.</TD>
<TD>tracks=1;</TD>
</TR>
<TR>
<TD>TrajectoryHeight</TD>
<TD>The amount that the weapon is fired upwards. I'm pretty sure this can only work on missile weapons. It is useful for compensating for mountains or debris. Can be set between 0 and 1. 0 fires straight, 1 fires at 90 degrees (directly upward). Obviously, only useful on weapons with guidance.</TD>
<TD>trajectoryheight=0.5;</TD>
</TR>
<TR>
<TD>Turnrate</TD>
<TD>How fast a guided weapon can turn. Can be any numerical value. If set to 0, the weapon can't turn at all, if set to 99999, the weapon can literally defy all known physics and turn 180 degrees in a fraction of a second. This is relative to a weapon's velocity; a weapon with a very low velocity (~200) wouldn't need a very high turnrate to keep up with a fighter, although it would probably never catch it because of its slow speed. A weapon with a very high velocity (~1000) would need a very high value in order to be able to hit targets that turn suddenly.
<TD>turnrate=32000;</TD>
</TR>
<TR>
<TD>Turret</TD>
<TD>Set to 1 if weapon is used by a turret that rotates. Set to 0 if weapon is forward firing, ie, has no rotating turret piece.</TD>
<TD>turret=1;</TD>
</TR>
<TR>
<TD>TwoPhase</TD>
<TD>Weapon operates in two phases... eh... yeah, I honestly have no idea what the difference between this and VLaunch is. Generally use it with VLaunch as well. Can be set to 1 or 0.</TD>
<TD>twophase=1;</TD>
</TR>
<TR>
<TD>VLaunch</TD>
<TD>Set to 1 to launch the weapon vertically. Can only be used with missile-type weapons with a TurnRate. Cannot be used at the same time as Turret. Set to 1 or 0.</TD>
<TD>vlaunch=1;</TD>
</TR>
<TR>
<TD>WaterWeapon</TD>
<TD>Does the weapon fire below water? Can be set to 1 or 0.</TD>
<TD>waterweapon=1;</TD>
</TR>
<TR>
<TD>WeaponAcceleration</TD>
<TD>Tells the weapon how fast it should accelerate from its StartVelocity to its actual WeaponVelocity. Increases the weapon's velocity every second by the amount specified. Can be any numerical value.</TD>
<TD>weaponacceleration=50;</TD>
</TR>
<TR>
<TD>WeaponTimer</TD>
<TD>How long until the weapon will go into its second phase. For use with missile weapons. For VLaunch weapons, the weapon will turn to actually go towards its target after the specified number of seconds has expired. For non-VLaunch missiles with a TurnRate, the weapon will go randomly off-course after this period of time. Can be set to any numerical value.</TD>
<TD>weapontimer=5;</TD>
</TR>
<TR>
<TD>WeaponVelocity</TD>
<TD>The speed the weapon moves after being fired. If StartVelocity is lower than this number, the weapon will increase speed to its WeaponVelocity at the rate specified by its WeaponAcceleration.</TD>
<TD>weaponvelocity=800;</TD>
</TR>
<TR>
<TD>Wobble</TD>
<TD>The amount that a missile will wobble off-course. Probably doesn't work with Guidance weapons. Requires TurnRate. Can be set to any numerical value.</TD>
<TD>wobble=15000;</TD>
</TR>
</table>
 

=Shield/Repulsor Variable Descriptions=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>ExteriorShield</TD>
<TD>If set to 1, the shield/repulsor will not have any effect on weapons fired from within its field. Can be 1 or 0.</TD>
<TD>exteriorshield=1;</TD>
</TR>
<TR>
<TD>IsShield</TD>
<TD>If set to 1, this "weapon" is no longer a weapon, is now a repulsor or a shield, based on the other properties given to it. Can be 1 or 0.</TD>
<TD>isshield=1;</TD>
</TR>
<TR>
<TD>ShieldAlpha</TD>
<TD>How clearly visible the shield is, if you have VisibleShield turned on. Value is between 0 and 1.</TD>
<TD>shieldalpha=0.4;</TD>
</TR>
<TR>
<TD>ShieldEnergyUse</TD>
<TD>The amount of energy used to repulse or destroy weapons. Will be used constantly while the weapon is in its area of effect if it is a repulsor, will be used only once on impact if it is a shield.</TD>
<TD>shieldenergyuse=1500;</TD>
</TR>
<TR>
<TD>ShieldForce</TD>
<TD>The force applied to weapons, an arbitrary number. Set to 1, it will not deflect very well. Only for use on repulsor-type. Can be set to any numerical value.</TD>
<TD>shieldforce=1.75;</TD>
</TR>
<TR>
<TD>ShieldBadColor</TD>
<TD>The color the shield is when it is at 0% strength, if you have VisibleShield turned on. Defined in R G B format.</TD>
<TD>shieldbadcolor=0 1 0;</TD>
</TR>
<TR>
<TD>ShieldGoodColor</TD>
<TD>The color the shield is when it is at 100% strength, if you have VisibleShield turned on.</TD>
<TD>shieldgoodcolor=1 0 0;</TD>
</TR>
<TR>
<TD>ShieldInterceptType</TD>
<TD>Bitfield representing the types of weapons that this shield can intercept. The best way to think about this is to think of it as the resulting binary. Every digit of binary that is set to one means that a weapon with that digit set to one will be intercepted by this shield, for instance, the example will result in the shield blocking weapons with types 2 and/or 3. Maxium of 32 unique types. See [[Shield Interception Tag Use]].</TD>
<TD>ShieldInterceptType=6;</TD>
</TR>
<TR>
<TD>ShieldMaxSpeed</TD>
<TD>The maximum speed the repulsor will push weapons away at. Only for use on repulsor-type. Can be set to any numerical value.</TD>
<TD>shieldmaxspeed=400;</TD>
</TR>
<TR>
<TD>ShieldPower</TD>
<TD>How much "power" a shield can store. "Power" is not the same as energy; think of it as the shield/repulsor's private battery source. It can be drained completely by defending against weapons, even if you have lots of energy. Can be set to any numerical value.</TD>
<TD>shieldpower=1000;</TD>
</TR>
<TR>
<TD>ShieldPowerRegen</TD>
<TD>How quickly the shield regenerates its "power", even when under attack. Regenerates the amount specified every second. Can be set to any numerical value.</TD>
<TD>shieldpowerregen=25;</TD>
</TR>
<TR>
<TD>ShieldPowerRegenEnergy</TD>
<TD>How much energy is required to keep the shield regenerating its "power". For instance, you might have it set so that 100 units of energy are necessary for every 25 units of "power".</TD>
<TD>shieldpowerregenenergy=100;</TD>
</TR>
<TR>
<TD>ShieldRadius</TD>
<TD>Defines the size of the area the shield/repulsor protects. Can be set to any numerical value.</TD>
<TD>shieldradius=500;</TD>
</TR>
<TR>
<TD>ShieldRepulsor</TD>
<TD>If set to 1, the "shield"-type weapon will repulse projectiles. If set to 0, it will destroy them. Can be set to 1 or 0.</TD>
<TD>shieldrepulsor=1;</TD>
</TR>
<TR>
<TD>SmartShield</TD>
<TD>If set to 1, the shield/repulsor will not affect owned/allied weapons. Can be set to 1 or 0.</TD>
<TD>smartshield=1;</TD>
</TR>
<TR>
<TD>VisibleShield</TD>
<TD>If set to 1, the shield will be visible. Only for use on shield-type. Can be set to 1 or 0.</TD>
<TD>visibleshield=1;</TD>
</TR>
<TR>
<TD>VisibleShieldRepulse</TD>
<TD>If set to 1, the repulsing effect will be visible. Only for use on repulsor-type. Can be set to 1 or 0.</TD>
<TD>visibleshieldrepulse=1;</TD>
</TR>
</table>
</center>

[[category:Weapons]]

[[category:Shields]]

Custom Unit Icons

2006-09-15T19:54:24Z

FoeOfTheBee: /* Example files */

==Custom Unit Icons==

[[Image:Minimap icons.jpg]]

===About===

On the minimap the units are displayed as icons, which also appear when you zoom out. Mod developers can set icons for different types of units (such as in the picture above, with different icons for land, air, sea, and commanders), or go so far as to give every unit its own icon.

The different types icons will be shown for friendly units, and enemy units within Line Of Sight. For enemy units in radar range Spring will use the 'default' icon.

===How to specify different types of icons===

The custom icons specification, gamedata/icontypes.tdf, should look like this:

[icontypes]
{
[default]
{
// Spring replaces missing or incorrect bitmaps by the radar dot.
size=1;
radiusadjust=1;
distance=1;
}
[type1]
{
bitmap=icons/type1.bmp;
size=2;
radiusadjust=0;
distance=3;
}
[type2]
{
bitmap=icons/type2.bmp;
size=2;
radiusadjust=0;
distance=0.5;
}
// other type definitions may follow
}

'''bitmap''' is the location of the custom icon bitmap. If it is missing or incorrect, Spring replaces it with the standard radar dot. The bitmap will get blended with the team color, so there is no special team color channel.
In order to look nice, the bitmap will need to have an alpha channel for transparancy.

'''size''' is a number that acts as multiplier for the icon size. The bigger the number, the bigger the icon will be. Default is 1.

'''radiusadjust''' is a boolean (0 or 1) that tells Spring whether or not the icon should scale with the unit radius. Default is 0 (false).

'''distance''' is a number that acts as a multiplier for the distance at which the unit will show up as an icon. The bigger the number, the further away the camera has to be from the unit for it to turn into an icon. Default is 1.

The "default" icon type is a bit special; every unit that misses an 'iconType' tag (see below) or has one that doesn't match a type specified in gamedate/icontypes.tdf gets assigned to the "default" type. If the "default" type is not specified, Spring will create it with the default values.

Furthermore, enemy units that are within radar range, but not in your Line Of Sight, will be shown as the default icon. Thus if there is a bitmap specified for the "default" icon type it will override the standard radar blip.

=== How to assign icon types to units ===

To assign units to a specific icon type, add the following line to their FBI file:

iconType=type1;

You can replace "type1" with icontypes defined in gamedata/icontypes.tdf. If the tag "iconType" is missing, Spring sets it to the icontype "default".

===Example files===

You can grab
http://teake.home.fmf.nl/temp/unit_icons.zip
as a starting set for unit icons.

The screenshot above was taken using these icons.

[[category:Mod Development]]