Spring - User contributions [en]

Reporting

2021-02-07T08:37:55Z

Silentwings: /* Contacting moderators */

[[Main_Page|Wiki]] < {{FULLPAGENAME}}

== Contacting moderators ==

For individual forum posts, which might not follow our [[Felony|forum rules]], use the 'report post' button which you can find [https://springrts.com/phpbb/app.php/help/faq#f2r9 near the top right of every forum post].

In all other cases, when a reaction is wanted from Springs moderators, reports may be sent, via private messages, with evidence in the form of links/logfiles/replays, [https://springrts.com/phpbb/ucp.php?i=pm&mode=compose&g=3623 to the Spring staff (=moderators and administrators) forum group].

'''Forum threads should not be used for reporting users behaviour to moderators.''' Why not? Because forum threads are for discussions, which don't require a heavy burden of proving something when you say it - consequently we will never treat them as a request for a reaction or judgement from moderators, although we might react for other reasons. We may not always read them, but if we do then we will generally lock threads made to request moderator reactions.

== Moderation within autohosts ==

Misbehaviour within autohosts should be reported to the autohost owners or operators. Send a private lobby message <code>!list users</code> to the autohost to find out who these are.

Autohosts are typically run by particular users and have a degree of autonomy, [[Botflags|as detailed here]]. Springs (global) moderators will typically not process disputes between players relating to ingame behaviour.

Read Me First

2021-02-07T08:35:21Z

Silentwings: /* Wondering where all the former popular games are ? */

__NOTOC__= Playing =
'''Spring is an engine!''' It can play many different games and maps. To play, you need at least one [[Games|Game]] and [[Maps|Map]]!

==Getting Started==

To get started with Spring, download [https://springlobby.info/ SpringLobby], which you can use to play, chat and download games and maps.

==Downloading Games/Maps==

'''To download [[Games|Games]] (or [[Maps|Maps]]), use your lobby to join an online battle hosting the game/map that you want. It should offer to download for you.'''

If the download fails, or if no games/maps show up, you should check that your lobby has found your Spring install. With SpringLobby, click edit -> preferences -> Spring, and make sure that it has the correct paths.

You can also download games and maps manually, see the [[FAQ|FAQ]]. There is also the option to install different [[GamesDownloads#Universal_Downloaders|Lobbies]].

==Single-Player==

To start a single-player game, use your lobby. Go to the Single-Player tab. Select a game, map and [[AIs|AI]] and click "Start".

Some AIs don't work with all games. If the one you pick builds nothing, try another!

==Playing Online==
To play online, you need the latest version of the [[Download|Spring Engine]]. To join matches, look for the "battles" or "multiplayer" tab in your lobby client.

== Wondering where some former popular games are? ==
Some larger games run their own lobby servers!
* Zero-k (which grew out of CA) can be found at https://zero-k.info/
* Beyond All Reason (which grew out of BAR) can be found at https://www.beyondallreason.info/
* Balanced Annihilation and some other legacy *A games can be found at at: https://springfightclub.com

==Lan Party==
See the dedicated page [[Spring_on_a_LAN|Playing on a lan]].

=Useful Hotkeys, Etc.=

For the default keyboard layout please look at the [[Keyboard]] page.

=The Spring Forum=
[[Forum_Etiquette|Guidelines For Forum Etiquette]]

=Development=
To get started with development check the [[Engine_Development|Development]] page.

=Your question not answered here? Got problems?=
Read the [[FAQ|Frequently Asked Questions]] or ask in the [http://springrts.com/phpbb/viewforum.php?f=11 Forum].
You can also report [[Bugs]] to the developers so they can be fixed.

==Game Specific Questions==
If you have a question or problem with a certain gameplay mechanic in a game, you can talk about it at the [http://springrts.com/phpbb/viewforum.php?f=47 game's subforum]

If Spring crashes/hangs, please look at the [[FAQ:trouble|FAQ]].

[[Category:Help]]

Balanced Annihilation

2020-07-25T06:08:34Z

Silentwings:

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

[[Image:BA.gif|very epic tmp img of BA]]

===Links===
* [https://balancedannihilation.com/ BA website]
* [https://www.reddit.com/r/BalancedAnnihilation/ r/BalancedAnnihilation reddit]
* [https://springrts.com/phpbb/viewforum.php?f=44 BA subforum]

===Overview===
Balanced Annihilation was the long-term most popular game based at the Spring engine.
It's based at three basic principles:
* '''Refined [[OTA | Original Total Annihilation]]:''' BA's lineage traces back to fan mods of the original Total Annihilation. It feels similar, and play is ''more balanced'' for diverse multiplayer strategies.

* '''Stable gameplay:''' Balanced Annihilation has matured through several years of playtesting. New versions don't drastically alter the gameplay.

* '''Balance:''' Every unit has a role, and no unit has every role. Very few units get truly obsolete as a game progresses. The ideal state is to have no obsolete units at all.

===History===
Balanced Annihilation mod started as a fork of [[Absolute Annihilation]] 2.23 in the end of 2006. The community split in 2019 and shortly afterwards Floris (2016-19) resigned as maintainer. The previous maintainers, who shouldn't be forgotten, were
* [teh]Decay (2016)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=7229 Silentwings] (2012-16)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=5958 Beherith] (2011-12)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=7403 Niobium] (2011)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=4460 TheFatController] (2010-11)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=326 NOiZE]. (2006-11)

===Legal===
Parts of this mod originate from non-free sources. However, there is an ongoing attempt to find and replace units' models with free ones. [https://springrts.com/phpbb/viewtopic.php?f=44&t=30537 BA Reloaded]

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

Games

2020-06-22T12:16:54Z

Silentwings: /* TA-derived */

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. 

You can download games automatically, using your lobby (see [[Read_Me_First|Read Me First]]). Some games also offer a stand-alone installer.

=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.''
{|-
| <h2>[https://zero-k.info/ Zero-K]</h2>
([https://github.com/ZeroK-RTS/Zero-K/blob/f24c14f31bcd1040e7dce66336ec39fce63b7de9/sounds/music/license.txt CC-BY-NC-ND for music], [https://github.com/ZeroK-RTS/Zero-K/blob/079af01d8781e9785d21e41057d0d67f0c571b12/legal.txt GPL/PD for code and all other assets])
|-
| [[Image:Zero-k_image.jpg|300px|link=https://zero-k.info/]]
| 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. (This game is available via [https://zerok.itch.io/zero-k Itch.io] and [https://store.steampowered.com/app/334920/ZeroK/ Steam].)
|-
| <h2>[https://github.com/spring1944/spring1944/wiki Spring: 1944]</h2>([https://github.com/spring1944/spring1944/blob/1e36bbf93f42018bb9f52af8c3dc3e9ffa9fbeff/docs/License.txt CC-BY-NC])
|-
| [[Image:S44_tigers.jpg|300px|link=http://spring1944.net/]]
| valign="top" | Spring:1944 is a WWII themed game with eight fully functional armies (US, Germany, USSR, Britain, Japan, Italy, Hungary, Sweden), period-accurate units and strengths. Realism comes second only to creating a game that is fun and accessible to play. ([https://spring1944.github.io/ homepage], [https://youtu.be/bg5k4b8Zgsk youtube 1], [https://youtu.be/76jFZvpvwoA youtube 2], [https://springrts.com/phpbb/viewforum.php?f=45 subforum])
|-
| | <h2>[https://www.evolutionrts.info Evolution RTS]</h2>([https://github.com/EvolutionRTS/Evolution-RTS/blob/f8a5df79b384f28fa8705f58df2cd2b580f0c982/license.txt CC-BY-SA])
|-
| [[Image:Evoimg.jpg|300px|link=https://www.evolutionrts.info]]
| 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. (This game is available via [https://forboding-angel.itch.io/evolution-rts Itch.io] and [https://store.steampowered.com/app/291150/Evolution_RTS/ Steam].)
|-
| <h2>[[Kernel Panic]]</h2>([[Kernel_Panic#License:|FOSS]])
|-
| [[Image:Kernel_Panic_3.4.jpg|300px|link=Kernel Panic]]
| 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.
|-
| <h2>[https://springfiles.com/spring/games/edge-1 On The Edge]</h2> (GPL, [https://github.com/PepeAmpere/On-The-Edge/blob/master/README.md CC-BY-NC-SA], [https://github.com/PepeAmpere/On-The-Edge/blob/master/wiki/credits.md etc])
|-
| [[Image:start3.jpg|300px|link=https://springfiles.com/spring/games/edge-1]]
| valign="top" | First Spring MOBA with unique pre-game hero setup. Under heavy development. ([http://springrts.com/phpbb/viewtopic.php?f=55&t=31476 On The Edge forum thread])
|-
| <h2>[http://www.metalfactions.pt Metal Factions]</h2>
([http://www.metalfactions.pt/about.html#license CC-BY-ND, with GPL/PD code])
|-
| [[Image:Mf_spring_wiki.jpg|300px|link=http://www.metalfactions.pt]]
| valign="top" | An evolving game that started as a TA mod and currently features four factions: AVEN, GEAR, CLAW and SPHERE. Commanders can morph to fit into different play styles and be easily revived. Economy scaling is more strictly tied to map control.
|-
| <h2>[https://springrts.com/phpbb/viewtopic.php?f=54&t=23988#p447937 The Cursed]</h2>
([https://springrts.com/phpbb/viewtopic.php?f=54&t=23988&p=566530&hilit=license#p566530 CC-BY-NC-SA])
|-
| [[Image:cursed_logo.jpg|300px|link=http://www.indiedb.com/games/the-cursed]]
| 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. ([https://www.indiedb.com/games/the-cursed homepage], [https://youtu.be/EiBh8l200oo youtube 1], [https://youtu.be/oah7Xt0CgVY youtube 2], [https://springrts.com/phpbb/viewforum.php?f=54 subforum])
|-
| <h2> [https://drive.google.com/file/d/0Bx_Nvv6rzVvgLXJkckpYaDhaOVU/view Journeywar] </h2>
([https://github.com/PicassoCT/Journeywar/blob/97aa399693cd04097367eb5c587eeb590723b700/LICENSE GPLv3])
|-
| [[Image:JwLogo.jpg|300px|link=https://springrts.com/phpbb/viewtopic.php?f=69&t=23275&start=1180#p578989]]
| valign="top" | Journeywar is the final battle between Combine and Exobiotics. Join the fight and rediscover the HL- Universe from a new, strategic perspective. ([https://springrts.com/phpbb/viewtopic.php?f=69&t=23275&start=1220#p588002 dev blog], [https://springrts.com/phpbb/viewforum.php?f=69 subforum])
|}

=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 include large GPL-friendly content collections.''

{|
|-
| <h2>[https://www.moddb.com/games/conflict-terra/tutorials/how-to-start-a-game-of-conflict-terra Conflict Terra]</h2>
|-
| [[Image:CT_Hojos.png|300px|link=http://www.moddb.com/games/conflict-terra]]
| valign="top" | A unique game with heavy emphasis on mobility and featuring Spring's first major "collect and drop-off" economy, Conflict Terra boasts a distinctive art style. Play as one of two factions in an ever-changing battlefield as you struggle to come out on top. ([http://www.moddb.com/games/conflict-terra homepage], [https://github.com/oksnoop2/conflictterra/commit/0e72529194e1ff363c986a43ce3af77d0cf720f7 currently proprietary], [https://github.com/oksnoop2/conflictterra/blob/e4a974c697f425c6ed00f83b1864d64c366da2f1/games/CT/License.txt last known public domain release], [https://springrts.com/phpbb/viewforum.php?f=63 subforum])
|-
| <h2> [https://springrts.com/phpbb/viewforum.php?f=46 Star Wars: Imperial Winter] </h2>
|-
| [[Image:Imperial Winter assault.jpg|300px|link=https://springrts.com/phpbb/viewforum.php?f=46]]
| valign="top" | A Star Wars themed game set in the troubled post-Return of the Jedi era.
|-
| <h2> [https://github.com/SpringMCLegacy/SpringMCLegacy/wiki Spring Mech Commander Legacy Project] </h2>
|-
| [[Image:Spring_Mech_Commander_Legacy_Project.jpg|300px|link=https://github.com/SpringMCLegacy/SpringMCLegacy/wiki]]
| valign="top" | A cool RTS based in the Battletech Universe.
|}

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

{|
|-
|<h2> [https://springrts.com/wiki/Balanced_Annihilation#Links Balanced Annihilation] </h2>
|-
| [[Image:BAScreenShot.jpg|300px]]
| 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.
([https://youtu.be/qeZYghUPU-s youtube], [https://springrts.com/phpbb/viewforum.php?f=44 subforum])

|-
|<h2>[https://springrts.com/phpbb/viewforum.php?f=55 NOTA]</h2>
|-
| [[Image:notAgame02.jpg|300px|link=http://nota.machys.net/]]
| 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. (This game is available via [http://nota.machys.net/downloads its own lobby].)
|-

|-
| <h2> [http://fluidplay.co/taprime TA Prime] </h2>
|-
| [[Image:Taprime site.png|300px|link=http://fluidplay.co/taprime]]
| valign="top" |Highly polished prequel to Total Annihilation, with a full-blown tech tree, unit abilities and a strong rock-paper-scissors countering system similar to C&C games.
|-

|-
| <h2> [https://springrts.com/phpbb/viewforum.php?f=91 Tech Annihilation] </h2>
|-
| [[Image:Tech_Annihilation.png|300px|link=https://springrts.com/phpbb/viewforum.php?f=91]]
| valign="top" |This Game is bigger, greater and more epic! Tech your Commander from a tiny Commander to a Galactic Commander! (currently no homepage)
|-

|-
| <h2> [[XTA]] </h2>
|-
| [[Image:Screen508_s.jpg|300px|link=XTA]]
| 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! Otherwise a lobby such as [[SpringLobby]] will download everything for you when you join a game room.

Games can also be downloaded manually as .sdz/.sd7 files, for example ''BA750'''''.sd7''' or ''XTA'''''.sdz''', and placed into ''...\My Documents\My Games\Spring\Games\'' or ''...\Spring\games\'' folder (''~/.spring/games/'' on Linux/Unix/Mac). Read the advice on [[Read_Me_First|this page]] if your lobby does not find your games.
You may install multiple games in the same engine installation. The same goes for [[Maps]]. Place them into a folder called maps in the same folder where the games folder is.

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]]

Games

2020-06-22T12:16:25Z

Silentwings: /* TA-derived */

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. 

You can download games automatically, using your lobby (see [[Read_Me_First|Read Me First]]). Some games also offer a stand-alone installer.

=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.''
{|-
| <h2>[https://zero-k.info/ Zero-K]</h2>
([https://github.com/ZeroK-RTS/Zero-K/blob/f24c14f31bcd1040e7dce66336ec39fce63b7de9/sounds/music/license.txt CC-BY-NC-ND for music], [https://github.com/ZeroK-RTS/Zero-K/blob/079af01d8781e9785d21e41057d0d67f0c571b12/legal.txt GPL/PD for code and all other assets])
|-
| [[Image:Zero-k_image.jpg|300px|link=https://zero-k.info/]]
| 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. (This game is available via [https://zerok.itch.io/zero-k Itch.io] and [https://store.steampowered.com/app/334920/ZeroK/ Steam].)
|-
| <h2>[https://github.com/spring1944/spring1944/wiki Spring: 1944]</h2>([https://github.com/spring1944/spring1944/blob/1e36bbf93f42018bb9f52af8c3dc3e9ffa9fbeff/docs/License.txt CC-BY-NC])
|-
| [[Image:S44_tigers.jpg|300px|link=http://spring1944.net/]]
| valign="top" | Spring:1944 is a WWII themed game with eight fully functional armies (US, Germany, USSR, Britain, Japan, Italy, Hungary, Sweden), period-accurate units and strengths. Realism comes second only to creating a game that is fun and accessible to play. ([https://spring1944.github.io/ homepage], [https://youtu.be/bg5k4b8Zgsk youtube 1], [https://youtu.be/76jFZvpvwoA youtube 2], [https://springrts.com/phpbb/viewforum.php?f=45 subforum])
|-
| | <h2>[https://www.evolutionrts.info Evolution RTS]</h2>([https://github.com/EvolutionRTS/Evolution-RTS/blob/f8a5df79b384f28fa8705f58df2cd2b580f0c982/license.txt CC-BY-SA])
|-
| [[Image:Evoimg.jpg|300px|link=https://www.evolutionrts.info]]
| 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. (This game is available via [https://forboding-angel.itch.io/evolution-rts Itch.io] and [https://store.steampowered.com/app/291150/Evolution_RTS/ Steam].)
|-
| <h2>[[Kernel Panic]]</h2>([[Kernel_Panic#License:|FOSS]])
|-
| [[Image:Kernel_Panic_3.4.jpg|300px|link=Kernel Panic]]
| 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.
|-
| <h2>[https://springfiles.com/spring/games/edge-1 On The Edge]</h2> (GPL, [https://github.com/PepeAmpere/On-The-Edge/blob/master/README.md CC-BY-NC-SA], [https://github.com/PepeAmpere/On-The-Edge/blob/master/wiki/credits.md etc])
|-
| [[Image:start3.jpg|300px|link=https://springfiles.com/spring/games/edge-1]]
| valign="top" | First Spring MOBA with unique pre-game hero setup. Under heavy development. ([http://springrts.com/phpbb/viewtopic.php?f=55&t=31476 On The Edge forum thread])
|-
| <h2>[http://www.metalfactions.pt Metal Factions]</h2>
([http://www.metalfactions.pt/about.html#license CC-BY-ND, with GPL/PD code])
|-
| [[Image:Mf_spring_wiki.jpg|300px|link=http://www.metalfactions.pt]]
| valign="top" | An evolving game that started as a TA mod and currently features four factions: AVEN, GEAR, CLAW and SPHERE. Commanders can morph to fit into different play styles and be easily revived. Economy scaling is more strictly tied to map control.
|-
| <h2>[https://springrts.com/phpbb/viewtopic.php?f=54&t=23988#p447937 The Cursed]</h2>
([https://springrts.com/phpbb/viewtopic.php?f=54&t=23988&p=566530&hilit=license#p566530 CC-BY-NC-SA])
|-
| [[Image:cursed_logo.jpg|300px|link=http://www.indiedb.com/games/the-cursed]]
| 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. ([https://www.indiedb.com/games/the-cursed homepage], [https://youtu.be/EiBh8l200oo youtube 1], [https://youtu.be/oah7Xt0CgVY youtube 2], [https://springrts.com/phpbb/viewforum.php?f=54 subforum])
|-
| <h2> [https://drive.google.com/file/d/0Bx_Nvv6rzVvgLXJkckpYaDhaOVU/view Journeywar] </h2>
([https://github.com/PicassoCT/Journeywar/blob/97aa399693cd04097367eb5c587eeb590723b700/LICENSE GPLv3])
|-
| [[Image:JwLogo.jpg|300px|link=https://springrts.com/phpbb/viewtopic.php?f=69&t=23275&start=1180#p578989]]
| valign="top" | Journeywar is the final battle between Combine and Exobiotics. Join the fight and rediscover the HL- Universe from a new, strategic perspective. ([https://springrts.com/phpbb/viewtopic.php?f=69&t=23275&start=1220#p588002 dev blog], [https://springrts.com/phpbb/viewforum.php?f=69 subforum])
|}

=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 include large GPL-friendly content collections.''

{|
|-
| <h2>[https://www.moddb.com/games/conflict-terra/tutorials/how-to-start-a-game-of-conflict-terra Conflict Terra]</h2>
|-
| [[Image:CT_Hojos.png|300px|link=http://www.moddb.com/games/conflict-terra]]
| valign="top" | A unique game with heavy emphasis on mobility and featuring Spring's first major "collect and drop-off" economy, Conflict Terra boasts a distinctive art style. Play as one of two factions in an ever-changing battlefield as you struggle to come out on top. ([http://www.moddb.com/games/conflict-terra homepage], [https://github.com/oksnoop2/conflictterra/commit/0e72529194e1ff363c986a43ce3af77d0cf720f7 currently proprietary], [https://github.com/oksnoop2/conflictterra/blob/e4a974c697f425c6ed00f83b1864d64c366da2f1/games/CT/License.txt last known public domain release], [https://springrts.com/phpbb/viewforum.php?f=63 subforum])
|-
| <h2> [https://springrts.com/phpbb/viewforum.php?f=46 Star Wars: Imperial Winter] </h2>
|-
| [[Image:Imperial Winter assault.jpg|300px|link=https://springrts.com/phpbb/viewforum.php?f=46]]
| valign="top" | A Star Wars themed game set in the troubled post-Return of the Jedi era.
|-
| <h2> [https://github.com/SpringMCLegacy/SpringMCLegacy/wiki Spring Mech Commander Legacy Project] </h2>
|-
| [[Image:Spring_Mech_Commander_Legacy_Project.jpg|300px|link=https://github.com/SpringMCLegacy/SpringMCLegacy/wiki]]
| valign="top" | A cool RTS based in the Battletech Universe.
|}

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

{|
|-
|<h2> [https://springrts.com/wiki/Balanced_Annihilation#Links Balanced Annihilation] </h2>
|-
| [[Image:BAScreenShot.jpg|300px|link=https://balancedannihilation.com]]
| 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.
([https://youtu.be/qeZYghUPU-s youtube], [https://springrts.com/phpbb/viewforum.php?f=44 subforum])

|-
|<h2>[https://springrts.com/phpbb/viewforum.php?f=55 NOTA]</h2>
|-
| [[Image:notAgame02.jpg|300px|link=http://nota.machys.net/]]
| 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. (This game is available via [http://nota.machys.net/downloads its own lobby].)
|-

|-
| <h2> [http://fluidplay.co/taprime TA Prime] </h2>
|-
| [[Image:Taprime site.png|300px|link=http://fluidplay.co/taprime]]
| valign="top" |Highly polished prequel to Total Annihilation, with a full-blown tech tree, unit abilities and a strong rock-paper-scissors countering system similar to C&C games.
|-

|-
| <h2> [https://springrts.com/phpbb/viewforum.php?f=91 Tech Annihilation] </h2>
|-
| [[Image:Tech_Annihilation.png|300px|link=https://springrts.com/phpbb/viewforum.php?f=91]]
| valign="top" |This Game is bigger, greater and more epic! Tech your Commander from a tiny Commander to a Galactic Commander! (currently no homepage)
|-

|-
| <h2> [[XTA]] </h2>
|-
| [[Image:Screen508_s.jpg|300px|link=XTA]]
| 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! Otherwise a lobby such as [[SpringLobby]] will download everything for you when you join a game room.

Games can also be downloaded manually as .sdz/.sd7 files, for example ''BA750'''''.sd7''' or ''XTA'''''.sdz''', and placed into ''...\My Documents\My Games\Spring\Games\'' or ''...\Spring\games\'' folder (''~/.spring/games/'' on Linux/Unix/Mac). Read the advice on [[Read_Me_First|this page]] if your lobby does not find your games.
You may install multiple games in the same engine installation. The same goes for [[Maps]]. Place them into a folder called maps in the same folder where the games folder is.

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]]

Balanced Annihilation

2020-06-22T12:13:42Z

Silentwings: /* Links */

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

[[Image:BA.gif|very epic tmp img of BA]]

===Links===
* [https://springrts.com/phpbb/viewforum.php?f=44 BA subforum]
* [https://github.com/Balanced-Annihilation/Balanced-Annihilation Game Source Repository]

===Overview===
Balanced Annihilation was the long-term most popular game based at the Spring engine.
It's based at three basic principles:
* '''Refined [[OTA | Original Total Annihilation]]:''' BA's lineage traces back to fan mods of the original Total Annihilation. It feels similar, and play is ''more balanced'' for diverse multiplayer strategies.

* '''Stable gameplay:''' Balanced Annihilation has matured through several years of playtesting. New versions don't drastically alter the gameplay.

* '''Balance:''' Every unit has a role, and no unit has every role. Very few units get truly obsolete as a game progresses. The ideal state is to have no obsolete units at all.

===History===
Balanced Annihilation mod started as a fork of [[Absolute Annihilation]] 2.23 in the end of 2006. The community split in 2019 and shortly afterwards Floris (2016-19) resigned as maintainer. The previous maintainers, who shouldn't be forgotten, were
* [teh]Decay (2016)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=7229 Silentwings] (2012-16)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=5958 Beherith] (2011-12)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=7403 Niobium] (2011)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=4460 TheFatController] (2010-11)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=326 NOiZE]. (2006-11)
The [https://github.com/Balanced-Annihilation/Balanced-Annihilation github repository] that remains is owned by ShoX.

===Legal===
Parts of this mod originate from non-free sources. However, there is an ongoing attempt to find and replace units' models with free ones. [https://springrts.com/phpbb/viewtopic.php?f=44&t=30537 BA Reloaded]

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

Balanced Annihilation

2020-06-22T12:13:00Z

Silentwings: history...

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

[[Image:BA.gif|very epic tmp img of BA]]

===Links===
* [https://balancedannihilation.com/ Official BA website]
* [https://springrts.com/phpbb/viewforum.php?f=44 BA subforum]
* [https://github.com/Balanced-Annihilation/Balanced-Annihilation Game Source Repository]

===Overview===
Balanced Annihilation was the long-term most popular game based at the Spring engine.
It's based at three basic principles:
* '''Refined [[OTA | Original Total Annihilation]]:''' BA's lineage traces back to fan mods of the original Total Annihilation. It feels similar, and play is ''more balanced'' for diverse multiplayer strategies.

* '''Stable gameplay:''' Balanced Annihilation has matured through several years of playtesting. New versions don't drastically alter the gameplay.

* '''Balance:''' Every unit has a role, and no unit has every role. Very few units get truly obsolete as a game progresses. The ideal state is to have no obsolete units at all.

===History===
Balanced Annihilation mod started as a fork of [[Absolute Annihilation]] 2.23 in the end of 2006. The community split in 2019 and shortly afterwards Floris (2016-19) resigned as maintainer. The previous maintainers, who shouldn't be forgotten, were
* [teh]Decay (2016)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=7229 Silentwings] (2012-16)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=5958 Beherith] (2011-12)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=7403 Niobium] (2011)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=4460 TheFatController] (2010-11)
* [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=326 NOiZE]. (2006-11)
The [https://github.com/Balanced-Annihilation/Balanced-Annihilation github repository] that remains is owned by ShoX.

===Legal===
Parts of this mod originate from non-free sources. However, there is an ongoing attempt to find and replace units' models with free ones. [https://springrts.com/phpbb/viewtopic.php?f=44&t=30537 BA Reloaded]

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

Games

2020-06-22T11:56:15Z

Silentwings: /* TA-derived */

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. 

You can download games automatically, using your lobby (see [[Read_Me_First|Read Me First]]). Some games also offer a stand-alone installer.

=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.''
{|-
| <h2>[https://zero-k.info/ Zero-K]</h2>
([https://github.com/ZeroK-RTS/Zero-K/blob/f24c14f31bcd1040e7dce66336ec39fce63b7de9/sounds/music/license.txt CC-BY-NC-ND for music], [https://github.com/ZeroK-RTS/Zero-K/blob/079af01d8781e9785d21e41057d0d67f0c571b12/legal.txt GPL/PD for code and all other assets])
|-
| [[Image:Zero-k_image.jpg|300px|link=https://zero-k.info/]]
| 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. (This game is available via [https://zerok.itch.io/zero-k Itch.io] and [https://store.steampowered.com/app/334920/ZeroK/ Steam].)
|-
| <h2>[https://github.com/spring1944/spring1944/wiki Spring: 1944]</h2>([https://github.com/spring1944/spring1944/blob/1e36bbf93f42018bb9f52af8c3dc3e9ffa9fbeff/docs/License.txt CC-BY-NC])
|-
| [[Image:S44_tigers.jpg|300px|link=http://spring1944.net/]]
| valign="top" | Spring:1944 is a WWII themed game with eight fully functional armies (US, Germany, USSR, Britain, Japan, Italy, Hungary, Sweden), period-accurate units and strengths. Realism comes second only to creating a game that is fun and accessible to play. ([https://spring1944.github.io/ homepage], [https://youtu.be/bg5k4b8Zgsk youtube 1], [https://youtu.be/76jFZvpvwoA youtube 2], [https://springrts.com/phpbb/viewforum.php?f=45 subforum])
|-
| | <h2>[https://www.evolutionrts.info Evolution RTS]</h2>([https://github.com/EvolutionRTS/Evolution-RTS/blob/f8a5df79b384f28fa8705f58df2cd2b580f0c982/license.txt CC-BY-SA])
|-
| [[Image:Evoimg.jpg|300px|link=https://www.evolutionrts.info]]
| 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. (This game is available via [https://forboding-angel.itch.io/evolution-rts Itch.io] and [https://store.steampowered.com/app/291150/Evolution_RTS/ Steam].)
|-
| <h2>[[Kernel Panic]]</h2>([[Kernel_Panic#License:|FOSS]])
|-
| [[Image:Kernel_Panic_3.4.jpg|300px|link=Kernel Panic]]
| 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.
|-
| <h2>[https://springfiles.com/spring/games/edge-1 On The Edge]</h2> (GPL, [https://github.com/PepeAmpere/On-The-Edge/blob/master/README.md CC-BY-NC-SA], [https://github.com/PepeAmpere/On-The-Edge/blob/master/wiki/credits.md etc])
|-
| [[Image:start3.jpg|300px|link=https://springfiles.com/spring/games/edge-1]]
| valign="top" | First Spring MOBA with unique pre-game hero setup. Under heavy development. ([http://springrts.com/phpbb/viewtopic.php?f=55&t=31476 On The Edge forum thread])
|-
| <h2>[http://www.metalfactions.pt Metal Factions]</h2>
([http://www.metalfactions.pt/about.html#license CC-BY-ND, with GPL/PD code])
|-
| [[Image:Mf_spring_wiki.jpg|300px|link=http://www.metalfactions.pt]]
| valign="top" | An evolving game that started as a TA mod and currently features four factions: AVEN, GEAR, CLAW and SPHERE. Commanders can morph to fit into different play styles and be easily revived. Economy scaling is more strictly tied to map control.
|-
| <h2>[https://springrts.com/phpbb/viewtopic.php?f=54&t=23988#p447937 The Cursed]</h2>
([https://springrts.com/phpbb/viewtopic.php?f=54&t=23988&p=566530&hilit=license#p566530 CC-BY-NC-SA])
|-
| [[Image:cursed_logo.jpg|300px|link=http://www.indiedb.com/games/the-cursed]]
| 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. ([https://www.indiedb.com/games/the-cursed homepage], [https://youtu.be/EiBh8l200oo youtube 1], [https://youtu.be/oah7Xt0CgVY youtube 2], [https://springrts.com/phpbb/viewforum.php?f=54 subforum])
|-
| <h2> [https://drive.google.com/file/d/0Bx_Nvv6rzVvgLXJkckpYaDhaOVU/view Journeywar] </h2>
([https://github.com/PicassoCT/Journeywar/blob/97aa399693cd04097367eb5c587eeb590723b700/LICENSE GPLv3])
|-
| [[Image:JwLogo.jpg|300px|link=https://springrts.com/phpbb/viewtopic.php?f=69&t=23275&start=1180#p578989]]
| valign="top" | Journeywar is the final battle between Combine and Exobiotics. Join the fight and rediscover the HL- Universe from a new, strategic perspective. ([https://springrts.com/phpbb/viewtopic.php?f=69&t=23275&start=1220#p588002 dev blog], [https://springrts.com/phpbb/viewforum.php?f=69 subforum])
|}

=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 include large GPL-friendly content collections.''

{|
|-
| <h2>[https://www.moddb.com/games/conflict-terra/tutorials/how-to-start-a-game-of-conflict-terra Conflict Terra]</h2>
|-
| [[Image:CT_Hojos.png|300px|link=http://www.moddb.com/games/conflict-terra]]
| valign="top" | A unique game with heavy emphasis on mobility and featuring Spring's first major "collect and drop-off" economy, Conflict Terra boasts a distinctive art style. Play as one of two factions in an ever-changing battlefield as you struggle to come out on top. ([http://www.moddb.com/games/conflict-terra homepage], [https://github.com/oksnoop2/conflictterra/commit/0e72529194e1ff363c986a43ce3af77d0cf720f7 currently proprietary], [https://github.com/oksnoop2/conflictterra/blob/e4a974c697f425c6ed00f83b1864d64c366da2f1/games/CT/License.txt last known public domain release], [https://springrts.com/phpbb/viewforum.php?f=63 subforum])
|-
| <h2> [https://springrts.com/phpbb/viewforum.php?f=46 Star Wars: Imperial Winter] </h2>
|-
| [[Image:Imperial Winter assault.jpg|300px|link=https://springrts.com/phpbb/viewforum.php?f=46]]
| valign="top" | A Star Wars themed game set in the troubled post-Return of the Jedi era.
|-
| <h2> [https://github.com/SpringMCLegacy/SpringMCLegacy/wiki Spring Mech Commander Legacy Project] </h2>
|-
| [[Image:Spring_Mech_Commander_Legacy_Project.jpg|300px|link=https://github.com/SpringMCLegacy/SpringMCLegacy/wiki]]
| valign="top" | A cool RTS based in the Battletech Universe.
|}

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

{|
|-
|<h2> [https://springrts.com/phpbb/viewforum.php?f=44 Balanced Annihilation] </h2>
|-
| [[Image:BAScreenShot.jpg|300px|link=https://balancedannihilation.com]]
| 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.
([https://youtu.be/qeZYghUPU-s youtube], [https://springrts.com/phpbb/viewforum.php?f=44 subforum])

|-
|<h2>[https://springrts.com/phpbb/viewforum.php?f=55 NOTA]</h2>
|-
| [[Image:notAgame02.jpg|300px|link=http://nota.machys.net/]]
| 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. (This game is available via [http://nota.machys.net/downloads its own lobby].)
|-

|-
| <h2> [http://fluidplay.co/taprime TA Prime] </h2>
|-
| [[Image:Taprime site.png|300px|link=http://fluidplay.co/taprime]]
| valign="top" |Highly polished prequel to Total Annihilation, with a full-blown tech tree, unit abilities and a strong rock-paper-scissors countering system similar to C&C games.
|-

|-
| <h2> [https://springrts.com/phpbb/viewforum.php?f=91 Tech Annihilation] </h2>
|-
| [[Image:Tech_Annihilation.png|300px|link=https://springrts.com/phpbb/viewforum.php?f=91]]
| valign="top" |This Game is bigger, greater and more epic! Tech your Commander from a tiny Commander to a Galactic Commander! (currently no homepage)
|-

|-
| <h2> [[XTA]] </h2>
|-
| [[Image:Screen508_s.jpg|300px|link=XTA]]
| 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! Otherwise a lobby such as [[SpringLobby]] will download everything for you when you join a game room.

Games can also be downloaded manually as .sdz/.sd7 files, for example ''BA750'''''.sd7''' or ''XTA'''''.sdz''', and placed into ''...\My Documents\My Games\Spring\Games\'' or ''...\Spring\games\'' folder (''~/.spring/games/'' on Linux/Unix/Mac). Read the advice on [[Read_Me_First|this page]] if your lobby does not find your games.
You may install multiple games in the same engine installation. The same goes for [[Maps]]. Place them into a folder called maps in the same folder where the games folder is.

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]]

CEG:Defs

2020-05-13T14:35:13Z

Silentwings: /* Overall Format */

= CEG Definitions =

==Source==
The engine source code which loads the tags from these files is viewable here:

* {{sourcelink|file=rts/Sim/Projectiles/}}
* {{sourcelink|file=rts/Sim/Projectiles/Unsynced/}}
* {{sourcelink|file=rts/Rendering/GroundFlash.cpp}}

== Data Types ==
CEGs use the following data types:
{{DataTypes}}

You can use [[CEG:Operators]] to define floats that are not fixed.

== CEG Textures ==

* Textures on CEG definitions are referenced by name.
* The list of available textures and their names should be in [[resources.lua]]
* Texture definitions to be used in projectile classes should be placed within the <code>projectiletextures</code> category and textures to be used with [[#CSimpleGroundFlash]] class should be placed within the <code>groundfx</code> category.
* Texture images are usually placed in the "bitmaps" subfolder.

== Overall Format ==

A CEG file contains one or more CEGs. Each CEG follows this format:

<pre>
return {
["ceg_name"] = {
-- EXPLOSION LEVEL
useDefaultExplosions = false,

spawner1_name = {
-- SPAWNER LEVEL
class = "CClassName",
count = 1,
air = true,
ground = true,
water = true,
properties = {
-- CLASS LEVEL
},
},
},
spawner2_name = {
-- SPAWNER LEVEL
-- each spawner follows the above format
},
groundflash = {
-- groundflash is a special spawner name; it always generates a CStandardGroundFlash
-- CStandardGroundFlash properties
},
-- other special spawner names exist, although their use is discouraged in favour of class="CSomeClass"
-- see https://github.com/spring/spring/blob/develop/cont/base/springcontent/gamedata/explosion_alias.lua#L61
},
}
</pre>

== Explosion Level Tags ==
{{tag
|name = useDefaultExplosions
|type = bool
|default = false
|description = If this is set, the CEG will use the default explosion (based on damage and area of effect) in addition to any spawners you define. The default explosions are sometimes very performance heavy, especially for large damage values (leading to higher particle counts).
}}

== Spawner Level Tags ==
A CEG can contain any number of spawners. The name of the spawners don't really matter, as long as it's not <code>groundflash</code>, which has a special meaning. You can think of each spawner as being one component of the overall explosion.

{{tag
|name = class
|type = string
|default = spawner_name
|description = Each spawner has a class that determines what kind of graphical effect it creates. Spring has a number of standard classes that you can choose from. Currently available classes are:
* [[#CExpGenSpawner|CExpGenSpawner]]
* [[#CBitmapMuzzleFlame|CBitmapMuzzleFlame]]
* [[#CExploSpikeProjectile|CExploSpikeProjectile]]
* [[#CHeatCloudProjectile|CHeatCloudProjectile]]
* [[#CSimpleParticleSystem|CSimpleParticleSystem]]
* [[#CSpherePartSpawner|CSpherePartSpawner]]
* [[#CSimpleGroundFlash|CSimpleGroundFlash]]
* [[#CStandardGroundFlash|CStandardGroundFlash]]
}}

{{tag
|name = count
|type = int
|default = 1
|description = The count determines the number of times the spawner will run.
}}

=== Visibility Conditions ===
These determine under what conditions the spawner will run. If you set the condition to true, the spawner will run if the explosion takes place under that condition. If you set more than one condition, the spawner will run if ''any'' of them are true. If you want a spawner to run only if two or more conditions are ''all'' true, you have to do a little trick with the [[#CExpGenSpawner]] class as explained in "suggested use".

{{tag
|name = air
|type = bool
|default = false
|description = The CEG will run if at least 20 [[elmo]]s above ground/sea level.
}}

{{tag
|name = water
|type = bool
|default = false
|description = The CEG will run if in water to a depth of -5 [[elmo]]s.
}}

{{tag
|name = underwater
|type = bool
|default = false
|description = The CEG will run if under water deeper than 5 [[elmo]]s.
}}

{{tag
|name = ground
|type = bool
|default = false
|description = The CEG will run if less than 20 [[elmo]]s above ground.
}}

{{tag
|name = unit
|type = bool
|default = false
|description = The CEG will run if the weapon hits a unit.
}}

{{tag
|name = nounit
|type = bool
|default = false
|description = The CEG will run if the weapon does not hit a unit.
}}

== Class Level Tags ==
=== Common Properties ===
All classes have the following properties, although not all of them use them:

{{tag
|name = alwaysVisible
|type = bool
|default = false
|description = If true, the spawner is always visible, ignoring LoS. Note that prior to 98.0 this did not work correctly.
}}

{{tag
|name = useAirLos
|type = bool
|default = false
|description = Whether the spawner uses air LoS to determine if it is visible. This may allow the spawner to be seen from a further distance than normal.
}}

{{tag
|name = pos
|type = float[3]
|default = {0.0, 0.0, 0.0}
|description = The initial position vector of the spawner.
}}

{{tag
|name = speed
|type = float[3]
|default = {0.0, 0.0, 0.0}
|description = The initial speed vector of the spawner.
}}

{{tag
|name = dir
|type = float[3]
|description = The initial direction vector of the spawner.
}}

=== CExpGenSpawner ===
This is the closest thing CEG has to a function call. Instead of creating a graphical effect on its own, it creates another CEG.

==== Suggested Use ====
* If you use a spawner a lot of times, you may want to make it a separate CEG to avoid having to copy-paste many times.
* This is the only way to truly delay a graphical effect.
* The spawned CEG still checks conditions, so if you want to, say, spawn an effect only if it is in water ''and'' doesn't hit a unit, you can give the CExpGenSpawner <code>nounit = 1;</code> and the spawned <code>CEG water = 1;</code>.
* This allows you to give a set of spawners the same (and possibly random) direction.
* You can animate an explosion flip-book style using delays and several bitmaps.

==== Properties ====

{{tag
|name = delay
|type = int
|default = 1
|description = How long to wait (in frames?) before spawning the CEG.
}}

{{tag
|name = damage
|type = float
|default = 0.0
|description = The CEG will be called with this damage. The CEG doesn't actually deal any damage, but you can use this as a parameter and read it using the [[CEG:Operators#Damage_.28.27d.27.29|'d' operator]].
}}

{{tag
|name = explosionGenerator
|type = string
|default = ""
|description = The name of the CEG you want to spawn.
}}

=== CBitmapMuzzleFlame ===
This creates three rectangular textures at right angles to each other. The {{taglink|frontTexture}} has {{taglink|dir}} as its normal.

==== Suggested Use ====
*Muzzle flames, obviously.
*You can use an upward-pointing CBitmapMuzzleFlame as a simple splash of water or dirt.
*Railgun trails.
*This is the only class that both obeys perspective and allows for a custom texture.

==== Properties ====

{{tag
|name = sideTexture
|type = string
|default = ""
|description = Texture as viewed from the side.
}}

{{tag
|name = frontTexture
|type = string
|default = ""
|description = Texture as viewed from the front.
}}

{{tag
|name = colorMap
|type = string
|default = ""
|description = See [[CColorMap]].
}}

{{tag
|name = size
|type = float
|default = 0.0
|description = The initial width of the muzzle flame.
}}

{{tag
|name = length
|type = float
|default = 0.0
|description = The initial length of the muzzle flame.
}}

{{tag
|name = sizeGrowth
|type = float
|default = 0.0
|description = By the end of its life, the muzzle flame grows to <code>1 + sizeGrowth</code> times its initial {{taglink|size}} and {{taglink|length}}. The flame grows quickly at first and more slowly toward the end.
}}

{{tag
|name = ttl
|type = int
|default = 0
|description = How long the muzzle flame lasts.
}}

{{tag
|name = frontOffset
|type = float
|default = 0.0
|description = Where the frontTexture is along the length of the muzzle flame. <code>0</code> means it is in the back, <code>1</code> is in the front.
}}

=== CExploSpikeProjectile ===

This creates a glowy spike. Note that the spike is two sided, i.e., symmetric about the position of the spawner.

==== Suggested Use ====
* Anything glowy.
* For large, slow missiles, you can try using this as an extended engine flame. Set the width to something fairly large.
* Long and thin spikes will look spiky; meanwhile, shorter and wider spikes look more blobby.
* The colors of spikes add together, so if you have several spikes and all three color channels are non-zero, it will be white in the center.
* The length growth of the spike depends on the norm of the dir vector. The spike does not grow in width.

==== Properties ====
{{tag
|name = length
|type = float
|default = 0.0
|description = The initial length of (half) of the spike (multiplied by {{taglink|dir}}).
}}

{{tag
|name = lengthGrowth
|type = float
|default = dir.Length() * (0.5 + RandFloat() * 0.4)
|description = How much the length increases by per update.
}}

{{tag
|name = width
|type = float
|default = 0.0
|description = Half the initial width of of the spike. This is an absolute value.
}}

{{tag
|name = alpha
|type = float
|default = 0.0
|description = The starting alpha of the spike.
}}

{{tag
|name = alphaDecay
|type = float
|default = 0.0
|description = How quickly the alpha of the spike decreases.
}}

{{tag
|name = color
|type = rgb
|default = {1.0, 0.8, 0.5}
|description = The color of the spike.
}}

=== CHeatCloudProjectile ===

Creates an expanding sprite. Simple but effective.

==== Suggested Use ====
* As the main background to an explosion.

==== Properties ====
{{tag
|name = heat
|type = float
|default = 0.0
|description = Used in alpha calculations. See {{taglink|heatFalloff}}.
}}

{{tag
|name = maxheat
|type = float
|default = 0.0
|description = Used in alpha calculations. See {{taglink|heatFalloff}}.
}}

{{tag
|name = heatFalloff
|type = float
|default = 0.0
|description = This is really confusing way of representing alpha and alphaDecay. Basically <code>alpha = </code>{{taglink|heat}}<code>/</code>{{taglink|maxheat}}, and <code>alphaDecay = </code>{{taglink|heatFalloff}}<code>/</code>{{taglink|maxHeat}}.
}}

{{tag
|name = size
|type = float
|default = 0.0
|description = The initial radius of the heatcloud.
}}

{{tag
|name = sizeGrowth
|type = float
|default = 0.0
|description = The heatcloud grows by this amount every frame.
}}

{{tag
|name = sizeMod
|type = float
|default = 0.0
|description = The size of the heatcloud is multiplied by <code>1 - sizeMod</code>.
}}

{{tag
|name = sizeModMod
|type = float
|default = 0.0
|description = Each frame, {{taglink|sizeMod}} is multiplied by {{taglink|sizeModMod}}.
}}

{{tag
|name = texture
|type = string
|default = "heatcloud" as referenced in [[resources.lua]]
|description = The texture used for the heatcloud.
}}

=== CSimpleParticleSystem ===

Creates a sprite that can undergo complex motion. Probably the most versatile class.

==== Suggested Use ====
* Anything moving that is not doing so at constant velocity.
* If you want something that expands (or shrinks) to some size then stops, set {{taglink|sizeMod}} to something less than <code>1</code>, and {{taglink|sizeGrowth}} to something positive. The particle will grow to a size equal to <code>sizeGrowth / (1 - sizeMod)</code> and stop. The smaller {{taglink|sizeMod}} is, the faster it will reach this size.

==== Properties ====
===== Initial Velocity Properties =====
{{tag
|name = emitVector
|type = float[3]
|default = {0.0, 0.0, 0.0}
|description = The initial direction vector in which the particle is emitted. When spawning CEGs via EmitSfx you can make the particles go into the direction of the emiting piece with {{taglink|emitvector|dir}}. This is useful for e.g. fire coming out of a gun barrel.
}}

{{tag
|name = emitRot
|type = float
|default = 0.0
|description = At what angle to emit the particle relative to {{taglink|emitVector}}. <code>0</code> means that the particle will be emitted in {{taglink|emitVector}}'s direction; <code>180</code> will emit the particle in the opposite direction. <code>90</code> will emit the particle in a random direction perpendicular to {{taglink|emitVector}}, which is good for creating rings.
}}

{{tag
|name = emitRotSpread
|type = float
|default = 0.0
|description = For each particle, a random number between <code>0</code> and {{taglink|emitRotSpread}} is added to the {{taglink|emitRot}}.
}}

{{tag
|name = emitMul
|type = float[3]
|default = {1.0, 1.0, 1.0}
|description = Scales the initial particle velocity; for this property, +y is considered to be in the direction of {{taglink|emitVector}}. Good if you want to create an egg-shaped explosion.
}}

{{tag
|name = particleSpeed
|type = float
|default = 0.0
|description = The particle's initial speed.
}}

{{tag
|name = particleSpeedSpread
|type = float
|default = 0.0
|description = For each particle, a random number between <code>0</code> and {{taglink|particleSpeedSpread}} is added to the {{taglink|particleSpeed}}.
}}

===== Movement Properties =====

{{tag
|name = gravity
|type = float[3]
|default = {0.0, 0.0, 0.0}
|description = This will be added to the particle's velocity every frame.
}}

{{tag
|name = airdrag
|type = float
|default = 0.0
|description = The particle's velocity is multiplied by this every frame.
}}

===== Size Properties =====

{{tag
|name = particleSize
|type = float
|default = 0.0
|description = The initial size of the particle.
}}

{{tag
|name = particleSizeSpread
|type = float
|default = 0.0
|description = For each particle, a random number between <code>0</code> and {{taglink|particleSizeSpread}} is added to the {{taglink|particleSize}}.
}}

{{tag
|name = sizeGrowth
|type = float
|default = 0.0
|description = How much the particle grows each frame.
}}

{{tag
|name = sizeMod
|type = float
|default = 0.0
|description = The size of the particle is multiplied by this each frame.
}}

===== Visual Properties =====

{{tag
|name = directional
|type = bool
|default = false
|description = If true, the particle will point in the direction it is moving.
}}

{{tag
|name = texture
|type = string
|default = ""
|description = The texture to use for the particle.
}}

{{tag
|name = colorMap
|type = string
|default = ""
|description = See [[CColorMap]].
}}

===== Life Properties =====

{{tag
|name = numParticles
|type = int
|default = 0
|description = How many particles to create. This is not the same as <code>count</code>; if you spawn multiple particles using <code>count</code>, any [[CEG:Operators]] will be re-evaluated for each particle, whereas if you use {{taglink|numParticles}} they will not be. However, the spread properties are evaluated separately for each particle regardless of which one you use.
}}

{{tag
|name = particleLife
|type = float
|default = 0.0
|description = How long each particle lasts.
}}

{{tag
|name = particleLifeSpread
|type = float
|default = 0.0
|description = For each particle, a random number between <code>0</code> and {{taglink|particleLifeSpread}} is added to the {{taglink|particleLife}}.
}}

=== CSpherePartSpawner ===

Draws an expanding sphere.

==== Suggested Use ====
*Looks like a shockwave.

==== Properties ====

{{tag
|name = alpha
|type = float
|default = 0.0
|description = The alpha of the sphere.
}}

{{tag
|name = ttl
|type = int
|default = 0
|description = Time to live, in frames(?).
}}

{{tag
|name = expansionSpeed
|type = float
|default = 0.0
|description = How quickly the sphere expands.
}}

{{tag
|name = color
|type = rgb
|default = {0.0, 0.0, 0.0}
|description = The color of the sphere.
}}

=== CSimpleGroundFlash ===

Draws an expanding ground texture.

==== Suggested Use ====
* A short groundflash (~8 frames) is good for any explosion that gives off light. You can also use a longer groundflash to suggest the ground is glowing from heat.

==== Properties ====

{{tag
|name = size
|type = float
|default = 0.0
|description = The radius of the particle.
}}

{{tag
|name = sizeGrowth
|type = float
|default = 0.0
|description = How much the particle grows each frame.
}}

{{tag
|name = ttl
|type = int
|default = 0
|description = Time to live, in frames(?).
}}

{{tag
|name = texture
|type = string
|default = ""
|description = The texture to use for the particle.
}}

{{tag
|name = colorMap
|type = string
|default = ""
|description = See [[CColorMap]].
}}

=== CStandardGroundFlash ===
If you name a spawner "groundflash," it will always generate a standard groundflash.

==== Suggested Use ====
A short groundflash (~8 frames) is good for any explosion that gives off light. You can also use a longer groundflash to suggest the ground is glowing from heat.

==== Properties ====

{{tag
|name = flashSize
|type = float
|default = 0.0
|description = The radius of the groundflash.
}}

{{tag
|name = flashAlpha
|type = float
|range = [0, 1]
|default = 0.0
|description = How transparent the groundflash is. Generally the higher the brighter.
}}

{{tag
|name = circleGrowth
|type = float
|default = 0.0
|description = A groundflash can have an additional circle that expands outwards. This controls how fast the circle grows.
}}

{{tag
|name = circleAlpha
|type = float
|range = [0, 1]
|default = 0.0
|description = How transparent the circle is.
}}

{{tag
|name = ttl
|type = int
|default = 0
|description = How long the groundflash lasts.
}}

{{tag
|name = color
|type = rgb
|default = {1.0, 1.0, 0.8}
|description = The color of the groundflash.
}}

=== CSmokeProjectile2 ===
( {{FIXME}} newly added to wiki. someone cross-check then remove this note )

Particles that begin with a hard-coded yellow-red colorfade and then fade to monochrom. (shades of grey)

Movement is influenced by the random wind.
Finer details of visual and position update are best explained by looking at the formulas in <code>CSmokeProjectile2::Update() & CSmokeProjectile2::Draw()</code>

==== Suggested Use ====
Smoke. Smokestacks, rocket exhaust, burning wreckage,...

For a nicer stream of smoke spawn it frequently over multiple frames, otherwise it looks rather bland.

==== Properties ====
{{tag
|name = color
|type = float
|default = 0.5
|description = How dark the final monochrom color of a particle is. 0 is black.
(Use >1 for slightly bugged funnies, like slightly non-monochrome colors or interessting black/white changes.)
}}

{{tag
|name = size
|type = float
|default = 0.0
|description = Size of a particle.
}}

{{tag
|name = ageSpeed
|type = float
|default = 0.5
|description = How fast the particle ages. Every frame: <code>age += ageSpeed</code> The particle is deleted at <code>if (age > 1)</code>
}}

{{tag
|name = glowFalloff
|type = float
|default = 0.0
|description = How fast the particle fades to monochrom.
}}

{{tag
|name = wantedPos
|type = float3
|default = "0,0,0"
|description = In which direction the smoke tends to drift. Less effective in y-coordinate and influenced by random wind.
}}

{{tag
|name = speed
|type = float3
|default = "0,0,0"
|description = <code>wantedPos += speed;</code> How fast and in which vector the particles move.
}}

{{tag
|name = texture
|type = hardcoded
|default = randomly chosen.
|description = Particles randomly pick one of the smoke textures (bitmaps\smoke) and remain with it until death.
}}

=== CSmokeProjectile ===
Monochrome particles that fade out.
A more "primitive" version of CSmokeProjectile2.
No hardcoded red-yellow start but it misses wantedPos to tweak the look a bit more detailed.

==== Suggested Use ====
Smoke.
For a nicer stream of smoke spawn it frequently over multiple frames, otherwise it looks rather bland.

==== Properties ====
{{tag
|name = color
|type = float
|default = 0.5
|description = Brightness of the particle. 0 is black.
}}

{{tag
|name = size
|type = float
|default = 0.0
|description = Size of a particle
}}

{{tag
|name = ageSpeed
|type = float
|default = 0.5
|description = How fast the particle ages. Every frame: <code>age += ageSpeed</code> The particle is deleted at <code>if (age > 1)</code>
}}

{{tag
|name = speed
|type = float3
|default = "0,0,0"
|description = <code>pos += speed;</code> How fast and in which vector the particles move.
}}

{{tag
|name = texture
|type = hardcoded
|default = randomly chosen.
|description = Particles randomly pick one of the smoke textures (bitmaps\smoke) and remain with it until death.
}}

==Examples==


[http://imolarpg.dyndns.org/trac/balatest/browser/trunk/gamedata/explosions 'Balanced Annihilation' CEGs] (TDF format)

[http://code.google.com/p/conflictterra/source/browse/#svn%2Fgames%2FCT%2Fgamedata%2Fexplosions 'Conflict Terra' CEGs]

[https://github.com/EvolutionRTS/Evolution-RTS/tree/master/Gamedata/explosions 'Evolution RTS' CEGs]

[https://github.com/imperialwinter/swiw.sdd/tree/master/gamedata/explosions 'Imperial Winter' CEGs] (TDF format)

[http://code.google.com/p/journeywar/source/browse/#svn%2Ftrunk%2Fgamedata%2Fexplosions 'Journeywar' CEGs]

[http://sourceforge.net/p/mwspring/code/HEAD/tree/effects/ 'MechCommander: Legacy' CEGs] (TDF format)

[https://github.com/spring1944/spring1944/tree/master/effects 'Spring: 1944' CEGs] (TDF format)

[http://code.google.com/p/springtutorialgame/source/browse/#svn%2Ftrunk%2FSpringTutorialGame.sdd%2FGamedata%2Fexplosions 'Spring Tutorial Game' CEGs]

[http://code.google.com/p/xta-springrts/source/browse/#svn%2Ftrunk%2Fgamedata%2Fexplosions 'XTA' CEGs] (TDF format)

[https://github.com/ZeroK-RTS/Zero-K/tree/master/effects 'ZeroK' CEGs]

[[Category:CEG]]

Data Usage

2020-04-26T13:57:28Z

Silentwings: /* Data and usage of data */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

==Data and usage of data==

The SpringRTS server (springrts.com) and its managed infrastructure process and retain information generated by users:

<ol style="list-style-type:upper-alpha">
<li>
Registration & login details: email address, IP address, chosen username, (hashed) password.
</li>
<li>
Actions taking place via Springs infrastructure: chat, games played by users and all associated ingame commands, hardware and connectivity information characterizing suitability to play such games, client software used, IP addresses of battle hosts; and derived statistics of these data. This data is divided into two types:
<ol style="list-style-type:decimal">
<li> Data created in publicly accessible contexts, such as non-passworded chat channels and battle hosts. </li>
<li> Data created in private contexts, such as private messages, passworded chat channels and passworded battle hosts. </li>
</ol>
<li>
Source files, artwork and other content relating to games and development of games.
</li>
</ol>
This data is used to provide services that would normally be expected from an online gaming platform, primarily:
# '''Publicly available replays of games''' that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.
# '''Persistent game and chat elements,''' which make users aware of publicly visible events that previously occurred on the platform.
# '''Development and provision of the Spring engine,''' plus supporting infrastructure, including a lobbyserver in which users chat to each other.
# '''Bridging of publicly accessible chat channels''' to external locations, typically those managed by our own users and sub-projects for purposes explicitly related to SpringRTS.
# '''Verification of user identity''' on login and within battle hosts.
# '''Moderator action''' in the event of disputes and suspected misconduct.
'''We retain and process data of types A, B and C on basis of legitimate interest, to provide the above services.'''

Users may connect to our server using external and bespoke software, known as a “client”, as specified through a publicly available protocol. This software may be outside of our control and knowledge. In such cases, whilst we may deny connections from clients that do not comply with GDPR and other legal requirements where it is technically and practically possible for us to do so, the operation and compliance of client software is the responsibility of its authors and users. The data usage policies summarised in this notice ONLY cover our usage of the data that is sent by users and users client software to our server, running at springrts.com.

Users are contacted via automated messages to email addresses that they provide for purposes related to item 5 when it is necessary to do so, such as when a user requests account recovery. In exceptional circumstances we may also manually contact individual users for purposes related to items 3 or 6. We do not use these email addresses to send marketing emails to our users and we do not disclose email addresses to third parties.

====Legitimate Interest====
We would be unable to provide the above services without retention and processing of the above data. Items 1 and 2 consist wholly of retaining and processing data of types B and C. Data retained and processed relating to item 3 consists of type B and C data, primarily communications occurring between users during their cooperative usage of our services, plus games and other content files for these services. Item 4 requires no retention of data, but requires on-the-fly processing of type B data. Item 5 requires type A data to correctly associate login attempts to user accounts and to help protect the server and battle hosts from malicious activity. Item 6 requires both type A and B data, to support moderator actions identifying, discouraging and preventing misconduct.

Type B.1 data is generated exclusively by individuals within in publicly accessible contexts, in which an expectation exists that this data will be shared with any number of other users. Type B.2 data is generated by individual in contexts where an expectation of privacy from other users exists. Such data is of a nature that is not expected to carry significant risk to an individual’s rights and freedoms, however steps are taken to respect this privacy as detailed below; this data is used only for purposes relating to items 3 and 6. The retention and processing of type B data carries a low risk of inhibiting individual’s rights and freedoms.

Type A data contains information (particularly: email, IP) provided in private contexts that could, in some cases, and when supplemented with external sources of related information, be used to identify a real individual from their online footprint and consequently requires appropriate protection as detailed below; since otherwise the data held by SpringRTS concerning such individuals is of a non-sensitive nature the associated impact on individuals interests, rights and freedoms is low.

Developers and other users who provide data of type C may also provide licenses for such data. Authors may choose to include their own contact details; the risk to the individual’s rights and freedoms is low. For details on how we handle such content see our policies on licensing, forking, and on how the GPL license of the spring engine affects game content.

We do not engage in targeted advertising. We do not engage in profiling or automated decision making that has legal implications for users. We do not process or retain criminal or special category data.

All of our codebases are open source, permitting our users and developers to verify and review that our systems perform as described in this document, and to report any related technical errors.

==User rights under GDPR==

Users wishing to exercise their rights under GDPR should contact moderation staff, who are identifiable on the server by means of a spanner icon, and are contactable via the forum hosted at springrts.com or by email at postmaster@springrts.com; such requests are handled on a case-by-case basis. We have procedures in place to assess numbers of moderation staff and ensure that such people are contactable and able to respond within the required time periods. Any data supplied in response will typically come in plain text form, or in the form of access to online replay files.

Note that the right to erasure under GDPR is not absolute; in particular we may refuse to fully erase data of individuals with a record of past misconduct if we believe such data may be required to prevent potential future misconduct of sufficient severity. See [http://www.privacy-regulation.eu/en/recital-49-GDPR.htm] for details.

==Disclosure of data to third parties and other users==

When information is supplied to us within a publicly visible medium, such as through a public chat channel or public game host, we may and typically will make this information publicly available to other users and to GDPR compliant third parties. This pertains to type all type B.1 data, plus usernames.

Type B.2 data is supplied to other users only when these other users are present or have access to the private context, such as a passworded chat channel or passworded game host, in which the data was created. This data is not disclosed to third parties, but it is retained to provide persistent chat functionality and is accessible to server administrators whilst it is retained.

When users choose to act as battle hosts, or provide automated battle hosts, the IP address of this host becomes publicly available information, necessarily to allow our users to make a (direct) connection to the battle, and for the battle host to accept or decline this connection. Battle hosts receive usernames plus type B data associated to the battles that they host and will typically distribute this data to other connected users. Battle hosts also necessarily become aware of the IP addresses of users attempting to connect to their battles. On a technical level, the distributed nature of battle hosting amongst our users arises from a need for more computational resources and connectivity than the Spring server alone provides. Consequently, battle hosts take on responsibilities of their own under the GDPR and are required to comply fully with the policies set out in this document.

Non-public information supplied to us on login, pertaining to all type A data excluding usernames, may be visible to our moderators and developers when there is a need under items 3 or 6. Hashed passwords are accessible only to developers with a need to access the live user database. Type A data excluding usernames is not disclosed to third parties or other users, except to battle hosts as described above, and except where we judge it necessary for purposes of verifying the authenticity of users; we use external GDPR compliant services to assist in automated detection of potentially malicious users attempting to conceal their own identities.

We reserve the right to pass ANY data that we hold to relevant law enforcement agencies if we believe that it may contain indications or evidence of illegal action.

==Data storage and protection==

All data retained are kept within databases and/or file archives on our server, located within the EU.

The database files are directly accessible only to chosen individuals who require access for purposes related to server development or administration; access is possible only via an encrypted connection using individual credentials. The list of individuals with this access is reviewed regularly on timescales related to their activity. All data of type A held by us is contained within these databases.
Archives of replay files are made available through a public website.

Communications of users to and from our lobbyserver, which covers all type A data sometimes excepting usernames and chat taking place on the lobbyserver, is encrypted (except in cases where users have persistently declined over many years to install software updates supporting this encryption). Passwords are communicated and stored only in hashed format.

Communications taking place between players and spectators within online games, typically consisting of ingame commands and chat, are not encrypted; the Spring engine uses a bespoke protocol for such communications, which prioritises low latency. These communications consist of less sensitive data - type B data plus usernames – and it is judged here that the requirement of minimal latency should take precedence over the benefits to privacy of an encryption layer.

==Retention and erasure of personal data==

The record of type A data of a user is retained for as long as we regard the user as active or with a significant possibility of returning to activity; we engage in automated deletion of such records for users who have remained inactive for 5 consecutive years. This threshold is chosen based on the behaviour of our users, who are known to return after lengthy periods of absence.

Type B.1 data of users, plus usernames, is retained in the form of publicly available archives of online games. We engage in automated deletion of this data after 3 years, but in special cases some replays may be retained for longer.

Type B.1 and type B.2 data consisting of chat taking place on the server within registered channels, in which channel history functionality has been enabled, is stored for up to one month in a database that provides persistent chat functionality. Otherwise, type B.2 data is not retained.

Users should note that when they create type B data they typically do so in the presence of other users who may retain and process the data for periods and purposes outside of our control or knowledge.

We retain and erase type C data according to its license. We regard maintaining a publicly available archive of this data as critical to providing our services and to future development and, whilst we respect individuals right to erasure upon request of any personal data within this archive, we do not engage in automated deletion of it after any time period.

[[Category:Spring]]

Data Usage

2020-04-26T13:55:44Z

Silentwings: /* Data and usage of data */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

==Data and usage of data==

The SpringRTS server (springrts.com) and its managed infrastructure process and retain information generated by users:

<ol style="list-style-type:upper-alpha">
<li>
Registration & login details: email address, IP address, chosen username, (hashed) password.
</li>
<li>
Actions taking place via Springs infrastructure: chat, games played by users and all associated ingame commands, hardware and connectivity information characterizing suitability to play such games, client software used, IP addresses of battle hosts; and derived statistics of these data. This data is divided into two types:
<ol style="list-style-type:decimal">
<li> Data created in publicly accessible contexts, such as non-passworded chat channels and battle hosts. </li>
<li> Data created in private contexts, such as private messages, passworded chat channels and passworded battle hosts. </li>
</ol>
<li>
Source files, artwork and other content relating to games and development of games.
</li>
</ol>
This data is used to provide services that would normally be expected from an online gaming platform, primarily:
# '''Publicly available replays of games''' that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.
# '''Persistent game and chat elements,''' which make users aware of publicly visible events that previously occurred on the platform.
# '''Development and provision of the Spring engine,''' plus supporting infrastructure, including a lobbyserver in which users chat to each other.
# '''Bridging of publicly accessible chat channels''' to external locations, typically those managed by our own users and sub-projects for purposes explicitly related to SpringRTS.
# '''Verification of user identity''' on login and within battle hosts.
# '''Moderator action''' in the event of disputes and suspected misconduct.
'''We retain and process data of types A, B and C on basis of legitimate interest, to provide the above services.'''

Users may connect to our server using external and bespoke software, known as a “client”, as specified through a publicly available protocol. This software may be outside of our control and knowledge. In such cases, whilst we may deny connections from clients that do not comply with GDPR and other legal requirements where it is technically and practically possible for us to do so, the operation and compliance of client software is the responsibility of its authors and users. The data usage policies summarised in this notice ONLY cover our usage of the data that is sent by users and users client software to our server.

Users are contacted via automated messages to email addresses that they provide for purposes related to item 5 when it is necessary to do so, such as when a user requests account recovery. In exceptional circumstances we may also manually contact individual users for purposes related to items 3 or 6. We do not use these email addresses to send marketing emails to our users and we do not disclose email addresses to third parties.

====Legitimate Interest====
We would be unable to provide the above services without retention and processing of the above data. Items 1 and 2 consist wholly of retaining and processing data of types B and C. Data retained and processed relating to item 3 consists of type B and C data, primarily communications occurring between users during their cooperative usage of our services, plus games and other content files for these services. Item 4 requires no retention of data, but requires on-the-fly processing of type B data. Item 5 requires type A data to correctly associate login attempts to user accounts and to help protect the server and battle hosts from malicious activity. Item 6 requires both type A and B data, to support moderator actions identifying, discouraging and preventing misconduct.

Type B.1 data is generated exclusively by individuals within in publicly accessible contexts, in which an expectation exists that this data will be shared with any number of other users. Type B.2 data is generated by individual in contexts where an expectation of privacy from other users exists. Such data is of a nature that is not expected to carry significant risk to an individual’s rights and freedoms, however steps are taken to respect this privacy as detailed below; this data is used only for purposes relating to items 3 and 6. The retention and processing of type B data carries a low risk of inhibiting individual’s rights and freedoms.

Type A data contains information (particularly: email, IP) provided in private contexts that could, in some cases, and when supplemented with external sources of related information, be used to identify a real individual from their online footprint and consequently requires appropriate protection as detailed below; since otherwise the data held by SpringRTS concerning such individuals is of a non-sensitive nature the associated impact on individuals interests, rights and freedoms is low.

Developers and other users who provide data of type C may also provide licenses for such data. Authors may choose to include their own contact details; the risk to the individual’s rights and freedoms is low. For details on how we handle such content see our policies on licensing, forking, and on how the GPL license of the spring engine affects game content.

We do not engage in targeted advertising. We do not engage in profiling or automated decision making that has legal implications for users. We do not process or retain criminal or special category data.

All of our codebases are open source, permitting our users and developers to verify and review that our systems perform as described in this document, and to report any related technical errors.

==User rights under GDPR==

Users wishing to exercise their rights under GDPR should contact moderation staff, who are identifiable on the server by means of a spanner icon, and are contactable via the forum hosted at springrts.com or by email at postmaster@springrts.com; such requests are handled on a case-by-case basis. We have procedures in place to assess numbers of moderation staff and ensure that such people are contactable and able to respond within the required time periods. Any data supplied in response will typically come in plain text form, or in the form of access to online replay files.

Note that the right to erasure under GDPR is not absolute; in particular we may refuse to fully erase data of individuals with a record of past misconduct if we believe such data may be required to prevent potential future misconduct of sufficient severity. See [http://www.privacy-regulation.eu/en/recital-49-GDPR.htm] for details.

==Disclosure of data to third parties and other users==

When information is supplied to us within a publicly visible medium, such as through a public chat channel or public game host, we may and typically will make this information publicly available to other users and to GDPR compliant third parties. This pertains to type all type B.1 data, plus usernames.

Type B.2 data is supplied to other users only when these other users are present or have access to the private context, such as a passworded chat channel or passworded game host, in which the data was created. This data is not disclosed to third parties, but it is retained to provide persistent chat functionality and is accessible to server administrators whilst it is retained.

When users choose to act as battle hosts, or provide automated battle hosts, the IP address of this host becomes publicly available information, necessarily to allow our users to make a (direct) connection to the battle, and for the battle host to accept or decline this connection. Battle hosts receive usernames plus type B data associated to the battles that they host and will typically distribute this data to other connected users. Battle hosts also necessarily become aware of the IP addresses of users attempting to connect to their battles. On a technical level, the distributed nature of battle hosting amongst our users arises from a need for more computational resources and connectivity than the Spring server alone provides. Consequently, battle hosts take on responsibilities of their own under the GDPR and are required to comply fully with the policies set out in this document.

Non-public information supplied to us on login, pertaining to all type A data excluding usernames, may be visible to our moderators and developers when there is a need under items 3 or 6. Hashed passwords are accessible only to developers with a need to access the live user database. Type A data excluding usernames is not disclosed to third parties or other users, except to battle hosts as described above, and except where we judge it necessary for purposes of verifying the authenticity of users; we use external GDPR compliant services to assist in automated detection of potentially malicious users attempting to conceal their own identities.

We reserve the right to pass ANY data that we hold to relevant law enforcement agencies if we believe that it may contain indications or evidence of illegal action.

==Data storage and protection==

All data retained are kept within databases and/or file archives on our server, located within the EU.

The database files are directly accessible only to chosen individuals who require access for purposes related to server development or administration; access is possible only via an encrypted connection using individual credentials. The list of individuals with this access is reviewed regularly on timescales related to their activity. All data of type A held by us is contained within these databases.
Archives of replay files are made available through a public website.

Communications of users to and from our lobbyserver, which covers all type A data sometimes excepting usernames and chat taking place on the lobbyserver, is encrypted (except in cases where users have persistently declined over many years to install software updates supporting this encryption). Passwords are communicated and stored only in hashed format.

Communications taking place between players and spectators within online games, typically consisting of ingame commands and chat, are not encrypted; the Spring engine uses a bespoke protocol for such communications, which prioritises low latency. These communications consist of less sensitive data - type B data plus usernames – and it is judged here that the requirement of minimal latency should take precedence over the benefits to privacy of an encryption layer.

==Retention and erasure of personal data==

The record of type A data of a user is retained for as long as we regard the user as active or with a significant possibility of returning to activity; we engage in automated deletion of such records for users who have remained inactive for 5 consecutive years. This threshold is chosen based on the behaviour of our users, who are known to return after lengthy periods of absence.

Type B.1 data of users, plus usernames, is retained in the form of publicly available archives of online games. We engage in automated deletion of this data after 3 years, but in special cases some replays may be retained for longer.

Type B.1 and type B.2 data consisting of chat taking place on the server within registered channels, in which channel history functionality has been enabled, is stored for up to one month in a database that provides persistent chat functionality. Otherwise, type B.2 data is not retained.

Users should note that when they create type B data they typically do so in the presence of other users who may retain and process the data for periods and purposes outside of our control or knowledge.

We retain and erase type C data according to its license. We regard maintaining a publicly available archive of this data as critical to providing our services and to future development and, whilst we respect individuals right to erasure upon request of any personal data within this archive, we do not engage in automated deletion of it after any time period.

[[Category:Spring]]

Download Systems

2020-03-10T11:07:43Z

Silentwings: /* clients/implementations */

There are curently three systems for spring content files:
*[[rapid]] is currently for games only (rsync like)
*[[upq]] allows to search for games maps and engine
*[[plasma]] allows to search for games and maps

These systems allow to automaticly download files.

==clients/implementations==
*[[SpringLobby]] (c++, cross-platform)
*[[chobby]] (lua, cross-platform)
*[[pr-downloader]] (c++, cross-platform)
[[Category: Download_Systems]]

Data Usage

2020-02-08T08:20:05Z

Silentwings: /* User rights under GDPR */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

==Data and usage of data==

The SpringRTS server and its managed game hosts process and retain information generated by users:

<ol style="list-style-type:upper-alpha">
<li>
Registration & login details: email address, IP address, chosen username, (hashed) password.
</li>
<li>
Actions taking place via Springs infrastructure: chat, games played by users and all associated ingame commands, hardware and connectivity information characterizing suitability to play such games, client software used, IP addresses of battle hosts; and derived statistics of these data. This data is divided into two types:
<ol style="list-style-type:decimal">
<li> Data created in publicly accessible contexts, such as non-passworded chat channels and battle hosts. </li>
<li> Data created in private contexts, such as private messages, passworded chat channels and passworded battle hosts. </li>
</ol>
<li>
Source files, artwork and other content relating to games and development of games.
</li>
</ol>
This data is used to provide services that would normally be expected from an online gaming platform, primarily:
# '''Publicly available replays of games''' that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.
# '''Persistent game and chat elements,''' which make users aware of publicly visible events that previously occurred on the platform.
# '''Development and provision of the Spring engine,''' plus supporting infrastructure, including a lobbyserver in which users chat to each other.
# '''Bridging of publicly accessible chat channels''' to external locations, typically those managed by our own users and sub-projects for purposes explicitly related to SpringRTS.
# '''Verification of user identity''' on login and within battle hosts.
# '''Moderator action''' in the event of disputes and suspected misconduct.
'''We retain and process data of types A, B and C on basis of legitimate interest, to provide the above services.'''

Users may connect to our server using external and bespoke software, known as a “client”, as specified through a publicly available protocol. This software may be outside of our control and knowledge. In such cases, whilst we may deny connections from clients that do not comply with GDPR and other legal requirements where it is technically and practically possible for us to do so, the operation and compliance of client software is the responsibility of its authors and users. The data usage policies summarised in this notice ONLY cover our usage of the data that is sent by users and users client software to our server.

Users are contacted via automated messages to email addresses that they provide for purposes related to item 5 when it is necessary to do so, such as when a user requests account recovery. In exceptional circumstances we may also manually contact individual users for purposes related to items 3 or 6. We do not use these email addresses to send marketing emails to our users and we do not disclose email addresses to third parties.

====Legitimate Interest====
We would be unable to provide the above services without retention and processing of the above data. Items 1 and 2 consist wholly of retaining and processing data of types B and C. Data retained and processed relating to item 3 consists of type B and C data, primarily communications occurring between users during their cooperative usage of our services, plus games and other content files for these services. Item 4 requires no retention of data, but requires on-the-fly processing of type B data. Item 5 requires type A data to correctly associate login attempts to user accounts and to help protect the server and battle hosts from malicious activity. Item 6 requires both type A and B data, to support moderator actions identifying, discouraging and preventing misconduct.

Type B.1 data is generated exclusively by individuals within in publicly accessible contexts, in which an expectation exists that this data will be shared with any number of other users. Type B.2 data is generated by individual in contexts where an expectation of privacy from other users exists. Such data is of a nature that is not expected to carry significant risk to an individual’s rights and freedoms, however steps are taken to respect this privacy as detailed below; this data is used only for purposes relating to items 3 and 6. The retention and processing of type B data carries a low risk of inhibiting individual’s rights and freedoms.

Type A data contains information (particularly: email, IP) provided in private contexts that could, in some cases, and when supplemented with external sources of related information, be used to identify a real individual from their online footprint and consequently requires appropriate protection as detailed below; since otherwise the data held by SpringRTS concerning such individuals is of a non-sensitive nature the associated impact on individuals interests, rights and freedoms is low.

Developers and other users who provide data of type C may also provide licenses for such data. Authors may choose to include their own contact details; the risk to the individual’s rights and freedoms is low. For details on how we handle such content see our policies on licensing, forking, and on how the GPL license of the spring engine affects game content.

We do not engage in targeted advertising. We do not engage in profiling or automated decision making that has legal implications for users. We do not process or retain criminal or special category data.

All of our codebases are open source, permitting our users and developers to verify and review that our systems perform as described in this document, and to report any related technical errors.

==User rights under GDPR==

Users wishing to exercise their rights under GDPR should contact moderation staff, who are identifiable on the server by means of a spanner icon, and are contactable via the forum hosted at springrts.com or by email at postmaster@springrts.com; such requests are handled on a case-by-case basis. We have procedures in place to assess numbers of moderation staff and ensure that such people are contactable and able to respond within the required time periods. Any data supplied in response will typically come in plain text form, or in the form of access to online replay files.

Note that the right to erasure under GDPR is not absolute; in particular we may refuse to fully erase data of individuals with a record of past misconduct if we believe such data may be required to prevent potential future misconduct of sufficient severity. See [http://www.privacy-regulation.eu/en/recital-49-GDPR.htm] for details.

==Disclosure of data to third parties and other users==

When information is supplied to us within a publicly visible medium, such as through a public chat channel or public game host, we may and typically will make this information publicly available to other users and to GDPR compliant third parties. This pertains to type all type B.1 data, plus usernames.

Type B.2 data is supplied to other users only when these other users are present or have access to the private context, such as a passworded chat channel or passworded game host, in which the data was created. This data is not disclosed to third parties, but it is retained to provide persistent chat functionality and is accessible to server administrators whilst it is retained.

When users choose to act as battle hosts, or provide automated battle hosts, the IP address of this host becomes publicly available information, necessarily to allow our users to make a (direct) connection to the battle, and for the battle host to accept or decline this connection. Battle hosts receive usernames plus type B data associated to the battles that they host and will typically distribute this data to other connected users. Battle hosts also necessarily become aware of the IP addresses of users attempting to connect to their battles. On a technical level, the distributed nature of battle hosting amongst our users arises from a need for more computational resources and connectivity than the Spring server alone provides. Consequently, battle hosts take on responsibilities of their own under the GDPR and are required to comply fully with the policies set out in this document.

Non-public information supplied to us on login, pertaining to all type A data excluding usernames, may be visible to our moderators and developers when there is a need under items 3 or 6. Hashed passwords are accessible only to developers with a need to access the live user database. Type A data excluding usernames is not disclosed to third parties or other users, except to battle hosts as described above, and except where we judge it necessary for purposes of verifying the authenticity of users; we use external GDPR compliant services to assist in automated detection of potentially malicious users attempting to conceal their own identities.

We reserve the right to pass ANY data that we hold to relevant law enforcement agencies if we believe that it may contain indications or evidence of illegal action.

==Data storage and protection==

All data retained are kept within databases and/or file archives on our server, located within the EU.

The database files are directly accessible only to chosen individuals who require access for purposes related to server development or administration; access is possible only via an encrypted connection using individual credentials. The list of individuals with this access is reviewed regularly on timescales related to their activity. All data of type A held by us is contained within these databases.
Archives of replay files are made available through a public website.

Communications of users to and from our lobbyserver, which covers all type A data sometimes excepting usernames and chat taking place on the lobbyserver, is encrypted (except in cases where users have persistently declined over many years to install software updates supporting this encryption). Passwords are communicated and stored only in hashed format.

Communications taking place between players and spectators within online games, typically consisting of ingame commands and chat, are not encrypted; the Spring engine uses a bespoke protocol for such communications, which prioritises low latency. These communications consist of less sensitive data - type B data plus usernames – and it is judged here that the requirement of minimal latency should take precedence over the benefits to privacy of an encryption layer.

==Retention and erasure of personal data==

The record of type A data of a user is retained for as long as we regard the user as active or with a significant possibility of returning to activity; we engage in automated deletion of such records for users who have remained inactive for 5 consecutive years. This threshold is chosen based on the behaviour of our users, who are known to return after lengthy periods of absence.

Type B.1 data of users, plus usernames, is retained in the form of publicly available archives of online games. We engage in automated deletion of this data after 3 years, but in special cases some replays may be retained for longer.

Type B.1 and type B.2 data consisting of chat taking place on the server within registered channels, in which channel history functionality has been enabled, is stored for up to one month in a database that provides persistent chat functionality. Otherwise, type B.2 data is not retained.

Users should note that when they create type B data they typically do so in the presence of other users who may retain and process the data for periods and purposes outside of our control or knowledge.

We retain and erase type C data according to its license. We regard maintaining a publicly available archive of this data as critical to providing our services and to future development and, whilst we respect individuals right to erasure upon request of any personal data within this archive, we do not engage in automated deletion of it after any time period.

[[Category:Spring]]

Data Usage

2020-02-08T08:17:00Z

Silentwings: /* Disclosure of data to third parties and other users */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

==Data and usage of data==

The SpringRTS server and its managed game hosts process and retain information generated by users:

<ol style="list-style-type:upper-alpha">
<li>
Registration & login details: email address, IP address, chosen username, (hashed) password.
</li>
<li>
Actions taking place via Springs infrastructure: chat, games played by users and all associated ingame commands, hardware and connectivity information characterizing suitability to play such games, client software used, IP addresses of battle hosts; and derived statistics of these data. This data is divided into two types:
<ol style="list-style-type:decimal">
<li> Data created in publicly accessible contexts, such as non-passworded chat channels and battle hosts. </li>
<li> Data created in private contexts, such as private messages, passworded chat channels and passworded battle hosts. </li>
</ol>
<li>
Source files, artwork and other content relating to games and development of games.
</li>
</ol>
This data is used to provide services that would normally be expected from an online gaming platform, primarily:
# '''Publicly available replays of games''' that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.
# '''Persistent game and chat elements,''' which make users aware of publicly visible events that previously occurred on the platform.
# '''Development and provision of the Spring engine,''' plus supporting infrastructure, including a lobbyserver in which users chat to each other.
# '''Bridging of publicly accessible chat channels''' to external locations, typically those managed by our own users and sub-projects for purposes explicitly related to SpringRTS.
# '''Verification of user identity''' on login and within battle hosts.
# '''Moderator action''' in the event of disputes and suspected misconduct.
'''We retain and process data of types A, B and C on basis of legitimate interest, to provide the above services.'''

Users may connect to our server using external and bespoke software, known as a “client”, as specified through a publicly available protocol. This software may be outside of our control and knowledge. In such cases, whilst we may deny connections from clients that do not comply with GDPR and other legal requirements where it is technically and practically possible for us to do so, the operation and compliance of client software is the responsibility of its authors and users. The data usage policies summarised in this notice ONLY cover our usage of the data that is sent by users and users client software to our server.

Users are contacted via automated messages to email addresses that they provide for purposes related to item 5 when it is necessary to do so, such as when a user requests account recovery. In exceptional circumstances we may also manually contact individual users for purposes related to items 3 or 6. We do not use these email addresses to send marketing emails to our users and we do not disclose email addresses to third parties.

====Legitimate Interest====
We would be unable to provide the above services without retention and processing of the above data. Items 1 and 2 consist wholly of retaining and processing data of types B and C. Data retained and processed relating to item 3 consists of type B and C data, primarily communications occurring between users during their cooperative usage of our services, plus games and other content files for these services. Item 4 requires no retention of data, but requires on-the-fly processing of type B data. Item 5 requires type A data to correctly associate login attempts to user accounts and to help protect the server and battle hosts from malicious activity. Item 6 requires both type A and B data, to support moderator actions identifying, discouraging and preventing misconduct.

Type B.1 data is generated exclusively by individuals within in publicly accessible contexts, in which an expectation exists that this data will be shared with any number of other users. Type B.2 data is generated by individual in contexts where an expectation of privacy from other users exists. Such data is of a nature that is not expected to carry significant risk to an individual’s rights and freedoms, however steps are taken to respect this privacy as detailed below; this data is used only for purposes relating to items 3 and 6. The retention and processing of type B data carries a low risk of inhibiting individual’s rights and freedoms.

Type A data contains information (particularly: email, IP) provided in private contexts that could, in some cases, and when supplemented with external sources of related information, be used to identify a real individual from their online footprint and consequently requires appropriate protection as detailed below; since otherwise the data held by SpringRTS concerning such individuals is of a non-sensitive nature the associated impact on individuals interests, rights and freedoms is low.

Developers and other users who provide data of type C may also provide licenses for such data. Authors may choose to include their own contact details; the risk to the individual’s rights and freedoms is low. For details on how we handle such content see our policies on licensing, forking, and on how the GPL license of the spring engine affects game content.

We do not engage in targeted advertising. We do not engage in profiling or automated decision making that has legal implications for users. We do not process or retain criminal or special category data.

All of our codebases are open source, permitting our users and developers to verify and review that our systems perform as described in this document, and to report any related technical errors.

==User rights under GDPR==

Users wishing to exercise their rights under GDPR should contact moderation staff, who are identifiable on the server by means of a spanner icon, and also contactable through springrts.com or by email at postmaster@springrts.com; such requests are handled on a case-by-case basis. We have procedures in place to assess numbers of moderation staff and ensure that such people are contactable and able to respond within the required time periods. Any data supplied in response will typically come in plain text form, or in the form of access to online replay files.

Note that the right to erasure under GDPR is not absolute; in particular we may refuse to fully erase data of individuals with a record of past misconduct if we believe such data may be required to prevent potential future misconduct of sufficient severity. See [http://www.privacy-regulation.eu/en/recital-49-GDPR.htm] for details.

==Disclosure of data to third parties and other users==

When information is supplied to us within a publicly visible medium, such as through a public chat channel or public game host, we may and typically will make this information publicly available to other users and to GDPR compliant third parties. This pertains to type all type B.1 data, plus usernames.

Type B.2 data is supplied to other users only when these other users are present or have access to the private context, such as a passworded chat channel or passworded game host, in which the data was created. This data is not disclosed to third parties, but it is retained to provide persistent chat functionality and is accessible to server administrators whilst it is retained.

When users choose to act as battle hosts, or provide automated battle hosts, the IP address of this host becomes publicly available information, necessarily to allow our users to make a (direct) connection to the battle, and for the battle host to accept or decline this connection. Battle hosts receive usernames plus type B data associated to the battles that they host and will typically distribute this data to other connected users. Battle hosts also necessarily become aware of the IP addresses of users attempting to connect to their battles. On a technical level, the distributed nature of battle hosting amongst our users arises from a need for more computational resources and connectivity than the Spring server alone provides. Consequently, battle hosts take on responsibilities of their own under the GDPR and are required to comply fully with the policies set out in this document.

Non-public information supplied to us on login, pertaining to all type A data excluding usernames, may be visible to our moderators and developers when there is a need under items 3 or 6. Hashed passwords are accessible only to developers with a need to access the live user database. Type A data excluding usernames is not disclosed to third parties or other users, except to battle hosts as described above, and except where we judge it necessary for purposes of verifying the authenticity of users; we use external GDPR compliant services to assist in automated detection of potentially malicious users attempting to conceal their own identities.

We reserve the right to pass ANY data that we hold to relevant law enforcement agencies if we believe that it may contain indications or evidence of illegal action.

==Data storage and protection==

All data retained are kept within databases and/or file archives on our server, located within the EU.

The database files are directly accessible only to chosen individuals who require access for purposes related to server development or administration; access is possible only via an encrypted connection using individual credentials. The list of individuals with this access is reviewed regularly on timescales related to their activity. All data of type A held by us is contained within these databases.
Archives of replay files are made available through a public website.

Communications of users to and from our lobbyserver, which covers all type A data sometimes excepting usernames and chat taking place on the lobbyserver, is encrypted (except in cases where users have persistently declined over many years to install software updates supporting this encryption). Passwords are communicated and stored only in hashed format.

Communications taking place between players and spectators within online games, typically consisting of ingame commands and chat, are not encrypted; the Spring engine uses a bespoke protocol for such communications, which prioritises low latency. These communications consist of less sensitive data - type B data plus usernames – and it is judged here that the requirement of minimal latency should take precedence over the benefits to privacy of an encryption layer.

==Retention and erasure of personal data==

The record of type A data of a user is retained for as long as we regard the user as active or with a significant possibility of returning to activity; we engage in automated deletion of such records for users who have remained inactive for 5 consecutive years. This threshold is chosen based on the behaviour of our users, who are known to return after lengthy periods of absence.

Type B.1 data of users, plus usernames, is retained in the form of publicly available archives of online games. We engage in automated deletion of this data after 3 years, but in special cases some replays may be retained for longer.

Type B.1 and type B.2 data consisting of chat taking place on the server within registered channels, in which channel history functionality has been enabled, is stored for up to one month in a database that provides persistent chat functionality. Otherwise, type B.2 data is not retained.

Users should note that when they create type B data they typically do so in the presence of other users who may retain and process the data for periods and purposes outside of our control or knowledge.

We retain and erase type C data according to its license. We regard maintaining a publicly available archive of this data as critical to providing our services and to future development and, whilst we respect individuals right to erasure upon request of any personal data within this archive, we do not engage in automated deletion of it after any time period.

[[Category:Spring]]

Data Usage

2020-02-07T08:25:24Z

Silentwings: /* Disclosure of data to third parties and other users */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

==Data and usage of data==

The SpringRTS server and its managed game hosts process and retain information generated by users:

<ol style="list-style-type:upper-alpha">
<li>
Registration & login details: email address, IP address, chosen username, (hashed) password.
</li>
<li>
Actions taking place via Springs infrastructure: chat, games played by users and all associated ingame commands, hardware and connectivity information characterizing suitability to play such games, client software used, IP addresses of battle hosts; and derived statistics of these data. This data is divided into two types:
<ol style="list-style-type:decimal">
<li> Data created in publicly accessible contexts, such as non-passworded chat channels and battle hosts. </li>
<li> Data created in private contexts, such as private messages, passworded chat channels and passworded battle hosts. </li>
</ol>
<li>
Source files, artwork and other content relating to games and development of games.
</li>
</ol>
This data is used to provide services that would normally be expected from an online gaming platform, primarily:
# '''Publicly available replays of games''' that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.
# '''Persistent game and chat elements,''' which make users aware of publicly visible events that previously occurred on the platform.
# '''Development and provision of the Spring engine,''' plus supporting infrastructure, including a lobbyserver in which users chat to each other.
# '''Bridging of publicly accessible chat channels''' to external locations, typically those managed by our own users and sub-projects for purposes explicitly related to SpringRTS.
# '''Verification of user identity''' on login and within battle hosts.
# '''Moderator action''' in the event of disputes and suspected misconduct.
'''We retain and process data of types A, B and C on basis of legitimate interest, to provide the above services.'''

Users may connect to our server using external and bespoke software, known as a “client”, as specified through a publicly available protocol. This software may be outside of our control and knowledge. In such cases, whilst we may deny connections from clients that do not comply with GDPR and other legal requirements where it is technically and practically possible for us to do so, the operation and compliance of client software is the responsibility of its authors and users. The data usage policies summarised in this notice ONLY cover our usage of the data that is sent by users and users client software to our server.

Users are contacted via automated messages to email addresses that they provide for purposes related to item 5 when it is necessary to do so, such as when a user requests account recovery. In exceptional circumstances we may also manually contact individual users for purposes related to items 3 or 6. We do not use these email addresses to send marketing emails to our users and we do not disclose email addresses to third parties.

====Legitimate Interest====
We would be unable to provide the above services without retention and processing of the above data. Items 1 and 2 consist wholly of retaining and processing data of types B and C. Data retained and processed relating to item 3 consists of type B and C data, primarily communications occurring between users during their cooperative usage of our services, plus games and other content files for these services. Item 4 requires no retention of data, but requires on-the-fly processing of type B data. Item 5 requires type A data to correctly associate login attempts to user accounts and to help protect the server and battle hosts from malicious activity. Item 6 requires both type A and B data, to support moderator actions identifying, discouraging and preventing misconduct.

Type B.1 data is generated exclusively by individuals within in publicly accessible contexts, in which an expectation exists that this data will be shared with any number of other users. Type B.2 data is generated by individual in contexts where an expectation of privacy from other users exists. Such data is of a nature that is not expected to carry significant risk to an individual’s rights and freedoms, however steps are taken to respect this privacy as detailed below; this data is used only for purposes relating to items 3 and 6. The retention and processing of type B data carries a low risk of inhibiting individual’s rights and freedoms.

Type A data contains information (particularly: email, IP) provided in private contexts that could, in some cases, and when supplemented with external sources of related information, be used to identify a real individual from their online footprint and consequently requires appropriate protection as detailed below; since otherwise the data held by SpringRTS concerning such individuals is of a non-sensitive nature the associated impact on individuals interests, rights and freedoms is low.

Developers and other users who provide data of type C may also provide licenses for such data. Authors may choose to include their own contact details; the risk to the individual’s rights and freedoms is low. For details on how we handle such content see our policies on licensing, forking, and on how the GPL license of the spring engine affects game content.

We do not engage in targeted advertising. We do not engage in profiling or automated decision making that has legal implications for users. We do not process or retain criminal or special category data.

All of our codebases are open source, permitting our users and developers to verify and review that our systems perform as described in this document, and to report any related technical errors.

==User rights under GDPR==

Users wishing to exercise their rights under GDPR should contact moderation staff, who are identifiable on the server by means of a spanner icon, and also contactable through springrts.com or by email at postmaster@springrts.com; such requests are handled on a case-by-case basis. We have procedures in place to assess numbers of moderation staff and ensure that such people are contactable and able to respond within the required time periods. Any data supplied in response will typically come in plain text form, or in the form of access to online replay files.

Note that the right to erasure under GDPR is not absolute; in particular we may refuse to fully erase data of individuals with a record of past misconduct if we believe such data may be required to prevent potential future misconduct of sufficient severity. See [http://www.privacy-regulation.eu/en/recital-49-GDPR.htm] for details.

==Disclosure of data to third parties and other users==

When information is supplied to us within a publicly visible medium, such as through a public chat channel or public game host, we may and typically will make this information publicly available to other users and to GDPR compliant third parties. This pertains to type all type B.1 data, plus usernames.

Type B.2 data is supplied to other users only when these other users are present or have access to the private context, such as a passworded chat channel or passworded game host, in which the data was created. This data is not disclosed to third parties, but it is retained to provide persistent chat functionality and is accessible to server administrators whilst it is retained.

When users choose to act as battle hosts, or provide automated battle hosts, the IP address of this host becomes publicly available information, necessarily to allow our users to make a (direct) connection to the battle, and for the battle host to accept or decline this connection. Battle hosts receive usernames plus type B data associated to the battles that they host and will typically distribute this data to other connected users. Battle hosts also necessarily become aware of the IP addresses of users attempting to connect to their battles. On a technical level, the distributed nature of battle hosting amongst our users arises from a need for more computational resources and connectivity than the Spring server alone provides. Consequently, battle hosts take on responsibilities of their own under the GDPR and are required to comply fully with the policies set out in this document.

Non-public information supplied to us on login, pertaining to all type A data excluding usernames, may be visible to our moderators and developers when there is a need under items 3 or 6. Hashed passwords are accessible only to developers with a need to access the live user database. Type A data is not disclosed to third parties or other users, except to battle hosts as described above, and except where we judge it necessary for purposes of verifying the authenticity of users; we use external GDPR compliant services to assist in automated detection of potentially malicious users attempting to conceal their own identities.

We reserve the right to pass ANY data that we hold to relevant law enforcement agencies if we believe that it may contain indications or evidence of illegal action.

==Data storage and protection==

All data retained are kept within databases and/or file archives on our server, located within the EU.

The database files are directly accessible only to chosen individuals who require access for purposes related to server development or administration; access is possible only via an encrypted connection using individual credentials. The list of individuals with this access is reviewed regularly on timescales related to their activity. All data of type A held by us is contained within these databases.
Archives of replay files are made available through a public website.

Communications of users to and from our lobbyserver, which covers all type A data sometimes excepting usernames and chat taking place on the lobbyserver, is encrypted (except in cases where users have persistently declined over many years to install software updates supporting this encryption). Passwords are communicated and stored only in hashed format.

Communications taking place between players and spectators within online games, typically consisting of ingame commands and chat, are not encrypted; the Spring engine uses a bespoke protocol for such communications, which prioritises low latency. These communications consist of less sensitive data - type B data plus usernames – and it is judged here that the requirement of minimal latency should take precedence over the benefits to privacy of an encryption layer.

==Retention and erasure of personal data==

The record of type A data of a user is retained for as long as we regard the user as active or with a significant possibility of returning to activity; we engage in automated deletion of such records for users who have remained inactive for 5 consecutive years. This threshold is chosen based on the behaviour of our users, who are known to return after lengthy periods of absence.

Type B.1 data of users, plus usernames, is retained in the form of publicly available archives of online games. We engage in automated deletion of this data after 3 years, but in special cases some replays may be retained for longer.

Type B.1 and type B.2 data consisting of chat taking place on the server within registered channels, in which channel history functionality has been enabled, is stored for up to one month in a database that provides persistent chat functionality. Otherwise, type B.2 data is not retained.

Users should note that when they create type B data they typically do so in the presence of other users who may retain and process the data for periods and purposes outside of our control or knowledge.

We retain and erase type C data according to its license. We regard maintaining a publicly available archive of this data as critical to providing our services and to future development and, whilst we respect individuals right to erasure upon request of any personal data within this archive, we do not engage in automated deletion of it after any time period.

[[Category:Spring]]

Lobby Development

2019-12-24T17:03:14Z

Silentwings: /* Protocol */

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

=Live systems=

===Protocol===
* [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html Spring Lobby Protocol Description]
* [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html#Changelog changelog]
* [http://springrts.com/dl/LobbyProtocol/ Index of commands]
These are both updated once per day from [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml the raw xml docs]

===Server:===

===[[Uberserver]]===
cross-platform,
Python,
by aegis, abma, silentwings

* The primary lobby server currently running on springrts.com. See the dedicated page on [[uberserver]] for more info.

===[[Download_Systems]]===
Various systems exist to supply content, see the dedicated page [[Download_Systems]].

===Lobby clients:===

===[[SpringLobby]]===
Linux, Windows, Mac ,
C++,
by Koshi, Braindamage, Abma and many others 

[https://github.com/springlobby/springlobby github: repository + issues]

===[[Chobby]]===
Windows,
Lua,
by gajop, with major contributions from various game devs

[https://github.com/Spring-Chobby/Chobby github: repository + issues]

=Zero-K systems=

===ZeroK Server===
cross-platform,
C#,
by Licho

Zero-K lobby server. Uses a different protocol. Source can be found at
https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZkLobbyServer

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Legacy systems=

==Legacy lobby clients==

From mostly functional, to WIP, abandoned or unusable. Apparently, its much harder to make a lobby client than most people think.

===flobby===
Linux,
C++,
by cleanrock, only maintained actively for use with the Zero-K lobbyserver.

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

===Weblobby===
cross-platform,
C++,
unmaintained (superceeded by Chobby)

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

===[[TASClient]]===
Windows,
Delphi,
by Satirik, unmaintained

===Alphalobby===
Windows,
C,
unmaintained

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===
cross-platform,
Java,
by Cheesecan, unmaintained

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

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

===QtLobby===
cross-platform,
C++,
unmaintained

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

===Spring-PythonBotFramework===
cross-platform,
Python, by
BrainDamage & koshi, unmaintained

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

===Go SpringLobbyClient===
cross-platform,
Go
unmaintained

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

==Legacy lobbyservers==
===SpringLS===
cross-platform,
Java,
hoijui

Legacy lobby server, created by Betalord. Superceeded by uberserver in 2012. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/SpringLS development site].

[[Category: Lobby]]

Lobby Development

2019-12-24T17:02:48Z

Silentwings: /* Protocol */

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

=Live systems=

===Protocol===
* [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html Spring Lobby Protocol Description]
* [file:///C:/nic/springrts/lobby_protocol/ProtocolDescription.xml#Changelog changelog]
* [http://springrts.com/dl/LobbyProtocol/ Index of commands]
These are both updated once per day from [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml the raw xml docs]

===Server:===

===[[Uberserver]]===
cross-platform,
Python,
by aegis, abma, silentwings

* The primary lobby server currently running on springrts.com. See the dedicated page on [[uberserver]] for more info.

===[[Download_Systems]]===
Various systems exist to supply content, see the dedicated page [[Download_Systems]].

===Lobby clients:===

===[[SpringLobby]]===
Linux, Windows, Mac ,
C++,
by Koshi, Braindamage, Abma and many others 

[https://github.com/springlobby/springlobby github: repository + issues]

===[[Chobby]]===
Windows,
Lua,
by gajop, with major contributions from various game devs

[https://github.com/Spring-Chobby/Chobby github: repository + issues]

=Zero-K systems=

===ZeroK Server===
cross-platform,
C#,
by Licho

Zero-K lobby server. Uses a different protocol. Source can be found at
https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZkLobbyServer

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Legacy systems=

==Legacy lobby clients==

From mostly functional, to WIP, abandoned or unusable. Apparently, its much harder to make a lobby client than most people think.

===flobby===
Linux,
C++,
by cleanrock, only maintained actively for use with the Zero-K lobbyserver.

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

===Weblobby===
cross-platform,
C++,
unmaintained (superceeded by Chobby)

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

===[[TASClient]]===
Windows,
Delphi,
by Satirik, unmaintained

===Alphalobby===
Windows,
C,
unmaintained

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===
cross-platform,
Java,
by Cheesecan, unmaintained

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

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

===QtLobby===
cross-platform,
C++,
unmaintained

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

===Spring-PythonBotFramework===
cross-platform,
Python, by
BrainDamage & koshi, unmaintained

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

===Go SpringLobbyClient===
cross-platform,
Go
unmaintained

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

==Legacy lobbyservers==
===SpringLS===
cross-platform,
Java,
hoijui

Legacy lobby server, created by Betalord. Superceeded by uberserver in 2012. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/SpringLS development site].

[[Category: Lobby]]

Lobby Development

2019-12-24T16:47:29Z

Silentwings: /* Protocol */

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

=Live systems=

===Protocol===
* [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html Spring Lobby Protocol Description]
* [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html#RecentChanges changelog]
* [http://springrts.com/dl/LobbyProtocol/ Index of commands]
These are both updated once per day from [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml the raw xml docs]

===Server:===

===[[Uberserver]]===
cross-platform,
Python,
by aegis, abma, silentwings

* The primary lobby server currently running on springrts.com. See the dedicated page on [[uberserver]] for more info.

===[[Download_Systems]]===
Various systems exist to supply content, see the dedicated page [[Download_Systems]].

===Lobby clients:===

===[[SpringLobby]]===
Linux, Windows, Mac ,
C++,
by Koshi, Braindamage, Abma and many others 

[https://github.com/springlobby/springlobby github: repository + issues]

===[[Chobby]]===
Windows,
Lua,
by gajop, with major contributions from various game devs

[https://github.com/Spring-Chobby/Chobby github: repository + issues]

=Zero-K systems=

===ZeroK Server===
cross-platform,
C#,
by Licho

Zero-K lobby server. Uses a different protocol. Source can be found at
https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZkLobbyServer

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Legacy systems=

==Legacy lobby clients==

From mostly functional, to WIP, abandoned or unusable. Apparently, its much harder to make a lobby client than most people think.

===flobby===
Linux,
C++,
by cleanrock, only maintained actively for use with the Zero-K lobbyserver.

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

===Weblobby===
cross-platform,
C++,
unmaintained (superceeded by Chobby)

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

===[[TASClient]]===
Windows,
Delphi,
by Satirik, unmaintained

===Alphalobby===
Windows,
C,
unmaintained

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===
cross-platform,
Java,
by Cheesecan, unmaintained

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

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

===QtLobby===
cross-platform,
C++,
unmaintained

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

===Spring-PythonBotFramework===
cross-platform,
Python, by
BrainDamage & koshi, unmaintained

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

===Go SpringLobbyClient===
cross-platform,
Go
unmaintained

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

==Legacy lobbyservers==
===SpringLS===
cross-platform,
Java,
hoijui

Legacy lobby server, created by Betalord. Superceeded by uberserver in 2012. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/SpringLS development site].

[[Category: Lobby]]

Lobby Development

2019-12-24T16:46:55Z

Silentwings: /* Protocol */

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

=Live systems=

===Protocol===
* [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html Spring Lobby Protocol Description] containing protocol [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html#RecentChanges changelog]
* [http://springrts.com/dl/LobbyProtocol/ Index of commands]
These are both updated once per day from [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml the raw xml docs]

===Server:===

===[[Uberserver]]===
cross-platform,
Python,
by aegis, abma, silentwings

* The primary lobby server currently running on springrts.com. See the dedicated page on [[uberserver]] for more info.

===[[Download_Systems]]===
Various systems exist to supply content, see the dedicated page [[Download_Systems]].

===Lobby clients:===

===[[SpringLobby]]===
Linux, Windows, Mac ,
C++,
by Koshi, Braindamage, Abma and many others 

[https://github.com/springlobby/springlobby github: repository + issues]

===[[Chobby]]===
Windows,
Lua,
by gajop, with major contributions from various game devs

[https://github.com/Spring-Chobby/Chobby github: repository + issues]

=Zero-K systems=

===ZeroK Server===
cross-platform,
C#,
by Licho

Zero-K lobby server. Uses a different protocol. Source can be found at
https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZkLobbyServer

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Legacy systems=

==Legacy lobby clients==

From mostly functional, to WIP, abandoned or unusable. Apparently, its much harder to make a lobby client than most people think.

===flobby===
Linux,
C++,
by cleanrock, only maintained actively for use with the Zero-K lobbyserver.

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

===Weblobby===
cross-platform,
C++,
unmaintained (superceeded by Chobby)

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

===[[TASClient]]===
Windows,
Delphi,
by Satirik, unmaintained

===Alphalobby===
Windows,
C,
unmaintained

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===
cross-platform,
Java,
by Cheesecan, unmaintained

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

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

===QtLobby===
cross-platform,
C++,
unmaintained

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

===Spring-PythonBotFramework===
cross-platform,
Python, by
BrainDamage & koshi, unmaintained

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

===Go SpringLobbyClient===
cross-platform,
Go
unmaintained

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

==Legacy lobbyservers==
===SpringLS===
cross-platform,
Java,
hoijui

Legacy lobby server, created by Betalord. Superceeded by uberserver in 2012. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/SpringLS development site].

[[Category: Lobby]]

Lobby Development

2019-12-16T08:44:32Z

Silentwings: /* SpringLS */

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

=Live systems=

===Protocol===
* [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html Spring Lobby Protocol Description]
* [http://springrts.com/dl/LobbyProtocol/ Index of commands]
These are both updated once per day from [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml the raw xml docs]

===Server:===

===[[Uberserver]]===
cross-platform,
Python,
by aegis, abma, silentwings

* The primary lobby server currently running on springrts.com. See the dedicated page on [[uberserver]] for more info.

===[[Download_Systems]]===
Various systems exist to supply content, see the dedicated page [[Download_Systems]].

===Lobby clients:===

===[[SpringLobby]]===
Linux, Windows, Mac ,
C++,
by Koshi, Braindamage, Abma and many others 

[https://github.com/springlobby/springlobby github: repository + issues]

===[[Chobby]]===
Windows,
Lua,
by gajop, with major contributions from various game devs

[https://github.com/Spring-Chobby/Chobby github: repository + issues]

=Zero-K systems=

===ZeroK Server===
cross-platform,
C#,
by Licho

Zero-K lobby server. Uses a different protocol. Source can be found at
https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZkLobbyServer

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Legacy systems=

==Legacy lobby clients==

From mostly functional, to WIP, abandoned or unusable. Apparently, its much harder to make a lobby client than most people think.

===flobby===
Linux,
C++,
by cleanrock, only maintained actively for use with the Zero-K lobbyserver.

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

===Weblobby===
cross-platform,
C++,
unmaintained (superceeded by Chobby)

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

===[[TASClient]]===
Windows,
Delphi,
by Satirik, unmaintained

===Alphalobby===
Windows,
C,
unmaintained

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===
cross-platform,
Java,
by Cheesecan, unmaintained

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

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

===QtLobby===
cross-platform,
C++,
unmaintained

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

===Spring-PythonBotFramework===
cross-platform,
Python, by
BrainDamage & koshi, unmaintained

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

===Go SpringLobbyClient===
cross-platform,
Go
unmaintained

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

==Legacy lobbyservers==
===SpringLS===
cross-platform,
Java,
hoijui

Legacy lobby server, created by Betalord. Superceeded by uberserver in 2012. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/SpringLS development site].

[[Category: Lobby]]

Lobby Development

2019-12-14T19:02:09Z

Silentwings: /* Legacy lobbyservers */

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

=Live systems=

===Protocol===
* [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html Spring Lobby Protocol Description]
* [http://springrts.com/dl/LobbyProtocol/ Index of commands]
These are both updated once per day from [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml the raw xml docs]

===Server:===

===[[Uberserver]]===
cross-platform,
Python,
by aegis, abma, silentwings

* The primary lobby server currently running on springrts.com. See the dedicated page on [[uberserver]] for more info.

===[[Download_Systems]]===
Various systems exist to supply content, see the dedicated page [[Download_Systems]].

===Lobby clients:===

===[[SpringLobby]]===
Linux, Windows, Mac ,
C++,
by Koshi, Braindamage, Abma and many others 

[https://github.com/springlobby/springlobby github: repository + issues]

===[[Chobby]]===
Windows,
Lua,
by gajop, with major contributions from various game devs

[https://github.com/Spring-Chobby/Chobby github: repository + issues]

=Zero-K systems=

===ZeroK Server===
cross-platform,
C#,
by Licho

Zero-K lobby server. Uses a different protocol. Source can be found at
https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZkLobbyServer

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Legacy systems=

==Legacy lobby clients==

From mostly functional, to WIP, abandoned or unusable. Apparently, its much harder to make a lobby client than most people think.

===flobby===
Linux,
C++,
by cleanrock, only maintained actively for use with the Zero-K lobbyserver.

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

===Weblobby===
cross-platform,
C++,
unmaintained (superceeded by Chobby)

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

===[[TASClient]]===
Windows,
Delphi,
by Satirik, unmaintained

===Alphalobby===
Windows,
C,
unmaintained

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===
cross-platform,
Java,
by Cheesecan, unmaintained

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

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

===QtLobby===
cross-platform,
C++,
unmaintained

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

===Spring-PythonBotFramework===
cross-platform,
Python, by
BrainDamage & koshi, unmaintained

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

===Go SpringLobbyClient===
cross-platform,
Go
unmaintained

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

==Legacy lobbyservers==
===SpringLS===
cross-platform,
Java,
hoijui

Legacy 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].

[[Category: Lobby]]

Lobby Development

2019-12-14T17:43:34Z

Silentwings: /* Legacy lobby clients */

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

=Live systems=

===Protocol===
* [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html Spring Lobby Protocol Description]
* [http://springrts.com/dl/LobbyProtocol/ Index of commands]
These are both updated once per day from [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml the raw xml docs]

===Server:===

===[[Uberserver]]===
cross-platform,
Python,
by aegis, abma, silentwings

* The primary lobby server currently running on springrts.com. See the dedicated page on [[uberserver]] for more info.

===[[Download_Systems]]===
Various systems exist to supply content, see the dedicated page [[Download_Systems]].

===Lobby clients:===

===[[SpringLobby]]===
Linux, Windows, Mac ,
C++,
by Koshi, Braindamage, Abma and many others 

[https://github.com/springlobby/springlobby github: repository + issues]

===[[Chobby]]===
Windows,
Lua,
by gajop, with major contributions from various game devs

[https://github.com/Spring-Chobby/Chobby github: repository + issues]

=Zero-K systems=

===ZeroK Server===
cross-platform,
C#,
by Licho

Zero-K lobby server. Uses a different protocol. Source can be found at
https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZkLobbyServer

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Legacy systems=

==Legacy lobby clients==

From mostly functional, to WIP, abandoned or unusable. Apparently, its much harder to make a lobby client than most people think.

===flobby===
Linux,
C++,
by cleanrock, only maintained actively for use with the Zero-K lobbyserver.

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

===Weblobby===
cross-platform,
C++,
unmaintained (superceeded by Chobby)

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

===[[TASClient]]===
Windows,
Delphi,
by Satirik, unmaintained

===Alphalobby===
Windows,
C,
unmaintained

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===
cross-platform,
Java,
by Cheesecan, unmaintained

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

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

===QtLobby===
cross-platform,
C++,
unmaintained

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

===Spring-PythonBotFramework===
cross-platform,
Python, by
BrainDamage & koshi, unmaintained

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

===Go SpringLobbyClient===
cross-platform,
Go
unmaintained

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

==Legacy lobbyservers==
===SpringLS===
cross-platform,
Java,
hoijui

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

[[Category: Lobby]]

Lobby Development

2019-12-14T17:22:53Z

Silentwings:

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

=Live systems=

===Protocol===
* [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html Spring Lobby Protocol Description]
* [http://springrts.com/dl/LobbyProtocol/ Index of commands]
These are both updated once per day from [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml the raw xml docs]

===Server:===

===[[Uberserver]]===
cross-platform,
Python,
by aegis, abma, silentwings

* The primary lobby server currently running on springrts.com. See the dedicated page on [[uberserver]] for more info.

===[[Download_Systems]]===
Various systems exist to supply content, see the dedicated page [[Download_Systems]].

===Lobby clients:===

===[[SpringLobby]]===
Linux, Windows, Mac ,
C++,
by Koshi, Braindamage, Abma and many others 

[https://github.com/springlobby/springlobby github: repository + issues]

===[[Chobby]]===
Windows,
Lua,
by gajop, with major contributions from various game devs

[https://github.com/Spring-Chobby/Chobby github: repository + issues]

=Zero-K systems=

===ZeroK Server===
cross-platform,
C#,
by Licho

Zero-K lobby server. Uses a different protocol. Source can be found at
https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZkLobbyServer

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Legacy systems=

==Legacy lobby clients==

From mostly functional, to WIP, abandoned or unusable. Apparently, its much harder to make a lobby client than most people think.

===flobby===
Linux,
C++,
by cleanrock, only maintained actively for use with the Zero-K lobbyserver.

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

===Weblobby===
cross-platform,
C++,
unmaintained, superceeded by Chobby

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

===[[TASClient]]===
Windows,
Delphi,
unmaintained

===Alphalobby===
Windows,
C,
unmaintained

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===
cross-platform,
Java,
by Cheesecan

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

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

===QtLobby===
cross-platform,
C++,
unmaintained

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

===Spring-PythonBotFramework===
cross-platform,
Python, by
BrainDamage & koshi

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

===Go SpringLobbyClient===
cross-platform,
Go

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

==Legacy lobbyservers==
===SpringLS===
cross-platform,
Java,
hoijui

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

[[Category: Lobby]]

Lobby Development

2019-12-14T17:11:17Z

Silentwings: /* Full featured lobby clients */

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

=Live systems=

===Protocol===
* [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html Protocol Description]
* [http://springrts.com/dl/LobbyProtocol/ Index of commands]
These are both updated once per day from [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml the raw xml docs]

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

===Lobby server: UberServer===
cross-platform,
Python,
by aegis

The primary lobby server currently running on springrts.com. Most protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and SpringLS (SpringLS hasn't seen as many updates recently). See the dedicated [[uberserver]] for more info.

==Full featured lobby clients==

===[[SpringLobby]]===
Linux, Windows, Mac ,
C++,
by Koshi, Braindamage, Abma and many others 

[https://github.com/springlobby/springlobby github: repository + issues]

===[[Chobby]]===
Windows,
Lua,
by gajop, with major contributions from various game devs

[https://github.com/Spring-Chobby/Chobby github: repository + issues]

=Zero-K systems=

===ZeroK Server===
cross-platform,
C#,
by Licho

Zero-K lobby server. Uses a different protocol. Source can be found at
https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZkLobbyServer

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Legacy systems=

==Legacy lobbiy clients==

From mostly functional, to WIP, abandoned or unusable. Apparently, its much harder to make a lobby client than most people think.

===flobby===
Linux,
C++,
by cleanrock, only maintained actively for use with the Zero-K lobbyserver.

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

===Weblobby===
cross-platform,
C++,
mostly unmaintained

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

===[[TASClient]]===
Windows,
Delphi,
unmaintained

===Alphalobby===
Windows,
C,
unmaintained

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===
cross-platform,
Java,
by Cheesecan

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

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

===QtLobby===
cross-platform,
C++,
unmaintained

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

===Spring-PythonBotFramework===
cross-platform,
Python, by
BrainDamage & koshi

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

===Go SpringLobbyClient===
cross-platform,
Go

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

==Legacy lobbyservers==
===SpringLS===
cross-platform,
Java,
hoijui

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

[[Category: Lobby]]

Lobby Development

2019-12-14T17:10:56Z

Silentwings: /* Full featured lobby clients */

Lobby Development

2019-12-14T17:10:39Z

Silentwings: /* Full featured lobby clients */

Lobby Development

2019-12-14T17:08:39Z

Silentwings: /* Protocol */

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

=Live systems=

===Protocol===
* [https://springrts.com/dl/LobbyProtocol/ProtocolDescription.html Protocol Description]
* [http://springrts.com/dl/LobbyProtocol/ Index of commands]
These are both updated once per day from [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml the raw xml docs]

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

===Lobby server: UberServer===
cross-platform,
Python,
by aegis

The primary lobby server currently running on springrts.com. Most protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and SpringLS (SpringLS hasn't seen as many updates recently). See the dedicated [[uberserver]] for more info.

==Full featured lobby clients==

===[[SpringLobby]]===
Linux, Windows, Mac ,
C++,
by Koshi, Braindamage, Abma and many others 

[https://github.com/springlobby/springlobby github: repository + issues]

=Zero-K systems=

===ZeroK Server===
cross-platform,
C#,
by Licho

Zero-K lobby server. Uses a different protocol. Source can be found at
https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZkLobbyServer

===Zero-K Lobby===

No longer uses the Spring lobby protocol

Windows/Linux,
C#,
by Licho & quantum

[https://github.com/ZeroK-RTS/Zero-K-Infrastructure/tree/master/ZeroKLobby Zero-K Lobby github]

=Legacy systems=

==Legacy lobbiy clients==

From mostly functional, to WIP, abandoned or unusable. Apparently, its much harder to make a lobby client than most people think.

===flobby===
Linux,
C++,
by cleanrock, only maintained actively for use with the Zero-K lobbyserver.

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

===Weblobby===
cross-platform,
C++,
mostly unmaintained

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

===[[TASClient]]===
Windows,
Delphi,
unmaintained

===Alphalobby===
Windows,
C,
unmaintained

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===
cross-platform,
Java,
by Cheesecan

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

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

===QtLobby===
cross-platform,
C++,
unmaintained

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

===Spring-PythonBotFramework===
cross-platform,
Python, by
BrainDamage & koshi

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

===Go SpringLobbyClient===
cross-platform,
Go

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

==Legacy lobbyservers==
===SpringLS===
cross-platform,
Java,
hoijui

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

[[Category: Lobby]]

Reporting

2019-06-23T11:08:52Z

Silentwings: /* Moderation within autohosts */

[[Main_Page|Wiki]] < {{FULLPAGENAME}}

== Contacting moderators ==

For individual forum posts, which might not follow our [[Felony|forum rules]], use the 'report post' button which you can find [https://springrts.com/phpbb/app.php/help/faq#f2r9 near the top right of every forum post].

In all other cases, when a reaction is wanted from Springs moderators, reports may be sent, via private messages, with evidence in the form of links/logfiles/replays, [https://springrts.com/phpbb/ucp.php?i=pm&mode=compose&g=3623 to the Spring staff (=moderators and administrators) forum group].

'''Forum threads should not be used for reporting users behaviour to moderators.''' Why not? Because forum threads are for discussions, which don't require a heavy burden of proving something when you say it - consequently we will never treat them as a request for a reaction or judgement from moderators. We may not always read them, but if we do then we will generally lock threads made to request moderator reactions.

== Moderation within autohosts ==

Misbehaviour within autohosts should be reported to the autohost owners or operators. Send a private lobby message <code>!list users</code> to the autohost to find out who these are.

Autohosts are typically run by particular users and have a degree of autonomy, [[Botflags|as detailed here]]. Springs (global) moderators will typically not process disputes between players relating to ingame behaviour.

Balanced Annihilation

2019-05-24T07:34:37Z

Silentwings: /* History */

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

[[Image:BA.gif|very epic tmp img of BA]]

===Links===
* [https://balancedannihilation.com/ Official BA website]
* [https://springrts.com/phpbb/viewforum.php?f=44 BA subforum]
* [https://github.com/Balanced-Annihilation/Balanced-Annihilation Game Source Repository]

===Overview===
Balanced Annihilation is the long-term most popular game based at the Spring engine.
It's based at three basic principles:
* '''Refined [[OTA | Original Total Annihilation]]:''' BA's lineage traces back to fan mods of the original Total Annihilation. It feels similar, and play is ''more balanced'' for diverse multiplayer strategies.

* '''Stable gameplay:''' Balanced Annihilation has matured through several years of playtesting. New versions don't drastically alter the gameplay.

* '''Balance:''' Every unit has a role, and no unit has every role. Very few units get truly obsolete as a game progresses. The ideal state is to have no obsolete units at all.

===History===
Balanced Annihilation mod started as a fork of [[Absolute Annihilation]] 2.23 in the end of 2006. The current maintainer is ShoX. The previous maintainers, who shouldn't be forgotten, were [teh]Decay, Floris, [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=7229 Silentwings], [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=5958 Beherith], [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=7403 Niobium], [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=4460 TheFatController] and [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=326 NOiZE].

===Legal===
Parts of this mod originate from non-free sources. However, there is an ongoing attempt to find and replace units' models with free ones. [https://springrts.com/phpbb/viewtopic.php?f=44&t=30537 BA Reloaded]

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

Balanced Annihilation

2019-05-24T07:25:49Z

Silentwings: /* Legal */

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

[[Image:BA.gif|very epic tmp img of BA]]

===Links===
* [https://balancedannihilation.com/ Official BA website]
* [https://springrts.com/phpbb/viewforum.php?f=44 BA subforum]
* [https://github.com/Balanced-Annihilation/Balanced-Annihilation Game Source Repository]

===Overview===
Balanced Annihilation is the long-term most popular game based at the Spring engine.
It's based at three basic principles:
* '''Refined [[OTA | Original Total Annihilation]]:''' BA's lineage traces back to fan mods of the original Total Annihilation. It feels similar, and play is ''more balanced'' for diverse multiplayer strategies.

* '''Stable gameplay:''' Balanced Annihilation has matured through several years of playtesting. New versions don't drastically alter the gameplay.

* '''Balance:''' Every unit has a role, and no unit has every role. Very few units get truly obsolete as a game progresses. The ideal state is to have no obsolete units at all.

===History===
Balanced Annihilation mod started as a fork of [[Absolute Annihilation]] 2.23 in the end of 2006. [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=5958 Beherith] & [teh]Decay and Floris are the current BA maintainers. The previous maintainers, who shouldn't be forgotten, were [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=7403 Niobium], [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=7229 Silentwings], [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=4460 TheFatController] and [https://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=326 NOiZE].

===Legal===
Parts of this mod originate from non-free sources. However, there is an ongoing attempt to find and replace units' models with free ones. [https://springrts.com/phpbb/viewtopic.php?f=44&t=30537 BA Reloaded]

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

Lua:Callins

2019-05-10T13:09:24Z

Silentwings: move hint about drawing callins to avoid the implication that Update is the "best" place for calcs

= Lua Callins =
This page is future looking to unified widget/gadget (aka "addon") handler, which may yet be some way off, c.f. the [https://github.com/spring/spring/blob/ebb704e008f6ea645947d07be1cfcc272af0428f/doc/changelog.txt#L71 changelog].

Related Sourcecode :
[https://github.com/spring/spring/blob/d9b3927a528a876b9ab4042771e82b050267572a/rts/Lua/LuaHandle.cpp https://github.com/spring/spring/rts/Lua/LuaHandle.cpp]

For now, to use these addons in a widget, replace addon with widget and, for a gadget, replace addon with gadget. For example,
<code><pre>
function widget:UnitCreated(unitID, unitDefID, unitTeam, builderID)
...
end
</pre></code>

Some functions may differ between (synced) gadget and widgets; those are in the [[#Synced_-_Unsynced_Shared]] section. Essentially the reason is that all information should be available to synced (game logic controlling) gadgets, but restricted to unsynced gadget/widget (e.g. information about an enemy unit only detected via radar and not yet in LOS). In such cases the full (synced) param list is documented.

'''Attention:''' some callins will only work on the unsynced portion of the gadget. Due to the type-unsafe nature of lua parsing, those callins not firing up might be hard to trace. This document will be continuously updated to properly alert about those situations.

== Common ==
{{LuaCallin
|name = Initialize
|info = Called when the addon is (re)loaded.
}}

{{LuaCallin
|name = Shutdown
|info = Called when the addon or the game is shutdown.
}}

== Unsynced Only ==

{{LuaCallin
|name = DefaultCommand
|args = type, id
|return = {{type|number}} cmdID
|info = Used to set the default command when a unit is selected. First parameter is the type of the object pointed at (either "unit or "feature") and the second is its {{var|unitID}} or {{var|featureID}} respectively.
}}

{{LuaCallin
|name = CommandNotify
|args = cmdID, cmdParams, cmdOptions
|return = {{type|bool}} removeCmd
|info = Called when a command is issued. Returning {{value|true}} deletes the command and does not send it through the network.
}}

{{LuaCallin
|name = CommandsChanged
|args = None
|return = ?
|info = Called when the command descriptions changed, e.g. when selecting or deselecting a unit.
}}

{{LuaCallin
|name = WorldTooltip
|args = ttType, data1, data2, data3
|return = {{type|string}} newTooltip
|info = The parameters can be {{value|"unit"}}, {{var|unitID}}; {{value|"feature"}}, {{var|featureID}}; {{value|"ground"}}, {{var|posX}}, {{var|posY}}, {{var|posZ}} or {{value|"selection"}}.
}}

{{LuaCallin
|name = UnsyncedHeightMapUpdate
|args = ???
|info = Called when the unsynced copy of the height-map is altered.
}}

{{LuaCallin
|name = GameProgress
|args = serverFrameNum
|info = Called every 60 frames, calculating delta between GameFrame and GameProgress. Can give an ETA about catching up with simulation for mid-game join players.
}}

{{LuaCallin
|name = GameSetup
|args = state, ready, playerStates
|return = {{type|bool}} success, {{type|bool}} newReady
|info = ???
}}

{{LuaCallin
|name = SunChanged
|args = ???
|info = ???
}}

{{LuaCallin
|name = AddConsoleLine
|args = msg, priority
|info = Called when text is entered into the console (e.g. Spring.Echo).
}}

{{LuaCallin
|name = RecvSkirmishAIMessage
|args = aiTeam, dataStr
|return = ???
|info = ???
}}

{{LuaCallin
|name = RecvFromSynced
|args = ...
|info = Receives data sent via [[Lua_System#Synced|SendToUnsynced]] callout.
}}

{{LuaCallin
|name = Save
|args = zip
|info = Called when a chat command '/save' or '/savegame' is received. The single argument is a userdatum representing the savegame zip file. See [[Lua_SaveLoad#Save_.28_zip_.29_-.3E_nil|Lua_SaveLoad]].
}}

{{LuaCallin
|name = LoadProgress
|args = message, replaceLastLine
|info = Only available to LuaIntro.
}}

{{LuaCallin
|name = GroupChanged
|args = groupID
|info = Called when a unit is added to or removed from a control group. Currently implemented for widgets only.
}}

{{LuaCallin
|name = ConfigureLayout
|args = ???
|return = ???
|info = ???
}}

=== Input ===
{{LuaCallin
|name = IsAbove
|args = x, y
|return = {{type|bool}} isAbove
|info = Called every Update. Must return {{value|true}} for {{name|Mouse*}} events and {{name|GetToolTip}} to be called.
}}

{{LuaCallin
|name = GetTooltip
|args = x, y
|return = {{type|string}} tooltip
|info = Called when {{name|IsAbove}} returns {{value|true}}.
}}

{{LuaCallin
|name = KeyPress
|args = key, mods, isRepeat
|return = {{type|bool}} becomeOwner
|info = Called repeatedly when a key is pressed down. If you want an action to occur only once check for {{var|1=isRepeat == {{value|false}}}}. The {{var|mods}} parameter is a {{type|table}}, with keys {{value|"alt"}}, {{value|"ctrl"}}, {{value|"meta"}} and {{value|"shift"}} each having a boolean value. Return {{value|true}} if you don't want other callins or the engine to also receive this keypress. A list of key codes can be seen at the [https://wiki.libsdl.org/SDLKeycodeLookup SDL wiki].
}}

{{LuaCallin
|name = KeyRelease
|args = key
|return = {{type|bool}}
|info = Called when the key is released.
}}

{{LuaCallin
|name = TextInput
|args = utf8char
|info = Called whenever a key press results in text input. Introduced in 97.0.
}}

{{LuaCallin
|name = JoystickEvent
|args = ???
|info = ???
}}

{{LuaCallin
|name = MousePress
|args = x, y, button
|return = {{type|bool}} becomeMouseOwner
|info = Called when a mouse button is pressed. The {{var|button}} parameter supports up to 7 buttons. Must return {{value|true}} for {{name|MouseRelease}} and other functions to be called.
}}

{{LuaCallin
|name = MouseRelease
|args = x, y, button
|return = bool becomeMouseOwner
|info = Called when a mouse button is released. Please note that in order to have Spring call {{name|MouseRelease}}, you need to have a {{name|MousePress}} call-in in the same addon that returns {{value|true}}.
}}

{{LuaCallin
|name = MouseWheel
|args = up, value
|info = Called when the mouse wheel is moved. The parameters indicate the direction and amount of travel.
}}

{{LuaCallin
|name = MouseMove
|args = x, y, dx, dy, button
|info = Called when the mouse is moved. The {{var|dx}} and {{var|dy}} parameters indicate the distance travelled, whereas the first two indicate the final position.
}}

=== Players ===
{{LuaCallin
|name = PlayerChanged
|args = playerID
|info = Called whenever a player's status changes e.g. becoming a spectator.
}}

{{LuaCallin
|name = PlayerAdded
|args = playerID
|info = Called whenever a new player joins the game.
}}

{{LuaCallin
|name = PlayerRemoved
|args = playerID, reason
|info = Called whenever a player is removed from the game.
}}

=== Downloads ===

{{LuaCallin
|name = DownloadStarted
|args = id
|info = Called when a [[Pr-downloader]] download is started via [[Lua_VFS#Archives|VFS.DownloadArchive]].
}}

{{LuaCallin
|name = DownloadFinished
|args = id
|info = Called when a [[Pr-downloader]] download finishes successfully.
}}

{{LuaCallin
|name = DownloadFailed
|args = id, errorID
|info = Called when a [[Pr-downloader]] download fails to complete.
}}

{{LuaCallin
|name = DownloadProgress
|args = id, downloaded, total
|info = Called incrementally during a [[Pr-downloader]] download.
}}

=== Drawing ===
{{LuaCallin
|name = ViewResize
|args = viewSizeX, viewSizeY
|info = Called whenever the window is resized.
}}

{{LuaCallin
|name = Update
|args = dt
|info = Called for every draw frame (including when the game is paused) and at least once per sim frame except when catching up. The parameter is the time since the last update. }}

=== Draw* Functions ===
Inside the Draw* functions, you can use the [[Lua_OpenGL_Api | Lua OpenGL Api]] to draw graphics.
 
Avoid doing heavy calculations inside these callins; ideally, do the calculations elsewhere and use Draw callins only for drawing.

{{LuaCallin
|name = DrawGenesis
|info = Doesn't render to screen! Use this callin to update textures, shaders, etc. Also available to LuaMenu.
}}

{{LuaCallin
|name = DrawWorldPreParticles
|info = ??? {{new|104.0}}
}}

{{LuaCallin
|name = DrawWorldPreUnit
|info = Spring draws units, features, some water types, cloaked units, and the sun.
}}

{{LuaCallin
|name = DrawWorld
|info = Spring draws command queues, 'map stuff', and map marks.
}}

{{LuaCallin
|name = DrawWorldShadow
|info = ???
}}

{{LuaCallin
|name = DrawWorldReflection
|info = ???
}}

{{LuaCallin
|name = DrawWorldRefraction
|info = ???
}}

{{LuaCallin
|name = DrawGroundPreForward
|info = Runs at the start of the forward pass when a custom map shader has been assigned via [[Lua_UnsyncedCtrl#Map|{{name|Spring.SetMapShader}}]] (convenient for setting uniforms).
}}

{{LuaCallin
|name = DrawGroundPreDeferred
|info = Runs at the start of the deferred pass when a custom map shader has been assigned via [[Lua_UnsyncedCtrl#Map|{{name|Spring.SetMapShader}}]] (convenient for setting uniforms).
}}

{{LuaCallin
|name = DrawGroundPostDeferred
|info = This runs at the end of its respective deferred pass and allows proper frame compositing (with ground flashes/decals/foliage/etc, which are drawn between it and [[#API:DrawWorldPreUnit|{{name|DrawWorldPreUnit}}]]) via [[Lua_OpenGL_Api#Textures|{{name|gl.CopyToTexture}}]].
}}

{{LuaCallin
|name = DrawUnitsPostDeferred
|info = Runs at the end of the unit deferred pass to inform Lua code it should make use of the {{value|$model_gbuffer_*}} textures before another pass overwrites them (and to allow proper blending with e.g. cloaked objects which are drawn between these events and [[#API:DrawWorld|{{name|DrawWorld}}]] via [[Lua_OpenGL_Api#Textures|{{name|gl.CopyToTexture}}]]). N.B. The *PostDeferred events are only sent (and only have a real purpose) if forward drawing is disabled.
}}

{{LuaCallin
|name = DrawFeaturesPostDeferred
|info = Runs at the end of the feature deferred pass to inform Lua code it should make use of the {{value|$model_gbuffer_*}} textures before another pass overwrites them (and to allow proper blending with e.g. cloaked objects which are drawn between these events and [[#API:DrawWorld|{{name|DrawWorld}}]] via [[Lua_OpenGL_Api#Textures|{{name|gl.CopyToTexture}}]]). N.B. The *PostDeferred events are only sent (and only have a real purpose) if forward drawing is disabled.
}}

{{LuaCallin
|name = DrawScreen
|args = vsx, vsy
|info = ??? Also available to LuaMenu.
}}

{{LuaCallin
|name = DrawScreenEffects
|args = vsx, vsy
|info = Where {{var|vsx}}, {{var|vsy}} are screen coordinates.
}}

{{LuaCallin
|name = DrawScreenPost
|args = vsx, vsy
|info = {{new|104.0}} Similar to {{name|DrawScreenEffects}}, this can be used to alter the contents of a frame after it has been completely rendered (i.e. World, MiniMap, Menu, UI).
}}

{{LuaCallin
|name = DrawLoadScreen
|info = {{new|95.0}} Only available to LuaIntro, draws custom load screens.
}}

{{LuaCallin
|name = DrawInMinimap
|args = sx, sy
|info = Where {{var|sx}}, {{var|sy}} are values relative to the minimap's position and scale.
}}

{{LuaCallin
|name = DrawInMinimapBackground
|args = sx, sy
|info = Where {{var|sx}}, {{var|sy}} are values relative to the minimap's position and scale.
}}

=== Custom Object Rendering ===
For the following calls {{var|drawMode}} can be one of the following, {{var|1=notDrawing = {{value|0}}}}, {{var|1=normalDraw = {{value|1}}}}, {{var|1=shadowDraw = {{value|2}}}}, {{var|1=reflectionDraw = {{value|3}}}}, {{var|1=refractionDraw = {{value|4}}}}, and finally {{var|1=gameDeferredDraw = {{value|5}}}} which was added in 102.0.

{{LuaCallin
|name = DrawUnit
|args = unitID, drawMode
|return = {{type|bool}} suppressEngineDraw
|info = For custom rendering of units, [[Lua_UnitRendering#Lua.27s_DrawXYZ-Callin|enabled here]].
}}

{{LuaCallin
|name = DrawFeature
|args = unitID, drawMode
|return = {{type|bool}} suppressEngineDraw
|info = For custom rendering of features, [[Lua_UnitRendering#Lua.27s_DrawXYZ-Callin|enabled here]].
}}

{{LuaCallin
|name = DrawShield
|args = unitID, weaponID, drawMode
|return = {{type|bool}} suppressEngineDraw
|info = For custom rendering of [[Gamedev:WeaponDefs#Shield_(WeaponType)|shields]].
}}

{{LuaCallin
|name = DrawProjectile
|args = projectileID, drawMode
|return = {{type|bool}} suppressEngineDraw
|info = For custom rendering of weapon (& other) projectiles.
}}

== Unsynced Menu Only ==

{{LuaCallin
|name = AllowDraw
|return = {{type|bool}} allowDraw
|info = Enables Draw{Genesis,Screen,ScreenPost} callins if {{value|true}} is returned, otherwise they are called once every 30 seconds. Only active when a game isn't running.
}}

{{LuaCallin
|name = ActivateMenu
|info = Called whenever LuaMenu is on with no game loaded.
}}

{{LuaCallin
|name = ActivateGame
|info = Called whenever LuaMenu is on with a game loaded.
}}

== Synced - Unsynced Shared ==

{{LuaCallin
|name = GotChatMsg
|args = msg, player
|info = Called when a player issues a UI command e.g. types {{var|/foo}} or {{var|/luarules foo}}.
}}

=== Game ===

{{LuaCallin
|name = GameID
|args = gameID
|info = Called once to deliver the {{var|gameID}}. As of 101.0+ the string is encoded in hex.
}}

{{LuaCallin
|name = GamePaused
|info = Called when the game is paused.
}}

{{LuaCallin
|name = GameOver
|args = winningAllyTeams
|info = The parameter is a {{type|table}} list of winning allyTeams, if empty the game result was undecided (like when dropping from an host).
}}

{{LuaCallin
|name = GameFrame
|args = frame
|info = Called for every game simulation frame (30 per second). Starts at frame {{value|0}} in 101.0+ and {{value|1}} in previous versions.
}}

{{LuaCallin
|name = GamePreload
|info = Called before the 0 gameframe. From 104.0 onwards, will not be called when a saved game is loaded.
}}

{{LuaCallin
|name = GameStart
|info = Called upon the start of the game. From 104.0 onwards, will not be called when a saved game is loaded.
}}

=== Teams ===
{{LuaCallin
|name = TeamChanged
|args = teamID
|info = ???
}}

{{LuaCallin
|name = TeamDied
|args = teamID
|info = Called when a team dies (see [[Lua_SyncedCtrl#Game_End|Spring.KillTeam]]).
}}

=== Units ===
{{LuaCallin
|name = UnitCreated
|args = unitID, unitDefID, unitTeam, builderID
|info = Called at the moment the unit is created.
}}

{{LuaCallin
|name = UnitFinished
|args = unitID, unitDefID, unitTeam
|info = Called at the moment the unit is completed.
}}

{{LuaCallin
|name = UnitFromFactory
|args = unitID, unitDefID, unitTeam, factID, factDefID, userOrders
|info = Called when a factory finishes construction of a unit.
}}

{{LuaCallin
|name = UnitReverseBuilt
|args = unitID, unitDefID, unitTeam
|info = Called when a living unit becomes a nanoframe again.
}}

{{LuaCallin
|name = UnitGiven
|args = unitID, unitDefID, newTeam, oldTeam
|info = Called when a unit is transferred between teams. This is called after {{name|UnitTaken}} and in that moment unit is assigned to the '''newTeam'''.
}}

{{LuaCallin
|name = UnitTaken
|args = unitID, unitDefID, oldTeam, newTeam
|info = Called when a unit is transferred between teams. This is called before {{name|UnitGiven}} and in that moment unit is still assigned to the '''oldTeam'''.
}}

{{LuaCallin
|name = UnitDamaged
|args = unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|info = Called when a unit is damaged (after {{name|UnitPreDamaged}}).
}}

{{LuaCallin
|name = UnitDestroyed
|args = unitID, unitDefID, unitTeam, attackerID, attackerDefID, attackerTeam
|info = Called when a unit is destroyed.
}}

{{LuaCallin
|name = RenderUnitDestroyed
|args = unitID, unitDefID, unitTeam
|info = Called just before a unit is invalid, after it finishes its death animation. {{new|101.0}}
}}

{{LuaCallin
|name = UnitStunned
|args = unitID, unitDefID, unitTeam, stunned
|info = Called when a unit changes its stun status. {{new|99.0}}
}}

{{LuaCallin
|name = UnitUnitCollision
|args = colliderID, collideeID
|info = Called when two units collide. Both units must be registered with [[Lua_System#Synced|Script.SetWatchUnit]].
}}

{{LuaCallin
|name = UnitFeatureCollision
|args = colliderID, collideeID
|info = Called when a unit collides with a feature. The unit must be registered with [[Lua_System#Synced|Script.SetWatchUnit]] and the feature registered with [[Lua_System#Synced|Script.SetWatchFeature]].
}}

{{LuaCallin
|name = UnitCommand
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOpts, cmdTag
|info = Called after when a unit accepts a command, after {{name|AllowCommand}} returns {{value|true}}.
}}

{{LuaCallin
|name = UnitCmdDone
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOpts, cmdTag
|info = Called when a unit completes a command.
}}

{{LuaCallin
|name = UnitLoaded
|args = unitID, unitDefID, unitTeam, transportID, transportTeam
|info = Called when a unit is loaded by a transport.
}}

{{LuaCallin
|name = UnitUnloaded
|args = unitID, unitDefID, unitTeam, transportID, transportTeam
|info = Called when a unit is unloaded by a transport.
}}

{{LuaCallin
|name = UnitExperience
|args = unitID, unitDefID, unitTeam, experience, oldExperience
|info = Called when a unit gains experience greater or equal to the minimum limit set by calling [[Lua_SyncedCtrl#Other|Spring.SetExperienceGrade]]. Should be called more reliably with small values of experience grade in 104.0+.
}}

{{LuaCallin
|name = UnitIdle
|args = unitID, unitDefID, unitTeam
|info = Called when a unit is idle (empty command queue).
}}

{{LuaCallin
|name = UnitCloaked
|args = unitID, unitDefID, unitTeam
|info = Called when a unit cloaks.
}}

{{LuaCallin
|name = UnitDecloaked
|args = unitID, unitDefID, unitTeam
|info = Called when a unit decloaks.
}}

{{LuaCallin
|name = UnitMoved
|args = ???
|info = ??? Not implemented in base handler
}}

{{LuaCallin
|name = UnitMoveFailed
|args = ???
|info = ??? Not implemented in base handler
}}

{{LuaCallin
|name = StockpileChanged
|args = unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount
|info = Called when a units stockpile of weapons increases or decreases. See {{xtaglink|Gamedev:WeaponDefs|stockpile}}.
}}

{{LuaCallin
|name = UnitEnteredLos
|args = unitID, unitTeam, allyTeam, unitDefID
|info = Called when a unit enters LOS of an allyteam.
}}

{{LuaCallin
|name = UnitLeftLos
|args = unitID, unitTeam, allyTeam, unitDefID
|info = Called when a unit leaves LOS of an allyteam.
}}

{{LuaCallin
|name = UnitEnteredRadar
|args = unitID, unitTeam, allyTeam, unitDefID
|info = Called when a unit enters radar of an allyteam.
}}

{{LuaCallin
|name = UnitLeftRadar
|args = unitID, unitTeam, allyTeam, unitDefID
|info = Called when a unit leaves radar of an allyteam.
}}

{{LuaCallin
|name = UnitEnteredAir
|args = ???
|info = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitLeftAir
|args = ???
|info = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitEnteredWater
|args = ???
|info = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitLeftWater
|args = ???
|info = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitSeismicPing
|args = x, y, z, strength, allyTeam, unitID, unitDefID
|info = Called when a unit emits a seismic ping. See {{xtaglink|Gamedev:UnitDefs|seismicSignature}}.
}}

=== Features ===
{{LuaCallin
|name = FeatureCreated
|args = featureID, allyTeamID
|info = Called when a feature is created.
}}

{{LuaCallin
|name = FeatureDamaged
|args = featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|info = Called when a feature is damaged.
}}

{{LuaCallin
|name = FeatureDestroyed
|args = featureID, allyTeamID
|info = Called when a feature is destroyed.
}}

{{LuaCallin
|name = FeatureMoved
|args = ???
|info = ???
}}

=== Projectiles ===
The following Callins are only called for weaponDefIDs registered via [[Lua_System#Synced|Script.SetWatchWeapon]].

{{LuaCallin
|name = ProjectileCreated
|args = proID, proOwnerID, weaponDefID
|info = Called when the projectile is created. Note that {{var|weaponDefID}} is missing if the projectile is spawned as part of a burst, but [[Lua_SyncedRead#Projectiles|Spring.GetProjectileDefID]] and [[Lua_SyncedRead#Projectiles|Spring.GetProjectileName]] still work in callin scope using {{var|proID}}.
}}

{{LuaCallin
|name = ProjectileDestroyed
|args = proID
|info = Called when the projectile is destroyed.
}}

== Synced Only ==
{{LuaCallin
|name = CommandFallback
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag
|return = {{type|bool}} used, {{type|bool}} finished
|info = Called when the unit reaches an unknown command in its queue (i.e. one not handled by the engine). If no addon returns {{var|used}} as {{value|true}} the command is dropped, if an addon returns {{value|true}}, {{value|true}} the command is removed because it's done, with {{value|true}}, {{value|false}} it's kept in the queue and {{name|CommandFallback}} gets called again on the next slowupdate.
}}

{{LuaCallin
|name = AllowCommand
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced
|return = {{type|bool}} allow
|info = Called when the command is given, before the unit's queue is altered. The return value is whether it should be let into the queue. The queue remains untouched when a command is blocked, whether it would be queued or replace the queue.
}}

{{LuaCallin
|name = AllowUnitCreation
|args = unitDefID, builderID, builderTeam, x, y, z, facing
|return = {{type|bool}} allow
|info = Called just before unit is created, the boolean return value determines whether or not the creation is permitted.
}}

{{LuaCallin
|name = AllowUnitTransfer
|args = unitID, unitDefID, oldTeam, newTeam, capture
|return = {{type|bool}} allow
|info = Called just before a unit is transferred to a different team, the boolean return value determines whether or not the transfer is permitted.
}}

{{LuaCallin
|name = AllowUnitBuildStep
|args = builderID, builderTeam, unitID, unitDefID, part
|return = {{type|bool}} allow
|info = Called just before a unit progresses its build percentage, the boolean return value determines whether or not the build makes progress.
}}

{{LuaCallin
|name = AllowFeatureCreation
|args = featureDefID, teamID, x, y, z
|return = {{type|bool}} allow
|info = Called just before feature is created, the boolean return value determines whether or not the creation is permitted.
}}

{{LuaCallin
|name = AllowFeatureBuildStep
|args = builderID, builderTeam, featureID, featureDefID, part
|return = {{type|bool}} allow
|info = Called just before a feature progresses its build percentage, the boolean return value determines whether or not the progress change is permitted.
}}

{{LuaCallin
|name = AllowResourceLevel
|args = teamID, res, level
|return = {{type|bool}} allow
|info = Called when a team sets the sharing level of a resource, the boolean return value determines whether or not the sharing level is permitted.
}}

{{LuaCallin
|name = AllowResourceTransfer
|args = oldTeamID, newTeamID, res, amount
|return = {{type|bool}} allow
|info = Called just before resources are transferred between players, the boolean return value determines whether or not the transfer is permitted.
}}

{{LuaCallin
|name = AllowStartPosition
|args = playerID, teamID, readyState, clampedX, clampedY, clampedZ, rawX, rawY, rawZ
|return = {{type|bool}} allow
|info = {{var|clamped{X,Y,Z}}} are the coordinates clamped into start-boxes, {{var|raw}} is where player tried to place their marker. The {{var|readyState}} can be any one of
* {{value|0}} - player picked a position,
* {{value|1}} - player clicked ready,
* {{value|2}} - player pressed ready OR the game was force-started (player did not click ready, but is now forcibly readied) or
* {{value|3}} - the player failed to load.
* {{new|95.0}} the default 'failed to choose' start-position is the north-west point of their startbox, or (0,0,0) if they do not have a startbox.
NB: The order of the parameters changed with the addition of {{var|teamID}} in 104.0. Previouly it was:
{{var|clampedX, clampedY, clampedZ, playerID, readyState, rawX, rawY, rawZ}}
}}

{{LuaCallin
|name = AllowDirectUnitControl
|args = unitID, unitDefID, unitTeam, playerID
|return = {{type|bool}} allow
|info = Determines if this unit can be controlled directly in FPS view.
}}

{{LuaCallin
|name = AllowWeaponTargetCheck
|args = attackerID, attackerWeaponNum, attackerWeaponDefID
|return = {{type|bool}} allowCheck, {{type|bool}} ignoreCheck
|info = Determines if this weapon can automatically generate targets itself. See also {{xtaglink|Gamedev:WeaponDefs|commandFire}} weaponDef tag. The {{var|ignoreCheck}} return value was added in 99.0 to allow ignoring the callin i.e. running normal engine check for this weapon.
}}

{{LuaCallin
|name = AllowWeaponTarget
|args = attackerID, targetID, attackerWeaponNum, attackerWeaponDefID, defPriority
|return = {{type|bool}} allowed, {{type|number}} newPriority
|info = Controls blocking of a specific target from being considered during a weapon's periodic auto-targeting sweep. The second return value is the new priority for this target (if you don't want to change it, return {{var|defPriority}}). Lower priority targets are targeted first.
}}

{{LuaCallin
|name = AllowWeaponInterceptTarget
|args = interceptorUnitID, interceptorWeaponID, targetProjectileID
|return = {{type|bool}} allowed
|info = Controls blocking of a specific intercept target from being considered during an {{xtaglink|Gamedev:WeaponDefs|interceptor}} weapon's periodic auto-targeting sweep. Only called for {{var|weaponDefIDs}} registered via [[Lua_System#Synced|Script.SetWatchWeapon]].
}}

{{LuaCallin
|name = AllowBuilderHoldFire
|args = unitID, unitDefID, action
|return = {{type|bool}} actionAllowed
|info = {{new|98.0}} {{Sourcelinkhash|5a82d750b89e72024bb0bb62cf05ea257737e0ac}} Called when a construction unit wants to "use his nano beams". {{var|action}} is one of following:
* {{value|-1}} Build
* {{value|CMD.REPAIR}} Repair
* {{value|CMD.RECLAIM}} Reclaim
* {{value|CMD.RESTORE}} Restore
* {{value|CMD.RESURRECT}} Resurrect
* {{value|CMD.CAPTURE}} Capture
}}

{{LuaCallin
|name = Explosion
|args = weaponDefID, px, py, pz, AttackerID, ProjectileID
|return = {{type|bool}} noGfx
|info = Called when an explosion occurs. If it returns {{value|true}} then no graphical effects are drawn by the engine for this explosion.
}}

{{LuaCallin
|name = TerraformComplete
|args = unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam
|return = {{type|bool}} stop
|info = Called when pre-building terrain levelling terraforms are completed (c.f. {{xtaglink|Gamedev:UnitDefs|levelGround}}). If the return value is {{value|true}} the current build order is terminated.
}}

{{LuaCallin
|name = MoveCtrlNotify
|args = unitID, unitDefID, unitTeam, data
|return = {{type|bool}} moveCtrlComplete
|info = Enable both [[Lua_MoveCtrl#Options|Spring.MoveCtrl.SetCollideStop]] and [[Lua_MoveCtrl#Options|Spring.MoveCtrl.SetTrackGround]] to enable this call-in, data was supposed to indicate the type of notification but currently never has a value other than {{value|1}} ("unit hit the ground"). The return value determines whether or not the unit should remain script-controlled ({{value|false}}) or return to engine controlled movement ({{value|true}}).
}}

{{LuaCallin
|name = RecvLuaMsg
|args = msg, playerID
|info = Receives messages from unsynced sent via [[Lua_UnsyncedCtrl#SendLuaMessage|Spring.SendLuaRulesMsg]].
}}

{{LuaCallin
|name = Load
|args = zip
|info = Called after {{name|GamePreload}} and before {{name|GameStart}}. See [[Lua_SaveLoad#Load_.28_zip_.29_-.3E_nil|Lua_SaveLoad]].
}}

=== Damage Controllers ===
For the following callins, in addition to being a regular weapon, {{var|weaponDefID}} may be one of the following:
* {{value|-1}} - debris collision, also default of [[Lua_SyncedCtrl#Unit_Control|Spring.AddUnitDamage]]
* {{value|-2}} - ground collision
* {{value|-3}} - object collision
* {{value|-4}} - fire damage
* {{value|-5}} - water damage
* {{value|-6}} - kill damage
* {{value|-7}} - crush damage

{{LuaCallin
|name = UnitPreDamaged
|args = unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|return = {{type|number}} newDamage, {{type|number}} impulseMult
|info = Called before damage is applied to the unit, allows fine control over how much damage and [http://en.wikipedia.org/wiki/Impulse_(physics) impulse] is applied.
}}

{{LuaCallin
|name = ShieldPreDamaged
|I recommend looking up the CallIns in Sourcecode, because the Lua-Documentation, generated from the lua handle of them is seriously flawed and not regenerated.
|Lua-Handler documented from version
|args = proID, proOwnerID, shieldEmitterWeaponNum, shieldCarrierUnitID, bounceProjectile, beamEmitterWeaponNum, beamEmitterUnitID, startX, startY, startZ, hitX, hitY, hitZ
|https://github.com/spring/spring/blob/d085e297416bd963ec25eaa3dbf0796ba22a3582/rts/Lua/LuaHandleSynced.h#L106
|Actual CallIn:
|args = proID, shieldCarrier, boolBounceProjectile, beamEmitterWeaponNum, beamEmitterUnitID, startX, startY, startZ, hitX, hitY, hitZ
|return = {{type|bool}} handleCollision
|info = Called before any engine shield-vs-projectile logic executes. If the return value is {{value|true}} the gadget handles the collision event and the engine does not remove the projectile. If the weapon is a hitscan type ([[Gamedev:WeaponDefs#Tag:weaponType|BeamLaser]] or [[Gamedev:WeaponDefs#Tag:weaponType|LightningCanon]]) then {{var|proID}} is {{value|nil}} and {{var|beamEmitterWeaponNum}} and {{var|beamEmitterUnitID}} are populated instead. The start and hit position arguments are provided from 104.0 onwards.
}}

{{LuaCallin
|name = FeaturePreDamaged
|args = featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|return = {{type|number}} newDamage, {{type|number}} impulseMult
|info = Called before damage is applied to the feature, allows fine control over how much damage and [http://en.wikipedia.org/wiki/Impulse_(physics) impulse] is applied.
}}

[[Category: Lua]]

Lua:Callins

2019-05-10T13:06:43Z

Silentwings: /* Drawing */ more clarity

= Lua Callins =
This page is future looking to unified widget/gadget (aka "addon") handler, which may yet be some way off, c.f. the [https://github.com/spring/spring/blob/ebb704e008f6ea645947d07be1cfcc272af0428f/doc/changelog.txt#L71 changelog].

Related Sourcecode :
[https://github.com/spring/spring/blob/d9b3927a528a876b9ab4042771e82b050267572a/rts/Lua/LuaHandle.cpp https://github.com/spring/spring/rts/Lua/LuaHandle.cpp]

For now, to use these addons in a widget, replace addon with widget and, for a gadget, replace addon with gadget. For example,
<code><pre>
function widget:UnitCreated(unitID, unitDefID, unitTeam, builderID)
...
end
</pre></code>

Some functions may differ between (synced) gadget and widgets; those are in the [[#Synced_-_Unsynced_Shared]] section. Essentially the reason is that all information should be available to synced (game logic controlling) gadgets, but restricted to unsynced gadget/widget (e.g. information about an enemy unit only detected via radar and not yet in LOS). In such cases the full (synced) param list is documented.

'''Attention:''' some callins will only work on the unsynced portion of the gadget. Due to the type-unsafe nature of lua parsing, those callins not firing up might be hard to trace. This document will be continuously updated to properly alert about those situations.

== Common ==
{{LuaCallin
|name = Initialize
|info = Called when the addon is (re)loaded.
}}

{{LuaCallin
|name = Shutdown
|info = Called when the addon or the game is shutdown.
}}

== Unsynced Only ==

{{LuaCallin
|name = DefaultCommand
|args = type, id
|return = {{type|number}} cmdID
|info = Used to set the default command when a unit is selected. First parameter is the type of the object pointed at (either "unit or "feature") and the second is its {{var|unitID}} or {{var|featureID}} respectively.
}}

{{LuaCallin
|name = CommandNotify
|args = cmdID, cmdParams, cmdOptions
|return = {{type|bool}} removeCmd
|info = Called when a command is issued. Returning {{value|true}} deletes the command and does not send it through the network.
}}

{{LuaCallin
|name = CommandsChanged
|args = None
|return = ?
|info = Called when the command descriptions changed, e.g. when selecting or deselecting a unit.
}}

{{LuaCallin
|name = WorldTooltip
|args = ttType, data1, data2, data3
|return = {{type|string}} newTooltip
|info = The parameters can be {{value|"unit"}}, {{var|unitID}}; {{value|"feature"}}, {{var|featureID}}; {{value|"ground"}}, {{var|posX}}, {{var|posY}}, {{var|posZ}} or {{value|"selection"}}.
}}

{{LuaCallin
|name = UnsyncedHeightMapUpdate
|args = ???
|info = Called when the unsynced copy of the height-map is altered.
}}

{{LuaCallin
|name = GameProgress
|args = serverFrameNum
|info = Called every 60 frames, calculating delta between GameFrame and GameProgress. Can give an ETA about catching up with simulation for mid-game join players.
}}

{{LuaCallin
|name = GameSetup
|args = state, ready, playerStates
|return = {{type|bool}} success, {{type|bool}} newReady
|info = ???
}}

{{LuaCallin
|name = SunChanged
|args = ???
|info = ???
}}

{{LuaCallin
|name = AddConsoleLine
|args = msg, priority
|info = Called when text is entered into the console (e.g. Spring.Echo).
}}

{{LuaCallin
|name = RecvSkirmishAIMessage
|args = aiTeam, dataStr
|return = ???
|info = ???
}}

{{LuaCallin
|name = RecvFromSynced
|args = ...
|info = Receives data sent via [[Lua_System#Synced|SendToUnsynced]] callout.
}}

{{LuaCallin
|name = Save
|args = zip
|info = Called when a chat command '/save' or '/savegame' is received. The single argument is a userdatum representing the savegame zip file. See [[Lua_SaveLoad#Save_.28_zip_.29_-.3E_nil|Lua_SaveLoad]].
}}

{{LuaCallin
|name = LoadProgress
|args = message, replaceLastLine
|info = Only available to LuaIntro.
}}

{{LuaCallin
|name = GroupChanged
|args = groupID
|info = Called when a unit is added to or removed from a control group. Currently implemented for widgets only.
}}

{{LuaCallin
|name = ConfigureLayout
|args = ???
|return = ???
|info = ???
}}

=== Input ===
{{LuaCallin
|name = IsAbove
|args = x, y
|return = {{type|bool}} isAbove
|info = Called every Update. Must return {{value|true}} for {{name|Mouse*}} events and {{name|GetToolTip}} to be called.
}}

{{LuaCallin
|name = GetTooltip
|args = x, y
|return = {{type|string}} tooltip
|info = Called when {{name|IsAbove}} returns {{value|true}}.
}}

{{LuaCallin
|name = KeyPress
|args = key, mods, isRepeat
|return = {{type|bool}} becomeOwner
|info = Called repeatedly when a key is pressed down. If you want an action to occur only once check for {{var|1=isRepeat == {{value|false}}}}. The {{var|mods}} parameter is a {{type|table}}, with keys {{value|"alt"}}, {{value|"ctrl"}}, {{value|"meta"}} and {{value|"shift"}} each having a boolean value. Return {{value|true}} if you don't want other callins or the engine to also receive this keypress. A list of key codes can be seen at the [https://wiki.libsdl.org/SDLKeycodeLookup SDL wiki].
}}

{{LuaCallin
|name = KeyRelease
|args = key
|return = {{type|bool}}
|info = Called when the key is released.
}}

{{LuaCallin
|name = TextInput
|args = utf8char
|info = Called whenever a key press results in text input. Introduced in 97.0.
}}

{{LuaCallin
|name = JoystickEvent
|args = ???
|info = ???
}}

{{LuaCallin
|name = MousePress
|args = x, y, button
|return = {{type|bool}} becomeMouseOwner
|info = Called when a mouse button is pressed. The {{var|button}} parameter supports up to 7 buttons. Must return {{value|true}} for {{name|MouseRelease}} and other functions to be called.
}}

{{LuaCallin
|name = MouseRelease
|args = x, y, button
|return = bool becomeMouseOwner
|info = Called when a mouse button is released. Please note that in order to have Spring call {{name|MouseRelease}}, you need to have a {{name|MousePress}} call-in in the same addon that returns {{value|true}}.
}}

{{LuaCallin
|name = MouseWheel
|args = up, value
|info = Called when the mouse wheel is moved. The parameters indicate the direction and amount of travel.
}}

{{LuaCallin
|name = MouseMove
|args = x, y, dx, dy, button
|info = Called when the mouse is moved. The {{var|dx}} and {{var|dy}} parameters indicate the distance travelled, whereas the first two indicate the final position.
}}

=== Players ===
{{LuaCallin
|name = PlayerChanged
|args = playerID
|info = Called whenever a player's status changes e.g. becoming a spectator.
}}

{{LuaCallin
|name = PlayerAdded
|args = playerID
|info = Called whenever a new player joins the game.
}}

{{LuaCallin
|name = PlayerRemoved
|args = playerID, reason
|info = Called whenever a player is removed from the game.
}}

=== Downloads ===

{{LuaCallin
|name = DownloadStarted
|args = id
|info = Called when a [[Pr-downloader]] download is started via [[Lua_VFS#Archives|VFS.DownloadArchive]].
}}

{{LuaCallin
|name = DownloadFinished
|args = id
|info = Called when a [[Pr-downloader]] download finishes successfully.
}}

{{LuaCallin
|name = DownloadFailed
|args = id, errorID
|info = Called when a [[Pr-downloader]] download fails to complete.
}}

{{LuaCallin
|name = DownloadProgress
|args = id, downloaded, total
|info = Called incrementally during a [[Pr-downloader]] download.
}}

=== Drawing ===
{{LuaCallin
|name = ViewResize
|args = viewSizeX, viewSizeY
|info = Called whenever the window is resized.
}}

{{LuaCallin
|name = Update
|args = dt
|info = Called for every draw frame (including when the game is paused) and at least once per sim frame except when catching up. The parameter is the time since the last update. Perform calculations in here and only perform drawing in Draw* callins (listed below). }}

=== Draw* Functions ===
Inside the Draw* functions, you can use the [[Lua_OpenGL_Api | Lua OpenGL Api]] to draw graphics.
 

{{LuaCallin
|name = DrawGenesis
|info = Doesn't render to screen! Use this callin to update textures, shaders, etc. Also available to LuaMenu.
}}

{{LuaCallin
|name = DrawWorldPreParticles
|info = ??? {{new|104.0}}
}}

{{LuaCallin
|name = DrawWorldPreUnit
|info = Spring draws units, features, some water types, cloaked units, and the sun.
}}

{{LuaCallin
|name = DrawWorld
|info = Spring draws command queues, 'map stuff', and map marks.
}}

{{LuaCallin
|name = DrawWorldShadow
|info = ???
}}

{{LuaCallin
|name = DrawWorldReflection
|info = ???
}}

{{LuaCallin
|name = DrawWorldRefraction
|info = ???
}}

{{LuaCallin
|name = DrawGroundPreForward
|info = Runs at the start of the forward pass when a custom map shader has been assigned via [[Lua_UnsyncedCtrl#Map|{{name|Spring.SetMapShader}}]] (convenient for setting uniforms).
}}

{{LuaCallin
|name = DrawGroundPreDeferred
|info = Runs at the start of the deferred pass when a custom map shader has been assigned via [[Lua_UnsyncedCtrl#Map|{{name|Spring.SetMapShader}}]] (convenient for setting uniforms).
}}

{{LuaCallin
|name = DrawGroundPostDeferred
|info = This runs at the end of its respective deferred pass and allows proper frame compositing (with ground flashes/decals/foliage/etc, which are drawn between it and [[#API:DrawWorldPreUnit|{{name|DrawWorldPreUnit}}]]) via [[Lua_OpenGL_Api#Textures|{{name|gl.CopyToTexture}}]].
}}

{{LuaCallin
|name = DrawUnitsPostDeferred
|info = Runs at the end of the unit deferred pass to inform Lua code it should make use of the {{value|$model_gbuffer_*}} textures before another pass overwrites them (and to allow proper blending with e.g. cloaked objects which are drawn between these events and [[#API:DrawWorld|{{name|DrawWorld}}]] via [[Lua_OpenGL_Api#Textures|{{name|gl.CopyToTexture}}]]). N.B. The *PostDeferred events are only sent (and only have a real purpose) if forward drawing is disabled.
}}

{{LuaCallin
|name = DrawFeaturesPostDeferred
|info = Runs at the end of the feature deferred pass to inform Lua code it should make use of the {{value|$model_gbuffer_*}} textures before another pass overwrites them (and to allow proper blending with e.g. cloaked objects which are drawn between these events and [[#API:DrawWorld|{{name|DrawWorld}}]] via [[Lua_OpenGL_Api#Textures|{{name|gl.CopyToTexture}}]]). N.B. The *PostDeferred events are only sent (and only have a real purpose) if forward drawing is disabled.
}}

{{LuaCallin
|name = DrawScreen
|args = vsx, vsy
|info = ??? Also available to LuaMenu.
}}

{{LuaCallin
|name = DrawScreenEffects
|args = vsx, vsy
|info = Where {{var|vsx}}, {{var|vsy}} are screen coordinates.
}}

{{LuaCallin
|name = DrawScreenPost
|args = vsx, vsy
|info = {{new|104.0}} Similar to {{name|DrawScreenEffects}}, this can be used to alter the contents of a frame after it has been completely rendered (i.e. World, MiniMap, Menu, UI).
}}

{{LuaCallin
|name = DrawLoadScreen
|info = {{new|95.0}} Only available to LuaIntro, draws custom load screens.
}}

{{LuaCallin
|name = DrawInMinimap
|args = sx, sy
|info = Where {{var|sx}}, {{var|sy}} are values relative to the minimap's position and scale.
}}

{{LuaCallin
|name = DrawInMinimapBackground
|args = sx, sy
|info = Where {{var|sx}}, {{var|sy}} are values relative to the minimap's position and scale.
}}

=== Custom Object Rendering ===
For the following calls {{var|drawMode}} can be one of the following, {{var|1=notDrawing = {{value|0}}}}, {{var|1=normalDraw = {{value|1}}}}, {{var|1=shadowDraw = {{value|2}}}}, {{var|1=reflectionDraw = {{value|3}}}}, {{var|1=refractionDraw = {{value|4}}}}, and finally {{var|1=gameDeferredDraw = {{value|5}}}} which was added in 102.0.

{{LuaCallin
|name = DrawUnit
|args = unitID, drawMode
|return = {{type|bool}} suppressEngineDraw
|info = For custom rendering of units, [[Lua_UnitRendering#Lua.27s_DrawXYZ-Callin|enabled here]].
}}

{{LuaCallin
|name = DrawFeature
|args = unitID, drawMode
|return = {{type|bool}} suppressEngineDraw
|info = For custom rendering of features, [[Lua_UnitRendering#Lua.27s_DrawXYZ-Callin|enabled here]].
}}

{{LuaCallin
|name = DrawShield
|args = unitID, weaponID, drawMode
|return = {{type|bool}} suppressEngineDraw
|info = For custom rendering of [[Gamedev:WeaponDefs#Shield_(WeaponType)|shields]].
}}

{{LuaCallin
|name = DrawProjectile
|args = projectileID, drawMode
|return = {{type|bool}} suppressEngineDraw
|info = For custom rendering of weapon (& other) projectiles.
}}

== Unsynced Menu Only ==

{{LuaCallin
|name = AllowDraw
|return = {{type|bool}} allowDraw
|info = Enables Draw{Genesis,Screen,ScreenPost} callins if {{value|true}} is returned, otherwise they are called once every 30 seconds. Only active when a game isn't running.
}}

{{LuaCallin
|name = ActivateMenu
|info = Called whenever LuaMenu is on with no game loaded.
}}

{{LuaCallin
|name = ActivateGame
|info = Called whenever LuaMenu is on with a game loaded.
}}

== Synced - Unsynced Shared ==

{{LuaCallin
|name = GotChatMsg
|args = msg, player
|info = Called when a player issues a UI command e.g. types {{var|/foo}} or {{var|/luarules foo}}.
}}

=== Game ===

{{LuaCallin
|name = GameID
|args = gameID
|info = Called once to deliver the {{var|gameID}}. As of 101.0+ the string is encoded in hex.
}}

{{LuaCallin
|name = GamePaused
|info = Called when the game is paused.
}}

{{LuaCallin
|name = GameOver
|args = winningAllyTeams
|info = The parameter is a {{type|table}} list of winning allyTeams, if empty the game result was undecided (like when dropping from an host).
}}

{{LuaCallin
|name = GameFrame
|args = frame
|info = Called for every game simulation frame (30 per second). Starts at frame {{value|0}} in 101.0+ and {{value|1}} in previous versions.
}}

{{LuaCallin
|name = GamePreload
|info = Called before the 0 gameframe. From 104.0 onwards, will not be called when a saved game is loaded.
}}

{{LuaCallin
|name = GameStart
|info = Called upon the start of the game. From 104.0 onwards, will not be called when a saved game is loaded.
}}

=== Teams ===
{{LuaCallin
|name = TeamChanged
|args = teamID
|info = ???
}}

{{LuaCallin
|name = TeamDied
|args = teamID
|info = Called when a team dies (see [[Lua_SyncedCtrl#Game_End|Spring.KillTeam]]).
}}

=== Units ===
{{LuaCallin
|name = UnitCreated
|args = unitID, unitDefID, unitTeam, builderID
|info = Called at the moment the unit is created.
}}

{{LuaCallin
|name = UnitFinished
|args = unitID, unitDefID, unitTeam
|info = Called at the moment the unit is completed.
}}

{{LuaCallin
|name = UnitFromFactory
|args = unitID, unitDefID, unitTeam, factID, factDefID, userOrders
|info = Called when a factory finishes construction of a unit.
}}

{{LuaCallin
|name = UnitReverseBuilt
|args = unitID, unitDefID, unitTeam
|info = Called when a living unit becomes a nanoframe again.
}}

{{LuaCallin
|name = UnitGiven
|args = unitID, unitDefID, newTeam, oldTeam
|info = Called when a unit is transferred between teams. This is called after {{name|UnitTaken}} and in that moment unit is assigned to the '''newTeam'''.
}}

{{LuaCallin
|name = UnitTaken
|args = unitID, unitDefID, oldTeam, newTeam
|info = Called when a unit is transferred between teams. This is called before {{name|UnitGiven}} and in that moment unit is still assigned to the '''oldTeam'''.
}}

{{LuaCallin
|name = UnitDamaged
|args = unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|info = Called when a unit is damaged (after {{name|UnitPreDamaged}}).
}}

{{LuaCallin
|name = UnitDestroyed
|args = unitID, unitDefID, unitTeam, attackerID, attackerDefID, attackerTeam
|info = Called when a unit is destroyed.
}}

{{LuaCallin
|name = RenderUnitDestroyed
|args = unitID, unitDefID, unitTeam
|info = Called just before a unit is invalid, after it finishes its death animation. {{new|101.0}}
}}

{{LuaCallin
|name = UnitStunned
|args = unitID, unitDefID, unitTeam, stunned
|info = Called when a unit changes its stun status. {{new|99.0}}
}}

{{LuaCallin
|name = UnitUnitCollision
|args = colliderID, collideeID
|info = Called when two units collide. Both units must be registered with [[Lua_System#Synced|Script.SetWatchUnit]].
}}

{{LuaCallin
|name = UnitFeatureCollision
|args = colliderID, collideeID
|info = Called when a unit collides with a feature. The unit must be registered with [[Lua_System#Synced|Script.SetWatchUnit]] and the feature registered with [[Lua_System#Synced|Script.SetWatchFeature]].
}}

{{LuaCallin
|name = UnitCommand
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOpts, cmdTag
|info = Called after when a unit accepts a command, after {{name|AllowCommand}} returns {{value|true}}.
}}

{{LuaCallin
|name = UnitCmdDone
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOpts, cmdTag
|info = Called when a unit completes a command.
}}

{{LuaCallin
|name = UnitLoaded
|args = unitID, unitDefID, unitTeam, transportID, transportTeam
|info = Called when a unit is loaded by a transport.
}}

{{LuaCallin
|name = UnitUnloaded
|args = unitID, unitDefID, unitTeam, transportID, transportTeam
|info = Called when a unit is unloaded by a transport.
}}

{{LuaCallin
|name = UnitExperience
|args = unitID, unitDefID, unitTeam, experience, oldExperience
|info = Called when a unit gains experience greater or equal to the minimum limit set by calling [[Lua_SyncedCtrl#Other|Spring.SetExperienceGrade]]. Should be called more reliably with small values of experience grade in 104.0+.
}}

{{LuaCallin
|name = UnitIdle
|args = unitID, unitDefID, unitTeam
|info = Called when a unit is idle (empty command queue).
}}

{{LuaCallin
|name = UnitCloaked
|args = unitID, unitDefID, unitTeam
|info = Called when a unit cloaks.
}}

{{LuaCallin
|name = UnitDecloaked
|args = unitID, unitDefID, unitTeam
|info = Called when a unit decloaks.
}}

{{LuaCallin
|name = UnitMoved
|args = ???
|info = ??? Not implemented in base handler
}}

{{LuaCallin
|name = UnitMoveFailed
|args = ???
|info = ??? Not implemented in base handler
}}

{{LuaCallin
|name = StockpileChanged
|args = unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount
|info = Called when a units stockpile of weapons increases or decreases. See {{xtaglink|Gamedev:WeaponDefs|stockpile}}.
}}

{{LuaCallin
|name = UnitEnteredLos
|args = unitID, unitTeam, allyTeam, unitDefID
|info = Called when a unit enters LOS of an allyteam.
}}

{{LuaCallin
|name = UnitLeftLos
|args = unitID, unitTeam, allyTeam, unitDefID
|info = Called when a unit leaves LOS of an allyteam.
}}

{{LuaCallin
|name = UnitEnteredRadar
|args = unitID, unitTeam, allyTeam, unitDefID
|info = Called when a unit enters radar of an allyteam.
}}

{{LuaCallin
|name = UnitLeftRadar
|args = unitID, unitTeam, allyTeam, unitDefID
|info = Called when a unit leaves radar of an allyteam.
}}

{{LuaCallin
|name = UnitEnteredAir
|args = ???
|info = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitLeftAir
|args = ???
|info = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitEnteredWater
|args = ???
|info = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitLeftWater
|args = ???
|info = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitSeismicPing
|args = x, y, z, strength, allyTeam, unitID, unitDefID
|info = Called when a unit emits a seismic ping. See {{xtaglink|Gamedev:UnitDefs|seismicSignature}}.
}}

=== Features ===
{{LuaCallin
|name = FeatureCreated
|args = featureID, allyTeamID
|info = Called when a feature is created.
}}

{{LuaCallin
|name = FeatureDamaged
|args = featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|info = Called when a feature is damaged.
}}

{{LuaCallin
|name = FeatureDestroyed
|args = featureID, allyTeamID
|info = Called when a feature is destroyed.
}}

{{LuaCallin
|name = FeatureMoved
|args = ???
|info = ???
}}

=== Projectiles ===
The following Callins are only called for weaponDefIDs registered via [[Lua_System#Synced|Script.SetWatchWeapon]].

{{LuaCallin
|name = ProjectileCreated
|args = proID, proOwnerID, weaponDefID
|info = Called when the projectile is created. Note that {{var|weaponDefID}} is missing if the projectile is spawned as part of a burst, but [[Lua_SyncedRead#Projectiles|Spring.GetProjectileDefID]] and [[Lua_SyncedRead#Projectiles|Spring.GetProjectileName]] still work in callin scope using {{var|proID}}.
}}

{{LuaCallin
|name = ProjectileDestroyed
|args = proID
|info = Called when the projectile is destroyed.
}}

== Synced Only ==
{{LuaCallin
|name = CommandFallback
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag
|return = {{type|bool}} used, {{type|bool}} finished
|info = Called when the unit reaches an unknown command in its queue (i.e. one not handled by the engine). If no addon returns {{var|used}} as {{value|true}} the command is dropped, if an addon returns {{value|true}}, {{value|true}} the command is removed because it's done, with {{value|true}}, {{value|false}} it's kept in the queue and {{name|CommandFallback}} gets called again on the next slowupdate.
}}

{{LuaCallin
|name = AllowCommand
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced
|return = {{type|bool}} allow
|info = Called when the command is given, before the unit's queue is altered. The return value is whether it should be let into the queue. The queue remains untouched when a command is blocked, whether it would be queued or replace the queue.
}}

{{LuaCallin
|name = AllowUnitCreation
|args = unitDefID, builderID, builderTeam, x, y, z, facing
|return = {{type|bool}} allow
|info = Called just before unit is created, the boolean return value determines whether or not the creation is permitted.
}}

{{LuaCallin
|name = AllowUnitTransfer
|args = unitID, unitDefID, oldTeam, newTeam, capture
|return = {{type|bool}} allow
|info = Called just before a unit is transferred to a different team, the boolean return value determines whether or not the transfer is permitted.
}}

{{LuaCallin
|name = AllowUnitBuildStep
|args = builderID, builderTeam, unitID, unitDefID, part
|return = {{type|bool}} allow
|info = Called just before a unit progresses its build percentage, the boolean return value determines whether or not the build makes progress.
}}

{{LuaCallin
|name = AllowFeatureCreation
|args = featureDefID, teamID, x, y, z
|return = {{type|bool}} allow
|info = Called just before feature is created, the boolean return value determines whether or not the creation is permitted.
}}

{{LuaCallin
|name = AllowFeatureBuildStep
|args = builderID, builderTeam, featureID, featureDefID, part
|return = {{type|bool}} allow
|info = Called just before a feature progresses its build percentage, the boolean return value determines whether or not the progress change is permitted.
}}

{{LuaCallin
|name = AllowResourceLevel
|args = teamID, res, level
|return = {{type|bool}} allow
|info = Called when a team sets the sharing level of a resource, the boolean return value determines whether or not the sharing level is permitted.
}}

{{LuaCallin
|name = AllowResourceTransfer
|args = oldTeamID, newTeamID, res, amount
|return = {{type|bool}} allow
|info = Called just before resources are transferred between players, the boolean return value determines whether or not the transfer is permitted.
}}

{{LuaCallin
|name = AllowStartPosition
|args = playerID, teamID, readyState, clampedX, clampedY, clampedZ, rawX, rawY, rawZ
|return = {{type|bool}} allow
|info = {{var|clamped{X,Y,Z}}} are the coordinates clamped into start-boxes, {{var|raw}} is where player tried to place their marker. The {{var|readyState}} can be any one of
* {{value|0}} - player picked a position,
* {{value|1}} - player clicked ready,
* {{value|2}} - player pressed ready OR the game was force-started (player did not click ready, but is now forcibly readied) or
* {{value|3}} - the player failed to load.
* {{new|95.0}} the default 'failed to choose' start-position is the north-west point of their startbox, or (0,0,0) if they do not have a startbox.
NB: The order of the parameters changed with the addition of {{var|teamID}} in 104.0. Previouly it was:
{{var|clampedX, clampedY, clampedZ, playerID, readyState, rawX, rawY, rawZ}}
}}

{{LuaCallin
|name = AllowDirectUnitControl
|args = unitID, unitDefID, unitTeam, playerID
|return = {{type|bool}} allow
|info = Determines if this unit can be controlled directly in FPS view.
}}

{{LuaCallin
|name = AllowWeaponTargetCheck
|args = attackerID, attackerWeaponNum, attackerWeaponDefID
|return = {{type|bool}} allowCheck, {{type|bool}} ignoreCheck
|info = Determines if this weapon can automatically generate targets itself. See also {{xtaglink|Gamedev:WeaponDefs|commandFire}} weaponDef tag. The {{var|ignoreCheck}} return value was added in 99.0 to allow ignoring the callin i.e. running normal engine check for this weapon.
}}

{{LuaCallin
|name = AllowWeaponTarget
|args = attackerID, targetID, attackerWeaponNum, attackerWeaponDefID, defPriority
|return = {{type|bool}} allowed, {{type|number}} newPriority
|info = Controls blocking of a specific target from being considered during a weapon's periodic auto-targeting sweep. The second return value is the new priority for this target (if you don't want to change it, return {{var|defPriority}}). Lower priority targets are targeted first.
}}

{{LuaCallin
|name = AllowWeaponInterceptTarget
|args = interceptorUnitID, interceptorWeaponID, targetProjectileID
|return = {{type|bool}} allowed
|info = Controls blocking of a specific intercept target from being considered during an {{xtaglink|Gamedev:WeaponDefs|interceptor}} weapon's periodic auto-targeting sweep. Only called for {{var|weaponDefIDs}} registered via [[Lua_System#Synced|Script.SetWatchWeapon]].
}}

{{LuaCallin
|name = AllowBuilderHoldFire
|args = unitID, unitDefID, action
|return = {{type|bool}} actionAllowed
|info = {{new|98.0}} {{Sourcelinkhash|5a82d750b89e72024bb0bb62cf05ea257737e0ac}} Called when a construction unit wants to "use his nano beams". {{var|action}} is one of following:
* {{value|-1}} Build
* {{value|CMD.REPAIR}} Repair
* {{value|CMD.RECLAIM}} Reclaim
* {{value|CMD.RESTORE}} Restore
* {{value|CMD.RESURRECT}} Resurrect
* {{value|CMD.CAPTURE}} Capture
}}

{{LuaCallin
|name = Explosion
|args = weaponDefID, px, py, pz, AttackerID, ProjectileID
|return = {{type|bool}} noGfx
|info = Called when an explosion occurs. If it returns {{value|true}} then no graphical effects are drawn by the engine for this explosion.
}}

{{LuaCallin
|name = TerraformComplete
|args = unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam
|return = {{type|bool}} stop
|info = Called when pre-building terrain levelling terraforms are completed (c.f. {{xtaglink|Gamedev:UnitDefs|levelGround}}). If the return value is {{value|true}} the current build order is terminated.
}}

{{LuaCallin
|name = MoveCtrlNotify
|args = unitID, unitDefID, unitTeam, data
|return = {{type|bool}} moveCtrlComplete
|info = Enable both [[Lua_MoveCtrl#Options|Spring.MoveCtrl.SetCollideStop]] and [[Lua_MoveCtrl#Options|Spring.MoveCtrl.SetTrackGround]] to enable this call-in, data was supposed to indicate the type of notification but currently never has a value other than {{value|1}} ("unit hit the ground"). The return value determines whether or not the unit should remain script-controlled ({{value|false}}) or return to engine controlled movement ({{value|true}}).
}}

{{LuaCallin
|name = RecvLuaMsg
|args = msg, playerID
|info = Receives messages from unsynced sent via [[Lua_UnsyncedCtrl#SendLuaMessage|Spring.SendLuaRulesMsg]].
}}

{{LuaCallin
|name = Load
|args = zip
|info = Called after {{name|GamePreload}} and before {{name|GameStart}}. See [[Lua_SaveLoad#Load_.28_zip_.29_-.3E_nil|Lua_SaveLoad]].
}}

=== Damage Controllers ===
For the following callins, in addition to being a regular weapon, {{var|weaponDefID}} may be one of the following:
* {{value|-1}} - debris collision, also default of [[Lua_SyncedCtrl#Unit_Control|Spring.AddUnitDamage]]
* {{value|-2}} - ground collision
* {{value|-3}} - object collision
* {{value|-4}} - fire damage
* {{value|-5}} - water damage
* {{value|-6}} - kill damage
* {{value|-7}} - crush damage

{{LuaCallin
|name = UnitPreDamaged
|args = unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|return = {{type|number}} newDamage, {{type|number}} impulseMult
|info = Called before damage is applied to the unit, allows fine control over how much damage and [http://en.wikipedia.org/wiki/Impulse_(physics) impulse] is applied.
}}

{{LuaCallin
|name = ShieldPreDamaged
|I recommend looking up the CallIns in Sourcecode, because the Lua-Documentation, generated from the lua handle of them is seriously flawed and not regenerated.
|Lua-Handler documented from version
|args = proID, proOwnerID, shieldEmitterWeaponNum, shieldCarrierUnitID, bounceProjectile, beamEmitterWeaponNum, beamEmitterUnitID, startX, startY, startZ, hitX, hitY, hitZ
|https://github.com/spring/spring/blob/d085e297416bd963ec25eaa3dbf0796ba22a3582/rts/Lua/LuaHandleSynced.h#L106
|Actual CallIn:
|args = proID, shieldCarrier, boolBounceProjectile, beamEmitterWeaponNum, beamEmitterUnitID, startX, startY, startZ, hitX, hitY, hitZ
|return = {{type|bool}} handleCollision
|info = Called before any engine shield-vs-projectile logic executes. If the return value is {{value|true}} the gadget handles the collision event and the engine does not remove the projectile. If the weapon is a hitscan type ([[Gamedev:WeaponDefs#Tag:weaponType|BeamLaser]] or [[Gamedev:WeaponDefs#Tag:weaponType|LightningCanon]]) then {{var|proID}} is {{value|nil}} and {{var|beamEmitterWeaponNum}} and {{var|beamEmitterUnitID}} are populated instead. The start and hit position arguments are provided from 104.0 onwards.
}}

{{LuaCallin
|name = FeaturePreDamaged
|args = featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|return = {{type|number}} newDamage, {{type|number}} impulseMult
|info = Called before damage is applied to the feature, allows fine control over how much damage and [http://en.wikipedia.org/wiki/Impulse_(physics) impulse] is applied.
}}

[[Category: Lua]]

Lua:Callins

2019-05-10T12:51:43Z

Silentwings: /* Drawing */

= Lua Callins =
This page is future looking to unified widget/gadget (aka "addon") handler, which may yet be some way off, c.f. the [https://github.com/spring/spring/blob/ebb704e008f6ea645947d07be1cfcc272af0428f/doc/changelog.txt#L71 changelog].

Related Sourcecode :
[https://github.com/spring/spring/blob/d9b3927a528a876b9ab4042771e82b050267572a/rts/Lua/LuaHandle.cpp https://github.com/spring/spring/rts/Lua/LuaHandle.cpp]

For now, to use these addons in a widget, replace addon with widget and, for a gadget, replace addon with gadget. For example,
<code><pre>
function widget:UnitCreated(unitID, unitDefID, unitTeam, builderID)
...
end
</pre></code>

Some functions may differ between (synced) gadget and widgets; those are in the [[#Synced_-_Unsynced_Shared]] section. Essentially the reason is that all information should be available to synced (game logic controlling) gadgets, but restricted to unsynced gadget/widget (e.g. information about an enemy unit only detected via radar and not yet in LOS). In such cases the full (synced) param list is documented.

'''Attention:''' some callins will only work on the unsynced portion of the gadget. Due to the type-unsafe nature of lua parsing, those callins not firing up might be hard to trace. This document will be continuously updated to properly alert about those situations.

== Common ==
{{LuaCallin
|name = Initialize
|info = Called when the addon is (re)loaded.
}}

{{LuaCallin
|name = Shutdown
|info = Called when the addon or the game is shutdown.
}}

== Unsynced Only ==

{{LuaCallin
|name = DefaultCommand
|args = type, id
|return = {{type|number}} cmdID
|info = Used to set the default command when a unit is selected. First parameter is the type of the object pointed at (either "unit or "feature") and the second is its {{var|unitID}} or {{var|featureID}} respectively.
}}

{{LuaCallin
|name = CommandNotify
|args = cmdID, cmdParams, cmdOptions
|return = {{type|bool}} removeCmd
|info = Called when a command is issued. Returning {{value|true}} deletes the command and does not send it through the network.
}}

{{LuaCallin
|name = CommandsChanged
|args = None
|return = ?
|info = Called when the command descriptions changed, e.g. when selecting or deselecting a unit.
}}

{{LuaCallin
|name = WorldTooltip
|args = ttType, data1, data2, data3
|return = {{type|string}} newTooltip
|info = The parameters can be {{value|"unit"}}, {{var|unitID}}; {{value|"feature"}}, {{var|featureID}}; {{value|"ground"}}, {{var|posX}}, {{var|posY}}, {{var|posZ}} or {{value|"selection"}}.
}}

{{LuaCallin
|name = UnsyncedHeightMapUpdate
|args = ???
|info = Called when the unsynced copy of the height-map is altered.
}}

{{LuaCallin
|name = GameProgress
|args = serverFrameNum
|info = Called every 60 frames, calculating delta between GameFrame and GameProgress. Can give an ETA about catching up with simulation for mid-game join players.
}}

{{LuaCallin
|name = GameSetup
|args = state, ready, playerStates
|return = {{type|bool}} success, {{type|bool}} newReady
|info = ???
}}

{{LuaCallin
|name = SunChanged
|args = ???
|info = ???
}}

{{LuaCallin
|name = AddConsoleLine
|args = msg, priority
|info = Called when text is entered into the console (e.g. Spring.Echo).
}}

{{LuaCallin
|name = RecvSkirmishAIMessage
|args = aiTeam, dataStr
|return = ???
|info = ???
}}

{{LuaCallin
|name = RecvFromSynced
|args = ...
|info = Receives data sent via [[Lua_System#Synced|SendToUnsynced]] callout.
}}

{{LuaCallin
|name = Save
|args = zip
|info = Called when a chat command '/save' or '/savegame' is received. The single argument is a userdatum representing the savegame zip file. See [[Lua_SaveLoad#Save_.28_zip_.29_-.3E_nil|Lua_SaveLoad]].
}}

{{LuaCallin
|name = LoadProgress
|args = message, replaceLastLine
|info = Only available to LuaIntro.
}}

{{LuaCallin
|name = GroupChanged
|args = groupID
|info = Called when a unit is added to or removed from a control group. Currently implemented for widgets only.
}}

{{LuaCallin
|name = ConfigureLayout
|args = ???
|return = ???
|info = ???
}}

=== Input ===
{{LuaCallin
|name = IsAbove
|args = x, y
|return = {{type|bool}} isAbove
|info = Called every Update. Must return {{value|true}} for {{name|Mouse*}} events and {{name|GetToolTip}} to be called.
}}

{{LuaCallin
|name = GetTooltip
|args = x, y
|return = {{type|string}} tooltip
|info = Called when {{name|IsAbove}} returns {{value|true}}.
}}

{{LuaCallin
|name = KeyPress
|args = key, mods, isRepeat
|return = {{type|bool}} becomeOwner
|info = Called repeatedly when a key is pressed down. If you want an action to occur only once check for {{var|1=isRepeat == {{value|false}}}}. The {{var|mods}} parameter is a {{type|table}}, with keys {{value|"alt"}}, {{value|"ctrl"}}, {{value|"meta"}} and {{value|"shift"}} each having a boolean value. Return {{value|true}} if you don't want other callins or the engine to also receive this keypress. A list of key codes can be seen at the [https://wiki.libsdl.org/SDLKeycodeLookup SDL wiki].
}}

{{LuaCallin
|name = KeyRelease
|args = key
|return = {{type|bool}}
|info = Called when the key is released.
}}

{{LuaCallin
|name = TextInput
|args = utf8char
|info = Called whenever a key press results in text input. Introduced in 97.0.
}}

{{LuaCallin
|name = JoystickEvent
|args = ???
|info = ???
}}

{{LuaCallin
|name = MousePress
|args = x, y, button
|return = {{type|bool}} becomeMouseOwner
|info = Called when a mouse button is pressed. The {{var|button}} parameter supports up to 7 buttons. Must return {{value|true}} for {{name|MouseRelease}} and other functions to be called.
}}

{{LuaCallin
|name = MouseRelease
|args = x, y, button
|return = bool becomeMouseOwner
|info = Called when a mouse button is released. Please note that in order to have Spring call {{name|MouseRelease}}, you need to have a {{name|MousePress}} call-in in the same addon that returns {{value|true}}.
}}

{{LuaCallin
|name = MouseWheel
|args = up, value
|info = Called when the mouse wheel is moved. The parameters indicate the direction and amount of travel.
}}

{{LuaCallin
|name = MouseMove
|args = x, y, dx, dy, button
|info = Called when the mouse is moved. The {{var|dx}} and {{var|dy}} parameters indicate the distance travelled, whereas the first two indicate the final position.
}}

=== Players ===
{{LuaCallin
|name = PlayerChanged
|args = playerID
|info = Called whenever a player's status changes e.g. becoming a spectator.
}}

{{LuaCallin
|name = PlayerAdded
|args = playerID
|info = Called whenever a new player joins the game.
}}

{{LuaCallin
|name = PlayerRemoved
|args = playerID, reason
|info = Called whenever a player is removed from the game.
}}

=== Downloads ===

{{LuaCallin
|name = DownloadStarted
|args = id
|info = Called when a [[Pr-downloader]] download is started via [[Lua_VFS#Archives|VFS.DownloadArchive]].
}}

{{LuaCallin
|name = DownloadFinished
|args = id
|info = Called when a [[Pr-downloader]] download finishes successfully.
}}

{{LuaCallin
|name = DownloadFailed
|args = id, errorID
|info = Called when a [[Pr-downloader]] download fails to complete.
}}

{{LuaCallin
|name = DownloadProgress
|args = id, downloaded, total
|info = Called incrementally during a [[Pr-downloader]] download.
}}

=== Drawing ===
{{LuaCallin
|name = ViewResize
|args = viewSizeX, viewSizeY
|info = Called whenever the window is resized.
}}

{{LuaCallin
|name = Update
|args = dt
|info = Called for every drawn frame. The parameter is the time since the last update. Perform calculations in here and only perform drawing in Draw* callins (listed below). On the synced portion of gadgets, use GameFrame() for per-frame computations. Please note that when the engine is not under heavy load you will typically get more than one Update callin for each GameFrame. Update is called even while the engine is paused, there is no such event in synced. }}

=== Draw* Functions ===
Inside the Draw* functions, you can use the [[Lua_OpenGL_Api | Lua OpenGL Api]] to draw graphics.
 

{{LuaCallin
|name = DrawGenesis
|info = Doesn't render to screen! Use this callin to update textures, shaders, etc. Also available to LuaMenu.
}}

{{LuaCallin
|name = DrawWorldPreParticles
|info = ??? {{new|104.0}}
}}

{{LuaCallin
|name = DrawWorldPreUnit
|info = Spring draws units, features, some water types, cloaked units, and the sun.
}}

{{LuaCallin
|name = DrawWorld
|info = Spring draws command queues, 'map stuff', and map marks.
}}

{{LuaCallin
|name = DrawWorldShadow
|info = ???
}}

{{LuaCallin
|name = DrawWorldReflection
|info = ???
}}

{{LuaCallin
|name = DrawWorldRefraction
|info = ???
}}

{{LuaCallin
|name = DrawGroundPreForward
|info = Runs at the start of the forward pass when a custom map shader has been assigned via [[Lua_UnsyncedCtrl#Map|{{name|Spring.SetMapShader}}]] (convenient for setting uniforms).
}}

{{LuaCallin
|name = DrawGroundPreDeferred
|info = Runs at the start of the deferred pass when a custom map shader has been assigned via [[Lua_UnsyncedCtrl#Map|{{name|Spring.SetMapShader}}]] (convenient for setting uniforms).
}}

{{LuaCallin
|name = DrawGroundPostDeferred
|info = This runs at the end of its respective deferred pass and allows proper frame compositing (with ground flashes/decals/foliage/etc, which are drawn between it and [[#API:DrawWorldPreUnit|{{name|DrawWorldPreUnit}}]]) via [[Lua_OpenGL_Api#Textures|{{name|gl.CopyToTexture}}]].
}}

{{LuaCallin
|name = DrawUnitsPostDeferred
|info = Runs at the end of the unit deferred pass to inform Lua code it should make use of the {{value|$model_gbuffer_*}} textures before another pass overwrites them (and to allow proper blending with e.g. cloaked objects which are drawn between these events and [[#API:DrawWorld|{{name|DrawWorld}}]] via [[Lua_OpenGL_Api#Textures|{{name|gl.CopyToTexture}}]]). N.B. The *PostDeferred events are only sent (and only have a real purpose) if forward drawing is disabled.
}}

{{LuaCallin
|name = DrawFeaturesPostDeferred
|info = Runs at the end of the feature deferred pass to inform Lua code it should make use of the {{value|$model_gbuffer_*}} textures before another pass overwrites them (and to allow proper blending with e.g. cloaked objects which are drawn between these events and [[#API:DrawWorld|{{name|DrawWorld}}]] via [[Lua_OpenGL_Api#Textures|{{name|gl.CopyToTexture}}]]). N.B. The *PostDeferred events are only sent (and only have a real purpose) if forward drawing is disabled.
}}

{{LuaCallin
|name = DrawScreen
|args = vsx, vsy
|info = ??? Also available to LuaMenu.
}}

{{LuaCallin
|name = DrawScreenEffects
|args = vsx, vsy
|info = Where {{var|vsx}}, {{var|vsy}} are screen coordinates.
}}

{{LuaCallin
|name = DrawScreenPost
|args = vsx, vsy
|info = {{new|104.0}} Similar to {{name|DrawScreenEffects}}, this can be used to alter the contents of a frame after it has been completely rendered (i.e. World, MiniMap, Menu, UI).
}}

{{LuaCallin
|name = DrawLoadScreen
|info = {{new|95.0}} Only available to LuaIntro, draws custom load screens.
}}

{{LuaCallin
|name = DrawInMinimap
|args = sx, sy
|info = Where {{var|sx}}, {{var|sy}} are values relative to the minimap's position and scale.
}}

{{LuaCallin
|name = DrawInMinimapBackground
|args = sx, sy
|info = Where {{var|sx}}, {{var|sy}} are values relative to the minimap's position and scale.
}}

=== Custom Object Rendering ===
For the following calls {{var|drawMode}} can be one of the following, {{var|1=notDrawing = {{value|0}}}}, {{var|1=normalDraw = {{value|1}}}}, {{var|1=shadowDraw = {{value|2}}}}, {{var|1=reflectionDraw = {{value|3}}}}, {{var|1=refractionDraw = {{value|4}}}}, and finally {{var|1=gameDeferredDraw = {{value|5}}}} which was added in 102.0.

{{LuaCallin
|name = DrawUnit
|args = unitID, drawMode
|return = {{type|bool}} suppressEngineDraw
|info = For custom rendering of units, [[Lua_UnitRendering#Lua.27s_DrawXYZ-Callin|enabled here]].
}}

{{LuaCallin
|name = DrawFeature
|args = unitID, drawMode
|return = {{type|bool}} suppressEngineDraw
|info = For custom rendering of features, [[Lua_UnitRendering#Lua.27s_DrawXYZ-Callin|enabled here]].
}}

{{LuaCallin
|name = DrawShield
|args = unitID, weaponID, drawMode
|return = {{type|bool}} suppressEngineDraw
|info = For custom rendering of [[Gamedev:WeaponDefs#Shield_(WeaponType)|shields]].
}}

{{LuaCallin
|name = DrawProjectile
|args = projectileID, drawMode
|return = {{type|bool}} suppressEngineDraw
|info = For custom rendering of weapon (& other) projectiles.
}}

== Unsynced Menu Only ==

{{LuaCallin
|name = AllowDraw
|return = {{type|bool}} allowDraw
|info = Enables Draw{Genesis,Screen,ScreenPost} callins if {{value|true}} is returned, otherwise they are called once every 30 seconds. Only active when a game isn't running.
}}

{{LuaCallin
|name = ActivateMenu
|info = Called whenever LuaMenu is on with no game loaded.
}}

{{LuaCallin
|name = ActivateGame
|info = Called whenever LuaMenu is on with a game loaded.
}}

== Synced - Unsynced Shared ==

{{LuaCallin
|name = GotChatMsg
|args = msg, player
|info = Called when a player issues a UI command e.g. types {{var|/foo}} or {{var|/luarules foo}}.
}}

=== Game ===

{{LuaCallin
|name = GameID
|args = gameID
|info = Called once to deliver the {{var|gameID}}. As of 101.0+ the string is encoded in hex.
}}

{{LuaCallin
|name = GamePaused
|info = Called when the game is paused.
}}

{{LuaCallin
|name = GameOver
|args = winningAllyTeams
|info = The parameter is a {{type|table}} list of winning allyTeams, if empty the game result was undecided (like when dropping from an host).
}}

{{LuaCallin
|name = GameFrame
|args = frame
|info = Called for every game simulation frame (30 per second). Starts at frame {{value|0}} in 101.0+ and {{value|1}} in previous versions.
}}

{{LuaCallin
|name = GamePreload
|info = Called before the 0 gameframe. From 104.0 onwards, will not be called when a saved game is loaded.
}}

{{LuaCallin
|name = GameStart
|info = Called upon the start of the game. From 104.0 onwards, will not be called when a saved game is loaded.
}}

=== Teams ===
{{LuaCallin
|name = TeamChanged
|args = teamID
|info = ???
}}

{{LuaCallin
|name = TeamDied
|args = teamID
|info = Called when a team dies (see [[Lua_SyncedCtrl#Game_End|Spring.KillTeam]]).
}}

=== Units ===
{{LuaCallin
|name = UnitCreated
|args = unitID, unitDefID, unitTeam, builderID
|info = Called at the moment the unit is created.
}}

{{LuaCallin
|name = UnitFinished
|args = unitID, unitDefID, unitTeam
|info = Called at the moment the unit is completed.
}}

{{LuaCallin
|name = UnitFromFactory
|args = unitID, unitDefID, unitTeam, factID, factDefID, userOrders
|info = Called when a factory finishes construction of a unit.
}}

{{LuaCallin
|name = UnitReverseBuilt
|args = unitID, unitDefID, unitTeam
|info = Called when a living unit becomes a nanoframe again.
}}

{{LuaCallin
|name = UnitGiven
|args = unitID, unitDefID, newTeam, oldTeam
|info = Called when a unit is transferred between teams. This is called after {{name|UnitTaken}} and in that moment unit is assigned to the '''newTeam'''.
}}

{{LuaCallin
|name = UnitTaken
|args = unitID, unitDefID, oldTeam, newTeam
|info = Called when a unit is transferred between teams. This is called before {{name|UnitGiven}} and in that moment unit is still assigned to the '''oldTeam'''.
}}

{{LuaCallin
|name = UnitDamaged
|args = unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|info = Called when a unit is damaged (after {{name|UnitPreDamaged}}).
}}

{{LuaCallin
|name = UnitDestroyed
|args = unitID, unitDefID, unitTeam, attackerID, attackerDefID, attackerTeam
|info = Called when a unit is destroyed.
}}

{{LuaCallin
|name = RenderUnitDestroyed
|args = unitID, unitDefID, unitTeam
|info = Called just before a unit is invalid, after it finishes its death animation. {{new|101.0}}
}}

{{LuaCallin
|name = UnitStunned
|args = unitID, unitDefID, unitTeam, stunned
|info = Called when a unit changes its stun status. {{new|99.0}}
}}

{{LuaCallin
|name = UnitUnitCollision
|args = colliderID, collideeID
|info = Called when two units collide. Both units must be registered with [[Lua_System#Synced|Script.SetWatchUnit]].
}}

{{LuaCallin
|name = UnitFeatureCollision
|args = colliderID, collideeID
|info = Called when a unit collides with a feature. The unit must be registered with [[Lua_System#Synced|Script.SetWatchUnit]] and the feature registered with [[Lua_System#Synced|Script.SetWatchFeature]].
}}

{{LuaCallin
|name = UnitCommand
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOpts, cmdTag
|info = Called after when a unit accepts a command, after {{name|AllowCommand}} returns {{value|true}}.
}}

{{LuaCallin
|name = UnitCmdDone
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOpts, cmdTag
|info = Called when a unit completes a command.
}}

{{LuaCallin
|name = UnitLoaded
|args = unitID, unitDefID, unitTeam, transportID, transportTeam
|info = Called when a unit is loaded by a transport.
}}

{{LuaCallin
|name = UnitUnloaded
|args = unitID, unitDefID, unitTeam, transportID, transportTeam
|info = Called when a unit is unloaded by a transport.
}}

{{LuaCallin
|name = UnitExperience
|args = unitID, unitDefID, unitTeam, experience, oldExperience
|info = Called when a unit gains experience greater or equal to the minimum limit set by calling [[Lua_SyncedCtrl#Other|Spring.SetExperienceGrade]]. Should be called more reliably with small values of experience grade in 104.0+.
}}

{{LuaCallin
|name = UnitIdle
|args = unitID, unitDefID, unitTeam
|info = Called when a unit is idle (empty command queue).
}}

{{LuaCallin
|name = UnitCloaked
|args = unitID, unitDefID, unitTeam
|info = Called when a unit cloaks.
}}

{{LuaCallin
|name = UnitDecloaked
|args = unitID, unitDefID, unitTeam
|info = Called when a unit decloaks.
}}

{{LuaCallin
|name = UnitMoved
|args = ???
|info = ??? Not implemented in base handler
}}

{{LuaCallin
|name = UnitMoveFailed
|args = ???
|info = ??? Not implemented in base handler
}}

{{LuaCallin
|name = StockpileChanged
|args = unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount
|info = Called when a units stockpile of weapons increases or decreases. See {{xtaglink|Gamedev:WeaponDefs|stockpile}}.
}}

{{LuaCallin
|name = UnitEnteredLos
|args = unitID, unitTeam, allyTeam, unitDefID
|info = Called when a unit enters LOS of an allyteam.
}}

{{LuaCallin
|name = UnitLeftLos
|args = unitID, unitTeam, allyTeam, unitDefID
|info = Called when a unit leaves LOS of an allyteam.
}}

{{LuaCallin
|name = UnitEnteredRadar
|args = unitID, unitTeam, allyTeam, unitDefID
|info = Called when a unit enters radar of an allyteam.
}}

{{LuaCallin
|name = UnitLeftRadar
|args = unitID, unitTeam, allyTeam, unitDefID
|info = Called when a unit leaves radar of an allyteam.
}}

{{LuaCallin
|name = UnitEnteredAir
|args = ???
|info = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitLeftAir
|args = ???
|info = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitEnteredWater
|args = ???
|info = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitLeftWater
|args = ???
|info = ??? Not implemented by base handler
}}

{{LuaCallin
|name = UnitSeismicPing
|args = x, y, z, strength, allyTeam, unitID, unitDefID
|info = Called when a unit emits a seismic ping. See {{xtaglink|Gamedev:UnitDefs|seismicSignature}}.
}}

=== Features ===
{{LuaCallin
|name = FeatureCreated
|args = featureID, allyTeamID
|info = Called when a feature is created.
}}

{{LuaCallin
|name = FeatureDamaged
|args = featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|info = Called when a feature is damaged.
}}

{{LuaCallin
|name = FeatureDestroyed
|args = featureID, allyTeamID
|info = Called when a feature is destroyed.
}}

{{LuaCallin
|name = FeatureMoved
|args = ???
|info = ???
}}

=== Projectiles ===
The following Callins are only called for weaponDefIDs registered via [[Lua_System#Synced|Script.SetWatchWeapon]].

{{LuaCallin
|name = ProjectileCreated
|args = proID, proOwnerID, weaponDefID
|info = Called when the projectile is created. Note that {{var|weaponDefID}} is missing if the projectile is spawned as part of a burst, but [[Lua_SyncedRead#Projectiles|Spring.GetProjectileDefID]] and [[Lua_SyncedRead#Projectiles|Spring.GetProjectileName]] still work in callin scope using {{var|proID}}.
}}

{{LuaCallin
|name = ProjectileDestroyed
|args = proID
|info = Called when the projectile is destroyed.
}}

== Synced Only ==
{{LuaCallin
|name = CommandFallback
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag
|return = {{type|bool}} used, {{type|bool}} finished
|info = Called when the unit reaches an unknown command in its queue (i.e. one not handled by the engine). If no addon returns {{var|used}} as {{value|true}} the command is dropped, if an addon returns {{value|true}}, {{value|true}} the command is removed because it's done, with {{value|true}}, {{value|false}} it's kept in the queue and {{name|CommandFallback}} gets called again on the next slowupdate.
}}

{{LuaCallin
|name = AllowCommand
|args = unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced
|return = {{type|bool}} allow
|info = Called when the command is given, before the unit's queue is altered. The return value is whether it should be let into the queue. The queue remains untouched when a command is blocked, whether it would be queued or replace the queue.
}}

{{LuaCallin
|name = AllowUnitCreation
|args = unitDefID, builderID, builderTeam, x, y, z, facing
|return = {{type|bool}} allow
|info = Called just before unit is created, the boolean return value determines whether or not the creation is permitted.
}}

{{LuaCallin
|name = AllowUnitTransfer
|args = unitID, unitDefID, oldTeam, newTeam, capture
|return = {{type|bool}} allow
|info = Called just before a unit is transferred to a different team, the boolean return value determines whether or not the transfer is permitted.
}}

{{LuaCallin
|name = AllowUnitBuildStep
|args = builderID, builderTeam, unitID, unitDefID, part
|return = {{type|bool}} allow
|info = Called just before a unit progresses its build percentage, the boolean return value determines whether or not the build makes progress.
}}

{{LuaCallin
|name = AllowFeatureCreation
|args = featureDefID, teamID, x, y, z
|return = {{type|bool}} allow
|info = Called just before feature is created, the boolean return value determines whether or not the creation is permitted.
}}

{{LuaCallin
|name = AllowFeatureBuildStep
|args = builderID, builderTeam, featureID, featureDefID, part
|return = {{type|bool}} allow
|info = Called just before a feature progresses its build percentage, the boolean return value determines whether or not the progress change is permitted.
}}

{{LuaCallin
|name = AllowResourceLevel
|args = teamID, res, level
|return = {{type|bool}} allow
|info = Called when a team sets the sharing level of a resource, the boolean return value determines whether or not the sharing level is permitted.
}}

{{LuaCallin
|name = AllowResourceTransfer
|args = oldTeamID, newTeamID, res, amount
|return = {{type|bool}} allow
|info = Called just before resources are transferred between players, the boolean return value determines whether or not the transfer is permitted.
}}

{{LuaCallin
|name = AllowStartPosition
|args = playerID, teamID, readyState, clampedX, clampedY, clampedZ, rawX, rawY, rawZ
|return = {{type|bool}} allow
|info = {{var|clamped{X,Y,Z}}} are the coordinates clamped into start-boxes, {{var|raw}} is where player tried to place their marker. The {{var|readyState}} can be any one of
* {{value|0}} - player picked a position,
* {{value|1}} - player clicked ready,
* {{value|2}} - player pressed ready OR the game was force-started (player did not click ready, but is now forcibly readied) or
* {{value|3}} - the player failed to load.
* {{new|95.0}} the default 'failed to choose' start-position is the north-west point of their startbox, or (0,0,0) if they do not have a startbox.
NB: The order of the parameters changed with the addition of {{var|teamID}} in 104.0. Previouly it was:
{{var|clampedX, clampedY, clampedZ, playerID, readyState, rawX, rawY, rawZ}}
}}

{{LuaCallin
|name = AllowDirectUnitControl
|args = unitID, unitDefID, unitTeam, playerID
|return = {{type|bool}} allow
|info = Determines if this unit can be controlled directly in FPS view.
}}

{{LuaCallin
|name = AllowWeaponTargetCheck
|args = attackerID, attackerWeaponNum, attackerWeaponDefID
|return = {{type|bool}} allowCheck, {{type|bool}} ignoreCheck
|info = Determines if this weapon can automatically generate targets itself. See also {{xtaglink|Gamedev:WeaponDefs|commandFire}} weaponDef tag. The {{var|ignoreCheck}} return value was added in 99.0 to allow ignoring the callin i.e. running normal engine check for this weapon.
}}

{{LuaCallin
|name = AllowWeaponTarget
|args = attackerID, targetID, attackerWeaponNum, attackerWeaponDefID, defPriority
|return = {{type|bool}} allowed, {{type|number}} newPriority
|info = Controls blocking of a specific target from being considered during a weapon's periodic auto-targeting sweep. The second return value is the new priority for this target (if you don't want to change it, return {{var|defPriority}}). Lower priority targets are targeted first.
}}

{{LuaCallin
|name = AllowWeaponInterceptTarget
|args = interceptorUnitID, interceptorWeaponID, targetProjectileID
|return = {{type|bool}} allowed
|info = Controls blocking of a specific intercept target from being considered during an {{xtaglink|Gamedev:WeaponDefs|interceptor}} weapon's periodic auto-targeting sweep. Only called for {{var|weaponDefIDs}} registered via [[Lua_System#Synced|Script.SetWatchWeapon]].
}}

{{LuaCallin
|name = AllowBuilderHoldFire
|args = unitID, unitDefID, action
|return = {{type|bool}} actionAllowed
|info = {{new|98.0}} {{Sourcelinkhash|5a82d750b89e72024bb0bb62cf05ea257737e0ac}} Called when a construction unit wants to "use his nano beams". {{var|action}} is one of following:
* {{value|-1}} Build
* {{value|CMD.REPAIR}} Repair
* {{value|CMD.RECLAIM}} Reclaim
* {{value|CMD.RESTORE}} Restore
* {{value|CMD.RESURRECT}} Resurrect
* {{value|CMD.CAPTURE}} Capture
}}

{{LuaCallin
|name = Explosion
|args = weaponDefID, px, py, pz, AttackerID, ProjectileID
|return = {{type|bool}} noGfx
|info = Called when an explosion occurs. If it returns {{value|true}} then no graphical effects are drawn by the engine for this explosion.
}}

{{LuaCallin
|name = TerraformComplete
|args = unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam
|return = {{type|bool}} stop
|info = Called when pre-building terrain levelling terraforms are completed (c.f. {{xtaglink|Gamedev:UnitDefs|levelGround}}). If the return value is {{value|true}} the current build order is terminated.
}}

{{LuaCallin
|name = MoveCtrlNotify
|args = unitID, unitDefID, unitTeam, data
|return = {{type|bool}} moveCtrlComplete
|info = Enable both [[Lua_MoveCtrl#Options|Spring.MoveCtrl.SetCollideStop]] and [[Lua_MoveCtrl#Options|Spring.MoveCtrl.SetTrackGround]] to enable this call-in, data was supposed to indicate the type of notification but currently never has a value other than {{value|1}} ("unit hit the ground"). The return value determines whether or not the unit should remain script-controlled ({{value|false}}) or return to engine controlled movement ({{value|true}}).
}}

{{LuaCallin
|name = RecvLuaMsg
|args = msg, playerID
|info = Receives messages from unsynced sent via [[Lua_UnsyncedCtrl#SendLuaMessage|Spring.SendLuaRulesMsg]].
}}

{{LuaCallin
|name = Load
|args = zip
|info = Called after {{name|GamePreload}} and before {{name|GameStart}}. See [[Lua_SaveLoad#Load_.28_zip_.29_-.3E_nil|Lua_SaveLoad]].
}}

=== Damage Controllers ===
For the following callins, in addition to being a regular weapon, {{var|weaponDefID}} may be one of the following:
* {{value|-1}} - debris collision, also default of [[Lua_SyncedCtrl#Unit_Control|Spring.AddUnitDamage]]
* {{value|-2}} - ground collision
* {{value|-3}} - object collision
* {{value|-4}} - fire damage
* {{value|-5}} - water damage
* {{value|-6}} - kill damage
* {{value|-7}} - crush damage

{{LuaCallin
|name = UnitPreDamaged
|args = unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|return = {{type|number}} newDamage, {{type|number}} impulseMult
|info = Called before damage is applied to the unit, allows fine control over how much damage and [http://en.wikipedia.org/wiki/Impulse_(physics) impulse] is applied.
}}

{{LuaCallin
|name = ShieldPreDamaged
|I recommend looking up the CallIns in Sourcecode, because the Lua-Documentation, generated from the lua handle of them is seriously flawed and not regenerated.
|Lua-Handler documented from version
|args = proID, proOwnerID, shieldEmitterWeaponNum, shieldCarrierUnitID, bounceProjectile, beamEmitterWeaponNum, beamEmitterUnitID, startX, startY, startZ, hitX, hitY, hitZ
|https://github.com/spring/spring/blob/d085e297416bd963ec25eaa3dbf0796ba22a3582/rts/Lua/LuaHandleSynced.h#L106
|Actual CallIn:
|args = proID, shieldCarrier, boolBounceProjectile, beamEmitterWeaponNum, beamEmitterUnitID, startX, startY, startZ, hitX, hitY, hitZ
|return = {{type|bool}} handleCollision
|info = Called before any engine shield-vs-projectile logic executes. If the return value is {{value|true}} the gadget handles the collision event and the engine does not remove the projectile. If the weapon is a hitscan type ([[Gamedev:WeaponDefs#Tag:weaponType|BeamLaser]] or [[Gamedev:WeaponDefs#Tag:weaponType|LightningCanon]]) then {{var|proID}} is {{value|nil}} and {{var|beamEmitterWeaponNum}} and {{var|beamEmitterUnitID}} are populated instead. The start and hit position arguments are provided from 104.0 onwards.
}}

{{LuaCallin
|name = FeaturePreDamaged
|args = featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam
|return = {{type|number}} newDamage, {{type|number}} impulseMult
|info = Called before damage is applied to the feature, allows fine control over how much damage and [http://en.wikipedia.org/wiki/Impulse_(physics) impulse] is applied.
}}

[[Category: Lua]]

Terms of Service

2019-04-06T07:20:43Z

Silentwings: /* Terms of Service of the SpringRTS lobby server */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

== Terms of Service of the SpringRTS lobby server ==

''You agree not to use any abusive, obscene, vulgar, slanderous, hateful, threatening, sexually-oriented or any other material that may violate any applicable laws. Doing so may lead to you being immediately and permanently banned, and to your service provider and relevant legal authorities being informed of your actions and of data which personally identifies you.''

''You agree that the administrators and moderators of this server have the right to mute, kick or ban you at any time should they see fit, and you agree to abide by any such restrictions imposed on you.''

''You agree not to share, relay or otherwise publish the content of any passworded channels, passworded hosts or other contexts with restricted access, without the explicit permission of both the channel owner and server adminstrators.''

''You confirm that you are at least 13 years of age.''

''The SpringRTS server and its managed game hosts process and retain data generated by their users:''
<ol style="list-style-type:upper-alpha">
<li> ''Registration & login details: email address, IP address, chosen username, (hashed) password.''</li>
<li> ''Actions taking place via Springs infrastructure: chat, games and all associated ingame commands, related hardware and connectivity information, client software used; and derived statistics of these data.'' </li>
<li> ''Source files, artwork and other content relating to games and development of games.'' </li>
</ol>
''The data are used to provide services that would normally be expected from an online gaming platform, primarily: ''
# ''Publicly available replays of games that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.''
# ''Persistent game and chat elements, which make users aware of publicly visible events that previously occurred on the platform.''
# ''Development and provision of the Spring engine, plus supporting infrastructure, including a lobbyserver in which users chat to each other. ''
# ''Bridging of publicly accessible chat channels to external locations, typically those managed by our own users or subprojects for purposes explicitly related to SpringRTS.''
# ''Verification of user identity on login and within battle hosts.''
# ''Moderator action in the event of disputes and suspected misconduct.''
''We process and retain information on basis of legitimate interest, to provide the above services. See the [[Data_Usage|data usage]] page on the springrts.com wiki for further information.''

''Battle hosts listed on our server are typically provided and hosted by our users. When you join to a battle host your IP address will become known to this battle host. If you choose to operate a battle host yourself, your IP address will be shared with other users.''

''We allow connections to our server using external and bespoke client software; which you may be using. In such cases you must refer to your client software data usage policies for information concerning its treatment of the data you provide to it; the data usage policies summarised in this notice ONLY cover our usage of the data that is sent by you or your client software to our server.''

''While the administrators and moderators of this server will attempt to keep users from violating this agreement, it is impossible for them to maintain order at all times. Therefore you acknowledge that any messages or actions within our server expresses the views and opinions of its author and not those of the administrators and moderators, who will not be held liable for other users actions.''

''By using this service you hereby agree to all of the above terms.''

Botflags

2019-03-31T17:31:38Z

Silentwings: /* Battle hosts on the lobby server */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

== Battle hosts on the lobby server ==

All battle hosts that do not have a botflag are limited to a maximum number of 8 players, plus unlimited spectators. This includes both human hosters and autohosts.

Host admins that would like to get a botflag for an Autohost need to create a new thread in the [https://springrts.com/phpbb/viewforum.php?f=16 Ingame Community Forum] with "Botflag request" as topic title and the lobby username which should get the botflag. ''Note: A botflagged user account should not be used to play games on, except when hosting; otherwise it will not function correctly.
''

All users, including battle hosts, must adhere to the [[Terms_of_Service|terms of service of the lobby server]]. In addition:

=== Battle hosts with a botflag ===

Hosts with a botflag are expected to encourage and maintain an environment in which users are able to play games, free from serious disruption and excessively hateful or obscene behavior.

Autohosts with a botflag are expected to appoint host owners and/or admins who are generally capable of maintaining the above expectations, with the help of the tools (pms/kicks/bans/mutes/plugins/etc) provided by the lobby server and SPADS. They should react and respond to all server commands in accordance with the lobby protocol. As part of the response to a ''!list users'' command sent via private message, the autohost must list the usernames of all host admins, and at least one contactable host owner. This list should be kept up to date.

Hosts with a botflag are normally expected to use the latest stable engine version, or a later developmental version, and to host content that is made available for automated download.

Hosts with a botflag may add additional features and enforce restrictions on their use (such as rank limits, plugins, special game modes) providing that they meet the above expectations. In extreme cases, if lobby moderators judge that the above expectations are consistently not met, lobby moderators may require that particular people are added and/or removed as host admins or owners, or that particular features/restrictions are removed. Hosts that do not comply will lose their botflag.

=== Battle hosts without a botflag ===

Hosts without a botflag are not subject to the same expectations as botflagged hosts, and are free to act as a private service provided by one or more users. Such hosts may arbitrarily appoint/remove their admins and owners, add additional features and enforce restrictions on their use, providing they remain within the terms of service of the lobby server.

=== Reporting ===

All issues concerning users behaviour inside battle hosts should be reported to the hosts owners and admins. Springs moderators will not normally become involved in such cases. Issues of serious and prolonged disruption that extend beyond an individual battle host, or concern the conduct of host owners/admins, should be reported to Springs moderators via [https://springrts.com/phpbb/ucp.php?i=pm&mode=compose&g=1643 private message].

Note that the terms of service of the lobby server explicitly recognize that it will not be possible for Springs moderators, or autohost owners and admins, to maintain order at all times.

Terms of Service

2019-03-29T21:52:30Z

Silentwings: /* Terms of Service */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

== Terms of Service of the SpringRTS lobby server ==

''You agree not to use any abusive, obscene, vulgar, slanderous, hateful, threatening, sexually-oriented or any other material that may violate any applicable laws. Doing so may lead to you being immediately and permanently banned, and to your service provider and relevant legal authorities being informed of your actions and of data which personally identifies you.''

''You agree that the administrators and moderators of this server have the right to mute, kick or ban you at any time should they see fit, and you agree to abide by any such restrictions imposed on you.''

''You agree not to share, relay or otherwise publish the content of any passworded channels, passworded hosts or other contexts with restricted access, without the explicit permission of both the channel owner and server adminstrators.''

''You confirm that you are at least 13 years of age.''

''The SpringRTS server and its managed game hosts process and retain data generated by their users:''
<ol style="list-style-type:upper-alpha">
<li> ''Registration & login details: email address, IP/MAC address, chosen username, (hashed) password.''</li>
<li> ''Actions taking place via Springs infrastructure: chat, games and all associated ingame commands, related hardware and connectivity information, client software used; and derived statistics of these data.'' </li>
<li> ''Source files, artwork and other content relating to games and development of games.'' </li>
</ol>
''The data are used to provide services that would normally be expected from an online gaming platform, primarily: ''
# ''Publicly available replays of games that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.''
# ''Persistent game and chat elements, which make users aware of publicly visible events that previously occurred on the platform.''
# ''Development and provision of the Spring engine, plus supporting infrastructure, including a lobbyserver in which users chat to each other. ''
# ''Bridging of publicly accessible chat channels to external locations, typically those managed by our own users or subprojects for purposes explicitly related to SpringRTS.''
# ''Verification of user identity on login and within battle hosts.''
# ''Moderator action in the event of disputes and suspected misconduct.''
''We process and retain information on basis of legitimate interest, to provide the above services. See the [[Data_Usage|data usage]] page on the springrts.com wiki for further information.''

''Battle hosts listed on our server are typically provided and hosted by our users. When you join to a battle host your IP address will become known to this battle host. If you choose to operate a battle host yourself, your IP address will be shared with other users.''

''We allow connections to our server using external and bespoke client software; which you may be using. In such cases you must refer to your client software data usage policies for information concerning its treatment of the data you provide to it; the data usage policies summarised in this notice ONLY cover our usage of the data that is sent by you or your client software to our server.''

''While the administrators and moderators of this server will attempt to keep users from violating this agreement, it is impossible for them to maintain order at all times. Therefore you acknowledge that any messages or actions within our server expresses the views and opinions of its author and not those of the administrators and moderators, who will not be held liable for other users actions.''

''By using this service you hereby agree to all of the above terms.''

Terms of Service

2019-03-29T21:51:26Z

Silentwings: /* Terms of Service & Data Usage Information for the Lobby Server */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

== Terms of Service ==

''You agree not to use any abusive, obscene, vulgar, slanderous, hateful, threatening, sexually-oriented or any other material that may violate any applicable laws. Doing so may lead to you being immediately and permanently banned, and to your service provider and relevant legal authorities being informed of your actions and of data which personally identifies you.''

''You agree that the administrators and moderators of this server have the right to mute, kick or ban you at any time should they see fit, and you agree to abide by any such restrictions imposed on you.''

''You agree not to share, relay or otherwise publish the content of any passworded channels, passworded hosts or other contexts with restricted access, without the explicit permission of both the channel owner and server adminstrators.''

''You confirm that you are at least 13 years of age.''

''The SpringRTS server and its managed game hosts process and retain data generated by their users:''
<ol style="list-style-type:upper-alpha">
<li> ''Registration & login details: email address, IP/MAC address, chosen username, (hashed) password.''</li>
<li> ''Actions taking place via Springs infrastructure: chat, games and all associated ingame commands, related hardware and connectivity information, client software used; and derived statistics of these data.'' </li>
<li> ''Source files, artwork and other content relating to games and development of games.'' </li>
</ol>
''The data are used to provide services that would normally be expected from an online gaming platform, primarily: ''
# ''Publicly available replays of games that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.''
# ''Persistent game and chat elements, which make users aware of publicly visible events that previously occurred on the platform.''
# ''Development and provision of the Spring engine, plus supporting infrastructure, including a lobbyserver in which users chat to each other. ''
# ''Bridging of publicly accessible chat channels to external locations, typically those managed by our own users or subprojects for purposes explicitly related to SpringRTS.''
# ''Verification of user identity on login and within battle hosts.''
# ''Moderator action in the event of disputes and suspected misconduct.''
''We process and retain information on basis of legitimate interest, to provide the above services. See the [[Data_Usage|data usage]] page on the springrts.com wiki for further information.''

''Battle hosts listed on our server are typically provided and hosted by our users. When you join to a battle host your IP address will become known to this battle host. If you choose to operate a battle host yourself, your IP address will be shared with other users.''

''We allow connections to our server using external and bespoke client software; which you may be using. In such cases you must refer to your client software data usage policies for information concerning its treatment of the data you provide to it; the data usage policies summarised in this notice ONLY cover our usage of the data that is sent by you or your client software to our server.''

''While the administrators and moderators of this server will attempt to keep users from violating this agreement, it is impossible for them to maintain order at all times. Therefore you acknowledge that any messages or actions within our server expresses the views and opinions of its author and not those of the administrators and moderators, who will not be held liable for other users actions.''

''By using this service you hereby agree to all of the above terms.''

Terms of Service

2019-03-29T21:46:48Z

Silentwings: more shorten

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

== Terms of Service & Data Usage Information for the Lobby Server ==

''You agree not to use any abusive, obscene, vulgar, slanderous, hateful, threatening, sexually-oriented or any other material that may violate any applicable laws. Doing so may lead to you being immediately and permanently banned, and to your service provider and relevant legal authorities being informed of your actions and of data which personally identifies you.''

''You agree that the administrators and moderators of this server have the right to mute, kick or ban you at any time should they see fit, and you agree to abide by any such restrictions imposed on you.''

''You agree not to share, relay or otherwise publish the content of any passworded channels, passworded hosts or other contexts with restricted access, without the explicit permission of both the channel owner and server adminstrators.''

''You confirm that you are at least 13 years of age.''

''The SpringRTS server and its managed game hosts process and retain data generated by their users:''
<ol style="list-style-type:upper-alpha">
<li> ''Registration & login details: email address, IP/MAC address, chosen username, (hashed) password.''</li>
<li> ''Actions taking place via Springs infrastructure: chat, games and all associated ingame commands, related hardware and connectivity information, client software used; and derived statistics of these data.'' </li>
<li> ''Source files, artwork and other content relating to games and development of games.'' </li>
</ol>
''The data are used to provide services that would normally be expected from an online gaming platform, primarily: ''
# ''Publicly available replays of games that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.''
# ''Persistent game and chat elements, which make users aware of publicly visible events that previously occurred on the platform.''
# ''Development and provision of the Spring engine, plus supporting infrastructure, including a lobbyserver in which users chat to each other. ''
# ''Bridging of publicly accessible chat channels to external locations, typically those managed by our own users or subprojects for purposes explicitly related to SpringRTS.''
# ''Verification of user identity on login and within battle hosts.''
# ''Moderator action in the event of disputes and suspected misconduct.''
''We process and retain information on basis of legitimate interest, to provide the above services. See the [[Data_Usage|data usage]] page on the springrts.com wiki for further information.''

''Battle hosts listed on our server are typically provided and hosted by our users. When you join to a battle host your IP address will become known to this battle host. If you choose to operate a battle host yourself, your IP address will be shared with other users.''

''We allow connections to our server using external and bespoke client software; which you may be using. In such cases you must refer to your client software data usage policies for information concerning its treatment of the data you provide to it; the data usage policies summarised in this notice ONLY cover our usage of the data that is sent by you or your client software to our server.''

''While the administrators and moderators of this server will attempt to keep users from violating this agreement, it is impossible for them to maintain order at all times. Therefore you acknowledge that any messages or actions within our server expresses the views and opinions of its author and not those of the administrators and moderators, who will not be held liable for other users actions.''

''By using this service you hereby agree to all of the above terms.''

Terms of Service

2019-03-29T21:38:26Z

Silentwings: shorten

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

== Terms of Service & Data Usage Information for the Lobby Server ==

''You agree not to use any abusive, obscene, vulgar, slanderous, hateful, threatening, sexually-oriented or any other material that may violate any applicable laws. Doing so may lead to you being immediately and permanently banned, and to your service provider and relevant legal authorities being informed of your actions and of data which personally identifies you.''

''You agree that the administrators and moderators of this server have the right to mute, kick or ban you at any time should they see fit, and you agree to abide by any such restrictions imposed on you.''

''You agree not to share, relay or otherwise publish the content of any passworded channels, passworded hosts or other contexts with restricted access, without the explicit permission of both the channel owner and server adminstrators.''

''You confirm that you are at least 13 years of age.''

''The SpringRTS server and its managed game hosts process and retain data generated by their users:''
<ol style="list-style-type:upper-alpha">
<li> ''Registration & login details: email address, IP/MAC address, chosen username, (hashed) password.''</li>
<li> ''Actions taking place via Springs infrastructure: chat, games and all associated ingame commands, related hardware and connectivity information, client software used; and derived statistics of these data.'' </li>
<li> ''Source files, artwork and other content relating to games and development of games.'' </li>
</ol>
''The data are used to provide services that would normally be expected from an online gaming platform, primarily: ''
# ''Publicly available replays of games that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.''
# ''Persistent game and chat elements, which make users aware of publicly visible events that previously occurred on the platform.''
# ''Development and provision of the Spring engine, plus supporting infrastructure, including a lobbyserver in which users chat to each other. ''
# ''Bridging of publicly accessible chat channels to external locations, typically those managed by our own users or subprojects for purposes explicitly related to SpringRTS.''
# ''Verification of user identity on login and within battle hosts.''
# ''Moderator action in the event of disputes and suspected misconduct.''
''We process and retain information on basis of legitimate interest, to provide the above services. See the [[Data_Usage|data usage]] page on the springrts.com wiki for further information.''

''Battle hosts listed on our server are typically provided and hosted by our users; consequently when you choose to connect to a battle host your IP address will become known to this battle host, as will any data as described in item B above that you generate during your usage of the battle host. If you choose to operate a battle host yourself, your IP address will be shared with other users. ''

''We permit users to connect to our server using external and bespoke client software. Consequently, the operation of such software may be outside of our control and knowledge. In such cases you must refer to your client software data usage policies for information concerning its treatment of the data you provide to it; the data usage policies summarised in this notice ONLY cover our usage of the data that is sent by you or your client software to our server.''

''While the administrators and moderators of this server will attempt to keep users from violating this agreement, it is impossible for them to maintain order at all times. Therefore you acknowledge that any messages or actions within our server expresses the views and opinions of its author and not those of the administrators and moderators, who will not be held liable for other users actions.''

''By using this service you hereby agree to all of the above terms.''

Matrix

2019-03-22T20:28:00Z

Silentwings: /* Matrix - Ubserver Bridge */

Matrix is an open network for secure, decentralized communication. Spring has its own matrix server which is connected with [[Glenda]] to the lobby server.

A lobby account is required to login: https://springrts.com/matrix/

==== Matrix Server ====
* synapse: https://github.com/matrix-org/synapse
* authprovider: https://github.com/TurBoss/matrix-synapser-uberserver-xmlrpc

==== Matrix - Uberserver Bridge ====
* framework: https://github.com/tulir/mautrix-python
* lobby library: https://github.com/TurBoss/asyncspring
* appservice: https://github.com/TurBoss/matrix-spring-appservice, https://github.com/half-shot/matrix-appservice-discord

[[Category: Lobby]]

Matrix

2019-03-22T20:27:20Z

Silentwings: add links to repos for new bridges

Matrix is an open network for secure, decentralized communication. Spring has its own matrix server which is connected with [[Glenda]] to the lobby server.

A lobby account is required to login: https://springrts.com/matrix/

==== Matrix Server ====
* synapse: https://github.com/matrix-org/synapse
* authprovider: https://github.com/TurBoss/matrix-synapser-uberserver-xmlrpc

==== Matrix - Ubserver Bridge ====
* framework: https://github.com/tulir/mautrix-python
* lobby library: https://github.com/TurBoss/asyncspring
* appservice: https://github.com/TurBoss/matrix-spring-appservice, https://github.com/half-shot/matrix-appservice-discord

[[Category: Lobby]]

Community Docs

2019-03-19T11:28:39Z

Silentwings: /* Lobby Server */

[[Main_Page|Wiki]] < {{FULLPAGENAME}}

== Community Docs ==
This page holds links to various documents that shape our online community.

=== Licensing and forking ===

Guidelines outlining how we handle [[Licenses_Forking_Mutators|licensing and forking]] of content within our own servers.

Detailed information on how we think the engines [https://springrts.com/phpbb/viewtopic.php?f=1&t=17847 GPL license affects games and other content].

=== Forum ===

Our [[Felony|forum rules]], including a list of unacceptable conduct that can lead to warnings and bans.

Guidelines on [[Forum_Etiquette|etiquette within online forums]].

=== Lobby Server ===

The [[Terms_of_Service|terms of service]] of the springrts.com lobby server, and [[Data_Usage|data usage policy]].

Information for host owners about the role of [[Botflags|botflags and lobby moderators]].

== Contact ==

[[Reporting|How to report issues to moderators.]]

List of Springs current [https://springrts.com/phpbb/memberlist.php?mode=team moderators, administrators and engine developers].

[[Category:Spring]]

Data Usage

2019-03-07T09:17:42Z

Silentwings: /* Disclosure of data to third parties and other users */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

==Data and usage of data==

The SpringRTS server and its managed game hosts process and retain information generated by users:

<ol style="list-style-type:upper-alpha">
<li>
Registration & login details: email address, IP address, chosen username, (hashed) password.
</li>
<li>
Actions taking place via Springs infrastructure: chat, games played by users and all associated ingame commands, hardware and connectivity information characterizing suitability to play such games, client software used, IP addresses of battle hosts; and derived statistics of these data. This data is divided into two types:
<ol style="list-style-type:decimal">
<li> Data created in publicly accessible contexts, such as non-passworded chat channels and battle hosts. </li>
<li> Data created in private contexts, such as private messages, passworded chat channels and passworded battle hosts. </li>
</ol>
<li>
Source files, artwork and other content relating to games and development of games.
</li>
</ol>
This data is used to provide services that would normally be expected from an online gaming platform, primarily:
# '''Publicly available replays of games''' that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.
# '''Persistent game and chat elements,''' which make users aware of publicly visible events that previously occurred on the platform.
# '''Development and provision of the Spring engine,''' plus supporting infrastructure, including a lobbyserver in which users chat to each other.
# '''Bridging of publicly accessible chat channels''' to external locations, typically those managed by our own users and sub-projects for purposes explicitly related to SpringRTS.
# '''Verification of user identity''' on login and within battle hosts.
# '''Moderator action''' in the event of disputes and suspected misconduct.
'''We retain and process data of types A, B and C on basis of legitimate interest, to provide the above services.'''

Users may connect to our server using external and bespoke software, known as a “client”, as specified through a publicly available protocol. This software may be outside of our control and knowledge. In such cases, whilst we may deny connections from clients that do not comply with GDPR and other legal requirements where it is technically and practically possible for us to do so, the operation and compliance of client software is the responsibility of its authors and users. The data usage policies summarised in this notice ONLY cover our usage of the data that is sent by users and users client software to our server.

Users are contacted via automated messages to email addresses that they provide for purposes related to item 5 when it is necessary to do so, such as when a user requests account recovery. In exceptional circumstances we may also manually contact individual users for purposes related to items 3 or 6. We do not use these email addresses to send marketing emails to our users and we do not disclose email addresses to third parties.

====Legitimate Interest====
We would be unable to provide the above services without retention and processing of the above data. Items 1 and 2 consist wholly of retaining and processing data of types B and C. Data retained and processed relating to item 3 consists of type B and C data, primarily communications occurring between users during their cooperative usage of our services, plus games and other content files for these services. Item 4 requires no retention of data, but requires on-the-fly processing of type B data. Item 5 requires type A data to correctly associate login attempts to user accounts and to help protect the server and battle hosts from malicious activity. Item 6 requires both type A and B data, to support moderator actions identifying, discouraging and preventing misconduct.

Type B.1 data is generated exclusively by individuals within in publicly accessible contexts, in which an expectation exists that this data will be shared with any number of other users. Type B.2 data is generated by individual in contexts where an expectation of privacy from other users exists. Such data is of a nature that is not expected to carry significant risk to an individual’s rights and freedoms, however steps are taken to respect this privacy as detailed below; this data is used only for purposes relating to items 3 and 6. The retention and processing of type B data carries a low risk of inhibiting individual’s rights and freedoms.

Type A data contains information (particularly: email, IP) provided in private contexts that could, in some cases, and when supplemented with external sources of related information, be used to identify a real individual from their online footprint and consequently requires appropriate protection as detailed below; since otherwise the data held by SpringRTS concerning such individuals is of a non-sensitive nature the associated impact on individuals interests, rights and freedoms is low.

Developers and other users who provide data of type C may also provide licenses for such data. Authors may choose to include their own contact details; the risk to the individual’s rights and freedoms is low. For details on how we handle such content see our policies on licensing, forking, and on how the GPL license of the spring engine affects game content.

We do not engage in targeted advertising. We do not engage in profiling or automated decision making that has legal implications for users. We do not process or retain criminal or special category data.

All of our codebases are open source, permitting our users and developers to verify and review that our systems perform as described in this document, and to report any related technical errors.

==User rights under GDPR==

Users wishing to exercise their rights under GDPR should contact moderation staff, who are identifiable on the server by means of a spanner icon, and also contactable through springrts.com or by email at postmaster@springrts.com; such requests are handled on a case-by-case basis. We have procedures in place to assess numbers of moderation staff and ensure that such people are contactable and able to respond within the required time periods. Any data supplied in response will typically come in plain text form, or in the form of access to online replay files.

Note that the right to erasure under GDPR is not absolute; in particular we may refuse to fully erase data of individuals with a record of past misconduct if we believe such data may be required to prevent potential future misconduct of sufficient severity. See [http://www.privacy-regulation.eu/en/recital-49-GDPR.htm] for details.

==Disclosure of data to third parties and other users==

When information is supplied to us within a publicly visible medium, such as through a public chat channel or public game host, we may and typically will make this information publicly available to other users and to GDPR compliant third parties. This pertains to type all type B.1 data, plus usernames.

Type B.2 data is supplied to other users only when these other users are present or have access to the private context, such as a passworded chat channel or passworded game host, in which the data was created. This data is not disclosed to third parties, but it is retained to provide persistent chat functionality and is accessible to server administrators whilst it is retained.

When users choose to act as battle hosts, or provide automated battle hosts, the IP address of this host becomes publicly available information, necessarily to allow our users to make a (direct) connection to the battle, and for the battle host to accept or decline this connection. Battle hosts receive usernames plus type B data associated to the battles that they host and will typically distribute this data to other connected users. Battle hosts also necessarily become aware of the IP addresses of users attempting to connect to their battles, but they do not become aware of any other type A data of these users. On a technical level, the distributed nature of battle hosting amongst our users arises from a need for more computational resources and connectivity than the Spring server alone provides. Consequently, battle hosts take on responsibilities of their own under the GDPR and are required to comply fully with the policies set out in this document.

Non-public information supplied to us on login, pertaining to all type A data excluding usernames, may be visible to our moderators and developers when there is a need under items 3 or 6. Hashed passwords are accessible only to developers with a need to access the live user database. Type A data is not disclosed to third parties or other users, except to battle hosts as described above, and except where we judge it necessary for purposes of verifying the authenticity of users; we use external GDPR compliant services to assist in automated detection of potentially malicious users attempting to conceal their own identities.

We reserve the right to pass ANY data that we hold to relevant law enforcement agencies if we believe that it may contain indications or evidence of illegal action.

==Data storage and protection==

All data retained are kept within databases and/or file archives on our server, located within the EU.

The database files are directly accessible only to chosen individuals who require access for purposes related to server development or administration; access is possible only via an encrypted connection using individual credentials. The list of individuals with this access is reviewed regularly on timescales related to their activity. All data of type A held by us is contained within these databases.
Archives of replay files are made available through a public website.

Communications of users to and from our lobbyserver, which covers all type A data sometimes excepting usernames and chat taking place on the lobbyserver, is encrypted (except in cases where users have persistently declined over many years to install software updates supporting this encryption). Passwords are communicated and stored only in hashed format.

Communications taking place between players and spectators within online games, typically consisting of ingame commands and chat, are not encrypted; the Spring engine uses a bespoke protocol for such communications, which prioritises low latency. These communications consist of less sensitive data - type B data plus usernames – and it is judged here that the requirement of minimal latency should take precedence over the benefits to privacy of an encryption layer.

==Retention and erasure of personal data==

The record of type A data of a user is retained for as long as we regard the user as active or with a significant possibility of returning to activity; we engage in automated deletion of such records for users who have remained inactive for 5 consecutive years. This threshold is chosen based on the behaviour of our users, who are known to return after lengthy periods of absence.

Type B.1 data of users, plus usernames, is retained in the form of publicly available archives of online games. We engage in automated deletion of this data after 3 years, but in special cases some replays may be retained for longer.

Type B.1 and type B.2 data consisting of chat taking place on the server within registered channels, in which channel history functionality has been enabled, is stored for up to one month in a database that provides persistent chat functionality. Otherwise, type B.2 data is not retained.

Users should note that when they create type B data they typically do so in the presence of other users who may retain and process the data for periods and purposes outside of our control or knowledge.

We retain and erase type C data according to its license. We regard maintaining a publicly available archive of this data as critical to providing our services and to future development and, whilst we respect individuals right to erasure upon request of any personal data within this archive, we do not engage in automated deletion of it after any time period.

[[Category:Spring]]

Data Usage

2019-03-07T09:17:10Z

Silentwings: /* Data and usage of data */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

==Data and usage of data==

The SpringRTS server and its managed game hosts process and retain information generated by users:

<ol style="list-style-type:upper-alpha">
<li>
Registration & login details: email address, IP address, chosen username, (hashed) password.
</li>
<li>
Actions taking place via Springs infrastructure: chat, games played by users and all associated ingame commands, hardware and connectivity information characterizing suitability to play such games, client software used, IP addresses of battle hosts; and derived statistics of these data. This data is divided into two types:
<ol style="list-style-type:decimal">
<li> Data created in publicly accessible contexts, such as non-passworded chat channels and battle hosts. </li>
<li> Data created in private contexts, such as private messages, passworded chat channels and passworded battle hosts. </li>
</ol>
<li>
Source files, artwork and other content relating to games and development of games.
</li>
</ol>
This data is used to provide services that would normally be expected from an online gaming platform, primarily:
# '''Publicly available replays of games''' that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.
# '''Persistent game and chat elements,''' which make users aware of publicly visible events that previously occurred on the platform.
# '''Development and provision of the Spring engine,''' plus supporting infrastructure, including a lobbyserver in which users chat to each other.
# '''Bridging of publicly accessible chat channels''' to external locations, typically those managed by our own users and sub-projects for purposes explicitly related to SpringRTS.
# '''Verification of user identity''' on login and within battle hosts.
# '''Moderator action''' in the event of disputes and suspected misconduct.
'''We retain and process data of types A, B and C on basis of legitimate interest, to provide the above services.'''

Users may connect to our server using external and bespoke software, known as a “client”, as specified through a publicly available protocol. This software may be outside of our control and knowledge. In such cases, whilst we may deny connections from clients that do not comply with GDPR and other legal requirements where it is technically and practically possible for us to do so, the operation and compliance of client software is the responsibility of its authors and users. The data usage policies summarised in this notice ONLY cover our usage of the data that is sent by users and users client software to our server.

Users are contacted via automated messages to email addresses that they provide for purposes related to item 5 when it is necessary to do so, such as when a user requests account recovery. In exceptional circumstances we may also manually contact individual users for purposes related to items 3 or 6. We do not use these email addresses to send marketing emails to our users and we do not disclose email addresses to third parties.

====Legitimate Interest====
We would be unable to provide the above services without retention and processing of the above data. Items 1 and 2 consist wholly of retaining and processing data of types B and C. Data retained and processed relating to item 3 consists of type B and C data, primarily communications occurring between users during their cooperative usage of our services, plus games and other content files for these services. Item 4 requires no retention of data, but requires on-the-fly processing of type B data. Item 5 requires type A data to correctly associate login attempts to user accounts and to help protect the server and battle hosts from malicious activity. Item 6 requires both type A and B data, to support moderator actions identifying, discouraging and preventing misconduct.

Type B.1 data is generated exclusively by individuals within in publicly accessible contexts, in which an expectation exists that this data will be shared with any number of other users. Type B.2 data is generated by individual in contexts where an expectation of privacy from other users exists. Such data is of a nature that is not expected to carry significant risk to an individual’s rights and freedoms, however steps are taken to respect this privacy as detailed below; this data is used only for purposes relating to items 3 and 6. The retention and processing of type B data carries a low risk of inhibiting individual’s rights and freedoms.

Type A data contains information (particularly: email, IP) provided in private contexts that could, in some cases, and when supplemented with external sources of related information, be used to identify a real individual from their online footprint and consequently requires appropriate protection as detailed below; since otherwise the data held by SpringRTS concerning such individuals is of a non-sensitive nature the associated impact on individuals interests, rights and freedoms is low.

Developers and other users who provide data of type C may also provide licenses for such data. Authors may choose to include their own contact details; the risk to the individual’s rights and freedoms is low. For details on how we handle such content see our policies on licensing, forking, and on how the GPL license of the spring engine affects game content.

We do not engage in targeted advertising. We do not engage in profiling or automated decision making that has legal implications for users. We do not process or retain criminal or special category data.

All of our codebases are open source, permitting our users and developers to verify and review that our systems perform as described in this document, and to report any related technical errors.

==User rights under GDPR==

Users wishing to exercise their rights under GDPR should contact moderation staff, who are identifiable on the server by means of a spanner icon, and also contactable through springrts.com or by email at postmaster@springrts.com; such requests are handled on a case-by-case basis. We have procedures in place to assess numbers of moderation staff and ensure that such people are contactable and able to respond within the required time periods. Any data supplied in response will typically come in plain text form, or in the form of access to online replay files.

Note that the right to erasure under GDPR is not absolute; in particular we may refuse to fully erase data of individuals with a record of past misconduct if we believe such data may be required to prevent potential future misconduct of sufficient severity. See [http://www.privacy-regulation.eu/en/recital-49-GDPR.htm] for details.

==Disclosure of data to third parties and other users==

When information is supplied to us within a publicly visible medium, such as through a public chat channel or public game host, we may and typically will make this information publicly available to other users and to GDPR compliant third parties. This pertains to type all type B.1 data, plus usernames.

Type B.2 data is supplied to other users only when these other users are present or have access to the private context, such as a passworded chat channel or passworded game host, in which the data was created. This data is not disclosed to third parties, but it is retained to provide persistent chat functionality and is accessible to server administrators whilst it is retained.

When users choose to act as battle hosts, or provide automated battle hosts, the IP address of this host becomes publicly available information, necessarily to allow our users to make a (direct) connection to the battle, and for the battle host to accept or decline this connection. Battle hosts receive usernames plus type B data associated to the battles that they host and will typically distribute this data to other connected users. Battle hosts also necessarily become aware of the IP addresses of users attempting to connect to their battles, but they do not become aware of any other type A data of these users. On a technical level, the distributed nature of battle hosting amongst our users arises from a need for more computational resources and connectivity than the Spring server alone provides. Consequently, battle hosts take on responsibilities of their own under the GDPR and are required to comply fully with the policies set out in this document.

Non-public information supplied to us on login, pertaining to all type A data excluding usernames, may be visible to our moderators and developers when there is a need under items 3 or 6. Hashed passwords are accessible only to developers with a need to access the live user database. Type A data is not disclosed to third parties or other users, except to battle hosts as described above, and except where we judge it necessary for purposes of verifying the authenticity of users; we use the external GDPR compliant service IPHub to assist in automated detection of potentially malicious users attempting to conceal their own identities.

We reserve the right to pass ANY data that we hold to relevant law enforcement agencies if we believe that it may contain indications or evidence of illegal action.

==Data storage and protection==

All data retained are kept within databases and/or file archives on our server, located within the EU.

The database files are directly accessible only to chosen individuals who require access for purposes related to server development or administration; access is possible only via an encrypted connection using individual credentials. The list of individuals with this access is reviewed regularly on timescales related to their activity. All data of type A held by us is contained within these databases.
Archives of replay files are made available through a public website.

Communications of users to and from our lobbyserver, which covers all type A data sometimes excepting usernames and chat taking place on the lobbyserver, is encrypted (except in cases where users have persistently declined over many years to install software updates supporting this encryption). Passwords are communicated and stored only in hashed format.

Communications taking place between players and spectators within online games, typically consisting of ingame commands and chat, are not encrypted; the Spring engine uses a bespoke protocol for such communications, which prioritises low latency. These communications consist of less sensitive data - type B data plus usernames – and it is judged here that the requirement of minimal latency should take precedence over the benefits to privacy of an encryption layer.

==Retention and erasure of personal data==

The record of type A data of a user is retained for as long as we regard the user as active or with a significant possibility of returning to activity; we engage in automated deletion of such records for users who have remained inactive for 5 consecutive years. This threshold is chosen based on the behaviour of our users, who are known to return after lengthy periods of absence.

Type B.1 data of users, plus usernames, is retained in the form of publicly available archives of online games. We engage in automated deletion of this data after 3 years, but in special cases some replays may be retained for longer.

Type B.1 and type B.2 data consisting of chat taking place on the server within registered channels, in which channel history functionality has been enabled, is stored for up to one month in a database that provides persistent chat functionality. Otherwise, type B.2 data is not retained.

Users should note that when they create type B data they typically do so in the presence of other users who may retain and process the data for periods and purposes outside of our control or knowledge.

We retain and erase type C data according to its license. We regard maintaining a publicly available archive of this data as critical to providing our services and to future development and, whilst we respect individuals right to erasure upon request of any personal data within this archive, we do not engage in automated deletion of it after any time period.

[[Category:Spring]]

Terms of Service

2019-02-22T17:36:26Z

Silentwings: /* Terms of Service & Data Usage Information for the Lobby Server */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

== Terms of Service & Data Usage Information for the Lobby Server ==

''You agree not to use any abusive, obscene, vulgar, slanderous, hateful, threatening, sexually-oriented or any other material that may violate any applicable laws. Doing so may lead to you being immediately and permanently banned, and to your service provider and relevant legal authorities being informed of your actions and of data which personally identifies you.''

''You agree that the administrators and moderators of this server have the right to mute, kick or ban you at any time should they see fit, and you agree to abide by any such restrictions imposed on you.''

''You agree not to share, relay or otherwise publish the content of any passworded channels, passworded hosts or other contexts with restricted access, without the explicit permission of both the channel owner and server adminstrators.''

''You confirm that you are at least 13 years of age.''

''The SpringRTS server and its managed game hosts process and retain data generated by their users:''
<ol style="list-style-type:upper-alpha">
<li> ''Registration & login details: email address, IP/MAC address, chosen username, (hashed) password.''</li>
<li> ''Actions taking place via Springs infrastructure: chat, games and all associated ingame commands, related hardware and connectivity information, client software used; and derived statistics of these data.'' </li>
<li> ''Source files, artwork and other content relating to games and development of games.'' </li>
</ol>
''The data are used to provide services that would normally be expected from an online gaming platform, primarily: ''
# ''Publicly available replays of games that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.''
# ''Persistent game and chat elements, which make users aware of publicly visible events that previously occurred on the platform.''
# ''Development and provision of the Spring engine, plus supporting infrastructure, including a lobbyserver in which users chat to each other. ''
# ''Bridging of publicly accessible chat channels to external locations, typically those managed by our own users or subprojects for purposes explicitly related to SpringRTS.''
# ''Verification of user identity on login and within battle hosts.''
# ''Moderator action in the event of disputes and suspected misconduct.''
''We process and retain information on basis of legitimate interest, to provide the above services. See the [[Data_Usage|data usage]] page on the springrts.com wiki for further information. A summary follows:''

''Data supplied within a publicly visible context, such as a public chat channel, will be made publicly available to other users and may also be disclosed to third parties. Private messages and the contents of passworded channels are not made publicly available or disclosed to third parties. All data supplied in contexts that are shared with other users is forwarded to other users in real-time and may potentially be retained or processed by those other users for periods and purposes outside of our control and knowledge. We reserve the right to pass ANY data that we hold to relevant law enforcement agencies if we believe that users may have engaged in illegal activity. ''

''Battle hosts listed on our server are typically provided and hosted by our users; consequently when you choose to connect to a battle host your IP address will become known to this battle host, as will any data as described in item B above that you generate during your usage of the battle host. If you choose to operate a battle host yourself, your IP address will be shared with other users. ''

''We may send automated emails for purposes related to account verification, such as if you request account recovery. We do not engage in targeted advertising and will not send you emails marketing any services or products, including our own. We do not disclose your email address to third parties.''

''We permit users to connect to our server using external and bespoke client software. Consequently, the operation of such software may be outside of our control and knowledge. In such cases you must refer to your client software data usage policies for information concerning its treatment of the data you provide to it; the data usage policies summarised in this notice ONLY cover our usage of the data that is sent by you or your client software to our server.''

''While the administrators and moderators of this server will attempt to keep users from violating this agreement, it is impossible for them to maintain order at all times. Therefore you acknowledge that any messages or actions within our server expresses the views and opinions of its author and not those of the administrators and moderators, who will not be held liable for other users actions.''

''By using this service you hereby agree to all of the above terms.''

Gamedev:PublicRepos

2019-02-22T06:55:26Z

Silentwings: /* Known Repos */

==What Is This?==
This is a small collection of publicly known and readable code repositories for established Spring games. The intention being to provide a wealth of examples to all game developers from noob to pro.

Most of these repositories can be downloaded with one of the [[Rapid_Tags]].

== Known Repos ==
[https://github.com/KingRaptor/air-raid-spring Air Raid]

[https://github.com/balanced-annihilation Balanced Annihilation]

[https://github.com/spring-archive/basically-ota BOTA]

[https://github.com/spring-archive/conflictterra Conflict Terra]

[http://www.petro.darkstars.co.uk/damned/ Damned]

[https://github.com/EvolutionRTS/Evolution-RTS Evolution RTS]

[https://github.com/SpringCabal/Gravitas Gravitas]

[https://github.com/imperialwinter/swiw.sdd Imperial Winter]

[https://bitbucket.org/PicassoCT/journeywar Journeywar]

[https://github.com/jk3064?tab=repositories jK]
* [[Chili]]
* [[LUPS]]
* Custom-Unit-Shader-Framework
* [[Mapdev:Main#Blueprint | Map-Blueprint]]

[https://github.com/David-Becker/mods KDR_11k]
* Cuberors' Finest
* CvC
* Doserz
* Fibre
* GINTA
* Gun Wings Test
* Light Side of Spring
* MicroModules
* Pong

[https://github.com/SpringMCLegacy/SpringMCLegacy MechCommander: Legacy]

[https://github.com/spring1944/spring1944 Spring: 1944]

[https://github.com/spring-archive/springtanks Spring Tanks]

[https://github.com/spring-archive/springtutorialgame/tree/master/SpringTutorialGame.sdd Spring Tutorial Game]

[https://github.com/n3wm1nd/TA Tech Annihilation]

[https://github.com/KingRaptor/THIS THIS]

[http://code.google.com/p/xta-springrts/ XTA]

[https://github.com/ZeroK-RTS/Zero-K/ Zero-K]

[[Category:Game Dev]]
[[Category:Download Systems]]

ChanServ

2019-02-12T21:40:42Z

Silentwings: /* Channel forwarding */

ChanServ is the lobby bot of [[uberserver]] for managing channels in the springrts.com lobby. It is intended that one day ChanServ will be replaced with a GUI, but we didn't get there yet.

==Interacting with ChanServ==
ChanServ commands are prefixed by a colon '''<code>:</code>'''. They can be given in two forms:
* By PM to the ChanServ bot, in the form e.g. '''<code>:topic newbies Welcome to #newbies!</code>'''
* Within a channel in which ChanServ is present, in the form e.g. '''<code>:topic Welcome to #newbies!</code>'''
In the second form, the channel name is omitted. Note that in this first form the channel name 'newbies' is not preceded by a # character.

ChanServ is present in all registered channels, and adds extra functionality to these channels as documented below. Contact a lobbyserver moderator to register a channel.

==Commands==
All expressed as though sent in PM to ChanServ; when used inside a channel the chanName arg is omitted. All commands are callable by users with channel operator/founder or lobby moderator status, unless specified otherwise.

===Registering channels and operators===
These commands are accessible only to lobby moderators and the channel founder.
*'''<code>:register chanName chanFounder</code>''' Registers a channel. If the final argument is omitted, the callee will be the founder.
*'''<code>:unregister chanName</code>''' Un-registers a channel.
*'''<code>:changefounder chanName username</code>''' Make a user not be a channel operator.
*'''<code>:op chanName username</code>''' Make a user into a channel operator. Accessible only to lobbyserver moderators and the channel founder.
*'''<code>:deop chanName username</code>''' Make a user not be a channel operator. Accessible only to lobbyserver moderators and the channel founder.
*'''<code>:history chanName state</code>''' Turns persistent chat functionality on/off. State should be "on" or "off".
*'''<code>:antispam chanName state</code>''' Turns antispam chat functionality on/off. State should be "on" or "off".
===Managing users===
These commands are accessible to channel operators, as well as lobby moderators and the channel founder.
*'''<code>:topic chanName topic</code>''' Sets the topic, which is displayed to all users when they join the channel.
*'''<code>:mute chanName target_username duration reason</code>''' Mutes a user. The duration can be in form e.g. "2d" for two days or "1h" for one hour.
*'''<code>:unmute chanName target_username </code>''' Unmutes a user.
*'''<code>:listmutes</code>''' Returns a list of muted users.
*'''<code>:ban chanName target_username duration reason</code>''' Bans a user.
*'''<code>:unban chanName target_username duration reason</code>''' Unbans a user.
*'''<code>:listbans</code>''' Returns a list of banned users.
*'''<code>:kick chanName username</code>''' Kicks a user.

===Channel forwarding===
These commands are accessible only to lobby moderators.
*'''<code>:forward from_chanName to_chanName</code>''' Set up forwarding of all operator statuses, mutes and bans, from a channel to a battle. Call this command more than once to forward to more than one battle.
*'''<code>:unforward from_chanName to_chanName</code>''' Remove forwarding.
*'''<code>:listforwards chanName</code>''' Returns a list of the locations this channel is forwarding too.

===General info===
These commands can be called by anyone.
*'''<code>:battlename username</code>''' Returns the name of the channel in use by this user to host their current battle.
*'''<code>:info chanName</code>''' Displays information about the channel, including the founder and list of operators.
*'''<code>:help</code>''' Offers you a link to this page!

[[Category:Lobby]]

ChanServ

2019-02-12T21:40:28Z

Silentwings: /* Managing users and channels */

ChanServ is the lobby bot of [[uberserver]] for managing channels in the springrts.com lobby. It is intended that one day ChanServ will be replaced with a GUI, but we didn't get there yet.

==Interacting with ChanServ==
ChanServ commands are prefixed by a colon '''<code>:</code>'''. They can be given in two forms:
* By PM to the ChanServ bot, in the form e.g. '''<code>:topic newbies Welcome to #newbies!</code>'''
* Within a channel in which ChanServ is present, in the form e.g. '''<code>:topic Welcome to #newbies!</code>'''
In the second form, the channel name is omitted. Note that in this first form the channel name 'newbies' is not preceded by a # character.

ChanServ is present in all registered channels, and adds extra functionality to these channels as documented below. Contact a lobbyserver moderator to register a channel.

==Commands==
All expressed as though sent in PM to ChanServ; when used inside a channel the chanName arg is omitted. All commands are callable by users with channel operator/founder or lobby moderator status, unless specified otherwise.

===Registering channels and operators===
These commands are accessible only to lobby moderators and the channel founder.
*'''<code>:register chanName chanFounder</code>''' Registers a channel. If the final argument is omitted, the callee will be the founder.
*'''<code>:unregister chanName</code>''' Un-registers a channel.
*'''<code>:changefounder chanName username</code>''' Make a user not be a channel operator.
*'''<code>:op chanName username</code>''' Make a user into a channel operator. Accessible only to lobbyserver moderators and the channel founder.
*'''<code>:deop chanName username</code>''' Make a user not be a channel operator. Accessible only to lobbyserver moderators and the channel founder.
*'''<code>:history chanName state</code>''' Turns persistent chat functionality on/off. State should be "on" or "off".
*'''<code>:antispam chanName state</code>''' Turns antispam chat functionality on/off. State should be "on" or "off".
===Managing users===
These commands are accessible to channel operators, as well as lobby moderators and the channel founder.
*'''<code>:topic chanName topic</code>''' Sets the topic, which is displayed to all users when they join the channel.
*'''<code>:mute chanName target_username duration reason</code>''' Mutes a user. The duration can be in form e.g. "2d" for two days or "1h" for one hour.
*'''<code>:unmute chanName target_username </code>''' Unmutes a user.
*'''<code>:listmutes</code>''' Returns a list of muted users.
*'''<code>:ban chanName target_username duration reason</code>''' Bans a user.
*'''<code>:unban chanName target_username duration reason</code>''' Unbans a user.
*'''<code>:listbans</code>''' Returns a list of banned users.
*'''<code>:kick chanName username</code>''' Kicks a user.

===Channel forwarding===
These commands are accessible only to lobby moderators.
*'''<code>:forward from_chanName to_chanName</code>''' Set up forwarding of all operator statuses, mutes and bans, from a channel to a battle. Call this command more than once to forward to more than one battle.
*'''<code>:unforward from_chanName to_chanName</code>''' Remove forwarding.
*'''<code>:listforwards chanName</code>''' Returns a list of the loations this channel is forwarding too.
===General info===
These commands can be called by anyone.
*'''<code>:battlename username</code>''' Returns the name of the channel in use by this user to host their current battle.
*'''<code>:info chanName</code>''' Displays information about the channel, including the founder and list of operators.
*'''<code>:help</code>''' Offers you a link to this page!

[[Category:Lobby]]

ChanServ

2019-02-12T21:39:52Z

Silentwings: /* Managing users */

ChanServ is the lobby bot of [[uberserver]] for managing channels in the springrts.com lobby. It is intended that one day ChanServ will be replaced with a GUI, but we didn't get there yet.

==Interacting with ChanServ==
ChanServ commands are prefixed by a colon '''<code>:</code>'''. They can be given in two forms:
* By PM to the ChanServ bot, in the form e.g. '''<code>:topic newbies Welcome to #newbies!</code>'''
* Within a channel in which ChanServ is present, in the form e.g. '''<code>:topic Welcome to #newbies!</code>'''
In the second form, the channel name is omitted. Note that in this first form the channel name 'newbies' is not preceded by a # character.

ChanServ is present in all registered channels, and adds extra functionality to these channels as documented below. Contact a lobbyserver moderator to register a channel.

==Commands==
All expressed as though sent in PM to ChanServ; when used inside a channel the chanName arg is omitted. All commands are callable by users with channel operator/founder or lobby moderator status, unless specified otherwise.

===Registering channels and operators===
These commands are accessible only to lobby moderators and the channel founder.
*'''<code>:register chanName chanFounder</code>''' Registers a channel. If the final argument is omitted, the callee will be the founder.
*'''<code>:unregister chanName</code>''' Un-registers a channel.
*'''<code>:changefounder chanName username</code>''' Make a user not be a channel operator.
*'''<code>:op chanName username</code>''' Make a user into a channel operator. Accessible only to lobbyserver moderators and the channel founder.
*'''<code>:deop chanName username</code>''' Make a user not be a channel operator. Accessible only to lobbyserver moderators and the channel founder.
*'''<code>:history chanName state</code>''' Turns persistent chat functionality on/off. State should be "on" or "off".
*'''<code>:antispam chanName state</code>''' Turns antispam chat functionality on/off. State should be "on" or "off".
===Managing users and channels===
These commands are accessible to channel operators, as well as lobby moderators and the channel founder.
*'''<code>:topic chanName topic</code>''' Sets the topic, which is displayed to all users when they join the channel.
*'''<code>:mute chanName target_username duration reason</code>''' Mutes a user. The duration can be in form e.g. "2d" for two days or "1h" for one hour.
*'''<code>:unmute chanName target_username </code>''' Unmutes a user.
*'''<code>:listmutes</code>''' Returns a list of muted users.
*'''<code>:ban chanName target_username duration reason</code>''' Bans a user.
*'''<code>:unban chanName target_username duration reason</code>''' Unbans a user.
*'''<code>:listbans</code>''' Returns a list of banned users.
*'''<code>:kick chanName username</code>''' Kicks a user.

===Channel forwarding===
These commands are accessible only to lobby moderators.
*'''<code>:forward from_chanName to_chanName</code>''' Set up forwarding of all operator statuses, mutes and bans, from a channel to a battle. Call this command more than once to forward to more than one battle.
*'''<code>:unforward from_chanName to_chanName</code>''' Remove forwarding.
*'''<code>:listforwards chanName</code>''' Returns a list of the loations this channel is forwarding too.
===General info===
These commands can be called by anyone.
*'''<code>:battlename username</code>''' Returns the name of the channel in use by this user to host their current battle.
*'''<code>:info chanName</code>''' Displays information about the channel, including the founder and list of operators.
*'''<code>:help</code>''' Offers you a link to this page!

[[Category:Lobby]]

Data Usage

2019-02-12T13:18:28Z

Silentwings: /* Disclosure of data to third parties and other users */

[[Main_Page|Wiki]] < [[Community_Docs|Community]] < {{FULLPAGENAME}}

==Data and usage of data==

The SpringRTS server and its managed game hosts process and retain information generated by users:

<ol style="list-style-type:upper-alpha">
<li>
Registration & login details: email address, IP/MAC address, chosen username, (hashed) password.
</li>
<li>
Actions taking place via Springs infrastructure: chat, games played by users and all associated ingame commands, hardware and connectivity information characterizing suitability to play such games, client software used, IP addresses of battle hosts; and derived statistics of these data. This data is divided into two types:
<ol style="list-style-type:decimal">
<li> Data created in publicly accessible contexts, such as non-passworded chat channels and battle hosts. </li>
<li> Data created in private contexts, such as private messages, passworded chat channels and passworded battle hosts. </li>
</ol>
<li>
Source files, artwork and other content relating to games and development of games.
</li>
</ol>
This data is used to provide services that would normally be expected from an online gaming platform, primarily:
# '''Publicly available replays of games''' that were played in publicly accessible contexts. These include all actions taken by players, including chat, within the game.
# '''Persistent game and chat elements,''' which make users aware of publicly visible events that previously occurred on the platform.
# '''Development and provision of the Spring engine,''' plus supporting infrastructure, including a lobbyserver in which users chat to each other.
# '''Bridging of publicly accessible chat channels''' to external locations, typically those managed by our own users and sub-projects for purposes explicitly related to SpringRTS.
# '''Verification of user identity''' on login and within battle hosts.
# '''Moderator action''' in the event of disputes and suspected misconduct.
'''We retain and process data of types A, B and C on basis of legitimate interest, to provide the above services.'''

Users may connect to our server using external and bespoke software, known as a “client”, as specified through a publicly available protocol. This software may be outside of our control and knowledge. In such cases, whilst we may deny connections from clients that do not comply with GDPR and other legal requirements where it is technically and practically possible for us to do so, the operation and compliance of client software is the responsibility of its authors and users. The data usage policies summarised in this notice ONLY cover our usage of the data that is sent by users and users client software to our server.

Users are contacted via automated messages to email addresses that they provide for purposes related to item 5 when it is necessary to do so, such as when a user requests account recovery. In exceptional circumstances we may also manually contact individual users for purposes related to items 3 or 6. We do not use these email addresses to send marketing emails to our users and we do not disclose email addresses to third parties.

====Legitimate Interest====
We would be unable to provide the above services without retention and processing of the above data. Items 1 and 2 consist wholly of retaining and processing data of types B and C. Data retained and processed relating to item 3 consists of type B and C data, primarily communications occurring between users during their cooperative usage of our services, plus games and other content files for these services. Item 4 requires no retention of data, but requires on-the-fly processing of type B data. Item 5 requires type A data to correctly associate login attempts to user accounts and to help protect the server and battle hosts from malicious activity. Item 6 requires both type A and B data, to support moderator actions identifying, discouraging and preventing misconduct.

Type B.1 data is generated exclusively by individuals within in publicly accessible contexts, in which an expectation exists that this data will be shared with any number of other users. Type B.2 data is generated by individual in contexts where an expectation of privacy from other users exists. Such data is of a nature that is not expected to carry significant risk to an individual’s rights and freedoms, however steps are taken to respect this privacy as detailed below; this data is used only for purposes relating to items 3 and 6. The retention and processing of type B data carries a low risk of inhibiting individual’s rights and freedoms.

Type A data contains information (particularly: email, IP and MAC addresses) provided in private contexts that could, in some cases, and when supplemented with external sources of related information, be used to identify a real individual from their online footprint and consequently requires appropriate protection as detailed below; since otherwise the data held by SpringRTS concerning such individuals is of a non-sensitive nature the associated impact on individuals interests, rights and freedoms is low.

Developers and other users who provide data of type C may also provide licenses for such data. Authors may choose to include their own contact details; the risk to the individual’s rights and freedoms is low. For details on how we handle such content see our policies on licensing, forking, and on how the GPL license of the spring engine affects game content.

We do not engage in targeted advertising. We do not engage in profiling or automated decision making that has legal implications for users. We do not process or retain criminal or special category data.

All of our codebases are open source, permitting our users and developers to verify and review that our systems perform as described in this document, and to report any related technical errors.

==User rights under GDPR==

Users wishing to exercise their rights under GDPR should contact moderation staff, who are identifiable on the server by means of a spanner icon, and also contactable through springrts.com or by email at postmaster@springrts.com; such requests are handled on a case-by-case basis. We have procedures in place to assess numbers of moderation staff and ensure that such people are contactable and able to respond within the required time periods. Any data supplied in response will typically come in plain text form, or in the form of access to online replay files.

Note that the right to erasure under GDPR is not absolute; in particular we may refuse to fully erase data of individuals with a record of past misconduct if we believe such data may be required to prevent potential future misconduct of sufficient severity. See [http://www.privacy-regulation.eu/en/recital-49-GDPR.htm] for details.

==Disclosure of data to third parties and other users==

When information is supplied to us within a publicly visible medium, such as through a public chat channel or public game host, we may and typically will make this information publicly available to other users and to GDPR compliant third parties. This pertains to type all type B.1 data, plus usernames.

Type B.2 data is supplied to other users only when these other users are present or have access to the private context, such as a passworded chat channel or passworded game host, in which the data was created. This data is not disclosed to third parties, but it is retained to provide persistent chat functionality and is accessible to server administrators whilst it is retained.

When users choose to act as battle hosts, or provide automated battle hosts, the IP address of this host becomes publicly available information, necessarily to allow our users to make a (direct) connection to the battle, and for the battle host to accept or decline this connection. Battle hosts receive usernames plus type B data associated to the battles that they host and will typically distribute this data to other connected users. Battle hosts also necessarily become aware of the IP addresses of users attempting to connect to their battles, but they do not become aware of any other type A data of these users. On a technical level, the distributed nature of battle hosting amongst our users arises from a need for more computational resources and connectivity than the Spring server alone provides. Consequently, battle hosts take on responsibilities of their own under the GDPR and are required to comply fully with the policies set out in this document.

Non-public information supplied to us on login, pertaining to all type A data excluding usernames, may be visible to our moderators and developers when there is a need under items 3 or 6. Hashed passwords are accessible only to developers with a need to access the live user database. Type A data is not disclosed to third parties or other users, except to battle hosts as described above, and except where we judge it necessary for purposes of verifying the authenticity of users; we use the external GDPR compliant service IPHub to assist in automated detection of potentially malicious users attempting to conceal their own identities.

We reserve the right to pass ANY data that we hold to relevant law enforcement agencies if we believe that it may contain indications or evidence of illegal action.

==Data storage and protection==

All data retained are kept within databases and/or file archives on our server, located within the EU.

The database files are directly accessible only to chosen individuals who require access for purposes related to server development or administration; access is possible only via an encrypted connection using individual credentials. The list of individuals with this access is reviewed regularly on timescales related to their activity. All data of type A held by us is contained within these databases.
Archives of replay files are made available through a public website.

Communications of users to and from our lobbyserver, which covers all type A data sometimes excepting usernames and chat taking place on the lobbyserver, is encrypted (except in cases where users have persistently declined over many years to install software updates supporting this encryption). Passwords are communicated and stored only in hashed format.

Communications taking place between players and spectators within online games, typically consisting of ingame commands and chat, are not encrypted; the Spring engine uses a bespoke protocol for such communications, which prioritises low latency. These communications consist of less sensitive data - type B data plus usernames – and it is judged here that the requirement of minimal latency should take precedence over the benefits to privacy of an encryption layer.

==Retention and erasure of personal data==

The record of type A data of a user is retained for as long as we regard the user as active or with a significant possibility of returning to activity; we engage in automated deletion of such records for users who have remained inactive for 5 consecutive years. This threshold is chosen based on the behaviour of our users, who are known to return after lengthy periods of absence.

Type B.1 data of users, plus usernames, is retained in the form of publicly available archives of online games. We engage in automated deletion of this data after 3 years, but in special cases some replays may be retained for longer.

Type B.1 and type B.2 data consisting of chat taking place on the server within registered channels, in which channel history functionality has been enabled, is stored for up to one month in a database that provides persistent chat functionality. Otherwise, type B.2 data is not retained.

Users should note that when they create type B data they typically do so in the presence of other users who may retain and process the data for periods and purposes outside of our control or knowledge.

We retain and erase type C data according to its license. We regard maintaining a publicly available archive of this data as critical to providing our services and to future development and, whilst we respect individuals right to erasure upon request of any personal data within this archive, we do not engage in automated deletion of it after any time period.

[[Category:Spring]]