Spring - User contributions [en]

GamesDownloads

2015-01-20T01:21:45Z

Carrepairer: Added weblobby

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

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

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

= Game installers (for players) =
Below are two Spring games that comes with complete installer (containing all the files you need to play those games):
<div id="installers" style="padding-left:7px">
{{Template:GamesDownload|name=Kernel Panic|image=Kernel_Panic_3.4.jpg|url=http://springfiles.com/spring/game-installers/kernel-panic-installer}}
</div>

<span class="warning">(!)</span> Old engine version included. Experience of online play might be hampered.

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

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

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

{{Template:GamesDownload|name=Zero-K lobby|image=eclipse.jpg|url=http://zero-k.info/Wiki/Download}}
(Windows & Linux (mono), uncheck 'official games' to see all)

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

{{Template:GamesDownload|name=Spring Web Lobby|image=Blobby.png|url=https://github.com/springweblobby/swl-website#spring-web-lobby}}
(Windows & Linux)
</div>

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

[[Category:Spring]]

File:Blobby.png

2015-01-20T01:19:03Z

Carrepairer: Springweblobby Logo

Springweblobby Logo

Lobby Development

2014-06-07T03:39:42Z

Carrepairer: Update weblobby link

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

=Documentation=

==Protocol==
* [http://springrts.com/dl/LobbyProtocol/ HTML] (is updated once a day)
* [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml XML] (raw, always latest)

==Download Systems==
* [http://springrts.com/wiki/Dev:LobbyDownloadSystems Lobby Download Systems]

=Lobby client development=

==Useable lobby clients==

===[[SpringLobby]]===

===Zero-K Lobby===
<font color="orange">Windows/Linux</font>,
<font color="#00AAFF">C#</font>,
by <font color="#00CC00">Licho</font> & <font color="#00CC00">quantum</font>

[https://code.google.com/p/zero-k/ Zero-K project page]

===TASClient===
<font color="orange">Windows</font>,
<font color="#00AAFF">Delphi</font>,
by <font color="#00CC00">Satirik</font>

You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here:
http://springrts.com/dl/tasclient/TASClientLatest.7z

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

===flobby===
<font color="orange">Linux</font>,
<font color="#00AAFF">C++</font>,
by <font color="#00CC00">cleanrock</font>

[https://github.com/cleanrock/flobby github page]

===Weblobby===
<font color="orange">cross-platform</font>,
<font color="#00AAFF">C++</font>,
by <font color="#00CC00">CarRepairer</font>

[https://github.com/springweblobby/swl-website#spring-web-lobby project site]

==Work in progress or abandoned==

===Alphalobby===
<font color="orange">Windows</font>,
<font color="#00AAFF">C</font>,
<font color="#FF0000">unmaintained</font>

Alphalobby is still very much work in progress. If you still wish to use it, source available from the [http://code.google.com/p/alphalobby/source/checkout mercurial repository], binary available on the [http://springfiles.com/spring/lobby-clients/alphalobby springfiles page].

===CheeseLobby===
<font color="orange">cross-platform</font>,
<font color="#00AAFF">Java</font>,
by <font color="#00CC00">Cheesecan</font>

[http://springrts.com/phpbb/viewtopic.php?f=64&t=24905 forum thread]

[https://github.com/jahwag/cheeselobby binaries and code]

===QtLobby===
<font color="orange">cross-platform</font>,
<font color="#00AAFF">C++</font>,
<font color="#FF0000">unmaintained</font>

[https://github.com/tizbac/qtlobby project page]

===muslce (most useless spring lobby client ever)===
<font color="orange">android</font>,
<font color="#00AAFF">java</font>,
<font color="#FF0000">unmaintained</font>

http://springrts.massive.ch/muslce/Muslce-20130617.tar.bz2

=Libraries and frameworks=

==Spring-PythonBotFramework==
<font color="orange">cross-platform</font>,
<font color="#00AAFF">Python</font>, by
<font color="#00CC00">BrainDamage</font> & <font color="#00CC00">koshi</font>

A bot framework written in python. [https://github.com/renemilk/tasbot/wiki GitHub wiki]

==Go SpringLobbyClient==
<font color="orange">cross-platform</font>,
<font color="#00AAFF">Go</font>

A simple client implementation of the lobby protocol in Go.
[https://github.com/Agon/go-slc/ project page]

=Lobby server development=

==SpringLS==
<font color="orange">cross-platform</font>,
<font color="#00AAFF">Java</font>,
<font color="#00CC00">hoijui</font>

The longest-running lobby server, created by Betalord. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/SpringLS development site].

==UberServer==
<font color="orange">cross-platform</font>,
<font color="#00AAFF">Python</font>,
by <font color="#00CC00">aegis</font>

The primary lobby server currently running on springrts.com. All protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and SpringLS. See the dedicated [[uberserver]] for mor info.

[[Category: Lobby]]

EvoGreenLitFAQ

2014-04-11T22:39:07Z

Carrepairer: /* Registration Failed. Reason: Invalid md5 sum. */ removed

__NOTOC__

'''EvolutionRTS emergency FAQ'''
----

'''Before you ask a question in chat, please see if it is already answered on this list.'''

==Playable at the moment?==
It might seem so!

http://www.vemags.de/wp-content/uploads/2012/06/Status_LSA_gruen1.jpg

In last hours I have seen several players successfully launching games and playing.

==Downloads fail (because windows user name has special characters)==
http://i.imgur.com/6qZTQOZ.png

If the lobby states it is downloading the engine but nothing happens:

Check if your windows account name contains any "funny" characters or umlauts like Ã¶Ã¼Ã¤Ã´Ã¡ etc.

As a workaround use a windows account name without such characters. This is will be fixed of course.

==Singleplayer?==
There is a singleplayer tab but with a fresh install it will not work.
(Game files and engine are missing)

'''Solution:''' Create a multiplayer battleroom with the button at the bottom and make it private by giving it a password.

The lobby will download the necessary files. Afterwards you can select the evolutionRTS game in singleplayer menu, or stay in this battleroom and play. See below for adding bots.



==Automatic download of game files does not work==
NOTE: the GAME file.

Best idea is to wait a bit, the lobby should eventually download it.
If it really absolutely does not work:
1. Go to http://packages.springrts.com/builds/
2. download the .sdz with the latest evolutionRTS version. (Currently that is 7.37 but check vs what is played in lobby)
3. Put the .sdz file into: Documents/My Games/Spring/games
Do not unzip it, just move it there. When you're done, close and reopen the lobby.

As said, that is only for advanced users and should not be necessary.

===Cannot start command: Downloading Engine 96.0: assign: The parameter is incorrect===

Are you on windows XP? Unfortunately the lobby does not work with Windows XP. You can use the Java Weblobby version by visiting http://www.weblobby.evolutionrts.info directly or you can try a different lobby: http://steamcommunity.com/app/291150/discussions/0/540738051772337468/

===Download stuck at 100%===
Close the lobby and start it again.

If that doesn't help, you can try this:
Download this file... http://springrts.com/dl/buildbot/default/master/96.0/win32/spring_96.0_minimal-portable.7z

Unzip the files into: Documents\My Games\Spring\weblobby\engine\96.0 (if this path doesn't exist, you should create it)

Start Lobby

==AI does not work!==
The evolutionRTS AI is the "Survial Spawner AI."
It spawns random enemies for you to shot at.

The NullAI bot can also be used: It does ''nothing'' which is nice to try out the game without enemies.

==Sandbox mode? I want to try the game without being rushed!==
Start a singleplayer game against the NullAI bot.

==Missions?==
Not there yet.

==It crashed!==
There is a logfile: [[Infolog.txt]]

The page also explains how to find and share it. You can post it in forum, on steam or in chat.

==Which maps should I play?==
Eye of Horus is a good map that works for team games, free-for-all, 1v1 and with bots.

==Why so many problems?==
Surprised by too many players.

==Hooray, I am ingame! How to play?==
http://www.wiki.evolutionrts.info/doku.php/evolution_rts:quick_start_guide

Or just try out things :)

==How to chat ingame?==
Press the RETURN key and type your message.

==Graphics problems! / the game runs very bad!==
Some problems can probally be solved by the general spring-engine FAQ: [[FAQ:trouble]]

==Cursor is painfully slow!==
Click Settings (the wrench) > Interface > Mouse Cursor > enable Hardware Cursor

==As a player, how can I help?==

1. '''If you have bugs to report''': It is okay to do so in the steam forum: http://steamcommunity.com/app/291150

(Or if you know how to use the google.code bugtracker: https://code.google.com/p/evolutionrts/issues/list )

'''Give as much ''info'' as possible:'''
*Operation system

*computer hardware (laptop or desktop, cpu, ram, graphics card,..)

*This logfile: [[Infolog.txt]]

*Lobby logfile: /Documents/My games/Spring/weblobby/'''weblobby.log''' , share via pastebin.com

*Screenshots can be uploaded to imgur.com or similiar

After a while check back on your post, devs might need more informations from you!

Reporting bugs in chat is pretty much useless, there get overlooked there or forgotten.

2. '''If you can play:''' help others players with their problems in chat.

3. Be patient :)

==More Information About Common Bugs==
https://code.google.com/p/springweblobby/wiki/EvoSteamBugs

EvoGreenLitFAQ

2014-04-10T04:10:01Z

Carrepairer: SP edit again

__NOTOC__

'''EvolutionRTS emergency FAQ'''
----

'''Before you ask a question in chat, please see if it is already answered on this list.'''

==Singleplayer?==
There is a singleplayer tab but with a fresh install it will not work.
(Game files and engine are missing)

'''Solution:''' Create a multiplayer battleroom with the button at the bottom and make it private by giving it a password.

The lobby will download the necessary files. Afterwards you can select the evolutionRTS game in singleplayer menu, or stay in this battleroom and play. See below for adding bots.



==Automatic download of game files does not work==
NOTE: the GAME file.

Best idea is to wait a bit, the lobby should eventually download it.
If it really absolutely does not work:
1. Go to http://packages.springrts.com/builds/
2. download the .sdz with the latest evolutionRTS version. (Currently that is 7.37 but check vs what is played in lobby)
3. Put the .sdz file into: Documents/My Games/Spring/games
Do not unzip it, just move it there. When you're done, close and reopen the lobby.

As said, that is only for advanced users and should not be necessary.

===Cannot start command: Downloading Engine 96.0: assign: The parameter is incorrect===

Are you on windows XP? Unfortunately the lobby does not work with Windows XP. You can use the Java Weblobby version by visiting http://www.weblobby.evolutionrts.info directly or you can try a different lobby: http://steamcommunity.com/app/291150/discussions/0/540738051772337468/

===Download stuck at 100%===
Close the lobby and start it again.

If that doesn't help, you can try this:
Download this file... http://springrts.com/dl/buildbot/default/master/96.0/win32/spring_96.0_minimal-portable.7z

Unzip the files into: Documents\My Games\Spring\weblobby\engine\96.0 (if this path doesn't exist, you should create it)

Start Lobby

==AI does not work!==
The evolutionRTS AI is the "Survial Spawner AI."
It spawns random enemies for you to shot at.

The NullAI bot can also be used: It does ''nothing'' which is nice to try out the game without enemies.

==Sandbox mode? I want to try the game without being rushed!==
Start a singleplayer game against the NullAI bot.

==Missions?==
Not there yet.

==It crashed!==
There is a logfile: [[Infolog.txt]]

The page also explains how to find and share it. You can post it in forum, on steam or in chat.

==Which maps should I play?==
Eye of Horus is a good map that works for team games, free-for-all, 1v1 and with bots.

==Why so many problems?==
Surprised by too many players.

==Hooray, I am ingame! How to play?==
http://www.wiki.evolutionrts.info/doku.php/evolution_rts:quick_start_guide

Or just try out things :)

==How to chat ingame?==
Press the RETURN key and type your message.

==Graphics problems! / the game runs very bad!==
Some problems can probally be solved by the general spring-engine FAQ: [[FAQ:trouble]]

==Cursor is painfully slow!==
Click Settings (the wrench) > Interface > Mouse Cursor > enable Hardware Cursor

==As a player, how can I help?==

1. '''If you have bugs to report''': It is okay to do so in the steam forum: http://steamcommunity.com/app/291150

(Or if you know how to use the google.code bugtracker: https://code.google.com/p/evolutionrts/issues/list )

'''Give as much ''info'' as possible:'''
*Operation system
*computer hardware (laptop or desktop, cpu, ram, graphics card,..)
*This logfile: [[Infolog.txt]]
*Screenshots can be uploaded to imgur.com or similiar

After a while check back on your post, devs might need more informations from you!

Reporting bugs in chat is pretty much useless, there get overlooked there or forgotten.

2. '''If you can play:''' help others players with their problems in chat.

3. Be patient :)

==More Information About Common Bugs==
https://code.google.com/p/springweblobby/wiki/EvoSteamBugs

EvoGreenLitFAQ

2014-04-10T01:50:04Z

Carrepairer: /* Singleplayer? */

__NOTOC__

'''EvolutionRTS emergency FAQ'''
----

'''Before you ask a question in chat, please see if it is already answered on this list.'''

==countdown, then no game starts==

<span class="warning">Right now there are many reports of games not starting.</span>
Instead there is loadscreen with a 30sec countdown.
http://abload.de/img/countdownnwsib.png

'''I do not know what is the problem with that.''' Lobby developers will hopefully be back in a few hours. Please post any details you can find on steam forum, your feedback is apprecitated.

==Singleplayer?==
There is a singleplayer tab but with a fresh install it will not work.
(Game files and engine are missing)

'''Solution:''' Create a multiplayer battleroom with the button at the bottom and make it private by giving it a password.

The lobby will download the necessary files. Afterwards you can select the evolutionRTS game in singleplayer menu, or stay in this battleroom and play. See below for adding bots.



==Automatic download of game files does not work==
NOTE: the GAME file.

Best idea is to wait a bit, the lobby should eventually download it.
If it really absolutely does not work:
1. Go to http://packages.springrts.com/builds/
2. download the .sdz with the latest evolutionRTS version. (Currently that is 7.37 but check vs what is played in lobby)
3. Put the .sdz file into: Documents/My Games/Spring/games
Do not unzip it, just move it there. When you're done, close and reopen the lobby.

As said, that is only for advanced users and should not be necessary.

===Cannot start command: Downloading Engine 96.0: assign: The parameter is incorrect===

Are you on windows XP? Unfortunately the lobby does not work with Windows XP. You can use the Java Weblobby version by visiting http://www.weblobby.evolutionrts.info directly or you can try a different lobby: http://steamcommunity.com/app/291150/discussions/0/540738051772337468/

===Download stuck at 100%===
Close the lobby and start it again.

If that doesn't help, you can try this:
Download this file... http://springrts.com/dl/buildbot/default/master/96.0/win32/spring_96.0_minimal-portable.7z

Unzip the files into: Documents\My Games\Spring\weblobby\engine\96.0 (if this path doesn't exist, you should create it)

Start Lobby

==AI does not work!==
The evolutionRTS AI is the "Survial Spawner AI."
It spawns random enemies for you to shot at.

The NullAI bot can also be used: It does ''nothing'' which is nice to try out the game without enemies.

==Sandbox mode? I want to try the game without being rushed!==
Start a singleplayer game against the NullAI bot.

==Missions?==
Not there yet.

==It crashed!==
There is a logfile: [[Infolog.txt]]

The page also explains how to find and share it. You can post it in forum, on steam or in chat.

==Which maps should I play?==
Eye of Horus is a good map that works for team games, free-for-all, 1v1 and with bots.

==Why so many problems?==
Surprised by too many players.

==Hooray, I am ingame! How to play?==
http://www.wiki.evolutionrts.info/doku.php/evolution_rts:quick_start_guide

Or just try out things :)

==How to chat ingame?==
Press the RETURN key and type your message.

==Graphics problems! / the game runs very bad!==
Some problems can probally be solved by the general spring-engine FAQ: [[FAQ:trouble]]

==Cursor is painfully slow!==
Click Settings (the wrench) > Interface > Mouse Cursor > enable Hardware Cursor

==As a player, how can I help?==

1. '''If you have bugs to report''': It is okay to do so in the steam forum: http://steamcommunity.com/app/291150

(Or if you know how to use the google.code bugtracker: https://code.google.com/p/evolutionrts/issues/list )

'''Give as much ''info'' as possible:'''
*Operation system
*computer hardware (laptop or desktop, cpu, ram, graphics card,..)
*This logfile: [[Infolog.txt]]
*Screenshots can be uploaded to imgur.com or similiar

After a while check back on your post, devs might need more informations from you!

Reporting bugs in chat is pretty much useless, there get overlooked there or forgotten.

2. '''If you can play:''' help others players with their problems in chat.

3. Be patient :)

==More Information About Common Bugs==
https://code.google.com/p/springweblobby/wiki/EvoSteamBugs

EvoGreenLitFAQ

2014-04-10T01:27:51Z

Carrepairer: Singleplayer changes

__NOTOC__

'''EvolutionRTS emergency FAQ'''
----

'''Before you ask a question in chat, please see if it is already answered on this list.'''

==countdown, then no game starts==

<span class="warning">Right now there are many reports of games not starting.</span>
Instead there is loadscreen with a 30sec countdown.
http://abload.de/img/countdownnwsib.png

'''I do not know what is the problem with that.''' Lobby developers will hopefully be back in a few hours. Please post any details you can find on steam forum, your feedback is apprecitated.

==Singleplayer?==
There is a singleplayer tab but with a fresh install it will not work.
(Game files and engine are missing)


'''Solution:''' Join a multiplayer battleroom. The lobby will download the necessary files. Afterwards you can select the evolutionRTS game in singleplayer menu. See below for adding bots.

==Automatic download of game files does not work==
NOTE: the GAME file.

Best idea is to wait a bit, the lobby should eventually download it.
If it really absolutely does not work:
1. Go to http://packages.springrts.com/builds/
2. download the .sdz with the latest evolutionRTS version. (Currently that is 7.37 but check vs what is played in lobby)
3. Put the .sdz file into: Documents/My Games/Spring/games
Do not unzip it, just move it there. When you're done, close and reopen the lobby.

As said, that is only for advanced users and should not be necessary.

===Cannot start command: Downloading Engine 96.0: assign: The parameter is incorrect===

Are you on windows XP? Unfortunately the lobby does not work with Windows XP. You can use the Java Weblobby version by visiting http://www.weblobby.evolutionrts.info directly or you can try a different lobby: http://steamcommunity.com/app/291150/discussions/0/540738051772337468/

===Download stuck at 100%===
Close the lobby and start it again.

If that doesn't help, you can try this:
Download this file... http://springrts.com/dl/buildbot/default/master/96.0/win32/spring_96.0_minimal-portable.7z

Unzip the files into: Documents\My Games\Spring\weblobby\engine\96.0 (if this path doesn't exist, you should create it)

Start Lobby

==AI does not work!==
The evolutionRTS AI is the "Survial Spawner AI."
It spawns random enemies for you to shot at.

The NullAI bot can also be used: It does ''nothing'' which is nice to try out the game without enemies.

==Sandbox mode? I want to try the game without being rushed!==
Start a singleplayer game against the NullAI bot.

==Missions?==
Not there yet.

==It crashed!==
There is a logfile: [[Infolog.txt]]

The page also explains how to find and share it. You can post it in forum, on steam or in chat.

==Which maps should I play?==
Eye of Horus is a good map that works for team games, free-for-all, 1v1 and with bots.

==Why so many problems?==
Surprised by too many players.

==Hooray, I am ingame! How to play?==
http://www.wiki.evolutionrts.info/doku.php/evolution_rts:quick_start_guide

Or just try out things :)

==How to chat ingame?==
Press the RETURN key and type your message.

==Graphics problems! / the game runs very bad!==
Some problems can probally be solved by the general spring-engine FAQ: [[FAQ:trouble]]

==Cursor is painfully slow!==
Click Settings (the wrench) > Interface > Mouse Cursor > enable Hardware Cursor

==As a player, how can I help?==

1. '''If you have bugs to report''': It is okay to do so in the steam forum: http://steamcommunity.com/app/291150

(Or if you know how to use the google.code bugtracker: https://code.google.com/p/evolutionrts/issues/list )

'''Give as much ''info'' as possible:'''
*Operation system
*computer hardware (laptop or desktop, cpu, ram, graphics card,..)
*This logfile: [[Infolog.txt]]
*Screenshots can be uploaded to imgur.com or similiar

After a while check back on your post, devs might need more informations from you!

Reporting bugs in chat is pretty much useless, there get overlooked there or forgotten.

2. '''If you can play:''' help others players with their problems in chat.

3. Be patient :)

==More Information About Common Bugs==
https://code.google.com/p/springweblobby/wiki/EvoSteamBugs

EvoGreenLitFAQ

2014-04-09T20:13:44Z

Carrepairer: /* Singleplayer? */

__NOTOC__

'''EvolutionRTS emergency FAQ'''
----

'''Before you ask a question in chat, please see if it is already answered on this list.'''

==Singleplayer?==
There is a singleplayer tab but with a fresh install it will not work.
(Game files and engine are missing)

'''Solution:''' Create a multiplayer battleroom with the button at the bottom and make it private by giving it a password.

The lobby will download the necessary files. Afterwards you can select the evolutionRTS game in singleplayer menu, or stay in this battleroom and play. See below for adding bots.

==Automatic download of game files does not work==
NOTE: the GAME file.

Best idea is to wait a bit, the lobby should eventually download it.
If it really absolutely does not work:
1. Go to http://packages.springrts.com/builds/
2. download the .sdz with the latest evolutionRTS version. (Currently that is 7.37 but check vs what is played in lobby)
3. Put the .sdz file into: Documents/My Games/Spring/games
Do not unzip it, just move it there. When you're done, close and reopen the lobby.

As said, that is only for advanced users and should not be necessary.

===Cannot start command: Downloading Engine 96.0: assign: The parameter is incorrect===

Are you on windows XP? Unfortunately the lobby does not work with Windows XP. You can use the Java Weblobby version by visiting http://www.weblobby.evolutionrts.info directly or you can try a different lobby: http://steamcommunity.com/app/291150/discussions/0/540738051772337468/

===Download stuck at 100%===
Close the lobby and start it again.

==AI does not work!==
The evolutionRTS AI is the "Survial Spawner AI."
It spawns random enemies for you to shot at.

The NullAI bot can also be used: It does ''nothing'' which is nice to try out the game without enemies.

==Sandbox mode? I want to try the game without being rushed!==
Start a singleplayer game against the NullAI bot.

==Missions?==
Not there yet.

==It crashed!==
There is a logfile: [[Infolog.txt]]

The page also explains how to find and share it. You can post it in forum, on steam or in chat.

==Which maps should I play?==
Eye of Horus is a good map that works for team games, free-for-all, 1v1 and with bots.

==Why so many problems?==
Surprised by too many players.

==Hooray, I am ingame! How to play?==
http://www.wiki.evolutionrts.info/doku.php/evolution_rts:quick_start_guide

Or just try out things :)

==How to chat ingame?==
Press the RETURN key and type your message.

==Graphics problems! / the game runs very bad!==
Some problems can probally be solved by the general spring-engine FAQ: [[FAQ:trouble]]

==Cursor is painfully slow!==
Click Settings (the wrench) > Interface > Mouse Cursor > enable Hardware Cursor

==As a player, how can I help?==

1. '''If you have bugs to report''': It is okay to do so in the steam forum: http://steamcommunity.com/app/291150

(Or if you know how to use the google.code bugtracker: https://code.google.com/p/evolutionrts/issues/list )

'''Give as much ''info'' as possible:'''
*Operation system
*computer hardware (laptop or desktop, cpu, ram, graphics card,..)
*This logfile: [[Infolog.txt]]
*Screenshots can be uploaded to imgur.com or similiar

After a while check back on your post, devs might need more informations from you!

Reporting bugs in chat is pretty much useless, there get overlooked there or forgotten.

2. '''If you can play:''' help others players with their problems in chat.

3. Be patient :)

==More Information About Common Bugs==
https://code.google.com/p/springweblobby/wiki/EvoSteamBugs

EvoGreenLitFAQ

2014-04-09T19:30:59Z

Carrepairer: Other AIs are now hidden from weblobby.

__NOTOC__

'''EvolutionRTS emergency FAQ'''
----

'''Before you ask a question in chat, please see if it is already answered on this list.'''

==Singleplayer?==
There is a singleplayer tab but with a fresh install it will not work.
(Game files and engine are missing)

'''Solution:''' Join a multiplayer game.

The lobby will download the nessecary files. Afterwards you can select the evolutionRTS game in singleplayer menu.

==Automatic download of game files does not work==
NOTE: the GAME file.

Best idea is to wait a bit, the lobby should eventually download it.
If it really absolutely does not work:
1. Go to http://packages.springrts.com/builds/
2. download the .sdz with the latest evolutionRTS version. (Currently that is 7.37 but check vs what is played in lobby)
3. Put the .sdz file into: Documents/My Games/Spring/games
Do not unzip it, just move it there. When you're done, close and reopen the lobby.

As said, that is only for advanced users and should not be necessary.

===Cannot start command: Downloading Engine 96.0: assign: The parameter is incorrect===

Are you on windows XP? Unfortunately the lobby does not work with Windows XP. You can use the Java Weblobby version by visiting http://www.weblobby.evolutionrts.info directly or you can try a different lobby: http://steamcommunity.com/app/291150/discussions/0/540738051772337468/

===Download stuck at 100%===
Close the lobby and start it again.

==AI does not work!==
The evolutionRTS AI is the "Survial Spawner AI."
It spawns random enemies for you to shot at.

The NullAI bot can also be used: It does ''nothing'' which is nice to try out the game without enemies.

==Sandbox mode? I want to try the game without being rushed!==
Start a singleplayer game against the NullAI bot.

==Missions?==
Not there yet.

==It crashed!==
There is a logfile: [[Infolog.txt]]

The page also explains how to find and share it. You can post it in forum, on steam or in chat.

==Which maps should I play?==
Eye of Horus is a good map that works for team games, free-for-all, 1v1 and with bots.

==Why so many problems?==
Surprised by too many players.

==Hooray, I am ingame! How to play?==
http://www.wiki.evolutionrts.info/doku.php/evolution_rts:quick_start_guide

Or just try out things :)

==How to chat ingame?==
Press the RETURN key and type your message.

==Graphics problems! / the game runs very bad!==
Some problems can probally be solved by the general spring-engine FAQ: [[FAQ:trouble]]

==Cursor is painfully slow!==
Click Settings (the wrench) > Interface > Mouse Cursor > enable Hardware Cursor

==As a player, how can I help?==

1. '''If you have bugs to report''': It is okay to do so in the steam forum: http://steamcommunity.com/app/291150

(Or if you know how to use the google.code bugtracker: https://code.google.com/p/evolutionrts/issues/list )

'''Give as much ''info'' as possible:'''
*Operation system
*computer hardware (laptop or desktop, cpu, ram, graphics card,..)
*This logfile: [[Infolog.txt]]
*Screenshots can be uploaded to imgur.com or similiar

After a while check back on your post, devs might need more informations from you!

Reporting bugs in chat is pretty much useless, there get overlooked there or forgotten.

2. '''If you can play:''' help others players with their problems in chat.

3. Be patient :)

==More Information About Common Bugs==
https://code.google.com/p/springweblobby/wiki/EvoSteamBugs

EvoGreenLitFAQ

2014-04-09T19:28:20Z

Carrepairer: added link to weblobby evo steam bugs.

__NOTOC__

'''EvolutionRTS emergency FAQ'''
----

'''Before you ask a question in chat, please see if it is already answered on this list.'''

==Singleplayer?==
There is a singleplayer tab but with a fresh install it will not work.
(Game files and engine are missing)

'''Solution:''' Join a multiplayer game.

The lobby will download the nessecary files. Afterwards you can select the evolutionRTS game in singleplayer menu.

==Automatic download of game files does not work==
NOTE: the GAME file.

Best idea is to wait a bit, the lobby should eventually download it.
If it really absolutely does not work:
1. Go to http://packages.springrts.com/builds/
2. download the .sdz with the latest evolutionRTS version. (Currently that is 7.37 but check vs what is played in lobby)
3. Put the .sdz file into: Documents/My Games/Spring/games
Do not unzip it, just move it there. When you're done, close and reopen the lobby.

As said, that is only for advanced users and should not be necessary.

===Cannot start command: Downloading Engine 96.0: assign: The parameter is incorrect===

Are you on windows XP? Unfortunately the lobby does not work with Windows XP. You can use the Java Weblobby version by visiting http://www.weblobby.evolutionrts.info directly or you can try a different lobby: http://steamcommunity.com/app/291150/discussions/0/540738051772337468/

===Download stuck at 100%===
Close the lobby and start it again.

==AI does not work!==
The evolutionRTS AI is the "Survial Spawner AI."
It spawns random enemies for you to shot at.

The NullAI bot can also be used: It does ''nothing'' which is nice to try out the game without enemies.

ALL OTHER AI BOTS DO NOT WORK! (they are meant for different spring games)

==Sandbox mode? I want to try the game without being rushed!==
Start a singleplayer game against the NullAI bot.

==Missions?==
Not there yet.

==It crashed!==
There is a logfile: [[Infolog.txt]]

The page also explains how to find and share it. You can post it in forum, on steam or in chat.

==Which maps should I play?==
Eye of Horus is a good map that works for team games, free-for-all, 1v1 and with bots.

==Why so many problems?==
Surprised by too many players.

==Hooray, I am ingame! How to play?==
http://www.wiki.evolutionrts.info/doku.php/evolution_rts:quick_start_guide

Or just try out things :)

==How to chat ingame?==
Press the RETURN key and type your message.

==Graphics problems! / the game runs very bad!==
Some problems can probally be solved by the general spring-engine FAQ: [[FAQ:trouble]]

==Cursor is painfully slow!==
Click Settings (the wrench) > Interface > Mouse Cursor > enable Hardware Cursor

==As a player, how can I help?==

1. '''If you have bugs to report''': It is okay to do so in the steam forum: http://steamcommunity.com/app/291150

(Or if you know how to use the google.code bugtracker: https://code.google.com/p/evolutionrts/issues/list )

'''Give as much ''info'' as possible:'''
*Operation system
*computer hardware (laptop or desktop, cpu, ram, graphics card,..)
*This logfile: [[Infolog.txt]]
*Screenshots can be uploaded to imgur.com or similiar

After a while check back on your post, devs might need more informations from you!

Reporting bugs in chat is pretty much useless, there get overlooked there or forgotten.

2. '''If you can play:''' help others players with their problems in chat.

3. Be patient :)

==More Information About Common Bugs==
https://code.google.com/p/springweblobby/wiki/EvoSteamBugs

EvoGreenLitFAQ

2014-04-09T06:49:18Z

Carrepairer: Added hardware cursor fix

__NOTOC__

'''EvolutionRTS emergency FAQ'''
----

'''Before you ask a question in chat, please see if it is already answered on this list.'''

==Singleplayer?==
There is a singleplayer tab but with a fresh install it will not work.
(Game files and engine are missing)

'''Solution:''' Join a multiplayer game.

The lobby will download the nessecary files. Afterwards you can select the evolutionRTS game in singleplayer menu.

==Automatic download of game files does not work==
NOTE: the GAME file.

Best idea is to wait a bit, the lobby should eventually download it.
If it really absolutely does not work:
1. Go to http://packages.springrts.com/builds/
2. download the .sdz with the latest evolutionRTS version. (Currently that is 7.37 but check vs what is played in lobby)
3. Put the .sdz file into: Documents/My Games/Spring/games
Do not unzip it, just move it there. When you're done, close and reopen the lobby.

As said, that is only for advanced users and should not be necessary.

===Download stuck at 100%===
Close the lobby and start it again.

==AI does not work!==
The evolutionRTS AI is the "Survial Spawner AI."
It spawns random enemies for you to shot at.

The NullAI bot can also be used: It does ''nothing'' which is nice to try out the game without enemies.

ALL OTHER AI BOTS DO NOT WORK! (they are meant for different spring games)

==Sandbox mode? I want to try the game without being rushed!==
Start a singleplayer game against the NullAI bot.

==Missions?==
Not there yet.

==It crashed!==
There is a logfile: [[Infolog.txt]]

The page also explains how to find and share it. You can post it in forum, on steam or in chat.

==Which maps should I play?==
Eye of Horus is a good map that works for team games, free-for-all, 1v1 and with bots.

==Why so many problems?==
Surprised by too many players.

==Hooray, I am ingame! How to play?==
http://www.wiki.evolutionrts.info/doku.php/evolution_rts:quick_start_guide

Or just try out things :)

==How to chat ingame?==
Press the RETURN key and type your message.

==Graphics problems! / the game runs very bad!==
Some problems can probally be solved by the general spring-engine FAQ: [[FAQ:trouble]]

==Cursor is painfully slow!==
Click Settings (the wrench) > Interface > Mouse Cursor > enable Hardware Cursor

==As a player, how can I help?==

1. '''If you have bugs to report''': It is okay to do so in the steam forum: http://steamcommunity.com/app/291150

(Or if you know how to use the google.code bugtracker: https://code.google.com/p/evolutionrts/issues/list )

'''Give as much ''info'' as possible:'''
*Operation system
*computer hardware (laptop or desktop, cpu, ram, graphics card,..)
*This logfile: [[Infolog.txt]]
*Screenshots can be uploaded to imgur.com or similiar

After a while check back on your post, devs might need more informations from you!

Reporting bugs in chat is pretty much useless, there get overlooked there or forgotten.

2. '''If you can play:''' help others players with their problems in chat.

3. Be patient :)

EvoGreenLitFAQ

2014-04-09T04:59:51Z

Carrepairer: /* Automatic download of game files does not work */

EvoGreenlitList

2014-04-08T23:46:18Z

Carrepairer: /* Bots, AIs */

List of most urgent problems currently preventing players from playing evo.

==Maps==
Too much random map changes. Too much downloading, too much unsync = no games start.

Some commonly chosen maps are unplayable (space maps etc)

Solve: '''Maplist''' on ALL hosts.

Best only put ONE map so that players do not have to download much and can just play.
Map could be:
http://springfiles.com/spring/spring-maps/eye-horus-v2

Progress:
unsynced players are specced and can not delay gamestart but does not seem to help so much

==Singleplayer==
Does not work with fresh install because there are no files.

One must first join a MP to download engine,map,mod.

Solve: '''Download files on login''' or something.

===empty room, use !lock===
The common solution to select an empty autohost and then lock the room does not work:

Players need to be manually to use !lock command. The empty hosts are impossible to find because players randomly join&leave all the time. Even if you join an empty host, hardly does one have enough time to type !lock before another player joins.

===Bots, AIs===
Needs '''filter''' for add-bot menu. Only evo-compatible bots must be listed.
AAI is too often choosen because top of list but it does not work.

Solve:
If nessecarly hard-coded hack in lobby might be needed?
(real solution like implenting validAI.lua probally no time)

CarRepairer: Actually the REAL real solution is to remove AIs from the engine, which should have been done years ago like widgets. That would solve it for future versions only so a validAI list would be needed now of course.

The evo-AIs reportedly "do nothing."

==engine download==
For unknown reasons '''often does not work.'''

"stops at 100%"

"nothing happens"

or errors like http://springrts.com/phpbb/viewtopic.php?f=64&p=556182#p556131

Assimp

2013-11-21T20:08:23Z

Carrepairer: Updated blender workflow tutorial

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

=Assimp=
Open Asset Import Library (short name: Assimp) is used in Spring for loading a number of model formats including Collada & 3ds (currently obj is parsed by a different codepaths).

What Spring supports in its Assimp renderer:
* extended metafile (<code>%modelfilename%.lua</code> next to the modefile)
* still uses tex1 & tex2 texture system of S3O (same shader as S3O)
* 2nd texcoord
* loading of the texture filepaths from the model (don't have to be in <code>unittextures/</code>)
* when texture filepaths aren't included in the model, it searches for <code>%modelfilename%.*</code> & <code>%modelfilename%2.*</code> in <code>unittextures/</code>
* special modelpieces `SpringHeight` & `SpringRadius`

=Assimp Textures=
See [[3DModels:Textures#Textures_-_Assimp_Model_Formats_.28DAE.2CMDL.2CMD3_and_others_except_OBJ.29 |3DModels:Textures (Assimp Section)]]

=Blender Workflow Tutorial=
This is a stub containing a simple outline of a Blender workflow.

# Open an existing Blender model or import a different format through the File menu (File > Import).
# In the 3D view, drag out the secret panel from the right. [[File:3-12-2013 5-02-21 PM.pngâ€Žâ€Ž|secret panel]]
# In that panel, select Display > Shading > GLSL. [[File:3-12-2013 5-02-04 PM.pngâ€Žâ€Ž|display settings]]
# Make sure you have a lamp in your scene while in this mode or your model will be dark.
# Applying texture:
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode.
## Hit A to select all your faces.
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.
## If you don't see any faces you'll need to add the UVMap to a new texture:
### In the Properties view click on Textures (checkerboard icon).
### Click on Add New Texture (plus icon).
### Select Type = Image or Movie.
### Under Image, click on the image icon and choose your image file.
### Under Mapping, select Coordinates = UV.
### Under Influence > Diffuse, check Color and make sure it's 1.00.
## To add a normalmap:
### Repeat steps 5.5.1 to 5.5.5.
### Under Image Sampling, check Normal Map.
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.
## You'll need to do this for each piece.
# Piece hierarchy:
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.
## <strike>Make sure all the pieces are descending from one single piece.</strike> This is no longer necessary but is still good practice. Spring will now place all your pieces into one root piece for you, regardless.
# Setting piece origins:
## Select a piece.
## Place the 3D cursor where you want the origin to be (left-click).
## Click on Object > Transform > Origin to 3D Cursor.
## You can now rotate your pieces:
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.
### Rotate.
## Do this for all your pieces.
# Preparing for Spring (this may or may not apply depending on how assimp handles your model.):
## <strike>Select your root piece.
## Press Shift-C to put the 3D cursor in the center of the world.
## Click on the dropdown "Pivot Center for Rotation/Scaling" and select 3D Cursor.
## Rotate your whole model so that it's -90 degrees. You can do this by typing "R X -90". This will make your model lie on its back.
## Click Object > Apply > Rotation & Scale.</strike>
# Save your model.
# Select all the pieces of your model, ignore the lamp.
# Click on File > Export > Collada.
# Check "Export Only Selected" and export.
# The dae file will be used as your object.

[[Category:3D Models]]

Assimp

2013-11-21T20:06:22Z

Carrepairer: Updated blender workflow tutorial

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

=Assimp=
Open Asset Import Library (short name: Assimp) is used in Spring for loading a number of model formats including Collada & 3ds (currently obj is parsed by a different codepaths).

What Spring supports in its Assimp renderer:
* extended metafile (<code>%modelfilename%.lua</code> next to the modefile)
* still uses tex1 & tex2 texture system of S3O (same shader as S3O)
* 2nd texcoord
* loading of the texture filepaths from the model (don't have to be in <code>unittextures/</code>)
* when texture filepaths aren't included in the model, it searches for <code>%modelfilename%.*</code> & <code>%modelfilename%2.*</code> in <code>unittextures/</code>
* special modelpieces `SpringHeight` & `SpringRadius`

=Assimp Textures=
See [[3DModels:Textures#Textures_-_Assimp_Model_Formats_.28DAE.2CMDL.2CMD3_and_others_except_OBJ.29 |3DModels:Textures (Assimp Section)]]

=Blender Workflow Tutorial=
This is a stub containing a simple outline of a Blender workflow.

# Open an existing Blender model or import a different format through the File menu (File > Import).
# In the 3D view, drag out the secret panel from the right. [[File:3-12-2013 5-02-21 PM.pngâ€Žâ€Ž|secret panel]]
# In that panel, select Display > Shading > GLSL. [[File:3-12-2013 5-02-04 PM.pngâ€Žâ€Ž|display settings]]
# Make sure you have a lamp in your scene while in this mode or your model will be dark.
# Applying texture:
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode.
## Hit A to select all your faces.
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.
## If you don't see any faces you'll need to add the UVMap to a new texture:
### In the Properties view click on Textures (checkerboard icon).
### Click on Add New Texture (plus icon).
### Select Type = Image or Movie.
### Under Image, click on the image icon and choose your image file.
### Under Mapping, select Coordinates = UV.
### Under Influence > Diffuse, check Color and make sure it's 1.00.
## To add a normalmap:
### Repeat steps 5.5.1 to 5.5.5.
### Under Image Sampling, check Normal Map.
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.
## You'll need to do this for each piece.
# Piece hierarchy:
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.
## <strike>Make sure all the pieces are descending from one single piece.</strike> This is no longer necessary but is still good practice. Spring will now place all your pieces into one root piece for you, regardless.
# Setting piece origins:
## Select a piece.
## Place the 3D cursor where you want the origin to be (left-click).
## Click on Object > Transform > Origin to 3D Cursor.
## You can now rotate your pieces:
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.
### Rotate.
## Do this for all your pieces.
# <strike>Preparing for Spring (this may or may not apply depending on how assimp handles your model):
## Select your root piece.
## Press Shift-C to put the 3D cursor in the center of the world.
## Click on the dropdown "Pivot Center for Rotation/Scaling" and select 3D Cursor.
## Rotate your whole model so that it's -90 degrees. You can do this by typing "R X -90". This will make your model lie on its back.
## Click Object > Apply > Rotation & Scale.</strike>
# Save your model.
# Select all the pieces of your model, ignore the lamp.
# Click on File > Export > Collada.
# Check "Export Only Selected" and export.
# The dae file will be used as your object.

[[Category:3D Models]]

Gamedev:Main

2013-10-22T21:44:36Z

Carrepairer: Strikeout QA site.

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

*[[Game structure]]
*[[VirtualFileSystem]]
*<strike>[http://answers.springlobby.info/ Q&A Site for the Spring Engine]</strike> Currently down.

= Templates & Examples =
*[[SpringTutorialGame|Spring Tutorial Game]] - A Tutorial Template Game with full examples
* [[Gamedev:PublicRepos|Public Repos]] - Publicly readable Spring game code repositories

= Technical Documentation =
; '''GameData'''
* [[Armordefs.lua]]
* [[Icontypes.lua]]
* [[Messages.lua]]
* [[Modinfo.lua]]
* [[Modrules.lua]] - Global game variables
* [[Movedefs.lua]]
* [[Resources.lua]]
* [[Sidedata.lua]]
* [[Sounds.lua]]

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

; '''Lua API & Libraries'''
* [[Lua_Scripting|Lua API Documentation]]
* [[LUPS]] - Lua Particle System
* [[Chili]] - A GUI Framework
* [[Custom Unit Shaders]] - Normal mapping and more
* {{forumlink|topic=28341|title=ChangePiece}} - Switch piece geometry

; '''Animation'''
Lua Animations
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
**[[Animation-CobLuaDifferences]]

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

; '''Unit Development'''
* [[Unit_collision_volumes | Unit Collision Volumes]] - collision detection
* [[Units:WeaponMainDir]]
* [[Units:Buildpics]]

; '''Models & Textures'''
* [[About_s3o|.s3o]]
* [[Assimp]]
* [[Units:Textures]]

; '''Misc'''
* [[MouseCursors]]
* [[Mod Development:Archives|Game Development:Archives]]
* [[Mod Development:Sidepics|Game Development:Sidepics]]

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

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

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

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

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

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

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

=Misc=
* [[Ren'Py]]: a visual novel engine that can be used with Spring

[[Category:Game Dev]]

Assimp

2013-09-26T05:45:14Z

Carrepairer: Updated tutorial

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

=Assimp=
Open Asset Import Library (short name: Assimp) is used in Spring for loading a number of model formats including Collada & 3ds (currently obj is parsed by a different codepaths).

What Spring supports in its Assimp renderer:
* extended metafile (<code>%modelfilename%.lua</code> next to the modefile)
* still uses tex1 & tex2 texture system of S3O (same shader as S3O)
* 2nd texcoord
* loading of the texture filepaths from the model (don't have to be in <code>unittextures/</code>)
* when texture filepaths aren't included in the model, it searches for <code>%modelfilename%.*</code> & <code>%modelfilename%2.*</code> in <code>unittextures/</code>
* special modelpieces `SpringHeight` & `SpringRadius`

=Assimp Textures=
See [[Units:Textures#Textures_-_Assimp_Model_Formats_.28DAE.2CMDL.2CMD3_and_others_except_OBJ.29 |Units:Textures (Assimp Section)]]

=Blender Workflow Tutorial=
This is a stub containing a simple outline of a Blender workflow.

# Open an existing Blender model or import a different format through the File menu (File > Import).
# In the 3D view, drag out the secret panel from the right. [[File:3-12-2013 5-02-21 PM.pngâ€Žâ€Ž|secret panel]]
# In that panel, select Display > Shading > GLSL. [[File:3-12-2013 5-02-04 PM.pngâ€Žâ€Ž|display settings]]
# Make sure you have a lamp in your scene while in this mode or your model will be dark.
# Applying texture:
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode.
## Hit A to select all your faces.
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.
## If you don't see any faces you'll need to add the UVMap to a new texture:
### In the Properties view click on Textures (checkerboard icon).
### Click on Add New Texture (plus icon).
### Select Type = Image or Movie.
### Under Image, click on the image icon and choose your image file.
### Under Mapping, select Coordinates = UV.
### Under Influence > Diffuse, check Color and make sure it's 1.00.
## To add a normalmap:
### Repeat steps 5.5.1 to 5.5.5.
### Under Image Sampling, check Normal Map.
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.
## You'll need to do this for each piece.
# Piece hierarchy:
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.
## Make sure all the pieces are descending from one single piece.
# Setting piece origins:
## Select a piece.
## Place the 3D cursor where you want the origin to be (left-click).
## Click on Object > Transform > Origin to 3D Cursor.
## You can now rotate your pieces:
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.
### Rotate.
## Do this for all your pieces.
# <strike>Preparing for Spring (this may or may not apply depending on how assimp handles your model):
## Select your root piece.
## Press Shift-C to put the 3D cursor in the center of the world.
## Click on the dropdown "Pivot Center for Rotation/Scaling" and select 3D Cursor.
## Rotate your whole model so that it's -90 degrees. You can do this by typing "R X -90". This will make your model lie on its back.
## Click Object > Apply > Rotation & Scale.</strike>
# Save your model.
# Select all the pieces of your model, ignore the lamp.
# Click on File > Export > Collada.
# Check "Export Only Selected" and export.
# The dae file will be used as your object.

[[Category:3D Models]]

Animation-LuaCallins

2013-09-06T23:17:38Z

Carrepairer: /* Weapons */

== Introduction ==

Call-ins are calls from the engine, into the unit script. In other words, these functions are called, if they are defined, when a particular â€œeventâ€ happens.

For Lua unit scripts, a new callin mechanism has been implemented, which is faster than the regular callin mechanism which is used for widgets and gadgets.

Types for arguments are only shown where they're ambiguous. For a number of (common) arguments, the types are:

* unitID: number
* piece: number
* axis: number (1 = x axis, 2 = y axis, 3 = z axis)
* heading/pitch: number (radians)

== Generic ==

'''Create''' ( ) -> nil

This is called just after the unit script has been created.

'''StartMoving''' ( ) -> nil<br>
'''StopMoving''' ( ) -> nil

These are called whenever the unit starts or stops moving. Typical use for them is to trigger wheels to start spinning, animate treads, or start/stop a walking animation.

'''Killed''' ( number recentDamage, number maxHealth ) -> number corpseType

This is called when the unit is killed. The severity of the kill may be calculated as severity=recentDamage/maxHealth ''(*100 so that it's in percent, no? at least that is how severity was expressed in Cob/bos, I think. Of course there's no reason to emulate that, just pointing it out for people "converting")''. Typically, this function would play a death animation for the unit, and finally return a corpse type.

'''WindChanged''' ( number heading, number strength ) -> nil

This is called for wind generators whenever the wind direction or strength changes.

'''ExtractionRateChanged''' ( number rate ) -> nil

Called for metal extractors each time their extraction rate (metal per second) changes.

'''setSFXoccupy''' ( number curTerrainType ) -> nil

Called when terrain type changes. Terrain type is calculated with the following rules (in this order):

* If unit is being transported -> curTerrainType = 0
* If ground height < -5 and unit is always upright -> curTerrainType = 2
* If ground height < -5 and unit is not always upright -> curTerrainType = 1
* If ground height < 0 and unit is always upright -> curTerrainType = 1
* Otherwise -> curTerrainType = 4

Where is curTerrainType = 3 ? :-)

Candidate to be changed to something saner later on.

'''MoveRate''' ( number curRate ) -> nil

Called only for certain types of aircraft (those which use ''CTAAirMoveType''.) The move rate is determined by the following rules (in this order):

* If the aircraft is landing or taking off -> curRate = 1
* Otherwise -> curRate = floor(curSpeed / maxSpeed * 3), clamped to be in the range [0, 2]

'''QueryLandingPads''' ( ) -> { number piece1, number piece2, ... }

Called one time for units with landing pads. Should return a table with pieces which should be used as landing pads. The number of pieces returned also determines the number of pads, so for Lua unit scripts there is no QueryLandingPadCount.

'''Activate''' ( ) -> nil<br>
'''Deactivate''' ( ) -> nil

Exact situation these are called depends a lot on the unit type. Factories are activated when they open their yard and deactivated when they close it. Aircraft are activated when they take off and deactivated when the land. Any unit that can be turned on or off is activated when it's turned on and deactivated when it's turned off. On ''SetUnitValue(COB.ACTIVATION, ...)'' one of these call-ins may be called too.

== Weapons ==

Weapon functions come in two variants.

* Separate function with numeric weapon number suffix. (e.g. ''AimWeapon<u>1</u>(heading, pitch)'')
* Combined function which gets weapon number as second argument. (e.g. ''AimWeapon(<u>weaponNum</u>, heading, pitch)'')

Only the first variant is listed here, so whenever you see a function whose name ends with a numeric one ("1"), you should either replace it with the actual weapon number, or you can write a single combined function that takes a ''weaponNum'' argument. For each script, all functions should use the same variant. Either all using name suffix, or all using combined functions.

'''QueryWeapon1''' ( ) -> number piece<br>
'''AimFromWeapon1''' ( ) -> number piece<br>
'''AimWeapon1''' ( heading, pitch ) -> boolean<br>
'''AimShield1''' ( ) -> boolean

Weapon support. The return value of QueryWeapon and AimFromWeapon determines the pieces which will be used for aiming: typically e.g. the barrel for QueryWeapon and the turret for AimFromWeapon. AimWeapon is then called to allow the script to turn the weapons in the target direction, which is passed as the heading and pitch argument (in radians). Only if AimWeapon returns true, the weapon is actually fired.

TODO: better explanation (?), note about AimWeapon being called very often etc.

'''FireWeapon1''' ( ) -> nil<br>
'''Shot1''' ( ) -> nil<br>
'''EndBurst1''' ( ) -> nil

If after aiming the unit actually fires it's weapon, FireWeapon is called once at the beginning of the salvo. Shot is called just before each projectile is fired. RockUnit (see below) is called just after all projectiles for that frame have been fired. At the end of the salvo, EndBurst is called.

Of these call-ins, FireWeapon is the more generic one and Shot and EndBurst are more specialized. FireWeapon is usually used to play a recoil animation or emit some smoke near the weapon's barrel using EmitSfx.

'''BlockShot1''' ( targetUnitID, boolean userTarget ) -> boolean

Allows you to block a weapon from shooting. TargetUnitID may be nil: in this case the unit has a ground-attack order.

'''TargetWeight1''' ( targetUnitID ) -> number

Allows you to tweak the priority of the target for this particular weapon. The target priority is multiplied by the return value of this function. Lower priority targets are targeted first, so return a value smaller than 1 to prioritize a target, or return a value larger than 1 to avoid a target.

The exact behavior of specific values shouldn't be relied upon.

'''RockUnit''' ( x, z ) -> nil

A bit like the weapon-specific FireWeapon function, although this is called after any weapon fires. As argument it gets a two dimensional vector in the direction the unit just fired. This may be used to â€œrockâ€ the unit as a whole a bit as part of the firing animation. Note though that this vector is in world space, so for a truly realistic rock direction it needs to be rotated according to the unit's current heading.

'''HitByWeapon''' ( x, z, weaponDefID, damage ) -> nil | number newDamage

This is called if a unit has been hit by a weapon. (x, z) is the direction from which the projectile came in unit space (the reverse direction of the impulse, to be exact.) It also gets the weaponDefID of the weapon which is dealing the damage, and the amount of damage. If HitByWeapon returns a number, this number will replace the damage value calculated by the engine.

Note: Pre Spring 95, this call-in runs just before the LuaRules UnitPreDamaged callin (see also [[LuaCallinReturn]]). If HitByWeapon overrides the damage, UnitPreDamaged will see the new damage value, and may override again the damage value. Starting Spring 95, it is run after UnitPreDamaged.

== Builders and factories ==

'''StartBuilding''' ( heading, pitch ) -> nil<br>
'''StartBuilding''' ( ) -> nil<br>
'''StopBuilding''' ( ) -> nil

These notify the script when a builder or factory starts or stops building.

The first variant (with heading and pitch arguments) is called for builders. For factories, the second variant is used. In this case the heading and pitch are not necessary, because the factory script specifies the build location itself using QueryBuildInfo.

BTW, don't forget to set INBUILDSTANCE to 1 to start building! For lua script, that is

<code>
function script.StartBuilding(heading, pitch)

SetUnitValue(COB.INBUILDSTANCE, 1)

end

function script.StopBuilding()
SetUnitValue(COB.INBUILDSTANCE, 0)
end
</code>

'''QueryBuildInfo''' ( ) -> number piece

For factories only. Should return the piece to which the unit which is going to be build will be attached while it's being build.

'''QueryNanopiece''' ( ) -> number piece

Called each time a nano particle is to be created. Should return the piece at which the particle will be spawned. This may be used to iterate through a few pieces, to simulate the factory/builder having multiple nanolathes.

<span class="note">N.B. As of 92.0 the results are cached and the function is called 31 times only. Deprecated in favour of Spring.SetUnitNanoPieces, which disables this callin when used.</span>

== Transports ==

There are some different code paths inside Spring related to transports, each (unfortunately) also associated with a different set of unit script call-ins.

This table shows for the three different transportUnloadMethods for both air transports and ground transports which callins are used and roughly when and how often they are called. Refer to the documentation below for a description of the call-ins.

The entire behavior around transports should be considered subject to change; it is obvious it is far from a perfect design currently.

{|border="1" style="border-spacing:0px;"
|+
!
!Load
!UnloadLand (0)
!UnloadDrop (1)
!UnloadLandFlood (2)
|-
|
|
|default unload
|fly over and drop unit
|land, then release all units at once
|-
|air
|BeginTransport (each)<br>QueryTransport (each)
|EndTransport (last)
|EndTransport (each)
|StartUnload (first)<br>TransportDrop (each)<br>EndTransport (last)
|-
|ground
|TransportPickup (each)
|TransportDrop (each)
|TransportDrop (each)
|TransportDrop (each)<br>EndTransport (last)
|}

=== Air transports ===

'''BeginTransport''' ( passengerID ) -> nil<br>
'''QueryTransport''' ( passengerID ) -> number piece

For an air transport, if any one unit is picked up, these two are called in succession and the passenger is attached to the piece returned by the second one.

'''StartUnload''' ( ) -> nil

Only called in UnloadLandFlood behavior. Signals the start of an unload cycle.

'''TransportDrop''' ( passengerID, x, y, z ) -> nil

Only called in UnloadLandFlood behavior. Called when a passenger will be unloaded. Contrary to ground transports, Spring will detach the passenger after the call.

'''EndTransport''' ( ) -> nil

In UnloadLand and UnloadLandFlood behaviors, these are called one time after all units are unloaded. (The transport is empty.) For the UnloadDrop behavior, this is called for every unit that is unloaded.

=== Ground transports ===

'''TransportPickup''' ( passengerID ) -> nil

Called when a passenger should be loaded into the transport. This should eventually call AttachUnit to actually attach the unit. Assuming the transport is in range of the next passenger, this will be called again for the next passenger 16 frames later, ''unless'' the script enters the BUSY state: then Spring will not move on to the next passenger until the script leaves the BUSY state.

'''TransportDrop''' ( passengerID, x, y, z ) -> nil

Called when a passenger should be unloaded. This should eventually call DetachUnit to actually detach the unit, ''unless'' the used unload method is UnloadLandFlood, in which case Spring will actually detach the unit after the call.

'''EndTransport''' ( ) -> nil

Only called in UnloadLandFlood behavior, after the last unit has been unloaded.

=== Passenger ===

'''Falling''' ( ) -> nil

For a unit dropped from an UnloadDrop transport, this is called every frame to inform the script the unit is still falling. It may be used to show a parachute for example.

'''Landed''' ( ) -> nil

This is called one time after the unit reached the ground. May be used to hide a parachute for example.

== Internal ==

These call-ins are NOT available to Lua unit scripts. They are called by the engine however, but always 'intercepted' by the framework gadget. For completeness (or if you are poking at the gadget), they are listed here anyway.

'''MoveFinished''' ( piece, axis ) -> nil<br>
'''TurnFinished''' ( piece, axis ) -> nil

Called when a move or turn finished. The framework gadget uses this to resume the coroutines which are waiting for the particular move or turn to be finished.

'''Destroy''
' ( ) -> nil

Called right before the unit's script is destroyed. This may happen if the unit is being destroyed, but also if the unit's script is being replaced by another script. The framework gadget uses this to stop all threads and remove the unit from some internal data structures.

[[Category:Animation]]
[[Category:Lua]]

Lobby Development

2013-05-02T15:36:29Z

Carrepairer: Usable lobby client

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

=Documentation=

==Protocol==
* [http://springrts.com/dl/LobbyProtocol/ HTML] (is updated once a day)
* [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml XML] (raw, always latest)

==Download Systems==
* [http://springrts.com/wiki/Dev:LobbyDownloadSystems Lobby Download Systems]

=Lobby client development=

==Useable lobby clients==

===SpringLobby===
<font color="orange">cross-platform</font>,
<font color="#00AAFF">C++</font>,
by <font color="#00CC00">BrainDamage</font> &
<font color="#00CC00">koshi</font>

SpringLobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It uses the ''wxWidgets'' library. You can browse the sources and submit issues on its [http://springlobby.info/ website].

===Zero-K===
<font color="orange">Windows</font>,
<font color="#00AAFF">C#</font>,
by <font color="#00CC00">Licho</font> & <font color="#00CC00">quantum</font>

[https://code.google.com/p/zero-k/ Zero-K project page]

===TASClient===
<font color="orange">Windows</font>,
<font color="#00AAFF">Delphi</font>,
by <font color="#00CC00">Satirik</font>

You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here:
http://springrts.com/dl/tasclient/TASClientLatest.7z

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

===NotaLobby===
<font color="orange">cross-platform</font>,
<font color="#00AAFF">C++</font>,
by <font color="#00CC00">danil_kalina</font>, <font color="#00CC00">a1983</font>, <font color="#00CC00">TruePer</font>

[http://springrts.com/phpbb/viewtopic.php?f=64&t=27289 Forum thread]

===flobby===
<font color="orange">Linux</font>,
<font color="#00AAFF">C++</font>,
by <font color="#00CC00">cleanrock</font>

[https://github.com/cleanrock/flobby github page]

===Weblobby===
<font color="orange">cross-platform</font>,
<font color="#00AAFF">Java</font>,
by <font color="#00CC00">CarRepairer</font>

[http://weblobby.springrts.com weblobby.springrts.com]

==Work in progress or abandoned==

===Alphalobby===
<font color="orange">Windows</font>,
<font color="#00AAFF">C</font>,
<font color="#FF0000">unmaintained</font>

Alphalobby is still very much work in progress. If you still wish to use it, source available from the [http://code.google.com/p/alphalobby/source/checkout mercurial repository], binary available on the [http://springfiles.com/spring/lobby-clients/alphalobby springfiles page].

===CheeseLobby===
<font color="orange">cross-platform</font>,
<font color="#00AAFF">Java</font>,
by <font color="#00CC00">Cheesecan</font>

[http://springrts.com/phpbb/viewtopic.php?f=64&t=24905 forum thread]

[https://github.com/jahwag/cheeselobby binaries and code]

===QtLobby===
<font color="orange">cross-platform</font>,
<font color="#00AAFF">C++</font>,
<font color="#FF0000">unmaintained</font>

[http://code.google.com/p/qtlobby/ project page]

=Libraries and frameworks=

==Spring-PythonBotFramework==
<font color="orange">cross-platform</font>,
<font color="#00AAFF">Python</font>, by
<font color="#00CC00">BrainDamage</font> & <font color="#00CC00">koshi</font>

A bot framework written in python. [https://github.com/renemilk/tasbot/wiki GitHub wiki]

==Go SpringLobbyClient==
<font color="orange">cross-platform</font>,
<font color="#00AAFF">Go</font>

A simple client implementation of the lobby protocol in Go.
[https://github.com/Agon/go-slc/ project page]

=Lobby server development=

==SpringLS==
<font color="orange">cross-platform</font>,
<font color="#00AAFF">Java</font>,
<font color="#00CC00">hoijui</font>

The longest-running lobby server, created by Betalord. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/SpringLS development site].

==UberServer==
<font color="orange">cross-platform</font>,
<font color="#00AAFF">Python</font>,
by <font color="#00CC00">aegis</font>

The primary lobby server currently running on springrts.com. All protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and SpringLS. You can get more information and download uberserver at the [https://github.com/lunixbochs/uberserver github page]

[[Category: Lobbies]]

Assimp

2013-04-28T07:26:52Z

Carrepairer: /* Blender Workflow Tutorial */

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

=Assimp=
Open Asset Import Library (short name: Assimp) is used in Spring for loading a number of model formats including Collada & 3ds (currently obj is parsed by a different codepaths).

What Spring supports in its Assimp renderer:
* extended metafile (<code>%modelfilename%.lua</code> next to the modefile)
* still uses tex1 & tex2 texture system of S3O (same shader as S3O)
* 2nd texcoord
* loading of the texture filepaths from the model (don't have to be in <code>unittextures/</code>)
* when texture filepaths aren't included in the model, it searches for <code>%modelfilename%.*</code> & <code>%modelfilename%2.*</code> in <code>unittextures/</code>
* special modelpieces `SpringHeight` & `SpringRadius`

=Assimp Textures=
See [[Units:Textures#Textures_-_Assimp_Model_Formats_.28DAE.2CMDL.2CMD3_and_others_except_OBJ.29 |Units:Textures (Assimp Section)]]

=Blender Workflow Tutorial=
This is a stub containing a simple outline of a Blender workflow.

# Open an existing Blender model or import a different format through the File menu (File > Import).
# In the 3D view, drag out the secret panel from the right. [[File:3-12-2013 5-02-21 PM.pngâ€Žâ€Ž|secret panel]]
# In that panel, select Display > Shading > GLSL. [[File:3-12-2013 5-02-04 PM.pngâ€Žâ€Ž|display settings]]
# Make sure you have a lamp in your scene while in this mode or your model will be dark.
# Applying texture:
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode.
## Hit A to select all your faces.
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.
## If you don't see any faces you'll need to add the UVMap to a new texture:
### In the Properties view click on Textures (checkerboard icon).
### Click on Add New Texture (plus icon).
### Select Type = Image or Movie.
### Under Image, click on the image icon and choose your image file.
### Under Mapping, select Coordinates = UV.
### Under Influence > Diffuse, check Color and make sure it's 1.00.
## To add a normalmap:
### Repeat steps 5.1 to 5.5.
### Under Image Sampling, check Normal Map.
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.
## You'll need to do this for each piece.
# Piece hierarchy:
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.
## Make sure all the pieces are descending from one single piece.
# Setting piece origins:
## Select a piece.
## Place the 3D cursor where you want the origin to be (left-click).
## Click on Object > Transform > Origin to 3D Cursor.
## You can now rotate your pieces:
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.
### Rotate.
## Do this for all your pieces.
# <strike>Preparing for Spring:
## Select your root piece.
## Press Shift-C to put the 3D cursor in the center of the world.
## Click on the dropdown "Pivot Center for Rotation/Scaling" and select 3D Cursor.
## Rotate your whole model so that it's -90 degrees. You can do this by typing "R X -90". This will make your model lie on its back.
## Click Object > Apply > Rotation & Scale.</strike>
# Save your model.
# Select all the pieces of your model, ignore the lamp.
# Click on File > Export > Collada.
# Check "Export Only Selected" and export.
# The dae file will be used as your object.

[[Category:3D Models]]

Assimp

2013-04-26T18:10:49Z

Carrepairer:

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

=Assimp=
Open Asset Import Library (short name: Assimp) is used in Spring for loading a number of model formats including Collada & 3ds (currently obj is parsed by a different codepaths).

What Spring supports in its Assimp renderer:
* extended metafile (<code>%modelfilename%.lua</code> next to the modefile)
* still uses tex1 & tex2 texture system of S3O (same shader as S3O)
* 2nd texcoord
* loading of the texture filepaths from the model (don't have to be in <code>unittextures/</code>)
* when texture filepaths aren't included in the model, it searches for <code>%modelfilename%.*</code> & <code>%modelfilename%2.*</code> in <code>unittextures/</code>
* special modelpieces `SpringHeight` & `SpringRadius`

=Assimp Textures=
See [[Units:Textures#Textures_-_Assimp_Model_Formats_.28DAE.2CMDL.2CMD3_and_others_except_OBJ.29 |Units:Textures (Assimp Section)]]

=Blender Workflow Tutorial=
This is a stub containing a simple outline of a Blender workflow.

# Open an existing Blender model or import a different format through the File menu (File > Import).
# In the 3D view, drag out the secret panel from the right. [[File:3-12-2013 5-02-21 PM.pngâ€Žâ€Ž|secret panel]]
# In that panel, select Display > Shading > GLSL. [[File:3-12-2013 5-02-04 PM.pngâ€Žâ€Ž|display settings]]
# Make sure you have a lamp in your scene while in this mode or your model will be dark.
# Applying texture:
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode.
## Hit A to select all your faces.
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.
## If you don't see any faces you'll need to add the UVMap to a new texture:
### In the Properties view click on Textures (checkerboard icon).
### Click on Add New Texture (plus icon).
### Select Type = Image or Movie.
### Under Image, click on the image icon and choose your image file.
### Under Mapping, select Coordinates = UV.
### Under Influence > Diffuse, check Color and make sure it's 1.00.
## To add a normalmap:
### Repeat steps 5.1 to 5.5.
### Under Image Sampling, check Normal Map.
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.
## You'll need to do this for each piece.
# Piece hierarchy:
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.
## Make sure all the pieces are descending from one single piece.
# Setting piece origins:
## Select a piece.
## Place the 3D cursor where you want the origin to be (left-click).
## Click on Object > Transform > Origin to 3D Cursor.
## You can now rotate your pieces:
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.
### Rotate.
## Do this for all your pieces.
# '''DISREGARD THIS STEP''' Preparing for Spring:
## Select your root piece.
## Press Shift-C to put the 3D cursor in the center of the world.
## Click on the dropdown "Pivot Center for Rotation/Scaling" and select 3D Cursor.
## Rotate your whole model so that it's -90 degrees. You can do this by typing "R X -90". This will make your model lie on its back.
## Click Object > Apply > Rotation & Scale.
# Save your model.
# Select all the pieces of your model, ignore the lamp.
# Click on File > Export > Collada.
# Check "Export Only Selected" and export.
# The dae file will be used as your object.

[[Category:3D Models]]

Assimp

2013-04-26T18:07:00Z

Carrepairer: /* Blender Workflow Tutorial */ Fixed page, the number indexes were all wrong. And the third photo is not a lamp, it's a camera.

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

=Assimp=
Open Asset Import Library (short name: Assimp) is used in Spring for loading a number of model formats including Collada & 3ds (currently obj is parsed by a different codepaths).

What Spring supports in its Assimp renderer:
* extended metafile (<code>%modelfilename%.lua</code> next to the modefile)
* still uses tex1 & tex2 texture system of S3O (same shader as S3O)
* 2nd texcoord
* loading of the texture filepaths from the model (don't have to be in <code>unittextures/</code>)
* when texture filepaths aren't included in the model, it searches for <code>%modelfilename%.*</code> & <code>%modelfilename%2.*</code> in <code>unittextures/</code>
* special modelpieces `SpringHeight` & `SpringRadius`

=Assimp Textures=
See [[Units:Textures#Textures_-_Assimp_Model_Formats_.28DAE.2CMDL.2CMD3_and_others_except_OBJ.29 |Units:Textures (Assimp Section)]]

=Blender Workflow Tutorial=
This is a stub containing a simple outline of a Blender workflow.

# Open an existing Blender model or import a different format through the File menu (File > Import).
# In the 3D view, drag out the secret panel from the right. [[File:3-12-2013 5-02-21 PM.pngâ€Žâ€Ž|secret panel]]
# In that panel, select Display > Shading > GLSL. [[File:3-12-2013 5-02-04 PM.pngâ€Žâ€Ž|display settings]]
# Make sure you have a lamp in your scene while in this mode or your model will be dark.
# Applying texture:
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode.
## Hit A to select all your faces.
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.
## If you don't see any faces you'll need to add the UVMap to a new texture:
### In the Properties view click on Textures (checkerboard icon).
### Click on Add New Texture (plus icon).
### Select Type = Image or Movie.
### Under Image, click on the image icon and choose your image file.
### Under Mapping, select Coordinates = UV.
### Under Influence > Diffuse, check Color and make sure it's 1.00.
## To add a normalmap:
### Repeat steps 5.1 to 5.5.
### Under Image Sampling, check Normal Map.
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.
## You'll need to do this for each piece.
# Piece hierarchy:
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.
## Make sure all the pieces are descending from one single piece.
# Setting piece origins:
## Select a piece.
## Place the 3D cursor where you want the origin to be (left-click).
## Click on Object > Transform > Origin to 3D Cursor.
## You can now rotate your pieces:
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.
### Rotate.
## Do this for all your pieces.
# Preparing for Spring:
## Select your root piece.
## Press Shift-C to put the 3D cursor in the center of the world.
## Click on the dropdown "Pivot Center for Rotation/Scaling" and select 3D Cursor.
## Rotate your whole model so that it's -90 degrees. You can do this by typing "R X -90". This will make your model lie on its back.
## Click Object > Apply > Rotation & Scale.
# Save your model.
# Select all the pieces of your model, ignore the lamp.
# Click on File > Export > Collada.
# Check "Export Only Selected" and export.
# The dae file will be used as your object.

[[Category:3D Models]]

Assimp

2013-02-20T07:13:38Z

Carrepairer:

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

== Blender Workflow Tutorial ==

This is a stub containing a simple outline of a Blender workflow. Disclaimer: I'm no modeling expert, there may be a better way to do this.

# Open an existing Blender model or import a different format through the File menu (File > Import).
# In the 3D view, drag out the secret panel from the right.
# In that panel, select Display > Shading > GLSL.
# Make sure you have a lamp in your scene while in this mode or your model will be dark.
# Applying texture:
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode.
## Hit A to select all your faces.
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.
## If you don't see any faces you'll need to add the UVMap to a new texture:
### In the Properties view click on Textures (checkerboard icon).
### Click on Add New Texture (plus icon).
### Select Type = Image or Movie.
### Under Image, click on the image icon and choose your image file.
### Under Mapping, select Coordinates = UV.
### Under Influence > Diffuse, check Color and make sure it's 1.00.
## To add a normalmap:
### Repeat steps 5.1 to 5.5.
### Under Image Sampling, check Normal Map.
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.
## You'll need to do this for each piece.
# Piece hierarchy:
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.
## Make sure all the pieces are descending from one single piece.
# Setting piece origins:
## Select a piece.
## Place the 3D cursor where you want the origin to be (left-click).
## Click on Object > Transform > Origin to 3D Cursor.
## You can now rotate your pieces:
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.
### Rotate.
## Do this for all your pieces.
# Preparing for Spring:
## Select your root piece.
## Press Shift-C to put the 3D cursor in the center of the world.
## Click on the dropdown "Pivot Center for Rotation/Scaling" and select 3D Cursor.
## Rotate your whole model so that it's -90 degrees. You can do this by typing "R X -90". This will make your model lie on its back.
## Click Object > Apply > Rotation & Scale.
# Save your model.
# Select all the pieces of your model, ignore the lamp.
# Click on File > Export > Collada.
# Check "Export Only Selected" and export.
# The dae file will be used as your object.

Assimp

2013-02-14T23:58:39Z

Carrepairer: /* Blender Workflow Tutorial */

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

== Blender Workflow Tutorial ==

This is a stub containing a simple outline of a Blender workflow. Disclaimer: I'm not modeling expert, there may be a better way to do this.

# Open an existing Blender model or import a different format through the File menu (File > Import).
# In the 3D view, drag out the secret panel from the right.
# In that panel, select Display > Shading > GLSL.
# Make sure you have a lamp in your scene while in this mode or your model will be dark.
# Applying texture:
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode.
## Hit A to select all your faces.
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.
## If you don't see any faces you'll need to add the UVMap to a new texture:
### In the Properties view click on Textures (checkerboard icon).
### Click on Add New Texture (plus icon).
### Select Type = Image or Movie.
### Under Image, click on the image icon and choose your image file.
### Under Mapping, select Coordinates = UV.
### Under Influence > Diffuse, check Color and make sure it's 1.00.
## To add a normalmap:
### Repeat steps 5.1 to 5.5.
### Under Image Sampling, check Normal Map.
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.
## You'll need to do this for each piece.
# Piece hierarchy:
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.
## Make sure all the pieces are descending from one single piece.
# Setting piece origins:
## Select a piece.
## Place the 3D cursor where you want the origin to be (left-click).
## Click on Object > Transform > Origin to 3D Cursor.
## You can now rotate your pieces:
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.
### Rotate.
## Do this for all your pieces.
# Preparing for Spring:
## Select your root piece.
## Press Shift-C to put the 3D cursor in the center of the world.
## Click on the dropdown "Pivot Center for Rotation/Scaling" and select 3D Cursor.
## Rotate your whole model so that it's -90 degrees. Unfortunately this appears to be only doable with the mouse (when using 3D cursor). This will make your model lie on its back.
## Click Object > Apply > Rotation & Scale.
# Save your model.
# Select all the pieces of your model, ignore the lamp.
# Click on File > Export > Collada.
# Check "Export Only Selected" and export.
# The dae file will be used as your object.

Assimp

2013-02-14T23:56:53Z

Carrepairer: /* Blender Workflow Tutorial */

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

== Blender Workflow Tutorial ==

This is a stub containing a simple outline of a Blender workflow. Disclaimer: I'm not modeling expert, there may be a better way to do this.

# Open an existing Blender model or import a different format through the File menu (File > Import).
# In the 3D view, drag out the secret panel from the right.
# In that panel, select Display > Shading > GLSL.
# Make sure you have a lamp in your scene while in this mode or your model will be dark.
# Applying texture:
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode.
## Hit A to select all your faces.
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.
## If you don't see any faces you'll need to add the UVMap to a new texture:
### In the Properties view click on Textures (checkerboard icon).
### Click on Add New Texture (plus icon).
### Select Type = Image or Movie.
### Under Image, click on the image icon and choose your image file.
### Under Mapping, select Coordinates = UV.
### Under Influence > Diffuse, check Color and make sure it's 1.00.
## To add a normalmap:
### Repeat steps 5.1 to 5.5.
### Under Image Sampling, check Normal Map.
### Under Influence > Geometry, check Normal. Make sure it.s 1.00.
## You'll need to do this for each piece.
# Piece hierarchy:
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.
## Make sure all the pieces are descending from one single piece.
# Setting piece origins:
## Select a piece.
## Place the 3D cursor where you want the origin to be (left-click).
## Click on Object > Transform > Origin to 3D Cursor.
## You can now rotate your pieces:
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.
### Rotate.
## Do this for all your pieces.
# Preparing for Spring:
## Select your root piece.
## Press Shift-C to put the 3D cursor in the center of the world.
## Click on the dropdown "Pivot Center for Rotation/Scaling" and select 3D Cursor.
## Rotate your whole model so that it's -90 degrees. Unfortunately this appears to be only doable with the mouse (when using 3D cursor).
## Click Object > Apply > Rotation & Scale.
# Save your model.
# Select all the pieces of your model, ignore the lamp.
# Click on File > Export > Collada.
# Check "Export Only Selected" and export.
# The dae file will be used as your object.

Assimp

2013-02-14T23:45:17Z

Carrepairer: Added new tutorial.

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

== Blender Workflow Tutorial ==

This is a stub containing a simple outline of a Blender workflow. Disclaimer: I'm not modeling expert, there may be a better way to do this.

# Open an existing Blender model or import a different format through the File menu (File > Import).
# In the 3D view, drag out the secret panel from the right.
# In that panel, select Display > Shading > GLSL.
# Make sure you have a lamp in your scene while in this mode or your model will be dark.
# Applying texture:
## In the UV/Image editor, click the image icon (Tooltip: Browse Image to be linked) to select your texture. If it's not there, click on Image > Open Image to browse for it.
## In the 3D View, select (right-click) your object and hit Tab to enter Mesh Mode.
## Hit A to select all your faces.
## In the 3D View, hit A to select all the faces there and select your image with the image icon. Assuming there's a UVMap, you should see your texture.
## <Future space for setting up UVMap and normalmap>
## You'll need to do this for each piece.
# Piece hierarchy:
## Select piece A, hold shift and select piece B. Hit Ctrl+P and it will make piece A a child of piece B.
## Make sure all the pieces are descending from one single piece.
# Setting piece origins:
## Select a piece.
## Place the 3D cursor where you want the origin to be (left-click).
## Click on Object > Transform > Origin to 3D Cursor.
## You can now rotate your pieces:
### Click on the dropdown "Pivot Center for Rotation/Scaling" and select Individual Origins.
### Rotate.
## Do this for all your pieces.
# Preparing for Spring:
## Select your root piece.
## Press Shift-C to put the 3D cursor in the center of the world.
## Click on the dropdown "Pivot Center for Rotation/Scaling" and select 3D Cursor.
## Rotate your whole model so that it's -90 degrees. Unfortunately this appears to be only doable with the mouse (when using 3D cursor).
## Click Object > Apply > Rotation & Scale.
# Save your model.
# Select all the pieces of your model, ignore the lamp.
# Click on File > Export > Collada.
# Check "Export Only Selected" and export.
# The dae file will be used as your object.

Game and Unit development

2013-02-14T23:18:48Z

Carrepairer: /* Modeling Tutorials */

[[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==
* [[Map,_Mod,_And_Unit_Development_Programs|Development Tools]]
*[[Game structure]]<br />
*[[Game specification|Game specification]]<br />
*[http://answers.springlobby.info/ Q&A Site for the Spring Engine]
*[http://springrts.com/phpbb/viewtopic.php?f=14&t=26409| Porting TA content to Spring]

==Resources==
*[[General_Resources|Free Assets]]
*[[SpringTutorialGame|Spring Tutorial Game]] - (attempt to create) a "template game" for new projects.
*[[LUPS]]
*[[Chili]]
*[[IceUI]]
*[[RedUI]]
*[[LOLUI]]
*[[Map Making: Feature Placer|Feature Placer]]

==Reference==
*UnitDefs (.fbi, .lua)
**[[Units-UnitDefs|UnitDefs]] - define the attributes of units
**[[Unit_Categories]] - define which weapon type aim at which targets
**[[Unit_collision_volumes | Unit Collision Volumes]] - collision detection
*WeaponDefs (.tdf, .lua)
**[[Units-WeaponDefs]] : define the attributes of weapons/projectiles
**[[Units:WeaponMainDir]]
**[[Weapons:Antinukes]]: All about antinukes.
*MoveDefs
**[[Units:MoveTypes]]
*FeatureDefs (objects on the map, wrecks of destroyed units)
**[[Units-FeatureDefs]]
*Global game variables (modrules.lua)
**[[Modrules.lua]]
*[[CEG]] Particle effects (explosions etc)

*Misc
**[[VirtualFileSystem]]
**[[MouseCursors]]
**[[Units:Textures]]
**[[Units:Buildpics]]
**[[Sidedata.lua]]
**[[Units:FlankingBonus]]
**[[Armordefs.lua|Units: Armor classes]]
**[[Mod Development:Archives|Game Development:Archives]]
**[[Mod Development:Sidepics|Game Development:Sidepics]]
**[[CustomUnitIcons|Game Development:Custom unit icons]]

=Unit Scripting/Animations (.cob, .bos, .lua)=
Unit scripts animate units and are needed for various function such as firing weapons.
* [[Animation-CobLuaDifferences | Differences of .lua and .cob unit scripts]]

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

==COB Animations==
The binary '.cob' file format is a compiled '.bos' script. To convert a '.bos' script file to '.cob' file you will need [[Scriptor]]

*[[Animation-CobOverview]]
**[[Animation-CobExamples]]
**[[Animation-CobAnimation]]
**[[Animation-CobCallins]]
**[[Animation-CobConstants]]
**[[Animation-CobThreads]]
**[[Animation-CobHitByWeaponID]]
*[[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.]

=Modeling =
Spring supports different 3d representations: '[[About_s3o|.s3o]]' and '[[About_3do|.3do]]', and additionally a variety of common model formats as supported by the ASSIMP library. The biggest difference between these formats is the workflow to create a new unit. There are also s3o exporter plugins for '3ds-max' and an older version of 'blender' 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.

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

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

===Modeling Tutorials===
* [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]
* [[TutorialBlenderWorkFlow|Blender Workflow Tutorial]]

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

[[Category: Unit_development]]
[[Category:Game development]]

Games

2011-12-26T23:41:56Z

Carrepairer: Removed false and misleading claim.

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

=Freeware/Open Source=
''These games are all free to download and play and may be open to modifications, however, be sure to read the licenses before doing so.''
{|
|-
| align="center" | <h2>[http://zero-k.info/ Zero-K]</h2>
([http://code.google.com/p/zero-k/source/browse/trunk/mods/zk/legal.txt GPL, PD])
| width=40 |
| align="center" | <h2>'''[http://www.spring1944.org/ Spring: 1944]'''</h2>([http://spring1944.svn.sourceforge.net/viewvc/spring1944/trunk/S44Main.sdd/docs/License.txt CC-BY-NC])
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=Zero-k_image.jpg|link=http://zero-k.info/}}
|
| align="center" |{{navimgx|xsize=300|ysize=225|image=S44_tigers.jpg|link=http://www.spring1944.org}}
|-
| align="justify" valign="top" | Zero-K is a fast, competitive game with a focus on a streamlined economy and advanced interface that takes the focus off tedious tasks and back on the action. A huge roster of interesting, unique units and a variety of unit abilities provides tremendous tactical and strategic depth to the game. [http://zero-k.info Download link]
|
| align="justify" valign="top" | Spring:1944 is a WWII themed game with four fully functional sides (US, Germany, USSR, Britain), period-accurate units and strengths. Realism comes second only to creating a game that is fun and accessible to play.
|-
| align="center" | <h2>[http://www.evolutionrts.info Evolution RTS]</h2>([http://creativecommons.org/licenses/by-nc-nd/3.0/us/ CC-BY-NC-ND])
| width=40 |
| align="center" | <h2>[[Kernel Panic]]</h2>([[Kernel_Panic#License:|FOSS, with only 2 FOSS maps]])
|-
| align="center" | {{navimgx|xsize=300|ysize=188|image=Evoimg.jpg|link=http://www.evolutionrts.info}}
|
| align="center" | {{navimg|xsize=300|ysize=225|image=Kernel_Panic_3.4.jpg|link=Kernel Panic}}
|-
| align="justify" valign="top" | A new war is brewing. A violent conflict, between the Six Colonies, each one convinced that it was in the right, each one sure of its own ability to defeat its enemies. But they need Generals. They need soldiers. They need you.
|
| align="justify" valign="top" | A game based around combat '''inside''' a computer, with 3 unique sides: the System, the Hacker and the Network waging war in a matrix of DOOM! No resource economy exists in KP, with the only constraints being time and space.
|-
| align="center" | <h2>'''[http://www.moddb.com/games/conflict-terra Conflict Terra]'''</h2>([http://code.google.com/p/conflictterra/source/browse/games/CT/sounds/evolutionRTS some non-free data] from EvolutionRTS)
|
| align="center" | <h2>[[Spring Tanks]]</h2>([http://pastebin.com/Wpub9wWw undecided, some obscure free license])
|-
| align="center" |{{navimgx|xsize=300|ysize=225|image=Conflict_terra.png|link=http://www.moddb.com/games/conflict-terra}}
|
| align="center" | {{navimg|xsize=300|ysize=221|image=Springtanks_wikipreview.jpg|link=Spring Tanks}}
|-
| align="justify" valign="top" | Based around the idea of a fictional faction fighting for the domination of Earth, Conflict Terra hopes to achieve balanced, interesting, intuitive and above all fun gameplay that tries to break some of the norms present in other Spring games.[http://www.moddb.com/games/conflict-terra/downloads Download link]
|
| align="justify" valign="top" | Some guys decided to attack each other with tanks and you can be one of them.
Build-in Single Player!
|}

=Proprietary=
''These games may or may not be free to play. Modifying their content (i.e. the art assets) is not allowed without the game authors explicit permission, although the code is GPL and some games (P.U.R.E.) include large GPL-friendly content collections.''
{|
|-
| width=40 |
| align="center" | <h2>[http://www.moddb.com/games/gundam-rts/news Gundam RTS]</h2>
|-
|
| align="center" |{{navimgx|xsize=300|ysize=225|image=Screen104.jpg|link=http://www.moddb.com/games/gundam-rts/news}}
|-
|
| align="justify" valign="top" | Set during the One-Year War in the Universal Century timeline of the Gundam Metaseries, Gundam RTS features fast, intense mech combat gameplay in a truly Gundam style.
|}

{|
|-
| align="center" | <h2>[http://www.imperialwinter.com Star Wars: Imperial Winter]</h2>
| width=40 |
| align="center" | <h2>[http://www.indiedb.com/games/the-cursed The Cursed]</h2>
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=Imperial Winter assault.jpg|link=http://www.imperialwinter.com}}
|
| align="center" |{{navimgx|xsize=300|ysize=225|image=cursed_logo.jpg|link=http://www.indiedb.com/games/the-cursed}}
|-
| align="justify" valign="top" | A Star Wars themed game set in the troubled post-Return of the Jedi era. SW:IW is currently [http://springrts.com/phpbb/viewtopic.php?f=46&t=25108|in closed development and not playable for the public.]
|
| align="justify" valign="top" | The game is about bones, undead, demons, space marines and magic settled in a futuristic environment. It is a fresh mixture of gameplay elements from many popular RTS games like Starcraft and C&C.
|}

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

{|
|-
| align="center" | <h2>[[Balanced Annihilation]]</h2>
| width=40 |
| align="center" | <h2> [http://springfiles.com/spring/games/tech-annihilation-8 Tech Annihilation] </h2>
|-
| align="center" | {{navimg|xsize=300|ysize=225|image=BAScreenShot.jpg|link=Balanced Annihilation}}
|
| align="center" |{{navimgx|xsize=300|ysize=200|image=Tech_Annihilation.png|link=http://springfiles.com/spring/games/tech-annihilation-8}}
|-
| align="justify" valign="top" |
Balanced Annihilation (BA) is a mature game and new versions feature only minor balance tweaks.

BA gameplay develops in stages of progressively heavier units with a growing economy. Many strategies are viable in BA, including focusing on map control, aggression, defense, air power, sea power, or mobility.

|
| align="justify" valign="top" | This Game is bigger, greater and more epic! Tech your Commander from a tiny Commander to a Galactic Commander! (by ''[BoS]Senna'', currently no homepage)
|}

{|
|-
| align="center" | <h2>[http://nota.machys.net/ NOTA]</h2>
| width=40 |
| align="center" | <h2>[[XTA]]</h2>
|-
| align="center" |{{navimgx|xsize=300|ysize=225|image=Nota2nukes.jpg|link=http://nota.machys.net/}}
|
| align="center" | {{navimg|xsize=300|ysize=225|image=Screen508_s.jpg|link=XTA}}
|-
| align="justify" valign="top" | Not Original Total Annihilation is a rethink of the Total Annihilation universe with a focus on strategic, base oriented gameplay. With its revised unit scale, huge battles erupt engaging hundreds of units and scores of unit types. NOTA's completely rethought air and sea gameplay forces participation in all elements and places the tide of conflict in your hands.
|
| align="justify" valign="top" | Originally developed as a Total Annihilation game by the Swedish Yankspankers, XTA is the Original Public Game released with first versions of Spring. Development of this game by the SYs has stopped a while ago, but it is still played and actively developed by the community.
|
|}

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

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

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

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

[[Category: Games]]

Getting Spring Content and Links

2011-10-17T17:50:52Z

Carrepairer: /* Content download websites for Spring */

===Content download websites for Spring===

;http://springfiles.com : Nearly all spring related files can be found here, files avaiable there are also downloadable by lobby clients.

;http://zero-k.info/Maps : List of most maps with detailed info

;http://widgets.springrts.de/index.php?s=d : Primary Spring Widget Data Base

;http://www.springinfo.info : a Spring Player's Portal (does not represent all Spring Development but is quite helpful)

;http://spring-portal.com : a nice Spring site with a short <b>Getting Spring to play tutorial</b> + more - thanks to BLC

;http://www.tasdownloads.com : thanks to M_A_D

;http://www.darkstars.co.uk/downloads/ : has the best <u>bandwidth</u> you will get - thanks to AF (a Dev with a running Spring blog) <span style="color:red">attention: mostly old files</span>

''' [[FAQ|<- Back to Help page]]'''

Complete Annihilation

2010-07-14T18:28:34Z

Carrepairer: Delete this page?

http://www.caspring.org

Games

2010-07-14T18:22:36Z

Carrepairer: /* TA-derived */ CA links to CA page.

{{Gameslanguage}}

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

=Freeware/Open Source=
''These games are all free to download and play and/or free to be modded without the author's permission (asking permission is considered a common courtesy though).''
{| class="wikitable" border="0"
|-
| align="center" | <h2>[http://www.evolutionrts.info Evolution RTS]</h2>(CC-BY-NC-ND)
| width=40 |
| align="center" | <h2>'''[http://www.spring1944.org/ Spring: 1944]'''</h2>
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=EvoRTS screenshot.jpg|link=http://www.evolutionrts.info}}
|
| align="center" |{{navimgx|xsize=300|ysize=225|image=S44_tigers.jpg|link=http://www.spring1944.org}}
|-
| align="justify" | A new war is brewing. A violent conflict, between the Six Colonies, each one convinced that it was in the right, each one sure of its own ability to defeat its enemies. But they need Generals. They need soldiers. They need you.
|
| align="justify" | Spring:1944 is a WWII themed game with four fully functional sides (US, Germany, USSR, Britain), period-accurate units and strengths. Realism comes second only to creating a game that is fun and accessible to play.
|}

{| class="wikitable" border="0"
|-
| align="center" | <h2>[[Kernel Panic]]</h2>("Public Domain")
| width=40 |
| align="center" | <h2>[[War Evolution]]</h2>
|-
| align="center" | {{navimg|xsize=300|ysize=225|image=Kernel_Panic_3.4.jpg|link=Kernel Panic}}
|
| align="center" |{{navimg|xsize=300|ysize=225|image=Warevoscreen.jpg|link=War Evolution}}
|-
| align="justify" | A game based around combat '''inside''' a computer, with 3 unique sides: the System, the Hacker and the Network waging war in a matrix of DOOM! No resource economy exists in KP, with the only constraints being time and space.
|
| align="justify" | In short words, War Evolution is different. Different from all other games. You dont have a base and you can not reinforce your "army". In fact, you command only one single mech and if he dies, you can only spectate until the game is over.
|}

=Proprietary=
''These games may or may not be free to play. Modifying their content (i.e. the art assets) is not allowed without the game authors explicit permission, although the code is GPL and some games (P.U.R.E.) include large GPL-friendly content collections.''
{| class="wikitable" border="0"
|-
| align="center" | <h2>[http://www.wolfegames.com P.U.R.E.]</h2>
| width=40 |
| align="center" | <h2>[[Gundam RTS]]</h2>
|-
| align="center" |{{navimgx|xsize=300|ysize=225|image=PURE_LOGO_1024.jpg|link=http://www.wolfegames.com}}
|
| align="center" |{{navimg|xsize=300|ysize=225|image=Screen104.jpg|link=Gundam RTS}}
|-
| align="justify" | A game based on a completely original IP, allowing players to participate in the epic, galaxy-spanning conflict between the human Resistance forces and the malevolent A.I. known as 'The Overmind'.
|
| align="justify" | Set during the One-Year War in the Universal Century timeline of the Gundam Metaseries, Gundam RTS features fast, intense mech combat gameplay in a truly Gundam style.
|}

{| class="wikitable" border="0"
|-
| align="center" | <h2>[http://www.imperialwinter.com Star Wars: Imperial Winter]</h2>
| width=40 |
| align="center" | <h2>[[Expand_and_Exterminate|Expand and Exterminate]]</h2>
|-
| align="center" | {{navimgx|xsize=300|ysize=225|image=Imperial Winter assault.jpg|link=http://www.imperialwinter.com}}
|
| align="center" |{{navimg|xsize=300|ysize=225|image=E&E-screenshot2.jpg|link=Expand and Exterminate}}
|-
| align="justify" | A Star Wars themed game set in the troubled post-Return of the Jedi era, SW:IW features over a hundred units for the fractured Galactic Empire and Rebel Alliance fighting for control of the galaxy.
|
| align="justify" | An original IP game loosely based around the Earth 2150 series of games.
|}

{| class="wikitable" border="0"
|-
| width=180 |
| align="center" | <h2>'''[http://azaremoth.supremedesign.org The Cursed]'''</h2>
| width=180 |
|-
|
| align="center" | {{navimgx|xsize=300|ysize=225|image=cursed.jpg|link=http://azaremoth.supremedesign.org}}
|
|-
|
| align="justify" | The unique game is about bones, undead, demons and magic settled in a futuristic environment.[[http://www.springfiles.com/show_file.php?id=2498 Download link]]
|
|}

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

{| class="wikitable" border="0"
|-
| align="center" | <h2>[[Balanced Annihilation]]</h2>
| width=40 |
| align="center" | <h2>[http://www.caspring.org Complete Annihilation]</h2>
|-
| align="center" | {{navimg|xsize=300|ysize=225|image=BAScreenShot.jpg|link=Balanced Annihilation}}
|
| align="center" | {{navimgx|xsize=300|ysize=225|image=Pyro.jpg|link=http://www.caspring.org}}
|-
| align="justify" |
Balanced Annihilation (BA) is currently the most popular game played using the Spring engine. BA is a mature mod and new versions feature only minor balance tweaks.

BA gameplay develops in stages of progressively heavier units with a growing economy. Many strategies are viable in BA, including focusing on map control, aggression, defense, air power, sea power, or mobility.

|
| align="justify" | CA is a regularly updated game that is often regarded as a showcase of what the Spring Engine can do. The game is designed with a flat tech tree, where the effectiveness of a unit is based on its appropriateness to the situation rather than lighter units being superseded by heavier ones.
Although CA is a game that uses OTA content, it is currently working towards being TA-IP free.
<b>If you like complex warfare this is Your Mod.</b>
|}

{| class="wikitable" border="0"
|-
| align="center" | <h2>[[NOTA]]</h2>
| width=40 |
| align="center" | <h2>[[XTA]]</h2>
|-
| align="center" |{{navimg|xsize=300|ysize=225|image=Nota2nukes.jpg|link=NOTA}}
|
| align="center" | {{navimg|xsize=300|ysize=225|image=XtaScreenShot.jpg|link=XTA}}
|-
| align="justify" | Not Original Total Annihilation is a rethink of the Total Annihilation universe with a focus on strategic, base oriented gameplay. With its revised unit scale, huge battles erupt engaging hundreds of units and scores of unit types. NOTA's completely rethought air and sea gameplay forces participation in all elements and places the tide of conflict in your hands.
|
| align="justify" | Originally developed as a Total Annihilation mod by the Swedish Yankspankers, XTA is the Original Public Mod released with first versions of Spring. Development of this mod by the SYs has stopped a while ago, but it is still played and actively developed by the community.
|}

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

In some cases however, the game will only distribute a "game-file" - in this case you will need to have [[Download|an installation of the Spring-Engine]], and place the file in the .../Spring/mods/ folder. If you are using a Lobby, this will often be able to do this for you automatically.

For an overview of information to get started, Click '''[[FAQ|Help]]'''.

=Game Development=
For information on creating games for the Spring engine, see the [[Mod_and_Unit_development|Game Making]] page.

[[Category: Games]]

Lua SyncedRead

2009-12-02T18:00:49Z

Carrepairer: Y and Z flipped in Spring.GetUnitWeaponVectors desc

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

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

'''Spring.GetGaiaTeamID'''
( ) -> number teamID

=== GameStates ===
'''Spring.IsGodModeEnabled'''
( ) -> boolean
'''Spring.IsCheatingEnabled'''
( ) -> boolean
'''Spring.IsDevLuaEnabled'''
( ) -> boolean
'''Spring.IsEditDefsEnabled'''
( ) -> boolean
'''Spring.AreHelperAIsEnabled'''
( ) -> boolean
'''Spring.FixedAllies'''
( ) -> nil | boolean

'''Spring.IsGameOver'''
( ) -> boolean

=== Rules ===
<font color="#55ee99">Those functions allow to save data per Game,Team and Unit.<br>The advantage of it is that it can be read from anywhere (even from LuaUI and AIs!)</font><br><br>
'''Spring.GetRulesInfoMap'''
( ) -> { [key1] = string value1, [key2] = string value2, ... }
( string "key" ) -> string

'''Spring.GetGameRulesParam'''
( number index | string ruleName ) -> number value
'''Spring.GetGameRulesParams'''
( ) -> { [rule1] = number value1, [rule2] = number value2, ... }

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

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

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

=== Speed/Time ===
'''Spring.GetGameSpeed'''
( ) -> number userSpeedFactor, number speedFactor, boolean paused
'''Spring.GetGameFrame'''
( ) -> number frameNum%dayFrames, number frameNum/dayFrames
'''Spring.GetGameSeconds'''
( ) -> number seconds

=== Vectors ===
'''Spring.GetWind'''
( ) -> number dirX, number dirY, number dirZ,
number strength, number normDirX, number normDirY, number normDirZ

'''Spring.GetHeadingFromVector'''
( number x, number z ) -> number heading
'''Spring.GetVectorFromHeading'''
( number heading ) -> number x, number z

== Sides/Factions ==
'''Spring.GetSideData'''
( string sideName ) -> nil | string startUnit, string caseSensitiveSideName
( number sideID ) -> nil | string sideName, string startUnit, string caseSensitiveSideName
( ) -> { [1] = { sideName=string,caseName=string,startUnit=string}, [2] = .., .. }

== Teams ==
=== StartBoxes/StartPositions ===
'''Spring.GetAllyTeamStartBox'''
( number allyID ) -> nil | number xmin, number zmin, number xmax, number zmax
'''Spring.GetTeamStartPosition'''
( number teamID ) -> nil | number x, number y, number z

=== Player,Team,Ally Lists/Info ===
'''Spring.GetPlayerList'''
( [number teamID = -1 | boolean onlyActive = false] [, number teamID | boolean onlyActive])
-> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID = -1] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

'''Spring.GetPlayerInfo'''
( number playerID ) ->
nil | string "name", <font color=#55ee99>(in synced code this is "SYNCED_NONAME"!)</font>
boolean active,
boolean spectator,
number teamID,
number allyTeamID,
number pingTime,
number cpuUsage,
string country,
number rank
table customPlayerKeys
'''Spring.GetPlayerControlledUnit'''
( number playerID ) -> nil | number unitID

'''Spring.GetAIInfo'''
( number teamID ) ->
nil | number teamID
number skirmishAIID,
string name,
number hostingPlayerID,
string shortName, <font color=#55ee99>(synced => "SYNCED_NOSHORTNAME"; non-local => "UNKNOWN")</font>
string version, <font color=#55ee99>(synced => "SYNCED_NOVERSION"; non-local => "UNKNOWN")</font>
table options <font color=#55ee99>(synced & non-local => empty-table)</font>

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

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamID,
number leader,
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam
table customTeamKeys
'''Spring.GetTeamResources'''
( number teamID, string "metal" | "energy" ) ->
nil | number currentLevel,
number storage,
number pull,
number income,
number expense,
number share,
number sent,
number received
'''Spring.GetTeamUnitStats'''
( number teamID ) ->
nil | number killed,
number died,
number capturedBy,
number capturedFrom,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID, number startTime, number endTime ) ->
{
[1] = {
"time" = number,
"frame" = number,
"metalUsed" = number,
"metalProduced" = number,
"metalExcess" = number,
"metalReceived" = number,
"metalSent" = number,
"energyUsed" = number,
"energyProduced" = number,
"energyExcess" = number,
"energyReceived" = number,
"energySent" = number,
"damageDealt" = number,
"damageReceived" = number,
"unitsProduced" = number,
"unitsDied" = number,
"unitsReceived" = number,
"unitsSent" = number,
"unitsCaptured" = number,
"unitsOutCaptured" = number,
"unitsKilled" = number
}, ...
}
'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

=== Teams/PlayersAllied ===
'''Spring.AreTeamsAllied'''
( number teamID1, number teamID2 ) -> nil | boolean
'''Spring.ArePlayersAllied'''
( number playerID1, number playerID2 ) -> nil | boolean

== Units ==
=== GetUnits ===
'''Spring.GetAllUnits'''
( ) -> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetTeamUnits'''
( number teamID ) -> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitsSorted'''
( number teamID ) -> nil |
unitDefTable = {
[number unitDefID] = { [1] = [number unitID], etc... },
etc...
}
'''Spring.GetTeamUnitsCounts'''
( number teamID ) -> nil | countTable = { [number unitDefID] = count, etc... }
'''Spring.GetTeamUnitsByDefs'''
( number teamID, number unitDefID | { number unitDefID1, ... } )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitDefCount'''
( number teamID, number unitDefID ) -> nil | number count
'''Spring.GetTeamUnitCount'''
( number teamID ) -> nil | number count

'''Spring.GetUnitsInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInBox'''
( number xmin, number ymin, number zmin,
number xmax, number ymax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInSphere'''
( number x, number y, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInCylinder'''
( number x, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInPlanes'''
( planes = { [1] = { number nx, number ny, number nz, number d }, etc... } )
-> nil | unitTable = { [1] = number unitID, etc... }
<font color="#55ee99">
plane normals point towards accepted space,
so the acceptance criteria for each plane is:
radius = unit radius
px, py, pz = unit position
[(nx * px) + (ny * py) + (nz * pz) + (d - radius)] <= 0
</font>

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

=== Unit Informations ===
'''Spring.ValidUnitID'''
( number unitID ) -> boolean
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitTooltip'''
( number unitID ) -> nil | string tooltip
'''Spring.GetUnitDefID'''
( number unitID ) -> nil | number unitDefID
'''Spring.GetUnitTeam'''
( number unitID ) -> nil | number teamID
'''Spring.GetUnitAllyTeam'''
( number unitID ) -> nil | number allyID
'''Spring.GetUnitLineage'''
( number unitID ) -> nil | number lineage | number lineage, boolean lineageIsRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
'''Spring.GetUnitArmored'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitExperience'''
( number unitID ) -> nil | number experience
'''Spring.GetUnitStates'''
( number unitID ) -> nil | {
"firestate" = number,
"movestate" = number,
"repeat" = boolean,
"cloak" = boolean,
"active" = boolean,
"trajectory" = boolean,
["autoland" = boolean,]
["autorepairlevel" = number,]
["loopbackattack" = boolean]
}
'''Spring.GetUnitIsActive'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitIsCloaked'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitSelfDTime'''
( number unitID ) -> nil | number
'''Spring.GetUnitStockpile'''
( number unitID ) -> nil | number numStockpiled, number numStockpileQued,
number buildPercent
'''Spring.GetUnitHeight'''
( number unitID ) -> nil | number
'''Spring.GetUnitRadius'''
( number unitID ) -> nil | number
'''Spring.GetUnitPosition'''
( number unitID ) -> nil | number x, number y, number z
<font color="#55ee99">returns the center position of the unit (midpos).</font>

'''Spring.GetUnitBasePosition'''
( number unitID ) -> nil | number x, number y, number z
<font color="#55ee99">returns the bottom of the unit.</font>

'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
'''Spring.GetUnitVelocity'''
( number unitID ) -> nil | number velx, number vely, number velz
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitFuel'''
( number unitID ) -> nil | number
'''Spring.GetUnitFlanking'''
( number unitID, string "dir" ) -> nil | number x, number y, number z
( number unitID, string "mode" | "moveFactor" | "minDamage" | "maxDamage" ) -> nil | number
( number unitID ) -> nil | number mode, number modilityAdd,
number minDamage, number maxDamage, number dirX, number dirY, number dirZ
'''Spring.GetUnitSensorRadius'''
( number unitID, string type ) -> nil | number radius
<font color="#55ee99">possible types are:<br>airLos, radar, sonar, seismic, radarJammer & sonarJammer</font>
'''Spring.GetUnitLosState''' <font color="red">raw is only available in gadgets</font>
( number unitID [, number allyTeamID [, boolean raw] ] ) -> nil |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' <font color="#55ee99">(returns the distance of 2 units)</font>
( number unitID1, number unitID2 [, boolean 2D ] ) -> nil | number distance
'''Spring.GetUnitDefDimensions'''
( number unitDefID ) -> nil |
{
"height" = number,
"radius" = number,
"midx" = number,
"minx" = number,
"maxx" = number,
"midy" = number,
"miny" = number,
"maxy" = number,
"midz" = number,
"minz" = number,
"maxz" = number
}
'''Spring.GetUnitWeaponVectors'''
( number unitID, number weaponNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirY, number dirZ
'''Spring.GetUnitWeaponState'''
( number unitID, number weaponNum ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame,
number salvoLeft, number numStockpiled
( number unitID, number weaponNum, string tag ) -> nil | number
<font color="#55ee99">tag can be:
"reloadState" | "reloadTime" | "accuracy" | "sprayAngle" |
"range" | "projectileSpeed" | "burst" | "burstRate" | "projectiles"</font>
'''Spring.GetUnitLastAttacker'''
( number unitID ) -> nil | number unitID

=== Unit Pieces ===
'''Spring.GetUnitVectors'''
( number unitID ) -> nil | {frontX,frontY,frontZ}, {upX,upY,upZ}, {rightX,rightY,rightZ}
'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
<font color="#55ee99">Returns piece position in unit space</font>

'''Spring.GetUnitPieceDirection'''
( number unitID, number piece ) -> number dirx, number diry, number dirz
<font color="red">Broken (returns reverse direction in piece space for pieces with >= 2 vertices, and returns (1,1,1) for pieces with < 2 vertices)</font>

'''Spring.GetUnitPieceMatrix'''
( number unitID, number piece ) -> { [1] = number, ... , [16] = number }
'''Spring.GetUnitPieceList'''
( number unitID ) -> { [1] = string "piecename", ... , [pieceNumN] = string "piecename" }
'''Spring.GetUnitPieceMap'''
( number unitID ) -> { "piecename1" = pieceNum1, ... , "piecenameN" = pieceNumN }
'''Spring.GetUnitPieceInfo'''
( number unitID, number piece ) -> {
"name" = string "piecename",
"isEmpty" = boolean,
"children" = { [1] = string "piecename", ... },
"min" = { [1] = number x, [2] = number y, [3] = number z },
"max" = { [1] = number x, [2] = number y, [3] = number z },
"offset" = { [1] = number x, [2] = number y, [3] = number z },
}
'''Spring.GetUnitScriptPiece'''
( number unitID [, number scriptPiece ] )
-> nil | { scriptPieceNum = number modelPieceNum } | number modelPieceNum

<font color="#55ee99">This functions translate the COB ScriptPiece numbers into the ModelPiece numbers (the set of ScriptPieces is a subset of the ModelPieces, means #ScriptPieces <= #ModelPieces), which is used in all other functions (the "number piece" means always the modelpiece). So if you get via Cob2Lua a pieceID you have to translate it with this function. Btw the COB ScriptPiece number is equal with the piece position in the <i>piece</i> definition in your cob/bos.</font>

'''Spring.GetUnitScriptNames'''
( number unitID )
-> { "cobpiecename1" = ScriptPieceNum1, ... , "cobpiecenameN" = ScriptPieceNumN }
'''Spring.GetUnitPiecePosDir'''
( number unitID, number pieceNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirZ, number dirY
<font color="#55ee99">Returns piece position and direction in world space. The direction (dirX, dirY, dirZ) is not necessarily normalized.</font>

=== CommandQueues ===

'''Spring.GetUnitCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}

'''Spring.GetCommandQueue''' <font color="#55ee99">(same as Spring.GetUnitCommands)</font>
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFullBuildQueue'''
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetRealBuildQueue''' <font color="#55ee99">(cleans the buildqueue of things the unit can't build itself)</font>
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetFactoryCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFactoryCounts''' (used to get the buildqueue of a factory, seems screwed o_O)
( number unitID [, number count [, boolean addCMDs ] ] ) -> nil | commandQueueTable = {
[2] = { [number unitDefID | number -cmdID] = number count }, ...
}

=== Command Descriptions/Buttons ===
'''Spring.GetUnitCmdDescs'''
( number unitID [, number startIndex [, number endIndex ] ] ) -> nil | {
[1] = {
"id" = number,
"type" = number,
"name" = string,
"action" = string,
"tooltip" = string,
"texture" = string,
"cursor" = string,
"hidden" = boolean,
"disabled" = boolean,
"showUnique" = boolean,
"onlyTexture" = boolean,

"params" = { [1] = string, ... }
}, ...
}
'''Spring.FindUnitCmdDesc'''
( number unitID, number cmdID ) -> nil | number index

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> nil | { [1] = number featureID, ... }
'''Spring.GetFeatureList''' <font color="red" style="font-weight:600"> NOTE: this is not really required, now all FeatureDefs are pre-loaded</font>

=== Feature Informations ===
'''Spring.ValidFeatureID'''
( number featureID ) -> boolean
'''Spring.GetFeatureDefID'''
( number featureID ) -> nil | number featureDefID
'''Spring.GetFeatureTeam'''
( number featureID ) -> nil | number teamID
'''Spring.GetFeatureAllyTeam'''
( number featureID ) -> nil | number allyID
'''Spring.GetFeatureHealth'''
( number featureID ) -> nil | number health, number maxHealth, number resurrectProgress
'''Spring.GetFeatureHeight'''
( number featureID ) -> nil | number
'''Spring.GetFeatureRadius'''
( number featureID ) -> nil | number
'''Spring.GetFeaturePosition'''
( number featureID ) -> nil | number x, number y, number z
'''Spring.GetFeatureDirection'''
( number featureID ) -> nil | number dirx, number diry, number dirz
'''Spring.GetFeatureHeading'''
( number featureID ) -> nil | number heading
'''Spring.GetFeatureResources'''
( number featureID ) -> nil | number RemainingMetal, number maxMetal,
number RemainingEnergy, number maxEnergy, number reclaimLeft
'''Spring.GetFeatureNoSelect'''
( number featureID ) -> nil | boolean noSelect
'''Spring.GetFeatureResurrect'''
( number featureID ) -> nil | string UnitDefName, number buildFacing

== COB ==
'''Spring.GetCOBUnitVar'''
( number unitID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBTeamVar'''
( number teamID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBAllyTeamVar'''
( number allyID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBGlobalVar'''
( integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY

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

'''Spring.GetGroundHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundOrigHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundNormal'''
( number x, number z ) -> number x, number y, number z
'''Spring.GetGroundInfo'''
( number x, number z ) -> string "Type", number metal, number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed,
number shipSpeed, boolean receiveTracks
'''Spring.GetGroundBlocked'''
( number x, number z |
number x1, number z1, number x2, number z2 )
-> nil | string "feature", number featureID | string "unit", number unitID
'''Spring.GetGroundExtremes'''
( ) -> nil | number minHeight, number maxHeight

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

<font color="#55ee99">blocking can be:
0 - blocked
1 - mobile unit in the way
2 - free (or if featureID is != 0 then with a blocking feature that can be reclaimed)
facing can be:
0, "s", "south"
1, "e", "east"
2, "n", "north"
3, "w", "west"</font>
'''Spring.Pos2BuildPos'''
( number unitDefID, number x, number y, number z ) -> nil | number x, number y, number z

=== PathFinding ===
'''Spring.GetUnitEstimatedPath'''
( number unitID ) -> nil | {
[1] = { x,y,z }, ...
},{
[1] = startIdxOfDetailedPath,
[2] = startIdxOfDetailedEstimatedPath1,
[3] = startIdxOfDetailedEstimatedPath2,
}
<font color="#55ee99">GetUnitEstimatedPath() returns 2 tables:
1 table the waypoints and 1 table with indices (in the waypoint table)
when a new (more lazy) pathfinding algorithm begins.
So the waypoint table contains 3 different levels of details.</font>

=== LOS ===
'''Spring.IsPosInLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInRadar'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInAirLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.GetPositionLosState'''
( number x, number y, number z [, number allyID] )
-> boolean LosOrRadar, boolean inLos, boolean inRadar
'''Spring.GetClosestValidPosition''' <font color="red">//NOT FINISHED YET</font>
( number unitDefID, number x, number z, number r ) -> nil

== Projectiles ==

'''Spring.GetProjectilePosition'''
( number projectileID ) --> px, py, pz
'''Spring.GetProjectileVelocity'''
( number projectileID ) --> vx, vy, vz

Game and Unit development

2009-11-13T17:02:35Z

Carrepairer: Added links to lua animation wiki pages.

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

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

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

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

==General==
*[[Mod Development]]
*[[Mod specification]]<br>
*[http://spring.clan-sy.com/phpbb/viewtopic.php?t=6015 What do I need to create a mod]
*[[Simple Mod Tutorial]]
*[[Freely available and reusable content|Freely available and reusable content/games/mods]]
*[[tools & software for make :map mod unit]]

==Unit Development==
====Automated Mod Creation====
* [[TA2Spring]] - Automatically adds and converts Total Annihilation unit packs (.ufo files, etc..) into Spring mods (requires a base modification for the game rules, XTA is recommended)
====Models - s3o Files====
*[http://user.supradigital.org/jcnossen/UpspringInstaller-1.54-EulerAngles.exe UpSpring, our second-gen import / export / rigging / animation tool.]
* [http://lassie.student.utwente.nl/vliet/springtut.pdf Maestro's tutorial of Upspring and textures].
* [[Basic s3o unit making guide]]
* [[Simple Mod Tutorial]]
* [[Units:CreateModel|UV Mapping in Wings3D]]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?p=75495 various things about unit making. (Also contains an illustrated alpha-channel tut)]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]
* [http://spring.clan-sy.com/phpbb/viewtopic.php?f=9&t=15106 Argh's UpSpring Easy Workflow Guide]
* [[Trouble-shooting s3o units]]

====Models - 3do Files====
outdated model format used by OTA<br>
(Note: UpSpring has some problems with empty objects and groundplates)
*use [http://spring.clan-sy.com/phpbb/viewtopic.php?f=12&t=7208&p=126129&hilit=upspring#p126129 UpSpring] and [http://www.fileuniverse.com/?p=show&a=it&id=305 3doBuilder] to edit those files

====[http://springrts.com/wiki/Category:Animation Scripting and Animation - COB/BOS Files]====
To edit .bos files you need a program/compiler. The most famous one is [http://jobjol.nl/1384 Scriptor]
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
*[[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|Mod Development:Calling basic CEGs from COB]]
* [http://spring.clan-sy.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]]
*[[Mod Development:Cursors]]
*[[Mod Development:Archives]]
*[[Mod Development:Sidepics]]
*[[CustomUnitIcons|Mod Development:Custom unit icons]]

Basic s3o unit making guide

2009-11-13T16:49:36Z

Carrepairer: Corrected info regarding new lua animation scripts.

==What you need:==

*The Model
*The UV map
*The Textures
*The Script
*[http://www.fileuniverse.com/?p=showitem&ID=2317 UpSpring]

== The Model ==

You can make it in any of the 3d modelling programs mentioned [http://taspring.clan-sy.com/wiki/Map%2C_Mod%2C_And_Unit_Development_Programs#3d_Modeling here.]

Upspring will import .OBJ, and .3DS, (.3DO is supported as well but we are supposed to be working from scratch here and not converting old units).

Importing 3DS files will have some sort of hierarchy, but with all pieces at the same level you will have to re-arrange them into the correct order using cut-paste commands.

If I'm not mistaken, .OBJ files don't have hierarchy, so there is no distinction between parts of the unit.

So for using this format you must save each part of the unit in separate files and import them individually from UpSpring. You must have at least one existing object to import to, so create an "empty" object if needed, then import the pieces following the hierarchy, or you can manually arrange them later.

For moving object origins, move part using the move tool, and then use "Apply transformation" button in object tab.

Put the saved .S3O file in the "Objects3D" folder in your mod structure files.

'''IMPORTANT'''
'''All part names in s3o must be in lower case in UpSpring.'''

This will avoid issues with the script.

== The UV map ==

Only one UV map image is allowed, so you must make all parts use the same UV map.

It's reported that the biggest texture size of the UV map is 2048x2048.

A guide on Skinning (UV mapping) can be found [http://taspring.clan-sy.com/phpbb/viewtopic.php?t=3511 here].

'''**Added by TA 3D:''' When you want to bring in UV coordinates, go to the Texture Mapping menu again and click on Import UV coordinates from model. Since the texture is flipped vertically you have to flip the UV coordinates. Only use 3ds files for this as obj files don't have UV coordinates. I hope this helps.'''**'''

'''**Added by Mehere101:''' This may be out of date, using Blender 2.42 RC3 I can get UV coordinates exported into the OBJ file. Make sure that you are exporting to Wavefront OBJ, and that whatever exporter you have has the UV Mapping Box checked (In blender its off by default for some reason)'''**'''

You can import .3DS models already UV mapped into UpSpring.

(But in my tests the UV map results incorrectly displayed, please fix this part if you know how to do it right)

Another way of making the UV map is importing the model first to UpSpring, either by using one .3DS file or the separate .OBJ files method.

Once you have the model imported and in the right place, use "Export Model for UV mapping" in UpSpring.

Then UV map that .OBJ file with whatever UV mapping tool of your liking, save, and then import back the UV using the "load UV map from file".

== The Textures ==

Quote

"There are two textures for each model, texture1 is the standard skin texture but the alpha is used for teamcolor. Texture2 uses the green channel for reflectivity and the red channel for self illumination, blue is unused so far."

(In The GIMP, what is texture will show completely black, and what is teamcolor will show transparent, showing the texture under the alpha. Which is a bit awkward if you ask me.. as you wont be able to see what is supposed to be texture, but what wont. buh!)

The value of the alpha will blend with the texture, so you can make cool teamcolor/texture transitions ;) .

(I've tested DDS format several times in The GIMP, using the export plugin, and have not been able to make these files work so far. Hopefully someone can add more information on this.). '''**Edit: I will do some digging to find out what the exact formats are that DDS is supposed to be saved as. TA 3D**'''

UpSpring 1.3 has a built it texture builder that works great. Use bmps.

'''**Added by TA 3D:''' Spring will use TGA and PNG files, but if you want the textures to work better and run more efficiently, use DDS files which is a native image format for videocards made by Nvidia. It works on any videocard, not just Nvidia's cards.
NOTE: UpSpring makes the files flipped vertically so you will have to flip the UV coordinates in UpSpring. '''Do not use any other format for making DDS files with UpSpring than bmp otherwise you will have problems. If you use anything else the alpha channel will screw it up. Note: The following images are png to conserve bandwith.'''
Here's an example of a DDS file I made for a model recently.
Texture 1 Texture and Team color:
Texture RGB-channels of the first dds texture file:

http://www.majhost.com/gallery/3dbricks/TASPRING/fc1.png

Team color-the alpha channel of the first dds texture file:

http://www.majhost.com/gallery/3dbricks/TASPRING/fc2.png

Texture 2 Reflectivity and Illumination:
Reflection green-channel of the second dds texture file:

http://www.majhost.com/gallery/3dbricks/TASPRING/fc3.png

Illumination red-channel of the second dds texture file:

http://www.majhost.com/gallery/3dbricks/TASPRING/fc4.png

Upspring can make dds files using the S3O Texture Builder option under the Texture menu.

http://www.majhost.com/gallery/3dbricks/TASPRING/menu.png

Making the first dds file.

http://www.majhost.com/gallery/3dbricks/TASPRING/texture_builder.png

And making the second.

http://www.majhost.com/gallery/3dbricks/TASPRING/texture_builder2.png

When you want to bring in UV coordinates, go to the Texture Mapping menu again and click on Import UV coordinates from model. Since the texture is flipped vertically you have to flip the UV coordinates. If the Team color doesn't work try inverting the the Team color image using the invert box. I hope this helps. As soon as I have a working model, then I will post a pic of the above textures applied to it.'''**'''

Put the finished files in "unittextures" folder inside your mod structure.

some other words on the textures:

"alpha is a greyscale... black = no team color, white = all team colour... because Photoshop is dumb stick to 1% balck or 99% black... anything in between is "blended"... like transparency in the team colour mapped over the main texture..."

== The Script ==

A common script, see other wiki resources for information on what is new/changed in spring.

== The unit FBI file ==

In this file goes the usual information, plus one change:

the usual
Objectname=UNITNAME;

must be
Objectname=UNITNAME'''.s3o''';

== Common Troubles ==

*The unit doesn't show up in game, although the "/give unitname" will work and you can see the selected base.

This is caused because the unit is underground. In the Model tab you must give your unit a center, collision sphere radius and heigth in UpSpring, you can use "estimate" which shall be fine.

*The unit texture is all black in game!

Read the texture section here. 3DOs cant be UV textured. Use .TGA format. Don't forget alpha.

*The UV seems wrong in game..

Flip the UV. In UpSpring go to, Texture Mapping>Show UV Maps, then, edit>Flip UVs.

*I get a "missing part" error, and the unit doesn't aim turrets or animate as indicated in the script.

See last lines in The Model part.

== Related Threads ==

[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=4519]
[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=2660]
[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=3766]
[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=3641]

[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=4536 Complementary information]

*Credits

Its all stolen from the above threads.

'''extra notes:'''

Texture filename can be anything; you allocate the texture to the model when you save it as a .s3o object

Object filename can be anything; the unit fbi/lua file you allocate which model to use.

Script filename must be the same name as the unit fbi/lua filename, unless you are using lua animation scripts, in which case you can use the script tag in the unitdef file.

''In the fbi/lua file:''

unitname is the name game refers to. ie. the one you type in the console to /give the unit.

name is the name that players will see.

[[Category:Unit development]]
[[Category:Tutorials]]