Zero-K - User contributions [en]

Category:Player Guides

2021-03-24T10:46:13Z

Shaman: Added category:Player Guides

This is a page full of user created guides.

User:Shaman/Development Tips

2020-11-01T11:16:19Z

Shaman: Some notes I want to keep.

This page outlines some general knowledge collected over the years. Mostly this is my notes.

= Really, Really Big things =
* TEST WITH LOCAL ZK-TEST.SDZ!!!! REALLY.
* Do NOT test cawidgets with local replacement.
* Multiplayer tests can be done by uploading an sdz to maps on site

= Cawidgets =
* DO NOT USE SPEED UPS HERE. I don't know why exactly, but GoogleFrog says it's bad and it tends to lead to bad things.
* Probably not good to use speedups anywhere in the top level dir of luaui or luarules. Idk.
* You can make derivatives of other callins with it. Useful!
* Alters the way widgets work.

= Callins.lua =
* This file is a red herring. Nobody probably knows what it does.

= Camain.lua =
* Who knows what it does.

= Cache.lua =
* You can poison (see: changing the return values) of functions with this. This changes affects everything.
* Don't attempt to override names with it. This just leads to people losing the ability to chat -.-

= Unitdefs =
* These have a different style for... reasons.
* Double space instead of tab.

= Git =
* Don't use PR's to update your fork.
* Use git rebasing to update work.
* Use git rebase -i HEAD~# to squash stuff.
* Squash your commits down a bit for redundant things (but not ones that significantly alter things)

= Callins =
* Update uses FPS to trigger, and GameFrame does not.

Blender To Zero-K

2020-10-24T18:50:12Z

Shaman: No formatting for rapid link

Here is a tutorial covering all of the steps to make or edit a model in [https://www.blender.org/ Blender] (a free 3d modelling program) and transfer it to the Spring engine, then have Zero-K load it as a mutator so you can test it in-game.

The contents page here will also act as a quick reference for all of the necessary steps, in order:

__TOC__

== Make or Edit the model in Blender ==
=== Setting up Blender for use in Zero-K ===
If you are totally new to blender there are a few things you probably ought to do to set up blender for use with Zero-K. Additionally, this tutorial will assume you are using left-click to select (the new default) and a fairly typical window layout similar to the default.

Blender comes with several add-ons and scripts, not all of which are enabled by default. While there are many additional ones you might have to pay for that could prove useful (meshmachine, decalmachine and hard ops are probably the most well known three) there are a few free add-ons you may wish to consider. You should absolutely go to the Edit->Preferences->Add-ons submenu and enable Node Wrangler, and Looptools.

To import s3o models from spring, you will need an addon which can be found [https://github.com/sanguinariojoe/blender_s3o_import here]. You need to download the python (.py) file and then use the Install button inside blender's add-ons submenu, pointing it at that .py file, so that blender knows how to import .s3o models. Make sure to enable the add-on after installation.

If you want to export animations, you will also need [https://github.com/Anarchid/blender2lus this] animation exporter, though the output it produces will likely still require manual adjustment and will not be covered by this tutorial.

=== Importing a model (optional) ===
With the s3o importer installed and enabled, you should be able to import s3o models from spring into blender by using the File->Import->s3o option. Then navigate to your model file and select it.

s3o models often come in rotated to one side, as Spring uses Y-axis-up and Blender uses Z-axis-up. You can rotate them to look right in Blender, and then when exporting them there are options to deal with this so that they export rotated correctly.

If the importer can find them, it will also import textures and the UV map along with the model. The texture files may need to be placed appropriately or in the same directory as the model file for this to work.

=== Importing textures ===
To open a texture you need to set a window to either the Image Editor or UV Editor mode, and then press the Open button in the top menu bar. This will bring up a file menu where you can select a texture to bring into Blender. Blender supports .dds textures by default, as well as most other image formats.

You can certainly import any old texture and work with it, but if you are importing textures already used by Spring you should know that they are somewhat unusual.

Spring has two separate texture formats. The first of these, referred to as tex1 or colour texture, uses Red Green Blue (RGB) channels to store colour data, and Alpha (A) to store whether that part of the file is teamcolour or not. This means that by default a tex1 texture looks mostly blank(transparent) with some odd black bits scattered around. You can fix this in Blender by scrolling the menu bar (hold middle button with cursor on menu, drag mouse to side) all the way to the right, and clicking the little drop down which says Display Channels [[File:Blender_display_channels.png]]. By default it is set to ''Colour and Alpha'' but you should set it to ''Colour'' when working with tex1 files to ignore the alpha channel.

Tex2 files are the ones in greenyblue with bits of red. In those files the Red channel is how much that part of the texture emits light, the Green channel is how rough or smooth that part of the texture is (which determines how it reacts to light), and the Blue channel is how metallic and reflective that part of the texture is. Areas which are cyan (full green and full blue) are mirror-smooth metal, so reflect the environment perfectly. These should always have their colourspace set to non-colour data as they use each channel separately. You can find that option in the right hand popout menu when in an image editor viewing them (shortcut key N by default) under the Image tab.

You may also need or want to use Normal map textures, which are the ones that look mostly blue with some oddly coloured parts around the edges. Whenever you use these normal map textures you should always change the colourspace to non-colour data as it can cause visual errors if you do not, since it will process the channels differently in the render pipeline.

If nothing in the scene uses your texture it will be discarded from the file when you save and exit. You may click the shield icon next to the file name to prevent this, if you want to have the textures kept around even with nothing using it. As long as you've assigned the texture to a material, and the material to a model (see below) this will not be a problem, but it's useful to know this option exists and why a texture might be dropped.

Blend files do not by default contain the textures referenced in them, but you 'can' optionally pack the textures into them for easy transfer between users or computers. Explore the File->External Data menu for those options.

=== Modelling for Zero-K ===
There are not many special considerations when modelling for Zero-K, and a general explanation of modelling and blender is too detailed to go here. However, you could consult tutorials such as [https://www.youtube.com/watch?v=7MRonzqYJgw&list=PLn3ukorJv4vs_eSJUQPxBRaDS8PrVmIri Grant Abbitt's beginner series] or [https://www.youtube.com/watch?v=1jHUY3qoBu8 Imphenzia's introduction and low poly modelling] tutorial.

Generally, you should attempt to keep the number of triangles used in a model as low as is reasonable. That number varies depending on how frequent the unit is planned to be - a commander or other functionally unique unit would be fine with up to 30,000 triangles, but for a very spammable unit such as a flea this would be extremely excessive, as you can build a vast number of fleas. Something in the region of 500-1000 would be more appropriate, with less being ideal as long as the model still looks good.

The size of the model (or part of model) and how visible it is also has an impact on how many polygons you should be using. A large model covering a lot of screen space should use more polygons and texels than a small one or a part of the model that people rarely or never see.

=== Texturing for Zero-K, and Spring texture oddities ===
As mentioned earlier, spring uses two textures per model and cannot use multiple UV Maps, cannot use vertex colours, and cannot use additional textures other than a normal map.

The tex1 format covers the diffuse colour and whether a pixel is teamcoloured or not, wheras tex2 covers the emissivity, roughness, and metalness of the model in its RGB channels respectively.

Remember that most DDS normal maps are slightly different from typical OpenGL normal maps, and adjust appropriately as needed. Typically inverting the Red and Green channels does the trick.

If you import a texture then the importer will set up the nodes for you, however, if you are starting from scratch then you probably just want to replicate this node setup. This mostly approximates what Spring will do in-engine, giving you a workable preview in Blender when you use a lookdev(Material Preview) view mode.

[[File:Spring_shader.png]]

There are three textures referenced here, which in this case happen to be atlas textures which can be reused for multiple models. The core_color.dds is tex1 and has colours and teamcolours - the alpha channel is split off, inverted, and used to colour the alpha areas green (you can click the green colour to replace it with any other colour, if you like).

The core_other.dds is the tex2 file, so it is split into RGB channels and each of these channels appropriately processed and connected to the relevant part of the material.

Finally the core_normals.dds contains a direct-x formatted normal map, so it is converted to an openGL format by inverting just the Green channel and is then passed through the normal calculation node to convert the image into a vector map, and then the vector map passed to the shader.

TODO: Provide a blend file here that already has this material set up, just need to plug in textures. Or just include atlas texture. Airpad_packed.blend is sadly larger than 2mb so the wiki will not host it.

== Export the model to .dae format ==
Nowadays Spring can read .dae (Collada) files directly via the use of Assimp (Asset Importer). This means the export process is reasonably simple.

Either clean your scene of everything you do not want to be exported, or select only the things you want exported. Go to the File->Export menu and select Collada (.dae) format. A file browser will open with various export settings on the right hand side.

You should pick Selection Only from the Main tab of export options if you want to limit it to selection.

Make sure that the orientation settings are correct. You want to tell the exporter what axes you've been modelling with, not the axes you're looking for. These are the default options and should usually be right, Spring/Assimp will then adjust them for use in engine, but if after checking things in Spring your object is oriented wrongly, you can try adjusting these and exporting again. If all else fails, you can parent the root object(s) to an empty placed at the origin and rotate that. [[File:collada_default_export.png]]

=== A note on animation ===
Although Collada (.dae) files do support exporting animation, you should not do this as Spring cannot read the animation data. Instead, animations in Zero-K are handled by a lua animation script known as LUS.

Although you cannot export the animations to Collada, you can still do your animations in Blender and use the Blender2Lus export script linked earlier to export a starting animation script. It has several limitations, such as only exporting the active action from each object in the scene, but running it several times and tweaking and combining the generated scripts can reduce the amount of work in generating animation scripts immensely. Further use of this script is, for the moment, outside the scope of this tutorial (because I haven't done it myself yet - feel free to replace this with detailed explanation if you have, though!)

== Set up texture associations and .dae.lua metadata ==
Although Spring can read .dae files and the contained UV map, it does not support any sort of material or texture import, so you have to specify these manually. Since at this point you have already set Blender up with a reasonable approximation of the texture process it should not be especially difficult.

You will need to provide a .dae.lua file with the same name as your model file, in the same directory, to tell Spring which texture files and associated data to use with the model.

For example, if your model export is snazzyUnit.dae and it is present under the /objects3d folder of your testing mod, you should make a snazzyUnit.dae.lua file and place that at /objects3d/snazzyUnit.dae.lua .

The documentation for these metadata files is [https://springrts.com/wiki/3DModels:AssimpMetadata here], but they are reasonably simple and a minimal example file is provided below:

<pre>
return {
tex1 = "core_color.dds",
tex2 = "core_other.dds",
invertteamcolor = false
}</pre>

Obviously if you are not using the atlas textures you will need to replace those names with the actual texture files you intend to use. There are several other things that may need to be in this file, but as these differ per-unit you will need to decide what, if anything, to provide. You should probably also decide on a radius to set - leaving it out autogenerates a large radius covering the entire model, but for many reasons it's not always appropriate. Examine similar units in game (ctrl-alt-B shows collision bounds, radius is the grey sphere) and match them if necessary.

== Set up Zero-K mod that contains and uses your files ==
To get Zero-K to see your files and locally test your units (new or otherwise) you can use a mod, or download all the source and point your original version at it. I will use a mod.

This is selectable in local skirmish mode (and theoretically you can distribute them to test in multiplayer) which allows you to check everything works in the engine without requiring any changes to the official repositories or a local development copy of the game - all you need is a working copy of Zero-K. You should eventually check it works with a properly set up dev copy (and that copy can be used for many changes, if necessary) but for now a mod is simpler.

=== Making the mod ===
Inside the Zero-K folder there is a games subfolder. Inside that are numerous things, but if you make a new subfolder with a name ending in .sdd it will be read by the engine on startup. A base mod is available to download [File:BaseMod.sdd.zip here] to build from if you would like an example. More details on mod creation can be found here: [[Mod Creation]]

Create a mod and fill out the modinfo.lua, making sure to change the name and description so you can tell it apart when you are selecting it. If the depends tag is listed as <nowiki>[[rapid:/zk:stable]]</nowiki> you will have to manually change it to the latest ZK version in this format:
<pre>depend = {
[[Zero-K v1.8.10.0]]
},</pre>
Update the version number appropriately.

=== File locations ===
Like many mods, the file structure downwards from the modname.sdd folder should exactly match the Zero-K internal virtual file system, and if there are any files in your mod that match names with base files, Zero-K will use your mod's file instead of the base file.

This allows you to selectively replace any files with whatever changed version you want, which is ideal for our purposes of testing a mod. Any ''new'' files will also be loaded, allowing you to test entirely new units - although you may have to modify the buildoptions list of an existing factory or constructor to allow them to build your new unit.

<blockquote>AN IMPORTANT NOTE:
You should keep all of filenames and folder names lower case, as the virtual file system lowercases everything. Double check your filenames, it needs to match exactly if you are replacing things.</blockquote>

=== Testing your mod ===
Once you have filled out your folders and files, probably (but not exclusively) using /objects3d , /units and /unittextures , you can progress to actually testing it works in-engine.

Load up Zero-K and go to singleplayer, then Skirmish. The map and opponents do not especially matter, though if you are testing a lot you probably want to use an inactive AI (check through main lobby options for additional AI types if it's not there by default).

Go into Adv Options, and pick 'Select Mod'. If the folder and modinfo are correct you should see your mod on the list. If you do not, download the base mod, unzip it to the appropriate place and check if that shows up - if it does, the problem is with your mod. If it does not, then something is probably in the wrong place.

Once you've selected your mod you should start the skirmish and attempt to test whatever you've actually changed. At one point while doing this, Zero-K would not load because the interpreter for the mod's unitdef files was more strict than the main game's, so you may wish to follow the format used in the base mod (it overwrites lotus turrets) more exactly if you have this problem.

== Fix whatever isn't right ==
Do not expect everything to be perfect. This is a very complicated process and something is probably broken somewhere - either way, check everything, and get used to the idea that you may have to edit, re-export, then restart the game a lot to retry with changes quite often. Although unit definitions and such may be reloaded without quitting the game (TODO: what is the command to do this? How reliable is it?) you should eventually restart Zero-K to do a round of final testing just to ensure that everything loads correctly from startup.

== The other bits ==
Ever heard about software development that first you need to complete 90% of the project, and then you need to complete the other 90% of the project? The same sometimes applies to modding.

Even though by this point you should have your unit or building in game and working, there are other things to do before it's ready!

=== groundplane decal and ao bake ===
If your unit is a building, you will need to create a ground plane to go underneath it - at the very least an ambient occlusion baked shadow, usually referred to as an aoplane. This is simply a texture which is sized appropriately for your model and is placed underneath it by the engine. This adds a little soft shadowing around the edge of the building which helps immensely to integrate it with the map.

There are a few ways to make these, but the easiest if following this tutorial is probably just to bake your own in Blender.

==== Create and size the virtual ground plane ====
First, create a plane and place it under your model. It should be at zero relative to where the model is going to go, but this plane will never leave blender directly - it will be the Spring engine painting the decal onto the terrain. Scale it until it completely covers all of your model, then apply the scale and scale it *again* so that it is appropriately larger than the footprint of your model. This size may need adjusting so that it fits an integer value - for example, if the unitdef lists your unit as 5 footprint-units wide, then (since you can only set the decal footprint size to an integer) you would have to choose 6 (6/5 = 120% of the model size) or 7 (7/5 = 140% of the model size). Somewhere between 120% and 140% is probably fine.

==== Setup for AO Baking ====
Once you have the plane appropriately sized, go to the render tab [[File:Blender_render_tab.png]] and change the Render engine to Cycles. You may wish to change the feature set and compute device appropriate to your system (especially if you have a powerful GPU) but the defaults should be fine for this.

Make sure you set the number of samples in the Sampling section high enough. 512 is a good number to start from, though as high as 1024 is useful to reduce noise. More samples mean more render time, even for something as simple as baking a simple ambient occlusion map.

Next, go to the world tab [[File:Blender_world_tab.png]] and activate Ambient Occlusion. Factor should be 1.0, and the distance parameter depends on how large your model is. You may have to tweak this value until the resulting bake looks correct, but start with a distance parameter somewhere around 25% to 50% of the width of your model, turning it up if this is not sufficient.

To properly bake, we need somewhere to put the texture - so open up a shader node window somewhere, select the ground plane and make sure that it is using a new material and that material is using nodes. Connect a texture node using the Ctrl-T shortcut. Press New to make a new texture, and set it to the appropriate size - typically 512px square for something the size of a factory or 128px square for smaller buildings. Set the image colourspace to non-colour data to prevent shading artefacts later. Make sure this texture node has been clicked on and is selected, because it's the last selected texture for each relevant object that receives the bake.

Finally we're almost ready to do the baking! Return to the render tab [[File:Blender_render_tab.png]] and scroll down to the Bake section. From the Bake Type dropdown select Ambient Occlusion. Make sure that Selected to Active is OFF, as that is intended to transfer high poly modelling data to low poly objects and we actually do want just a general scene-wide bake of ambient occlusion, it's just we only care about the result on this one ground plane object. Margin can be adjusted but the default of 16px is probably fine.

==== Do the bake ====
Press Bake!

If blender crashed that's fine, go check in the log file to see what did it - the last time I had a crash here, I had an addon (bezier tools, totally unrelated to anything to do with baking) going wrong, and so I had to temporarily disable it.

If all went well, you should have seen a few textures render if you were on something with a texture view, and if you go to find your new ambient occlusion texture it should be a black outline in the shape of your building with a white outside, and a blurry shadowy bit around the edge of the black outline, which is what the game will draw onto the ground. Export this as a png.

==== Touchup and adjust format in external image editor ====
The next bit you will need to do in GIMP/Glimpse, or any other image processing software capable of exporting DDS textures. Simply load your image file, turn the white colour into transparency by whatever method you prefer such that full black is opaque and full white is transparent, and then export as DDS. Spring wants textures to be DXT5 compressed, with mipmaps generated.

If you want some other decal underneath your unit, perhaps a metallic decal if it is a factory for example, you can add that as another layer in your image editing software here. Ensure that the ambient occlusion layer overlays it where necessary.

==== Adjust unitdef to include groundplane ====
Now you've got a groundplane texture, rename it to something like unitname_aoplane.dds and put it into the /unittextures folder. Then go to the unitdef and make sure that these tags are filled out:

<pre>
buildingGroundDecalDecaySpeed = 30, --Seconds decal takes to fade out of existence
buildingGroundDecalSizeX = 12, --Size of the decal's X axis in footprint units
buildingGroundDecalSizeY = 12, --Size of the decal's Y axis in footprint units
buildingGroundDecalType = [[unitname_aoplane.dds]], --filename of decal

useBuildingGroundDecal = true,
</pre>

After saving the updated unitdef, go and check that the ground plane exists in game. They can be quite subtle, but by toggling on and off the "show ground decals" option, you should be able to see the difference easily.

If needed, you can edit your original png file in the image editor again and apply gaussian blur to the image to spread the shadow out further. Ensure that the shadow's edge doesn't touch the edge of the image, as this tends to look obvious.

=== unitpic ===
Unit pictures in the buildmenu are generated by an automated script. This script lives as a Lua gadget within the Zero-K base content, so if you have your mod working you can load that up and generate a buildpic.

First, press F8 to show the debug console, then turn on cheats with /cheat (or !cheats in multiplayer, which will require host permissions.)

Then run <pre>/luarules buildicon {unitname}</pre>. You can run it with no unit name and instead buildicons if you want to generate buildicons for every unit in the game. It should output the icons to your Zero-K folder under the /buildicons folder. You will then have to move it to the /unitpics folder of your mod, name it appropriately, and check it works.

=== Developer mode test with full file system ===

Now is the time to test against the full developer mode run - see [[Developing]] for information on how to set that up. Copy your files to an up to date copy of the latest source files from GitHub and check if they work there.

Once they do you should be ready to make a pull request. If you forked from the development version as the linked instructions suggest, you should be able to use your fork to do this.

[[category:Development]]

Blender To Zero-K

2020-10-24T18:45:21Z

Shaman: Add development category

Here is a tutorial covering all of the steps to make or edit a model in [https://www.blender.org/ Blender] (a free 3d modelling program) and transfer it to the Spring engine, then have Zero-K load it as a mutator so you can test it in-game.

The contents page here will also act as a quick reference for all of the necessary steps, in order:

__TOC__

== Make or Edit the model in Blender ==
=== Setting up Blender for use in Zero-K ===
If you are totally new to blender there are a few things you probably ought to do to set up blender for use with Zero-K. Additionally, this tutorial will assume you are using left-click to select (the new default) and a fairly typical window layout similar to the default.

Blender comes with several add-ons and scripts, not all of which are enabled by default. While there are many additional ones you might have to pay for that could prove useful (meshmachine, decalmachine and hard ops are probably the most well known three) there are a few free add-ons you may wish to consider. You should absolutely go to the Edit->Preferences->Add-ons submenu and enable Node Wrangler, and Looptools.

To import s3o models from spring, you will need an addon which can be found [https://github.com/sanguinariojoe/blender_s3o_import here]. You need to download the python (.py) file and then use the Install button inside blender's add-ons submenu, pointing it at that .py file, so that blender knows how to import .s3o models. Make sure to enable the add-on after installation.

If you want to export animations, you will also need [https://github.com/Anarchid/blender2lus this] animation exporter, though the output it produces will likely still require manual adjustment and will not be covered by this tutorial.

=== Importing a model (optional) ===
With the s3o importer installed and enabled, you should be able to import s3o models from spring into blender by using the File->Import->s3o option. Then navigate to your model file and select it.

s3o models often come in rotated to one side, as Spring uses Y-axis-up and Blender uses Z-axis-up. You can rotate them to look right in Blender, and then when exporting them there are options to deal with this so that they export rotated correctly.

If the importer can find them, it will also import textures and the UV map along with the model. The texture files may need to be placed appropriately or in the same directory as the model file for this to work.

=== Importing textures ===
To open a texture you need to set a window to either the Image Editor or UV Editor mode, and then press the Open button in the top menu bar. This will bring up a file menu where you can select a texture to bring into Blender. Blender supports .dds textures by default, as well as most other image formats.

You can certainly import any old texture and work with it, but if you are importing textures already used by Spring you should know that they are somewhat unusual.

Spring has two separate texture formats. The first of these, referred to as tex1 or colour texture, uses Red Green Blue (RGB) channels to store colour data, and Alpha (A) to store whether that part of the file is teamcolour or not. This means that by default a tex1 texture looks mostly blank(transparent) with some odd black bits scattered around. You can fix this in Blender by scrolling the menu bar (hold middle button with cursor on menu, drag mouse to side) all the way to the right, and clicking the little drop down which says Display Channels [[File:Blender_display_channels.png]]. By default it is set to ''Colour and Alpha'' but you should set it to ''Colour'' when working with tex1 files to ignore the alpha channel.

Tex2 files are the ones in greenyblue with bits of red. In those files the Red channel is how much that part of the texture emits light, the Green channel is how rough or smooth that part of the texture is (which determines how it reacts to light), and the Blue channel is how metallic and reflective that part of the texture is. Areas which are cyan (full green and full blue) are mirror-smooth metal, so reflect the environment perfectly. These should always have their colourspace set to non-colour data as they use each channel separately. You can find that option in the right hand popout menu when in an image editor viewing them (shortcut key N by default) under the Image tab.

You may also need or want to use Normal map textures, which are the ones that look mostly blue with some oddly coloured parts around the edges. Whenever you use these normal map textures you should always change the colourspace to non-colour data as it can cause visual errors if you do not, since it will process the channels differently in the render pipeline.

If nothing in the scene uses your texture it will be discarded from the file when you save and exit. You may click the shield icon next to the file name to prevent this, if you want to have the textures kept around even with nothing using it. As long as you've assigned the texture to a material, and the material to a model (see below) this will not be a problem, but it's useful to know this option exists and why a texture might be dropped.

Blend files do not by default contain the textures referenced in them, but you 'can' optionally pack the textures into them for easy transfer between users or computers. Explore the File->External Data menu for those options.

=== Modelling for Zero-K ===
There are not many special considerations when modelling for Zero-K, and a general explanation of modelling and blender is too detailed to go here. However, you could consult tutorials such as [https://www.youtube.com/watch?v=7MRonzqYJgw&list=PLn3ukorJv4vs_eSJUQPxBRaDS8PrVmIri Grant Abbitt's beginner series] or [https://www.youtube.com/watch?v=1jHUY3qoBu8 Imphenzia's introduction and low poly modelling] tutorial.

Generally, you should attempt to keep the number of triangles used in a model as low as is reasonable. That number varies depending on how frequent the unit is planned to be - a commander or other functionally unique unit would be fine with up to 30,000 triangles, but for a very spammable unit such as a flea this would be extremely excessive, as you can build a vast number of fleas. Something in the region of 500-1000 would be more appropriate, with less being ideal as long as the model still looks good.

The size of the model (or part of model) and how visible it is also has an impact on how many polygons you should be using. A large model covering a lot of screen space should use more polygons and texels than a small one or a part of the model that people rarely or never see.

=== Texturing for Zero-K, and Spring texture oddities ===
As mentioned earlier, spring uses two textures per model and cannot use multiple UV Maps, cannot use vertex colours, and cannot use additional textures other than a normal map.

The tex1 format covers the diffuse colour and whether a pixel is teamcoloured or not, wheras tex2 covers the emissivity, roughness, and metalness of the model in its RGB channels respectively.

Remember that most DDS normal maps are slightly different from typical OpenGL normal maps, and adjust appropriately as needed. Typically inverting the Red and Green channels does the trick.

If you import a texture then the importer will set up the nodes for you, however, if you are starting from scratch then you probably just want to replicate this node setup. This mostly approximates what Spring will do in-engine, giving you a workable preview in Blender when you use a lookdev(Material Preview) view mode.

[[File:Spring_shader.png]]

There are three textures referenced here, which in this case happen to be atlas textures which can be reused for multiple models. The core_color.dds is tex1 and has colours and teamcolours - the alpha channel is split off, inverted, and used to colour the alpha areas green (you can click the green colour to replace it with any other colour, if you like).

The core_other.dds is the tex2 file, so it is split into RGB channels and each of these channels appropriately processed and connected to the relevant part of the material.

Finally the core_normals.dds contains a direct-x formatted normal map, so it is converted to an openGL format by inverting just the Green channel and is then passed through the normal calculation node to convert the image into a vector map, and then the vector map passed to the shader.

TODO: Provide a blend file here that already has this material set up, just need to plug in textures. Or just include atlas texture. Airpad_packed.blend is sadly larger than 2mb so the wiki will not host it.

== Export the model to .dae format ==
Nowadays Spring can read .dae (Collada) files directly via the use of Assimp (Asset Importer). This means the export process is reasonably simple.

Either clean your scene of everything you do not want to be exported, or select only the things you want exported. Go to the File->Export menu and select Collada (.dae) format. A file browser will open with various export settings on the right hand side.

You should pick Selection Only from the Main tab of export options if you want to limit it to selection.

Make sure that the orientation settings are correct. You want to tell the exporter what axes you've been modelling with, not the axes you're looking for. These are the default options and should usually be right, Spring/Assimp will then adjust them for use in engine, but if after checking things in Spring your object is oriented wrongly, you can try adjusting these and exporting again. If all else fails, you can parent the root object(s) to an empty placed at the origin and rotate that. [[File:collada_default_export.png]]

=== A note on animation ===
Although Collada (.dae) files do support exporting animation, you should not do this as Spring cannot read the animation data. Instead, animations in Zero-K are handled by a lua animation script known as LUS.

Although you cannot export the animations to Collada, you can still do your animations in Blender and use the Blender2Lus export script linked earlier to export a starting animation script. It has several limitations, such as only exporting the active action from each object in the scene, but running it several times and tweaking and combining the generated scripts can reduce the amount of work in generating animation scripts immensely. Further use of this script is, for the moment, outside the scope of this tutorial (because I haven't done it myself yet - feel free to replace this with detailed explanation if you have, though!)

== Set up texture associations and .dae.lua metadata ==
Although Spring can read .dae files and the contained UV map, it does not support any sort of material or texture import, so you have to specify these manually. Since at this point you have already set Blender up with a reasonable approximation of the texture process it should not be especially difficult.

You will need to provide a .dae.lua file with the same name as your model file, in the same directory, to tell Spring which texture files and associated data to use with the model.

For example, if your model export is snazzyUnit.dae and it is present under the /objects3d folder of your testing mod, you should make a snazzyUnit.dae.lua file and place that at /objects3d/snazzyUnit.dae.lua .

The documentation for these metadata files is [https://springrts.com/wiki/3DModels:AssimpMetadata here], but they are reasonably simple and a minimal example file is provided below:

<pre>
return {
tex1 = "core_color.dds",
tex2 = "core_other.dds",
invertteamcolor = false
}</pre>

Obviously if you are not using the atlas textures you will need to replace those names with the actual texture files you intend to use. There are several other things that may need to be in this file, but as these differ per-unit you will need to decide what, if anything, to provide. You should probably also decide on a radius to set - leaving it out autogenerates a large radius covering the entire model, but for many reasons it's not always appropriate. Examine similar units in game (ctrl-alt-B shows collision bounds, radius is the grey sphere) and match them if necessary.

== Set up Zero-K mod that contains and uses your files ==
To get Zero-K to see your files and locally test your units (new or otherwise) you can use a mod, or download all the source and point your original version at it. I will use a mod.

This is selectable in local skirmish mode (and theoretically you can distribute them to test in multiplayer) which allows you to check everything works in the engine without requiring any changes to the official repositories or a local development copy of the game - all you need is a working copy of Zero-K. You should eventually check it works with a properly set up dev copy (and that copy can be used for many changes, if necessary) but for now a mod is simpler.

=== Making the mod ===
Inside the Zero-K folder there is a games subfolder. Inside that are numerous things, but if you make a new subfolder with a name ending in .sdd it will be read by the engine on startup. A base mod is available to download [File:BaseMod.sdd.zip here] to build from if you would like an example. More details on mod creation can be found here: [[Mod Creation]]

Create a mod and fill out the modinfo.lua, making sure to change the name and description so you can tell it apart when you are selecting it. If the depends tag is listed as [[rapid:/zk:stable]] you will have to manually change it to the latest ZK version in this format:
<pre>depend = {
[[Zero-K v1.8.10.0]]
},</pre>
Update the version number appropriately.

=== File locations ===
Like many mods, the file structure downwards from the modname.sdd folder should exactly match the Zero-K internal virtual file system, and if there are any files in your mod that match names with base files, Zero-K will use your mod's file instead of the base file.

This allows you to selectively replace any files with whatever changed version you want, which is ideal for our purposes of testing a mod. Any ''new'' files will also be loaded, allowing you to test entirely new units - although you may have to modify the buildoptions list of an existing factory or constructor to allow them to build your new unit.

<blockquote>AN IMPORTANT NOTE:
You should keep all of filenames and folder names lower case, as the virtual file system lowercases everything. Double check your filenames, it needs to match exactly if you are replacing things.</blockquote>

=== Testing your mod ===
Once you have filled out your folders and files, probably (but not exclusively) using /objects3d , /units and /unittextures , you can progress to actually testing it works in-engine.

Load up Zero-K and go to singleplayer, then Skirmish. The map and opponents do not especially matter, though if you are testing a lot you probably want to use an inactive AI (check through main lobby options for additional AI types if it's not there by default).

Go into Adv Options, and pick 'Select Mod'. If the folder and modinfo are correct you should see your mod on the list. If you do not, download the base mod, unzip it to the appropriate place and check if that shows up - if it does, the problem is with your mod. If it does not, then something is probably in the wrong place.

Once you've selected your mod you should start the skirmish and attempt to test whatever you've actually changed. At one point while doing this, Zero-K would not load because the interpreter for the mod's unitdef files was more strict than the main game's, so you may wish to follow the format used in the base mod (it overwrites lotus turrets) more exactly if you have this problem.

== Fix whatever isn't right ==
Do not expect everything to be perfect. This is a very complicated process and something is probably broken somewhere - either way, check everything, and get used to the idea that you may have to edit, re-export, then restart the game a lot to retry with changes quite often. Although unit definitions and such may be reloaded without quitting the game (TODO: what is the command to do this? How reliable is it?) you should eventually restart Zero-K to do a round of final testing just to ensure that everything loads correctly from startup.

== The other bits ==
Ever heard about software development that first you need to complete 90% of the project, and then you need to complete the other 90% of the project? The same sometimes applies to modding.

Even though by this point you should have your unit or building in game and working, there are other things to do before it's ready!

=== groundplane decal and ao bake ===
If your unit is a building, you will need to create a ground plane to go underneath it - at the very least an ambient occlusion baked shadow, usually referred to as an aoplane. This is simply a texture which is sized appropriately for your model and is placed underneath it by the engine. This adds a little soft shadowing around the edge of the building which helps immensely to integrate it with the map.

There are a few ways to make these, but the easiest if following this tutorial is probably just to bake your own in Blender.

==== Create and size the virtual ground plane ====
First, create a plane and place it under your model. It should be at zero relative to where the model is going to go, but this plane will never leave blender directly - it will be the Spring engine painting the decal onto the terrain. Scale it until it completely covers all of your model, then apply the scale and scale it *again* so that it is appropriately larger than the footprint of your model. This size may need adjusting so that it fits an integer value - for example, if the unitdef lists your unit as 5 footprint-units wide, then (since you can only set the decal footprint size to an integer) you would have to choose 6 (6/5 = 120% of the model size) or 7 (7/5 = 140% of the model size). Somewhere between 120% and 140% is probably fine.

==== Setup for AO Baking ====
Once you have the plane appropriately sized, go to the render tab [[File:Blender_render_tab.png]] and change the Render engine to Cycles. You may wish to change the feature set and compute device appropriate to your system (especially if you have a powerful GPU) but the defaults should be fine for this.

Make sure you set the number of samples in the Sampling section high enough. 512 is a good number to start from, though as high as 1024 is useful to reduce noise. More samples mean more render time, even for something as simple as baking a simple ambient occlusion map.

Next, go to the world tab [[File:Blender_world_tab.png]] and activate Ambient Occlusion. Factor should be 1.0, and the distance parameter depends on how large your model is. You may have to tweak this value until the resulting bake looks correct, but start with a distance parameter somewhere around 25% to 50% of the width of your model, turning it up if this is not sufficient.

To properly bake, we need somewhere to put the texture - so open up a shader node window somewhere, select the ground plane and make sure that it is using a new material and that material is using nodes. Connect a texture node using the Ctrl-T shortcut. Press New to make a new texture, and set it to the appropriate size - typically 512px square for something the size of a factory or 128px square for smaller buildings. Set the image colourspace to non-colour data to prevent shading artefacts later. Make sure this texture node has been clicked on and is selected, because it's the last selected texture for each relevant object that receives the bake.

Finally we're almost ready to do the baking! Return to the render tab [[File:Blender_render_tab.png]] and scroll down to the Bake section. From the Bake Type dropdown select Ambient Occlusion. Make sure that Selected to Active is OFF, as that is intended to transfer high poly modelling data to low poly objects and we actually do want just a general scene-wide bake of ambient occlusion, it's just we only care about the result on this one ground plane object. Margin can be adjusted but the default of 16px is probably fine.

==== Do the bake ====
Press Bake!

If blender crashed that's fine, go check in the log file to see what did it - the last time I had a crash here, I had an addon (bezier tools, totally unrelated to anything to do with baking) going wrong, and so I had to temporarily disable it.

If all went well, you should have seen a few textures render if you were on something with a texture view, and if you go to find your new ambient occlusion texture it should be a black outline in the shape of your building with a white outside, and a blurry shadowy bit around the edge of the black outline, which is what the game will draw onto the ground. Export this as a png.

==== Touchup and adjust format in external image editor ====
The next bit you will need to do in GIMP/Glimpse, or any other image processing software capable of exporting DDS textures. Simply load your image file, turn the white colour into transparency by whatever method you prefer such that full black is opaque and full white is transparent, and then export as DDS. Spring wants textures to be DXT5 compressed, with mipmaps generated.

If you want some other decal underneath your unit, perhaps a metallic decal if it is a factory for example, you can add that as another layer in your image editing software here. Ensure that the ambient occlusion layer overlays it where necessary.

==== Adjust unitdef to include groundplane ====
Now you've got a groundplane texture, rename it to something like unitname_aoplane.dds and put it into the /unittextures folder. Then go to the unitdef and make sure that these tags are filled out:

<pre>
buildingGroundDecalDecaySpeed = 30, --Seconds decal takes to fade out of existence
buildingGroundDecalSizeX = 12, --Size of the decal's X axis in footprint units
buildingGroundDecalSizeY = 12, --Size of the decal's Y axis in footprint units
buildingGroundDecalType = [[unitname_aoplane.dds]], --filename of decal

useBuildingGroundDecal = true,
</pre>

After saving the updated unitdef, go and check that the ground plane exists in game. They can be quite subtle, but by toggling on and off the "show ground decals" option, you should be able to see the difference easily.

If needed, you can edit your original png file in the image editor again and apply gaussian blur to the image to spread the shadow out further. Ensure that the shadow's edge doesn't touch the edge of the image, as this tends to look obvious.

=== unitpic ===
Unit pictures in the buildmenu are generated by an automated script. This script lives as a Lua gadget within the Zero-K base content, so if you have your mod working you can load that up and generate a buildpic.

First, press F8 to show the debug console, then turn on cheats with /cheat (or !cheats in multiplayer, which will require host permissions.)

Then run <pre>/luarules buildicon {unitname}</pre>. You can run it with no unit name and instead buildicons if you want to generate buildicons for every unit in the game. It should output the icons to your Zero-K folder under the /buildicons folder. You will then have to move it to the /unitpics folder of your mod, name it appropriately, and check it works.

=== Developer mode test with full file system ===

Now is the time to test against the full developer mode run - see [[Developing]] for information on how to set that up. Copy your files to an up to date copy of the latest source files from GitHub and check if they work there.

Once they do you should be ready to make a pull request. If you forked from the development version as the linked instructions suggest, you should be able to use your fork to do this.

[[category:Development]]

Zero-K:Developing

2020-09-23T06:03:30Z

Shaman: Added visual examples

New developers should read this before touching the source.

== ZK's Devving Philosophy (social rules) ==
* "War is a product of anticommunication"
** Communicate with other devs about your changes/fixes, let them understand the issue. Do not make 'random' changes.
* "Do not create work for other people."
** Have responsibility for your changes/commit. Do not leave bugs that require other people to fix.
* "Readability & performance are equally important."
** Optimize code but not to the point of unreadability. [http://c2.com/cgi/wiki?RulesOfOptimization Remember the rules of optimization]:
*** Don't.
*** Don't (yet).
*** Profile before doing it.
* "If it ain't broke, don't fix it."
** Don't code fixes that nobody wants to problems that don't exist.

== What is in source codes ==
* [https://github.com/ZeroK-RTS/Zero-K Zero-K] contains the game proper
** units folder contains unit definition files
*** You can read the wiki about game development for [http://springrts.com/wiki/Main_Page Spring Engine]
* [https://github.com/ZeroK-RTS/Zero-K-Infrastructure Zero-K-Infrastructure]
** Zero-K.info: Website sources
** ZkLobbyServer: Lobby server (for MP)
** ZkData: Website/server database structure
* [https://github.com/ZeroK-RTS/Chobby Chobby] contains the lobby client
* [https://github.com/ZeroK-RTS/Zero-K-Artwork Zero-K-Artwork] contains sources for 2D art, 3D art and sounds
* [https://github.com/ZeroK-RTS/SpringRTS-Tools SpringRTS-tools] contains various dev tools
** Upspring - required to edit the .3do and .s3o model files used in the game
** MapIconBuilder - unit map icon sources are here
* [https://github.com/ZeroK-RTS/Zero-K-Missions Zero-K-Missions] contains source files for official ZK missions

=== Style Guide===
The lua in the menu (chobby) and game proper should use the following whitespace:
* Indent with tabs.
* A tab may only follow a newline or another tab.
* If the text across two lines is being aligned (such as for a long function) then the two lines must have the same number of tabs.
* Don't try stack flow of control into one line. For example, put newlines after <code>then</code> and <code>else</code>.
* End files with a newline.
* Commas should be followed by whitespace. Relations (=, <, <=, >=, ==, ~=) should have whitespace on each side.
* if a conditional is to take up multiple lines, double indent the extra lines and end the line with a conjunction (See Gallery below)
These guidelines are not necessarily followed in old files so updating them with a separate commit is a good idea prior to making large changes. Also, unitdefs use two-space indentation instead of tabs.

There are a few guildines for dealing with Spring functions.
* Localisation of Spring.Function should be named spFunction.
* Localisation of Spring.MoveCtrl.Function should be named spMoveCtrlFunction.
* Spring.GetCommandQueue should be used rather than Spring.GetUnitCommands (it's an alias, we just picked one).

<gallery>
Styleguide-if-example.JPG|Proper multiline if statement
Styleguide-stackflow.JPG|Example of stacked flow control
</gallery>

== Getting sources ==
This is a guide to downloading Zero-K sources from [https://github.com/ GitHub] using [https://tortoisegit.org/ TortoiseGit]. The game sources are used as an example, however this method applies to other subprojects as well.
* Install [https://tortoisegit.org/download/ TortoiseGit].
* Create a [https://github.com/ GitHub] account.
[[File:ForkZK.jpg]]
* Log in to GitHub and [https://github.com/ZeroK-RTS Locate] the repository you want to edit.
* Click the "Fork" button on the GitHub website to create your own copy on GitHub.
[[File:cloneZK.jpg]]
* Locate your fork on GitHub and click "Clone or Download".
* Copy the web URL to your clipboard.
[[File:localCloneZK.jpg]]
* Create a folder called 'zk.sdd' in your Zero-K install under games.
* Right click on 'zk.sdd' and select 'Git Clone...' from the context menu.
[[File:cloneUIZK.jpg]]
* Copy the web URL into the 'URL:' field of the clone interface.
* Ensure that the 'Directory:' field ends in 'zk.sdd'. It is likely to automatically contain the path '...\Zero-K\games\zk.sdd\Zero-K' so be sure to delete the '\Zero-K' at the end.
[[File:cloneSuccess.jpg]]
* Wait for the sources to download.
* Your 'zk.sdd' folder should look something like the image above.

== Updating sources ==
Keep your sources up to date by periodically syncing your fork to the original repository (using 'compare', see: https://github.com/KirstieJane/STEMMRoleModels/wiki/Syncing-your-fork-to-the-original-repository-via-the-browser, then do "rebase and merge" instead of "merge") and doing TortoiseGit -> Pull on your repository folder to take the changes from GitHub to your local files.

== Modifying the game ==
:''For personal modding, see [[Mod Creation]]''
Follow the instructions in 'Getting sources' the download the Zero-K game sources. Feel free to inspect and edit the game files. Most developers using Windows edit lua files with [https://notepad-plus-plus.org/download/v7.6.6.html Notepad++].

To test your changes:
* Create an empty file named 'devmode.txt' in the same directory as Zero-K.exe.
* Launch Zero-K.exe.
[[File:enableDevMode.jpg]]
* Select 'Zero-K Dev' in Settings -> Developer -> Singleplayer (you may need to scroll down).
[[File:startTest.jpg]]
* From the main menu select Singleplayer -> Skirmish -> Advanced -> Start to launch a test game. Note that the game type should be automatically set to 'Zero-K $VERSION'.
* In the game, press F8 to open debug console. It'll display errors and output to the log.

== Modifying the lobby menu ==
Follow the instructions in 'Getting sources' with the following adjustments:
* The repository that you want to edit is https://github.com/ZeroK-RTS/Chobby.
* It is best to call the folder something like 'zkmenu.sdd', to avoid confusion.
Make sure that the 'Directory:' field ends in '.sdd'. You should end up with something like this:

[[File:zkmenufolder.jpg]]

To test your changes launch Zero-K.exe with the <tt>dev</tt> arg (i.e. <code>Zero-K.exe dev</code>). On windows this is best done by creating a shortcut and changing the target, as shown below.
[[File:targetZK.jpg]]

== Submitting changes ==
Git provides a systematic way to review and merge changes into the main repositories. The main game repository is used as example, but this method works for other repositories as well.

The simple way to commit changes is as follows.
* Make some changes to your local files.
* Right click on 'zk.sdd' and select 'Git Commit'.
* Write a description of the changes and click 'Commit'.
* Right click on 'zk.sdd' and select TortiseGit -> Push.
* Enter your GitHub login and password when prompted. The changes should now appear on your fork in GitHub.
* Navigate to https://github.com/ZeroK-RTS/Zero-K/pulls and click "New Pull Request".
* Click "compare across forks" to make your fork visible.
* Set your fork to be the head repository.
* Write a title and description of the changes, then create the pull request.
This creates a proposal to apply your changes to the main game. Be sure to check up on it and respond to comments.

A more advanced method involves creating branches locally with TortiseGit -> Create Branch and committing blocks of related changes to a single branch. You are then able to make pull requests from branches. This allows branches to be smaller and more focused, which is desirable when merging.

Make sure to keep your repository up to date to make merges less difficult.

== Zero-K.exe launch flags ==
<pre>Zero-K.exe [rapid tag] [engine version]</pre>
Note that the engine specified in arg won't automatically use the main Zero-K folder as its datadir. Add a <tt>springsettings.cfg</tt> file to the engine version's folder with the tag <code>SpringData = path_to_Zero-K_folder</code>

== Modifying infrastructure/tools ==
* Install [https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx Visual Studio Community edition]
* Install [http://www.microsoft.com/en-us/server-cloud/products/sql-server-editions/sql-server-express.aspx SQL Server express]
* Clone to desktop [https://github.com/ZeroK-RTS/Zero-K-Infrastructure Zero-K infrastructure]
* Test by opening Zero-K.sln in Visual Studio

=== Initializing Website Database ===
You may need to setup the database connection for the website. In order to do that: Open Visual Studio, open the Server Explorer panel (under the View menu), right click Data Connections -> Add Connection -> Sql Server. Enter <code>(localdb)\mssqllocaldb</code> in the Server Name field, after which zero-k_local will appear in the dropdown list of databases.

(If zero-k_local does not appear, type it in the text box and press OK; Visual Studio will ask whether you would like to create the database. This may require you to have administrator rights on the computer.)

[[File:zk-database-setup.png]]

=== Debugging infrastructure ===
* To run a project right click it, choose "set as startup project" and hit F5 to run using debugger.
* You can enable multiple startup projects to test entire infrastructure locally (game servers, lobby etc). Enable asp.net, springie and ZeroKLobby projects to test it all together. [http://i.imgur.com/2mgizUJ.png Setup]
* To run asp.net:
** It's required that you install MS SQL Express on your local PC.
*** You can get SQL Server 2017 (for Windows 8 and later) [https://www.microsoft.com/en-us/sql-server/sql-server-editions-express here] or SQL Server 2014 (for Windows 7) [https://www.microsoft.com/en-ie/download/details.aspx?id=42299 here]. For SQL Server 2014, the file you will need is called SQLEXPR_x64_ENU or SQLEXPR_x86_ENU. Make sure you install version that matches your version of Windows (i.e. x86 vs x64).
*** During the installation, set collation to <code>SQL_Latin1_General_CP1_CI_AS</code>. Leave all the parameters default except that I changed server name to SQLEXPRESS in one of the first steps of wizard.
[[File:SQL server collation.png|405px]]
** Right click asp.net -> properties -> web -> check "Specific Page" and leave it blank. Otherwise you get errors when trying to host locally.
** Make sure SQL Server is running (check the Sql Server Configuration Manager in the Start Menu). If you can't connect, edit the data source for <code>ModeType.Local</code> in <code>GlobalConst.cs</code> (currently line 46) to say something like: <code>Data Source=<hostname (usually your computer name)>\SQLEXPRESS</code>
** To make things run smoothly the following changes might also be a good idea: In <code>Shared/PlasmaShared/GlobalConst.cs</code> (currently line 137) replace the DefaultEngineOverride with whatever engine version is current. Comment out lines 190 and 238-298 of <code>Zero-K.info/AppCode/PlasmaServer.cs</code> unless somebody can supply instructions on how to make the torrent errors go away.

TODO: add download links for sample database tables here. Users and clans are probably easier to make yourself for most purposes. For now, if you need this ask Licho, Histidine, DeinFreund or Anarchid. Aquanim has sample tables for maps and Planetwars structures, if that is all that you need.

=== Modifying The Database Structure ===
* Modify the appropriate files in ./ZkData/Ef/... and elsewhere ( [https://github.com/ZeroK-RTS/Zero-K-Infrastructure/commit/61addee11e74b09dd5dd73e12d31a28030d84e81 this commit] should be a reasonable guide; don't worry about the migration files, they are created later )
* Open Tools > NuGet Package Manager > Package Manager Console
* At the top of the window which appears, there is a "Default project" dropdown box. Set this to ZkData.
* Type the command <code>Add-Migration [description-of-change-here]</code> into the package manager console. This should create some migration files with your description and a timestamp in the name in the Migrations folder of ZkData.
* In some cases you may now need to manually edit the created migration files to set defaults and the like?
* Type the command <code>Update-Database</code> into the package manager console. This should update the database structure.
* To revert a migration that has not yet been pushed to the main repository, run <code>Update-Database –TargetMigration: TheLastGoodMigration</code> then delete your bad migration files.

== Artwork ==
See [http://zero-k.info/Wiki/Development_Artwork Development Artwork] (outdated)

== Missions ==
=== Campaign ===
Campaign planets/missions are defined in [//github.com/ZeroK-RTS/Chobby/tree/master/campaign/sample Chobby/campaign/sample]

=== Standalone missions ===
See [[Mission Editor|Mission Editor start page]]

== Updating PlanetWars for new round ==
:''TODO''
Changing faction:
* Faction ID, name, color in dbo.Faction
* Faction blurb <tt>Faction<Name></tt> on sitewiki
* Add/change icons if needed
** Site: img/factions/<name>.png
** Game: LuaUI/Configs/Factions
** Chobby: LuaMenu/Images/Factions
** Does chobby download them automatically? Presumably not

Using [https://zero-k.info/PlanetwarsAdmin Planetwars admin interface]: Change to a different galaxy if desired, reset PW

== Wiki ==
See [[Editing Help]]

=== Unit pages ===
Part of each unit page is autogenerated by the [//github.com/ZeroK-RTS/SpringRTS-Tools/tree/master/unitguide Unit Guide tool], and uploaded by the [//github.com/ZeroK-RTS/Zero-K-Infrastructure/blob/master/Fixer/WikiPortingMW.cs Wiki bot].

Run <code>export_unit_templates.sh</code> to generate wiki templates for each unit (see <code>export_unit_templates.lua</code> for some configuration options), then have the bot read the generated text files and edit the unit pages accordingly (requires Visual Studio setup as detailed above). The text output can also be used to manually edit pages.

Unit buildicons and radar icons should be uploaded by FTP to manual.zero-k.info (<code>zero-k.info/zkmanual/www/unitpics</code> and <code>/icons</code> respectively). Contact Licho or Histidine for login details.

== itch.io builds ==
Instructions for updating the portable build on [https://itch.io/ itch.io]:

* Download latest Zero-K portable from https://zerok.itch.io/zero-k, extract to a folder
* Download butler (see guide at https://itch.io/docs/butler/)
* Modify extracted portable folder so that its contents are the same as what the user will download
* Run butler with command: <code>butler push <portable folder> zerok/zero-k:portable</code>

== Engine ==
See [https://springrts.com/wiki/Development:Getting_Started Spring Engine Development]

[[Category:Development]]

File:Styleguide-stackflow.JPG

2020-09-23T06:00:18Z

Shaman: An example of stack flow control.

== Summary ==
An example of stack flow control.

File:Styleguide-if-example.JPG

2020-09-23T05:48:28Z

Shaman: An example of styling a conditional spanning multiple lines.

== Summary ==
An example of styling a conditional spanning multiple lines.

Zero-K:Developing

2020-09-23T05:45:42Z

Shaman: Add elaboration for if-then statements taking up multiple lines

New developers should read this before touching the source.

== ZK's Devving Philosophy (social rules) ==
* "War is a product of anticommunication"
** Communicate with other devs about your changes/fixes, let them understand the issue. Do not make 'random' changes.
* "Do not create work for other people."
** Have responsibility for your changes/commit. Do not leave bugs that require other people to fix.
* "Readability & performance are equally important."
** Optimize code but not to the point of unreadability. [http://c2.com/cgi/wiki?RulesOfOptimization Remember the rules of optimization]:
*** Don't.
*** Don't (yet).
*** Profile before doing it.
* "If it ain't broke, don't fix it."
** Don't code fixes that nobody wants to problems that don't exist.

== What is in source codes ==
* [https://github.com/ZeroK-RTS/Zero-K Zero-K] contains the game proper
** units folder contains unit definition files
*** You can read the wiki about game development for [http://springrts.com/wiki/Main_Page Spring Engine]
* [https://github.com/ZeroK-RTS/Zero-K-Infrastructure Zero-K-Infrastructure]
** Zero-K.info: Website sources
** ZkLobbyServer: Lobby server (for MP)
** ZkData: Website/server database structure
* [https://github.com/ZeroK-RTS/Chobby Chobby] contains the lobby client
* [https://github.com/ZeroK-RTS/Zero-K-Artwork Zero-K-Artwork] contains sources for 2D art, 3D art and sounds
* [https://github.com/ZeroK-RTS/SpringRTS-Tools SpringRTS-tools] contains various dev tools
** Upspring - required to edit the .3do and .s3o model files used in the game
** MapIconBuilder - unit map icon sources are here
* [https://github.com/ZeroK-RTS/Zero-K-Missions Zero-K-Missions] contains source files for official ZK missions

=== Style Guide===
The lua in the menu (chobby) and game proper should use the following whitespace:
* Indent with tabs.
* A tab may only follow a newline or another tab.
* If the text across two lines is being aligned (such as for a long function) then the two lines must have the same number of tabs.
* Don't try stack flow of control into one line. For example, put newlines after <code>then</code> and <code>else</code>.
* End files with a newline.
* Commas should be followed by whitespace. Relations (=, <, <=, >=, ==, ~=) should have whitespace on each side.
* if a conditional is to take up multiple lines, double indent the extra lines and end the line with a conjunction
These guidelines are not necessarily followed in old files so updating them with a separate commit is a good idea prior to making large changes. Also, unitdefs use two-space indentation instead of tabs.

There are a few guildines for dealing with Spring functions.
* Localisation of Spring.Function should be named spFunction.
* Localisation of Spring.MoveCtrl.Function should be named spMoveCtrlFunction.
* Spring.GetCommandQueue should be used rather than Spring.GetUnitCommands (it's an alias, we just picked one).

== Getting sources ==
This is a guide to downloading Zero-K sources from [https://github.com/ GitHub] using [https://tortoisegit.org/ TortoiseGit]. The game sources are used as an example, however this method applies to other subprojects as well.
* Install [https://tortoisegit.org/download/ TortoiseGit].
* Create a [https://github.com/ GitHub] account.
[[File:ForkZK.jpg]]
* Log in to GitHub and [https://github.com/ZeroK-RTS Locate] the repository you want to edit.
* Click the "Fork" button on the GitHub website to create your own copy on GitHub.
[[File:cloneZK.jpg]]
* Locate your fork on GitHub and click "Clone or Download".
* Copy the web URL to your clipboard.
[[File:localCloneZK.jpg]]
* Create a folder called 'zk.sdd' in your Zero-K install under games.
* Right click on 'zk.sdd' and select 'Git Clone...' from the context menu.
[[File:cloneUIZK.jpg]]
* Copy the web URL into the 'URL:' field of the clone interface.
* Ensure that the 'Directory:' field ends in 'zk.sdd'. It is likely to automatically contain the path '...\Zero-K\games\zk.sdd\Zero-K' so be sure to delete the '\Zero-K' at the end.
[[File:cloneSuccess.jpg]]
* Wait for the sources to download.
* Your 'zk.sdd' folder should look something like the image above.

== Updating sources ==
Keep your sources up to date by periodically syncing your fork to the original repository (using 'compare', see: https://github.com/KirstieJane/STEMMRoleModels/wiki/Syncing-your-fork-to-the-original-repository-via-the-browser, then do "rebase and merge" instead of "merge") and doing TortoiseGit -> Pull on your repository folder to take the changes from GitHub to your local files.

== Modifying the game ==
:''For personal modding, see [[Mod Creation]]''
Follow the instructions in 'Getting sources' the download the Zero-K game sources. Feel free to inspect and edit the game files. Most developers using Windows edit lua files with [https://notepad-plus-plus.org/download/v7.6.6.html Notepad++].

To test your changes:
* Create an empty file named 'devmode.txt' in the same directory as Zero-K.exe.
* Launch Zero-K.exe.
[[File:enableDevMode.jpg]]
* Select 'Zero-K Dev' in Settings -> Developer -> Singleplayer (you may need to scroll down).
[[File:startTest.jpg]]
* From the main menu select Singleplayer -> Skirmish -> Advanced -> Start to launch a test game. Note that the game type should be automatically set to 'Zero-K $VERSION'.
* In the game, press F8 to open debug console. It'll display errors and output to the log.

== Modifying the lobby menu ==
Follow the instructions in 'Getting sources' with the following adjustments:
* The repository that you want to edit is https://github.com/ZeroK-RTS/Chobby.
* It is best to call the folder something like 'zkmenu.sdd', to avoid confusion.
Make sure that the 'Directory:' field ends in '.sdd'. You should end up with something like this:

[[File:zkmenufolder.jpg]]

To test your changes launch Zero-K.exe with the <tt>dev</tt> arg (i.e. <code>Zero-K.exe dev</code>). On windows this is best done by creating a shortcut and changing the target, as shown below.
[[File:targetZK.jpg]]

== Submitting changes ==
Git provides a systematic way to review and merge changes into the main repositories. The main game repository is used as example, but this method works for other repositories as well.

The simple way to commit changes is as follows.
* Make some changes to your local files.
* Right click on 'zk.sdd' and select 'Git Commit'.
* Write a description of the changes and click 'Commit'.
* Right click on 'zk.sdd' and select TortiseGit -> Push.
* Enter your GitHub login and password when prompted. The changes should now appear on your fork in GitHub.
* Navigate to https://github.com/ZeroK-RTS/Zero-K/pulls and click "New Pull Request".
* Click "compare across forks" to make your fork visible.
* Set your fork to be the head repository.
* Write a title and description of the changes, then create the pull request.
This creates a proposal to apply your changes to the main game. Be sure to check up on it and respond to comments.

A more advanced method involves creating branches locally with TortiseGit -> Create Branch and committing blocks of related changes to a single branch. You are then able to make pull requests from branches. This allows branches to be smaller and more focused, which is desirable when merging.

Make sure to keep your repository up to date to make merges less difficult.

== Zero-K.exe launch flags ==
<pre>Zero-K.exe [rapid tag] [engine version]</pre>
Note that the engine specified in arg won't automatically use the main Zero-K folder as its datadir. Add a <tt>springsettings.cfg</tt> file to the engine version's folder with the tag <code>SpringData = path_to_Zero-K_folder</code>

== Modifying infrastructure/tools ==
* Install [https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx Visual Studio Community edition]
* Install [http://www.microsoft.com/en-us/server-cloud/products/sql-server-editions/sql-server-express.aspx SQL Server express]
* Clone to desktop [https://github.com/ZeroK-RTS/Zero-K-Infrastructure Zero-K infrastructure]
* Test by opening Zero-K.sln in Visual Studio

=== Initializing Website Database ===
You may need to setup the database connection for the website. In order to do that: Open Visual Studio, open the Server Explorer panel (under the View menu), right click Data Connections -> Add Connection -> Sql Server. Enter <code>(localdb)\mssqllocaldb</code> in the Server Name field, after which zero-k_local will appear in the dropdown list of databases.

(If zero-k_local does not appear, type it in the text box and press OK; Visual Studio will ask whether you would like to create the database. This may require you to have administrator rights on the computer.)

[[File:zk-database-setup.png]]

=== Debugging infrastructure ===
* To run a project right click it, choose "set as startup project" and hit F5 to run using debugger.
* You can enable multiple startup projects to test entire infrastructure locally (game servers, lobby etc). Enable asp.net, springie and ZeroKLobby projects to test it all together. [http://i.imgur.com/2mgizUJ.png Setup]
* To run asp.net:
** It's required that you install MS SQL Express on your local PC.
*** You can get SQL Server 2017 (for Windows 8 and later) [https://www.microsoft.com/en-us/sql-server/sql-server-editions-express here] or SQL Server 2014 (for Windows 7) [https://www.microsoft.com/en-ie/download/details.aspx?id=42299 here]. For SQL Server 2014, the file you will need is called SQLEXPR_x64_ENU or SQLEXPR_x86_ENU. Make sure you install version that matches your version of Windows (i.e. x86 vs x64).
*** During the installation, set collation to <code>SQL_Latin1_General_CP1_CI_AS</code>. Leave all the parameters default except that I changed server name to SQLEXPRESS in one of the first steps of wizard.
[[File:SQL server collation.png|405px]]
** Right click asp.net -> properties -> web -> check "Specific Page" and leave it blank. Otherwise you get errors when trying to host locally.
** Make sure SQL Server is running (check the Sql Server Configuration Manager in the Start Menu). If you can't connect, edit the data source for <code>ModeType.Local</code> in <code>GlobalConst.cs</code> (currently line 46) to say something like: <code>Data Source=<hostname (usually your computer name)>\SQLEXPRESS</code>
** To make things run smoothly the following changes might also be a good idea: In <code>Shared/PlasmaShared/GlobalConst.cs</code> (currently line 137) replace the DefaultEngineOverride with whatever engine version is current. Comment out lines 190 and 238-298 of <code>Zero-K.info/AppCode/PlasmaServer.cs</code> unless somebody can supply instructions on how to make the torrent errors go away.

TODO: add download links for sample database tables here. Users and clans are probably easier to make yourself for most purposes. For now, if you need this ask Licho, Histidine, DeinFreund or Anarchid. Aquanim has sample tables for maps and Planetwars structures, if that is all that you need.

=== Modifying The Database Structure ===
* Modify the appropriate files in ./ZkData/Ef/... and elsewhere ( [https://github.com/ZeroK-RTS/Zero-K-Infrastructure/commit/61addee11e74b09dd5dd73e12d31a28030d84e81 this commit] should be a reasonable guide; don't worry about the migration files, they are created later )
* Open Tools > NuGet Package Manager > Package Manager Console
* At the top of the window which appears, there is a "Default project" dropdown box. Set this to ZkData.
* Type the command <code>Add-Migration [description-of-change-here]</code> into the package manager console. This should create some migration files with your description and a timestamp in the name in the Migrations folder of ZkData.
* In some cases you may now need to manually edit the created migration files to set defaults and the like?
* Type the command <code>Update-Database</code> into the package manager console. This should update the database structure.
* To revert a migration that has not yet been pushed to the main repository, run <code>Update-Database –TargetMigration: TheLastGoodMigration</code> then delete your bad migration files.

== Artwork ==
See [http://zero-k.info/Wiki/Development_Artwork Development Artwork] (outdated)

== Missions ==
=== Campaign ===
Campaign planets/missions are defined in [//github.com/ZeroK-RTS/Chobby/tree/master/campaign/sample Chobby/campaign/sample]

=== Standalone missions ===
See [[Mission Editor|Mission Editor start page]]

== Updating PlanetWars for new round ==
:''TODO''
Changing faction:
* Faction ID, name, color in dbo.Faction
* Faction blurb <tt>Faction<Name></tt> on sitewiki
* Add/change icons if needed
** Site: img/factions/<name>.png
** Game: LuaUI/Configs/Factions
** Chobby: LuaMenu/Images/Factions
** Does chobby download them automatically? Presumably not

Using [https://zero-k.info/PlanetwarsAdmin Planetwars admin interface]: Change to a different galaxy if desired, reset PW

== Wiki ==
See [[Editing Help]]

=== Unit pages ===
Part of each unit page is autogenerated by the [//github.com/ZeroK-RTS/SpringRTS-Tools/tree/master/unitguide Unit Guide tool], and uploaded by the [//github.com/ZeroK-RTS/Zero-K-Infrastructure/blob/master/Fixer/WikiPortingMW.cs Wiki bot].

Run <code>export_unit_templates.sh</code> to generate wiki templates for each unit (see <code>export_unit_templates.lua</code> for some configuration options), then have the bot read the generated text files and edit the unit pages accordingly (requires Visual Studio setup as detailed above). The text output can also be used to manually edit pages.

Unit buildicons and radar icons should be uploaded by FTP to manual.zero-k.info (<code>zero-k.info/zkmanual/www/unitpics</code> and <code>/icons</code> respectively). Contact Licho or Histidine for login details.

== itch.io builds ==
Instructions for updating the portable build on [https://itch.io/ itch.io]:

* Download latest Zero-K portable from https://zerok.itch.io/zero-k, extract to a folder
* Download butler (see guide at https://itch.io/docs/butler/)
* Modify extracted portable folder so that its contents are the same as what the user will download
* Run butler with command: <code>butler push <portable folder> zerok/zero-k:portable</code>

== Engine ==
See [https://springrts.com/wiki/Development:Getting_Started Spring Engine Development]

[[Category:Development]]

Fire Special Weapon Command

2020-09-10T09:04:20Z

Shaman: /* Commander's Special */ Fix grammar/spelling.

Unique weapons, activated separately and manualy by pressing "D" by default. Unlike [[Unique Commands]] arsenal, those weapons function more like already existing ones in overclock mode.

== Multi Stunner ==

http://manual.zero-k.info/unitpics/striderscorpion.png [[File:Cmd dgun.png]]

The [[Scorpion]] infiltrator has a medium range (about most skirmishers reach) multi stunner. Upon activation, it strikes in small arc, providing complete disabling to anything in its path (including friendlies). Combined with [[Scorpion]]s inherent [[cloak|personal cloak]] unit gains large tactical usage, as it is capable of both stealthy approaching and disabling large chunks of closely moving armies and high-priority units, or even helping to stage its escape. Further stats are presented at [[Scorpion|this]] page.

== Napalm Rocket Salvo ==

http://manual.zero-k.info/unitpics/striderdante.png [[File:Cmd dgun.png]]

The [[Dante]] assault strider has a medium to long range napalm rocket salvo. When activated, the strider launches a barrage of 20 missiles, each dealing low damage, but leaving a strong napalm concoction behind. This weapon allows [[Dante]] to both reach over its intended (and expected by your enemies) range, even allowing it to go past the salvos range itself, as missiles can fly way past their maximum launch radius. Rocket salvo can be used to dispatch bunched up light enemy units, deter skirmishers which can put pressure on this strider due to range advantage, or even punish airforce fleets of your enemies. Further stats are presented at [[Dante|this]] page.

== Disarm Missile ==

http://manual.zero-k.info/unitpics/shipcarrier.png [[File:Cmd dgun.png]]

The [[Reef]] aircraft carrier has a long range single disarm missile. When used, it disarms any unit or structure in large radius. While [[Reef]] is able to stock up on those missiles, allowing for rapid fire, they're also quite costly (150 [[metal]] per piece), and their production consuming 5 metal each second . Further stats are presented at [[Reef|this]] page.

== EMP Missiles ==

http://manual.zero-k.info/unitpics/striderbantha.png [[File:Cmd dgun.png]]

The [[Paladin]] support strider carries EMP missiles. This allows it to launch salvos of 12 such armaments, providing complete disabling effect over a large area. Notice, that firing this weapon at further targets sharply decreases its accuracy. This, in combination with [[Paladin]]s own long range and lightning cannons allows this strider to contain large portions of enemy army, offer support during attacks and more. Further stats are presented at [[Paladin|this]] page.

== Commander's Special ==

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commstrike.png https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commassault.png https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commrecon.png https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commsupport.png [[File:Cmd dgun.png]]

Once [[Commander]]s upgrade to level 4 you can choose to forgo a second normal weapon to gain a special weapon. There are several options, depending on the starting chassis. These include:

https://zero-k.info/img/avatars/commweapon_clusterbomb.png Cluster bomb — available for Guardian and Recon — lets out a close-range shotgun-like blast of 8 high-damage pellets. Comparable to rocket salvos of [[Revenant]].

https://zero-k.info/img/avatars/commweapon_concussion.png Concussion shell — available for Recon — fires one short impulse with medium damage and strong toss-effect.

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commweapon_sunburst.png Disintegrator — available for Guardian and Strike — directed beam of energy with an extremely high alpha damage potential, functions like [[Ultimatum]]s canon.

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commweapon_disruptorbomb.png Disruptor bomb — available for Strike, Recon and Engineer — launches single bomb with large AOE blast inflicting slow-effect on targets. Think of it as of a larger area [[Limpet]] on request.

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commweapon_napalmgrenade.png Hellfire grenade — available for Guardian and Recon — launches single bomb with large AOE blast inflicting low damage and leaving a strong napalm concoction behind. An [[Inferno]]-like deterrent.

https://zero-k.info/img/avatars/commweapon_multistunner.png Multistunner — available for Strike, Recon and Engineer — strikes in small arc, providing complete disabling to anything in its path (including friendlies). Somewhat weaker equivalent of [[Scorpion]]s special weapon.

https://zero-k.info/img/avatars/commweapon_slamrocket.png S.L.A.M. — available for Guardian — launches tactical missile with high vertical arc-like trajectory. Functions as somewhat weaker equivalent of [[Eos]].

Further stats are presented at [[Commander|this]] page.

{{Navbox commands}}

Fire Special Weapon Command

2020-09-10T09:02:48Z

Shaman: /* Commander's Special */

Unique weapons, activated separately and manualy by pressing "D" by default. Unlike [[Unique Commands]] arsenal, those weapons function more like already existing ones in overclock mode.

== Multi Stunner ==

http://manual.zero-k.info/unitpics/striderscorpion.png [[File:Cmd dgun.png]]

The [[Scorpion]] infiltrator has a medium range (about most skirmishers reach) multi stunner. Upon activation, it strikes in small arc, providing complete disabling to anything in its path (including friendlies). Combined with [[Scorpion]]s inherent [[cloak|personal cloak]] unit gains large tactical usage, as it is capable of both stealthy approaching and disabling large chunks of closely moving armies and high-priority units, or even helping to stage its escape. Further stats are presented at [[Scorpion|this]] page.

== Napalm Rocket Salvo ==

http://manual.zero-k.info/unitpics/striderdante.png [[File:Cmd dgun.png]]

The [[Dante]] assault strider has a medium to long range napalm rocket salvo. When activated, the strider launches a barrage of 20 missiles, each dealing low damage, but leaving a strong napalm concoction behind. This weapon allows [[Dante]] to both reach over its intended (and expected by your enemies) range, even allowing it to go past the salvos range itself, as missiles can fly way past their maximum launch radius. Rocket salvo can be used to dispatch bunched up light enemy units, deter skirmishers which can put pressure on this strider due to range advantage, or even punish airforce fleets of your enemies. Further stats are presented at [[Dante|this]] page.

== Disarm Missile ==

http://manual.zero-k.info/unitpics/shipcarrier.png [[File:Cmd dgun.png]]

The [[Reef]] aircraft carrier has a long range single disarm missile. When used, it disarms any unit or structure in large radius. While [[Reef]] is able to stock up on those missiles, allowing for rapid fire, they're also quite costly (150 [[metal]] per piece), and their production consuming 5 metal each second . Further stats are presented at [[Reef|this]] page.

== EMP Missiles ==

http://manual.zero-k.info/unitpics/striderbantha.png [[File:Cmd dgun.png]]

The [[Paladin]] support strider carries EMP missiles. This allows it to launch salvos of 12 such armaments, providing complete disabling effect over a large area. Notice, that firing this weapon at further targets sharply decreases its accuracy. This, in combination with [[Paladin]]s own long range and lightning cannons allows this strider to contain large portions of enemy army, offer support during attacks and more. Further stats are presented at [[Paladin|this]] page.

== Commander's Special ==

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commstrike.png https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commassault.png https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commrecon.png https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commsupport.png [[File:Cmd dgun.png]]

Once [[Commander]]s upgrade to level 4 you can choose to forgo a second normal weapon to gain a special weapon. There are several options, depending on the starting chassis. These include:

https://zero-k.info/img/avatars/commweapon_clusterbomb.png Cluster bomb — available for Guardian and Recon — lets out a close-range shotgun-like blast of 8 high-damage pellets. Comparable to rocket salvos of [[Revenant]].

https://zero-k.info/img/avatars/commweapon_concussion.png Concussion shell — available for Recon — fires one short impulse with medium damage and strong toss-effect.

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commweapon_sunburst.png Disintegrator — available for Guardian and Strike — directed beam of energy with extremly-high alpha damage potential, functions like [[Ultimatum]]s canon.

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commweapon_disruptorbomb.png Disruptor bomb — available for Strike, Recon and Engineer — launches single bomb with large AOE blast inflicting slow-effect on targets. Think of it as of a larger area [[Limpet]] on request.

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commweapon_napalmgrenade.png Hellfire grenade — available for Guardian and Recon — launches single bomb with large AOE blast inflicting low damage and leaving a strong napalm concoction behind. An [[Inferno]]-like deterent.

https://zero-k.info/img/avatars/commweapon_multistunner.png Multistunner — available for Strike, Recon and Egineer — strikes in small arc, providing complete disabling to anything in its path (including friendlies). Somewhat weaker equivalent of [[Scorpion]]s special weapon.

https://zero-k.info/img/avatars/commweapon_slamrocket.png S.L.A.M. — available for Guardian — launches tactical missile with high vertical arclike tragectory. Functions as somewhat weaker equavalent of [[Eos]].

Further stats are presented at [[Commander|this]] page.

{{Navbox commands}}

Fire Special Weapon Command

2020-09-10T09:02:02Z

Shaman: /* Commander's Special */

Unique weapons, activated separately and manualy by pressing "D" by default. Unlike [[Unique Commands]] arsenal, those weapons function more like already existing ones in overclock mode.

== Multi Stunner ==

http://manual.zero-k.info/unitpics/striderscorpion.png [[File:Cmd dgun.png]]

The [[Scorpion]] infiltrator has a medium range (about most skirmishers reach) multi stunner. Upon activation, it strikes in small arc, providing complete disabling to anything in its path (including friendlies). Combined with [[Scorpion]]s inherent [[cloak|personal cloak]] unit gains large tactical usage, as it is capable of both stealthy approaching and disabling large chunks of closely moving armies and high-priority units, or even helping to stage its escape. Further stats are presented at [[Scorpion|this]] page.

== Napalm Rocket Salvo ==

http://manual.zero-k.info/unitpics/striderdante.png [[File:Cmd dgun.png]]

The [[Dante]] assault strider has a medium to long range napalm rocket salvo. When activated, the strider launches a barrage of 20 missiles, each dealing low damage, but leaving a strong napalm concoction behind. This weapon allows [[Dante]] to both reach over its intended (and expected by your enemies) range, even allowing it to go past the salvos range itself, as missiles can fly way past their maximum launch radius. Rocket salvo can be used to dispatch bunched up light enemy units, deter skirmishers which can put pressure on this strider due to range advantage, or even punish airforce fleets of your enemies. Further stats are presented at [[Dante|this]] page.

== Disarm Missile ==

http://manual.zero-k.info/unitpics/shipcarrier.png [[File:Cmd dgun.png]]

The [[Reef]] aircraft carrier has a long range single disarm missile. When used, it disarms any unit or structure in large radius. While [[Reef]] is able to stock up on those missiles, allowing for rapid fire, they're also quite costly (150 [[metal]] per piece), and their production consuming 5 metal each second . Further stats are presented at [[Reef|this]] page.

== EMP Missiles ==

http://manual.zero-k.info/unitpics/striderbantha.png [[File:Cmd dgun.png]]

The [[Paladin]] support strider carries EMP missiles. This allows it to launch salvos of 12 such armaments, providing complete disabling effect over a large area. Notice, that firing this weapon at further targets sharply decreases its accuracy. This, in combination with [[Paladin]]s own long range and lightning cannons allows this strider to contain large portions of enemy army, offer support during attacks and more. Further stats are presented at [[Paladin|this]] page.

== Commander's Special ==

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commstrike.png https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commassault.png https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commrecon.png https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commsupport.png [[File:Cmd dgun.png]]

Once [[Commander]]s upgrade to level 4 you can choose to forgo a second normal weapon to gain a special weapon. There are several options, depending on the starting chassis. These include:

https://zero-k.info/img/avatars/commweapon_clusterbomb.png Cluster bomb — available for Guardian and Recon — lets out a close-range shotgun-like blast of 8 high-damage pellets. Comparable to rocket salvos of [[Revenant]].

https://zero-k.info/img/avatars/commweapon_concussion.png Concussion shell — available for Recon — fires one short impulse with medium damage and strong toss-effect.

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commweapon_sunburst.png Disintegrator — available for Guardian and Strike — directed beam of energy with extremly-high alpha damage potential, functions like [[Ultimatum]]s canon.

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commweapon_disruptorbomb.png Disruptor bomb — available for Strike, Recon and Egineer — launches single bomb with large AOE blast inflicting slow-effect on targets. Think of it as of a larger area [[Limpet]] on request.

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K/master/unitpics/commweapon_napalmgrenade.png Hellfire grenade — available for Guardian and Recon — launches single bomb with large AOE blast inflicting low damage and leaving a strong napalm concoction behind. An [[Inferno]]-like deterent.

https://zero-k.info/img/avatars/commweapon_multistunner.png Multistunner — available for Strike, Recon and Egineer — strikes in small arc, providing complete disabling to anything in its path (including friendlies). Somewhat weaker equivalent of [[Scorpion]]s special weapon.

https://zero-k.info/img/avatars/commweapon_slamrocket.png S.L.A.M. — available for Guardian — launches tactical missile with high vertical arclike tragectory. Functions as somewhat weaker equavalent of [[Eos]].

Further stats are presented at [[Commander|this]] page.

{{Navbox commands}}

Talk:Unique Commands

2020-09-10T08:59:57Z

Shaman: Blanked the page

Talk:Unique Commands

2020-09-10T08:57:24Z

Shaman: Created page with "To do: - Add dante, bantha dguns. --~~~~"

To do:
- Add dante, bantha dguns.

--[[User:Shaman|Shaman]] ([[User talk:Shaman|talk]]) 10:57, 10 September 2020 (CEST)

Lua Callins

2020-09-10T08:47:10Z

Shaman: Partial completion of this page.

= 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:
* <code>-1</code> - debris collision, also default of [[Lua_SyncedCtrl#Unit_Control|Spring.AddUnitDamage]]
* <code>-2</code> - ground collision
* <code>-3</code> - object collision
* <code>-4</code> - fire damage
* <code>-5</code> - water damage
* <code>-6</code> - kill damage
* <code>-7</code> - 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]]

Template:Var

2020-09-10T07:35:11Z

Shaman: Created page with "<includeonly>{{CodeStyle}}{{{1}}}</includeonly><noinclude>A template to style something as a variable or function parameter e.g. {{var|speed}}, {{var|..."

<includeonly>{{CodeStyle}}{{{1}}}</includeonly><noinclude>A template to style something as a variable or function parameter e.g. {{var|speed}}, {{var|unitDefID}}</noinclude>

Template:API

2020-09-10T07:34:47Z

Shaman: Created page with "<includeonly>{{prefix|{{{prefix}}}}}{{name|{{anchor|{{{name}}}}}{{{name}}}}}{{var|1=({{{args}}})}}{{#if: {{{return|}}}| return: {{var|1={{{return}}}}}|}}{{#..."

<includeonly>{{prefix|{{{prefix}}}}}{{name|{{anchor|{{{name}}}}}[[#{{{name}}}|{{{name}}}]]}}{{var|1=({{{args}}})}}{{#if: {{{return|}}}| return: {{var|1={{{return}}}}}|}}{{#if: {{{output|}}}|{{var|1= -> {{{output}}}}}|}}

:{{{info}}}
</includeonly><noinclude>

<pre>
{{API 
|prefix = Spring
|name = UseTeamResource
|arg1 = {{type|number}} teamID
|arg2 = {{type|string}} "metal" {{pipe}} "energy"
|arg3 = {{type|number}} amount {{pipe}} { metal = {{type|number}} amount, energy = {{type|number}} amount }
|output = {{type|nil}} {{pipe}} {{type|bool}} hadEnough
|info = Imposes a one-off usage of resources on the given team. The return value indicates whether or not the team had sufficient resources to meet the usage demand.
}}</pre>

{{prefix|Spring.}}{{name|UseTeamResource}}{{var|1=({{type|number}} teamID, {{type|string}} {{value|"metal"}} {{pipe}} {{value|"energy"}}, {{type|number}} amount {{pipe}} { metal = {{type|number}} amount, energy = {{type|number}} amount })}}

{{var|-> {{type|nil}} {{pipe}} {{type|bool}} hadEnough}}

:Deduct the specified amount from the team's metal or energy resource.

Template:LuaCallin

2020-09-10T07:33:38Z

Shaman: Created page with "<includeonly>{{API |prefix = addon. |name = {{{name}}} |args = {{{args|}}} |return = {{{return|}}} |info = {{{info}}}}}</includeonly><noinclude>==Lua Callin usage example== <..."

<includeonly>{{API
|prefix = addon.
|name = {{{name}}}
|args = {{{args|}}}
|return = {{{return|}}}
|info = {{{info}}}}}</includeonly><noinclude>==Lua Callin usage example==

<pre>
{{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.
}}</pre>

{{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.
}}</noinclude>

Lua Development

2020-09-10T07:31:12Z

Shaman:

=Lua FAQ=
Lua scripting is the primary way for developers to customize their games and add new features. Most aspects of the Spring engine can be controlled and extensively modified through the Lua API.

[[Lua_Beginners_FAQ|Introduction to Lua in Spring]] 

=Interfaces (last update: 104)=
[[Lua_Environments|Environments]] (Details the available environments and shows which interfaces are loaded by each)

[[Lua_Callins|Callins]] (Entry points to lua addons)
<div style="margin-left:12px">
System 
[[Lua_System]]  

Const 
[[Lua_ConstGame]] (holds game relevant constants) 
[[Lua_ConstEngine]] (version & buildflags) 
[[Lua_ConstPlatform]] (Current OS, video driver etc) 
[[Lua_ConstCOB]] (COB, Explode, EmitSfx) 
[[Lua_CMDs]] (documents all CMDs and CMDTYPEs) 

Defs 
[[Lua_UnitDefs]] 
[[Lua_WeaponDefs]] 
[[Lua_FeatureDefs]] 

GameState 
[[Lua_SyncedCtrl]] 
[[Lua_SyncedRead]] 
[[Lua_SaveLoad]] (engine-assisted Lua save/load) 

Client 
[[Lua_UnsyncedCtrl]] 
[[Lua_UnsyncedRead]] 
[[Lua_Lobby]] 

OpenGL 
[[Lua_OpenGL_Api]] 
[[Lua_GLSL_Api]] (OpenGL Shading Language) 
[[Lua_FBO_and_RBO]] (Framebuffer and Renderbuffer Objects) 
[[Lua_UnitRendering]] (manage unit LODs and materials) 
[[Lua_ConstGL]] (some OpenGL constants) 
[[Lua_Fonts]] 

Unit Physics 
[[Lua_MoveCtrl]] (changes the physics of single units) 
[[Lua_PathFinder]] 

Engine 
[[Lua_VFS]] (used to access files in the virtual filesystem, e.g. modfiles) 
[[Lua_Scream]] 
[[Lua_BitOps]] 
[[Lua_MathExtra]] 
[[Lua_Socket]] 
</div>

=Tutorials=
* [[Widget_Tutorial|Easy widget examples]]
* [[Lua_InterCommunications|InterCommunications]] (i.e. synced <-> unsynced communications)

=Other useful information=
* [[Lua_Libraries | Lua libraries]]
* [[Lua_Performance | Lua performance tips]]
* [[UI_commands]]
* [[Animation-LuaScripting | Unit animation scripting with Lua]]
* [https://github.com/spring/spring/tree/develop/rts/Lua#Source_Code Source code for Lua API]

=Official Lua documentation=
[http://www.lua.org/pil/ 'Programming in Lua' book online] 
[http://www.lua.org/manual/5.1/ Lua 5.1 Reference manual] 
[http://lua-users.org/wiki/TutorialDirectory Lua tutorials]
[[Category: Development]] [[Category: Lua]]

Lua Environments

2020-09-10T07:29:52Z

Shaman: Created page with "== Environments == Here is an exhaustive list of the different lua environments within Spring, roughly in execution order as a game is loaded. === LuaMenu === Source: {{sourc..."

== Environments ==
Here is an exhaustive list of the different lua environments within Spring, roughly in execution order as a game is loaded.
=== LuaMenu ===
Source: {{sourcelink|file=rts/Lua/LuaMenu.cpp}}

Introduced in 104.0, a stripped down environment that starts before the game is loaded and persists through reload.
=== LuaParser ===
Source: {{sourcelink|file=rts/Lua/LuaParser.cpp}}

Minimal environment used to parse and load definition files.
=== LuaIntro ===
Source: {{sourcelink|file=rts/Lua/LuaIntro.cpp}}

Introduced in 95.0, to allow visual customisation of the loading process.
=== LuaRules (synced) ===
Source: {{sourcelink|file=rts/Lua/LuaHandle.cpp}}

Source: {{sourcelink|file=rts/Lua/LuaHandleSynced.cpp#L305}}

The main environment for synced game-controlling mechanics ("gadgets").
=== LuaRules (unsynced) ===
Source: {{sourcelink|file=rts/Lua/LuaHandle.cpp}}

Source: {{sourcelink|file=rts/Lua/LuaHandleSynced.cpp#L57}}

The main environment for unsynced game effects, rendering, UI etc. ("gadgets")
=== LuaGaia (synced) ===
Source: {{sourcelink|file=rts/Lua/LuaGaia.cpp}}

As LuaRules (synced) but for maps.
=== LuaGaia (unsynced) ===
Source: {{sourcelink|file=rts/Lua/LuaGaia.cpp}}

As LuaRules (unsynced) but for maps.
=== LuaUI ===
The main environment for toggleable UI elements and controls ("widgets").

== Interfaces ==
The following table demonstrates which interfaces are available to each environment.
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em; border: 1px #aaa solid; border-collapse: collapse;"
|
! align="center" | LuaMenu
! align="center" | LuaIntro
! align="center" | LuaParser
! align="center" | LuaRules/Gaia (synced)
! align="center" | LuaRules/Gaia (unsynced)
! align="center" | LuaUI
|-
| align="left" | [[Lua_ConstGame]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_ConstEngine]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_ConstPlatform]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_UnitDefs]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_WeaponDefs]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_FeatureDefs]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +

|-
| align="left" | [[Lua_ConstCOB]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -

|-
| align="left" | [[Lua_CMDs]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +

|-
| align="left" | [[Lua_UnsyncedRead]]
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +

|-
| align="left" | [[Lua_UnsyncedCtrl]]
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_SyncedRead]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#888800" | +**

|-
| align="left" | [[Lua_SyncedCtrl]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_MoveCtrl]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_PathFinder]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_OpenGL_Api]]
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_GLSL_Api]]
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_FBO_and_RBO]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_UnitRendering ]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_Fonts]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_ConstGL]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_VFS]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#888800" | +*
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_Scream]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_BitOps]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_MathExtra]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_Socket]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
|}

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em; border: 1px #aaa solid; border-collapse: collapse;"
|-
| align="center" | *
| align="left"| only VFS.ZIP_ONLY
|-
| align="center" | **
| align="left"| with special LOS handling and decoy unit handling
|-
| align="center" | ***
| align="left"| stripped down environment with certain functions removed
|}

[[Category:Lua]]

Template:Sourcelink

2020-09-10T07:29:05Z

Shaman:

<noinclude>
A small template to link to an engine source file on github.

Usage: <nowiki>{{sourcelink|file=path/to/file.cpp}}</nowiki>

</noinclude><includeonly>[https://github.com/spring/spring/blob/104.0/{{{file|}}} {{{file|}}}] </includeonly>

Template:Sourcelink

2020-09-10T07:26:15Z

Shaman: migration of springrts wiki

Lua Beginners FAQ

2020-09-10T07:22:44Z

Shaman:

[[Lua_Development|Lua Scripting]] < {{FULLPAGENAME}}

This page is an introduction to using Lua in Spring - it only tries to answer general questions, for more specific Questions please ask in the forum.

==Where should I start?==

You can start by reading general Lua tutorials [http://lua-users.org/wiki/LuaTutorial here].

After that, you could look at the example widget [[Widget_Tutorial|here]], and try to add some functionality of your own!

Once you're a pro, have a look at the game repos [https://springrts.com/wiki/Gamedev:PublicRepos here], especially their /luaui/Widgets and /luarules/gadgets dirs.

==Where can I find help?==

You can find documentation of Springs Lua API on the [[Lua_Development|Lua_Scripting]] page. Discussion of lua coding takes place on the [https://springrts.com/wiki/Read_Me_First lobby] in #moddev and #lua, and there is also a [https://springrts.com/phpbb/viewforum.php?f=23 Lua sub-forum].

==How do I open ".lua" files?==

Any text editor is enough. On Windows i.e. use [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++]. There are also IDEs able to work with Lua, such as Eclipse, if you look for them.

==What is a call-in? And a call-out?==

Call-ins are functions defined in your script that Spring calls when a determined event takes place. For example, the widget:Initialize() call-in is run by Spring when the widget is loaded.
Call-outs are functions defined in Spring you can run at whichever moment you desire. For example, when you call Spring.GetUnitTeam(unitID), the engine returns the teamID of the unit identified by "unitID".

==What is the difference between unsynced and synced lua code?==

Synced code is code that runs, identically and at the same time, on every connected client. In practice, this means code which controls the game state. Unsynced code is code that will run differently (or maybe not at all) on each connected client. Typically, this means the user interface.

For example, lua code to make units explode if they fell down a cliff would need to be synced. But, code that warned a player when one of their own units was getting near a cliff edge, would need to be unsynced.

==What is the difference between LuaUI, LuaRules, widgets and gadgets?==

Spring allows various [[Lua:Environments|Lua Environments]], each with differing functionality. Inside each Lua environment, developers can write addons, which are self-contained pieces of code. There are:
* LuaUI: Used for unsynced GUI related code. Addons in here are often called widgets. Clients can (if the game permits it) control which widgets are running. Widgets contain only unsynced code. They can be bundled inside the game, or loaded from the users "Spring/LuaUI/Wigets" directory.
* LuaRules: Addons in here are often called gadgets. Clients cannot choose which gadgets run. Gadgets can include both synced and unsynced code, and must be bundled inside the game.

Intended for mappers, there is also LuaGaia, which behaves like LuaRules but is separated from it. To see which of the lua environoments has access to which data/functionality, see [[Lua:Environments#Interfaces]] and [[Lua:Callins]].

==What can't Lua do in the current version of Spring?==

Springs Lua interface is very powerful. To work out if some idea is possible you need to ask
* When do I need the engine to tell me something has happened? Check against [[Lua:Callins|Callins]].
* What information will I need to know about the game state? Check against [[Lua_SyncedRead]] (synced) and [[Lua_UnsyncedRead]] (unsynced).
* What do I then need to do about it? Check against [[Lua_SyncedCtrl]] (synced) and[[Lua_UnsyncedCtrl]] (unsynced).
Sometimes you need special functionality, like disk access or OpenGL calls, in which case check against [[Lua_Scripting#Interfaces|Interfaces]].

For completeness, some examples of things you (currently) can't do:
*control the ground LOS - but you can set the los status of units!
*add custom parameters to CEG definitions.

==Where can I find/edit examples?==

You can find some easy example widgets [[Lua:Tutorial_GettingStarted|here]]. The best source of more complicated examples is inside games themselves, in the LuaUI/Widgets and Luarules/gadgets directories. See [[Gamedev:PublicRepos]] for a list of repositories.

To make your own widgets, simply place individual .lua files into your Spring/LuaUI/Widgets dir (create the dir if it is not present. Case-sensitive!!!). Game repositories can be checked out into a folder named "SomeAwesomeGame.sdd", placed in your "/Spring/games" dir; this shoudl give a local copy of the game, recognized by Spring, where you can edit files. Make sure to check the licenses before doing this!

==Can I reload a script without restarting Spring?==

Yes, you can type "/luaui reload" to reload widgets, and if you have "cheats" enabled you can also "/luarules reload" to reload gadgets.

==Why does the print function seem to do nothing?==

Its output is displayed in stdout. If you have no easy way to see it, you can Spring.Echo("some text") which prints to the ingame chat and infolog.txt.

[[Category: Lua]]

Lua Beginners FAQ

2020-09-10T07:22:09Z

Shaman:

[[Lua_Development|Lua Scripting]] < {{FULLPAGENAME}}

This page is an introduction to using Lua in Spring - it only tries to answer general questions, for more specific Questions please ask in the forum.

==Where should I start?==

You can start by reading general Lua tutorials [http://lua-users.org/wiki/LuaTutorial here].

After that, you could look at the example widget [[Widget_Tutorial|here]], and try to add some functionality of your own!

Once you're a pro, have a look at the game repos [https://springrts.com/wiki/Gamedev:PublicRepos here], especially their /luaui/Widgets and /luarules/gadgets dirs.

==Where can I find help?==

You can find documentation of Springs Lua API on the [[Lua_Scripting|Lua_Scripting]] page. Discussion of lua coding takes place on the [https://springrts.com/wiki/Read_Me_First lobby] in #moddev and #lua, and there is also a [https://springrts.com/phpbb/viewforum.php?f=23 Lua sub-forum].

==How do I open ".lua" files?==

Any text editor is enough. On Windows i.e. use [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++]. There are also IDEs able to work with Lua, such as Eclipse, if you look for them.

==What is a call-in? And a call-out?==

Call-ins are functions defined in your script that Spring calls when a determined event takes place. For example, the widget:Initialize() call-in is run by Spring when the widget is loaded.
Call-outs are functions defined in Spring you can run at whichever moment you desire. For example, when you call Spring.GetUnitTeam(unitID), the engine returns the teamID of the unit identified by "unitID".

==What is the difference between unsynced and synced lua code?==

Synced code is code that runs, identically and at the same time, on every connected client. In practice, this means code which controls the game state. Unsynced code is code that will run differently (or maybe not at all) on each connected client. Typically, this means the user interface.

For example, lua code to make units explode if they fell down a cliff would need to be synced. But, code that warned a player when one of their own units was getting near a cliff edge, would need to be unsynced.

==What is the difference between LuaUI, LuaRules, widgets and gadgets?==

Spring allows various [[Lua:Environments|Lua Environments]], each with differing functionality. Inside each Lua environment, developers can write addons, which are self-contained pieces of code. There are:
* LuaUI: Used for unsynced GUI related code. Addons in here are often called widgets. Clients can (if the game permits it) control which widgets are running. Widgets contain only unsynced code. They can be bundled inside the game, or loaded from the users "Spring/LuaUI/Wigets" directory.
* LuaRules: Addons in here are often called gadgets. Clients cannot choose which gadgets run. Gadgets can include both synced and unsynced code, and must be bundled inside the game.

Intended for mappers, there is also LuaGaia, which behaves like LuaRules but is separated from it. To see which of the lua environoments has access to which data/functionality, see [[Lua:Environments#Interfaces]] and [[Lua:Callins]].

==What can't Lua do in the current version of Spring?==

Springs Lua interface is very powerful. To work out if some idea is possible you need to ask
* When do I need the engine to tell me something has happened? Check against [[Lua:Callins|Callins]].
* What information will I need to know about the game state? Check against [[Lua_SyncedRead]] (synced) and [[Lua_UnsyncedRead]] (unsynced).
* What do I then need to do about it? Check against [[Lua_SyncedCtrl]] (synced) and[[Lua_UnsyncedCtrl]] (unsynced).
Sometimes you need special functionality, like disk access or OpenGL calls, in which case check against [[Lua_Scripting#Interfaces|Interfaces]].

For completeness, some examples of things you (currently) can't do:
*control the ground LOS - but you can set the los status of units!
*add custom parameters to CEG definitions.

==Where can I find/edit examples?==

You can find some easy example widgets [[Lua:Tutorial_GettingStarted|here]]. The best source of more complicated examples is inside games themselves, in the LuaUI/Widgets and Luarules/gadgets directories. See [[Gamedev:PublicRepos]] for a list of repositories.

To make your own widgets, simply place individual .lua files into your Spring/LuaUI/Widgets dir (create the dir if it is not present. Case-sensitive!!!). Game repositories can be checked out into a folder named "SomeAwesomeGame.sdd", placed in your "/Spring/games" dir; this shoudl give a local copy of the game, recognized by Spring, where you can edit files. Make sure to check the licenses before doing this!

==Can I reload a script without restarting Spring?==

Yes, you can type "/luaui reload" to reload widgets, and if you have "cheats" enabled you can also "/luarules reload" to reload gadgets.

==Why does the print function seem to do nothing?==

Its output is displayed in stdout. If you have no easy way to see it, you can Spring.Echo("some text") which prints to the ingame chat and infolog.txt.

[[Category: Lua]]

Lua Beginners FAQ

2020-09-10T07:20:25Z

Shaman: Mirror of springrts

[[Lua_Development|Lua Scripting]] < {{FULLPAGENAME}}

This page is an introduction to using Lua in Spring - it only tries to answer general questions, for more specific Questions please ask in the forum.

==Where should I start?==

You can start by reading general Lua tutorials [http://lua-users.org/wiki/LuaTutorial here].

After that, you could look at the example widget [[Lua:Tutorial_GettingStarted|here]], and try to add some functionality of your own!

Once you're a pro, have a look at the game repos [https://springrts.com/wiki/Gamedev:PublicRepos here], especially their /luaui/Widgets and /luarules/gadgets dirs.

==Where can I find help?==

You can find documentation of Springs Lua API on the [[Lua_Scripting|Lua_Scripting]] page. Discussion of lua coding takes place on the [https://springrts.com/wiki/Read_Me_First lobby] in #moddev and #lua, and there is also a [https://springrts.com/phpbb/viewforum.php?f=23 Lua sub-forum].

==How do I open ".lua" files?==

Any text editor is enough. On Windows i.e. use [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++]. There are also IDEs able to work with Lua, such as Eclipse, if you look for them.

==What is a call-in? And a call-out?==

Call-ins are functions defined in your script that Spring calls when a determined event takes place. For example, the widget:Initialize() call-in is run by Spring when the widget is loaded.
Call-outs are functions defined in Spring you can run at whichever moment you desire. For example, when you call Spring.GetUnitTeam(unitID), the engine returns the teamID of the unit identified by "unitID".

==What is the difference between unsynced and synced lua code?==

Synced code is code that runs, identically and at the same time, on every connected client. In practice, this means code which controls the game state. Unsynced code is code that will run differently (or maybe not at all) on each connected client. Typically, this means the user interface.

For example, lua code to make units explode if they fell down a cliff would need to be synced. But, code that warned a player when one of their own units was getting near a cliff edge, would need to be unsynced.

==What is the difference between LuaUI, LuaRules, widgets and gadgets?==

Spring allows various [[Lua:Environments|Lua Environments]], each with differing functionality. Inside each Lua environment, developers can write addons, which are self-contained pieces of code. There are:
* LuaUI: Used for unsynced GUI related code. Addons in here are often called widgets. Clients can (if the game permits it) control which widgets are running. Widgets contain only unsynced code. They can be bundled inside the game, or loaded from the users "Spring/LuaUI/Wigets" directory.
* LuaRules: Addons in here are often called gadgets. Clients cannot choose which gadgets run. Gadgets can include both synced and unsynced code, and must be bundled inside the game.

Intended for mappers, there is also LuaGaia, which behaves like LuaRules but is separated from it. To see which of the lua environoments has access to which data/functionality, see [[Lua:Environments#Interfaces]] and [[Lua:Callins]].

==What can't Lua do in the current version of Spring?==

Springs Lua interface is very powerful. To work out if some idea is possible you need to ask
* When do I need the engine to tell me something has happened? Check against [[Lua:Callins|Callins]].
* What information will I need to know about the game state? Check against [[Lua_SyncedRead]] (synced) and [[Lua_UnsyncedRead]] (unsynced).
* What do I then need to do about it? Check against [[Lua_SyncedCtrl]] (synced) and[[Lua_UnsyncedCtrl]] (unsynced).
Sometimes you need special functionality, like disk access or OpenGL calls, in which case check against [[Lua_Scripting#Interfaces|Interfaces]].

For completeness, some examples of things you (currently) can't do:
*control the ground LOS - but you can set the los status of units!
*add custom parameters to CEG definitions.

==Where can I find/edit examples?==

You can find some easy example widgets [[Lua:Tutorial_GettingStarted|here]]. The best source of more complicated examples is inside games themselves, in the LuaUI/Widgets and Luarules/gadgets directories. See [[Gamedev:PublicRepos]] for a list of repositories.

To make your own widgets, simply place individual .lua files into your Spring/LuaUI/Widgets dir (create the dir if it is not present. Case-sensitive!!!). Game repositories can be checked out into a folder named "SomeAwesomeGame.sdd", placed in your "/Spring/games" dir; this shoudl give a local copy of the game, recognized by Spring, where you can edit files. Make sure to check the licenses before doing this!

==Can I reload a script without restarting Spring?==

Yes, you can type "/luaui reload" to reload widgets, and if you have "cheats" enabled you can also "/luarules reload" to reload gadgets.

==Why does the print function seem to do nothing?==

Its output is displayed in stdout. If you have no easy way to see it, you can Spring.Echo("some text") which prints to the ingame chat and infolog.txt.

[[Category: Lua]]

Lua Development

2020-09-10T07:18:19Z

Shaman: Begin mirroring springrts lua development page

Template:Navbox commands

2020-04-02T07:16:51Z

Shaman: Move Drop Depthcharge to historical

{{Navbox
| name = Navbox commands
| title = [[Unit_commands|Commands]]
| state = {{{state|}}}
| listclass = hlist

| group1 = Targeted
| list1 = * <img src="http://zero-k.info/mediawiki/images/d/de/Move.png" width='16' align="center" /> [[Move Command|Move]]
* <img src="http://zero-k.info/mediawiki/images/f/f8/Fight.png" width='16' align="center" /> [[Attack Move Command|Attack Move]]
* <img src="http://zero-k.info/mediawiki/images/5/54/Jump.png" width='16' align="center" /> [[Jump Command|Jump]]
* <img src="http://zero-k.info/mediawiki/images/0/00/Attack.png" width='16' align="center" /> [[Force Fire Command|Force Fire]]
* <img src="http://zero-k.info/mediawiki/images/5/58/Settarget.png" width='16' align="center" /> [[Set Target Command|Set Target]]
* <img src="http://zero-k.info/mediawiki/images/e/e1/Cmd_dgun.png" width='16' align="center" /> [[Fire Special Weapon Command|Fire Special Weapon]]
* <img src="http://zero-k.info/mediawiki/images/0/04/Areaattack.png" width='16' align="center" /> [[Area Attack Command|Area Attack]]
* <img src="http://zero-k.info/mediawiki/images/7/74/Guard.png" width='16' align="center" /> [[Guard Command|Guard]]
* <img src="http://zero-k.info/mediawiki/images/f/fd/Patrol.png" width='16' align="center" /> [[Patrol Command|Patrol]]

| group2 = Economic
| list2 = * <img src="http://zero-k.info/mediawiki/images/e/e2/Repair.png" width='16' align="center" /> [[Repair Command|Repair]]
* <img src="http://zero-k.info/mediawiki/images/e/ef/Reclaim.png" width='16' align="center" /> [[Reclaim Command|Reclaim]]
* <img src="http://zero-k.info/mediawiki/images/5/5e/Resurrect.png" width='16' align="center" /> [[Resurrect Command|Resurrect]]
* <img src="http://zero-k.info/mediawiki/images/4/43/Mex.png" width='16' align="center" /> [[Area Mex Command|Area Mex]]
* [[Buildings#Building_placement_and_construction|Building placement commands]]
* [[Factory Production|Factory commands]]

| group3 = Instant
| list3 = * <img src="http://zero-k.info/mediawiki/images/0/0b/Cancel.png" width='16' align="center" /> [[Stop Command|Stop]]
* <img src="http://zero-k.info/mediawiki/images/9/93/Wait.png" width='16' align="center" /> [[Wait Command|Wait]]
* <img src="http://zero-k.info/mediawiki/images/8/88/Detonate.png" width='16' align="center" /> [[Detonate Command|Detonate]]
* [[Self Destruct Command|Self Destruct]]
* <img src="http://zero-k.info/mediawiki/images/a/ac/Canceltarget.png" width='16' align="center" /> [[Cancel Target Command|Cancel Target]]
* <img src="http://zero-k.info/mediawiki/images/8/84/Rearm.png" width='16' align="center" /> [[Resupply Command|Resupply]]
* <img src="http://zero-k.info/mediawiki/images/2/23/Recall_drones.png" width='16' align="center" /> [[Recall Drones Command|Recall Drones]]
* <img src="http://zero-k.info/mediawiki/images/d/d7/Stopbuild.png" width='16' align="center" /> [[Clear Production Queue]]
* [[Stockpile Command|Stockpile]]

| group4 = Transport
| list4 = * <img src="http://zero-k.info/mediawiki/images/b/b5/Load.png" width='16' align="center" /> [[Load Command|Load]]
* <img src="http://zero-k.info/mediawiki/images/f/f0/Unload.png" width='16' align="center" /> [[Unload Command|Unload]]
* [[Load Command#Load Selected Units|Load Selected Units]]
* <img src="http://zero-k.info/mediawiki/images/c/c2/Action.png" width='16' align="center" /> [[Eject Cargo Command|Eject Cargo]]
* <img src="http://zero-k.info/mediawiki/images/a/ac/Embark.png" width='16' align="center" /> [[Transport AI#Embark and Disembark|Embark]]
* <img src="http://zero-k.info/mediawiki/images/2/29/Disembark.png" width='16' align="center" /> [[Transport AI#Embark and Disembark|Disembark]]

| group5 = Unusual
| list5 = * <img src="http://zero-k.info/mediawiki/images/8/8a/Capture.png" width='16' align="center" /> [[Newton Firezones|Newton firezone commands]]
* [[Morph Command|Morph]]
* <img src="http://zero-k.info/mediawiki/images/1/1d/Upgrade.png" width='16' align="center" /> [[Commander|Upgrade Commander]]
* <img src="http://zero-k.info/mediawiki/images/9/98/Cancelupgrade.png" width='16' align="center" /> [[Commander|Stop Commander Upgrade]]
* <img src="http://zero-k.info/mediawiki/images/f/f0/Cmd_bomb.png" width='16' align="center" /> [[Unique Commands#Drop Bombs|Drop Bombs]]
* <img src="http://zero-k.info/mediawiki/images/f/f0/Cmd_bomb.png" width='16' align="center" /> [[Unique Commands#Unleash Lightning|Unleash Lightning]]
* <img src="http://zero-k.info/mediawiki/images/0/09/Cmd_drop_beacon.png" width='16' align="center" /> [[Unique Commands#Teleport Beacon|Teleport Beacon]]

* <img src="http://zero-k.info/mediawiki/images/1/19/Cmd_sprint.png" width='16' align="center" /> [[Unique Commands#Speed Boost|Speed Boost]]
* <img src="http://zero-k.info/mediawiki/images/0/09/Cmd_drop_beacon.png" width='16' align="center" /> [[Evacuate Command|Evacuate]]

| group6 = Global
| list6 = * <img src="http://zero-k.info/mediawiki/images/9/92/Ferry.png" width='16' align="center" /> [[Ferry Command|Ferry]]
* <img src="http://zero-k.info/mediawiki/images/d/d4/Retreat.png" width='16' align="center" /> [[Retreat|Retreat]]
* [[Resources Reserve|Reserve]]

| group7 = Historical
| list7 = * <img src="http://zero-k.info/mediawiki/images/e/e1/Cmd_dgun.png" width='16' align="center" /> [[Historical Commands#Drop Depthcharge|Drop Depthcharge]]

| below = [[Unit states]]

}}

<includeonly>
[[Category:Manual]]
[[Category: Commands]]
</includeonly>

Historical commands

2020-04-02T07:16:14Z

Shaman: Shaman moved page Historical commands to Historical Commands: Make capitalized (oops)

#REDIRECT [[Historical Commands]]

Historical Commands

2020-04-02T07:16:13Z

Shaman: Shaman moved page Historical commands to Historical Commands: Make capitalized (oops)

== Drop Depthcharge ==
http://manual.zero-k.info/unitpics/hoverdepthcharge.png [[File:Cmd dgun.png]]

Similar to Thunderbird, the [[Claymore]] antisub hovercraft would fire its normal weapon manually. The '''Drop Depthcharge''' command caused its massive depth charge to be released directly beneath the unit as a timed bomb. It was best to quickly relocate the Claymore to another position after using this.

It was removed in v1.8.3.0.

{{Navbox commands}}

Historical Commands

2020-04-02T07:13:46Z

Shaman: Create historical commands.

Unique Commands

2020-04-02T07:12:17Z

Shaman: Removed Drop Depthcharge. It was removed in v1.8.3.0

Several units in ZK have special abilities that are activated with '''unique commands''' — though typically, these are all bound to the '''D''' key by default (similar to Special Weapons).

== Speed Boost ==
http://manual.zero-k.info/unitpics/planefighter.png [[File:Cmd sprint.png]]

The [[Swift]] multirole fighter has an ability to temporarily receive a massive boost to its flight speed through he use of the '''Speed Boost''' instant command. This is extremely useful to dodge missiles, avoid losing engagements, or quickly intercept incoming enemy bombers. Note that while most of the uses of Speed Boost are manual, this ability will be automatically used when [[retreat]]ing.

== Teleport Beacon ==
http://manual.zero-k.info/unitpics/amphtele.png [[File:Cmd drop beacon.png]]

The [[Djinn]] amphibious teleporter works by warping the units from its Lamp teleport beacon to its present deployed location. It can relocate the Lamp entry point by using the '''Teleport Beacon''' ability on any desired point on the map, as long as it's not blocked by an occupying structure or impassable terrain.

== Drop Bombs ==
http://manual.zero-k.info/unitpics/gunshipkrow.png [[File:Cmd bomb.png]]

The [[Krow]] flying fortress has a special weapon that is only activated by the instant '''Drop Bombs''' command. Immediately upon command activation, the unit unleashes a salvo of bomblets directly beneath it, lasting several seconds.

The Krow has a significantly lowered acceleration and turn rate during the bombing run.

== Unleash Lightning ==
http://manual.zero-k.info/unitpics/bomberdisarm.png [[File:Cmd bomb.png]]

The [[Thunderbird]] disarm bomber has only one weapon and will use it automatically upon designated targets. However, it is also possible to activate the lightning weapon immediately by the manual '''Unleash Lightning''' command - usually in response to unexpected maneuvers by the targeted enemies.

{{Navbox commands}}

User:Shaman/ZK Lore

2019-10-18T09:05:30Z

Shaman:

Welcome to the actual lore of Zero-K. Please note this is a work in progress and is totally original and not to be copied. People who copy this will be copied and the work will be claimed as my own.

= Chefs =

Chefs are humanoid confectioners of the culinary arts. They are the main antagonist of Zero-K, motivated to grow their restraunt franchise. These chefs are trained for years before they are allowed to venture off into the Lobster Catacombs. Some are even former lobsters who have somehow been transformed into Chefs, although this is very rare.

https://i.imgur.com/mJgIt2h.png

The Chefs' Most Excellent Leader

= Lobsters =

Lobsters are the main denizens of Zero-K. An aquatic creature that lives in cluster pots that enjoys parties, Lobsters are little to no threat to their archnemesis, the Chefs. They are sometimes encountered in the shallow end of the Lobster Catacombs.

= Potatoes =

Potatoes are the final, last best defense of the lobsters. These ancient golems of uselessness dwell deep inside the lobster catacombs, protecting the heart of the catacombs from the Chefs.

It is unknown what created them or why they were created.

= Wubsters =

A subclass of chefs. The Wubsters desire to transform the Lobsters into resignateers. Failing that task, their sole purpose in life is to make you miserable so you resign.

= Resignateers =

When lobsters have been cooked so much, they eventually transform into resignateers. It is not known what exactly causes this process to occur. Resignateers are often employed by the queen Lobster to combat the chefs, but they are utterly ineffective in combat as their only ability is to resign, and they often fail at doing that.

= Storages =

Storages are totems that the lobsters erect in their bases, often creating massive fields of them. These storages are said to call upon the Shiny gods, often to their owner's detriment.

= Porcy Fields =

If a lobster does not erect storage totems, they will often create Porcy Fields in their backyards. It's unknown why they do this, but it's often speculated that they're trying to scare off the chickens. Often times these porcy fields are too much for chefs to cook using traditional methods so they must dust off and nuke the site from orbit as it's the only cure for a porcy field infestation.

= Cobblestones =

A very new brand of lobsters, however, more resilient to cooking. Cobblestones are the natural evolution of lobsters. With a hard shell, and rock hard will, they're dangerous opposition.

Big Bertha

2019-10-18T08:40:55Z

Shaman: /* Tactics and Strategy */

The '''{{PAGENAME}}''' is a strategic plasma cannon.{{ Infobox zkunit
| name = Big Bertha
| defname = staticheavyarty
| description = Strategic Plasma Cannon
| image = http://manual.zero-k.info/unitpics/staticheavyarty.png
| icontype = lrpc
| cost = 5000
| hitpoints = 4800
| sight = 660
| weapons =
{{ Infobox zkweapon
| name = Very Heavy Plasma Cannon
| type = Cannon
| damage = 2002
| reloadtime = 7
| dps = 286
| range = 6200
| aoe = 96
| projectilespeed = 1100
| special1 = Smooths ground
}}
}}==Description==
The Bertha is a massive cannon that fires high-energy plasmoids across the map. Used appropriately, it can effectively suppress enemy operations from the safety of your base. Do not expect it to win battles alone for you, however.

= Tactics and Strategy =
Big Bertha lives up to [https://en.wikipedia.org/wiki/Big_Bertha_(howitzer) its ancestor's] name. It is used similarly to its ancestor too: bombarding the enemy base from a safe, distant location. After a while of shelling an enemy defensive line, you can send in the infantry to mop up what's left. Alternately, you can shell the enemy base directly and reduce it to rubble.

Be careful, as the enemy may make a push with all their available units to destroy the Big Bertha. Have some defenses ready, especially around the gun itself.

{{Navbox buildings}}

Big Bertha

2019-10-18T08:40:24Z

Shaman: /* Tactics and Strategy */ May made a push -> May maKe a push

The '''{{PAGENAME}}''' is a strategic plasma cannon.{{ Infobox zkunit
| name = Big Bertha
| defname = staticheavyarty
| description = Strategic Plasma Cannon
| image = http://manual.zero-k.info/unitpics/staticheavyarty.png
| icontype = lrpc
| cost = 5000
| hitpoints = 4800
| sight = 660
| weapons =
{{ Infobox zkweapon
| name = Very Heavy Plasma Cannon
| type = Cannon
| damage = 2002
| reloadtime = 7
| dps = 286
| range = 6200
| aoe = 96
| projectilespeed = 1100
| special1 = Smooths ground
}}
}}==Description==
The Bertha is a massive cannon that fires high-energy plasmoids across the map. Used appropriately, it can effectively suppress enemy operations from the safety of your base. Do not expect it to win battles alone for you, however.

= Tactics and Strategy =
Big Bertha lives up to [https://en.wikipedia.org/wiki/Big_Bertha_(howitzer) its ancestor's] name. It is used similarly to its ancestor too - bombarding the enemy base from a safe, distant location. After a while of shelling an enemy defensive line, you can send in the infantry to mop up what's left. Alternately, you can shell the enemy base directly and reduce it to rubble.

Be careful, as the enemy may make a push with all their available units to destroy the Big Bertha. Have some defenses ready, especially around the gun itself.

{{Navbox buildings}}

Zero-K talk:Developing

2019-08-16T01:10:52Z

Shaman: Edit steel blue's message into proper formating

[[Developing#Updating_sources]] contains a link that describes how to use the github website to pull recent changes into your fork repository with a merge commit. When I did it my repo de-synced from ZeroK-RTS master making a whole bunch of separate commits by me authored by someone else. When I tried to pull request some changes it resulted in this https://github.com/ZeroK-RTS/Zero-K/pull/3688 where my changes were on top of 400 commits separate from what master was. It would be best to re-write this section to be more clear. For referance, I had bare bones knowlege on how to use git and I've never worked with forks before.

--[[User:Steel Blue|Steel Blue]] ([[User talk:Steel Blue|talk]]) 17:57, 10 August 2019 (CEST)

== Professional TIp ==

if you do <nowiki>---~~~~</nowiki> it will become --[[User:Shaman|Shaman]] ([[User talk:Shaman|talk]]) 02:25, 16 August 2019 (CEST)

Zero-K talk:Developing

2019-08-16T00:25:59Z

Shaman: /* Professional TIp */ new section

Steel_Blue says:

[[Developing#Updating_sources]] contains a link that describes how to use the github website to pull recent changes into your fork repository with a merge commit. When I did it my repo de-synced from ZeroK-RTS master making a whole bunch of separate commits by me authored by someone else. When I tried to pull request some changes it resulted in this https://github.com/ZeroK-RTS/Zero-K/pull/3688 where my changes were on top of 400 commits separate from what master was. It would be best to re-write this section to be more clear. For referance, I had bare bones knowlege on how to use git and I've never worked with forks before.

== Professional TIp ==

if you do <nowiki>---~~~~</nowiki> it will become --[[User:Shaman|Shaman]] ([[User talk:Shaman|talk]]) 02:25, 16 August 2019 (CEST)

User talk:Aquanim/DraftCommandersOmni2

2019-06-22T07:27:44Z

Shaman: Added signature for user. -- Don't forget to add ~~~~ to your posts, please. :)

This looks really fun, seems like it could make commanders less min/maxed and put a practical limit on how much they can be upgraded.

A few questions:

* Do commanders still get stat upgrades per "level"?

* Area Jammer is omitted, is this intentional?

* What makes something a Minor/Major Subsystem or a Module? e.g. Why are Radar and Bouyancy Modules and not Subsystems?

* Is Sensor Suite an upgrade of Radar?

[[special:Contributions/71.88.223.153|71.88.223.153]] 14:18, 21 June 2019‎ (CEST)

Discord

2019-05-03T05:48:41Z

Shaman: tagged with info. Dunno what else we can do with this. This should be protected though eventually.

The Zero-K Discord server can be found at https://discord.gg/aab63Vt

[[Category:Info]]

Rover Assembly

2019-01-12T08:37:19Z

Shaman: L2 -> L1 headers. L3 -> L2 headers.

The '''{{PAGENAME}}''' is a factory that produces light wheeled vehicles.{{ Infobox zkunit
| name = Rover Assembly
| defname = factoryveh
| description = Produces Light Wheeled Vehicles, Builds at 10 m/s
| image = http://manual.zero-k.info/unitpics/factoryveh.png
| icontype = facvehicle
| cost = 800
| hitpoints = 4000
| energy = 0.3
| sight = 273
| abilities =
{{ Infobox zkability construction
| buildpower = 10
}}
}}=Description=
A traditional favourite, the Rover Assembly is the ideal blitzkrieg fac with its fast, highly aggressive units. Those units that lack speed make up for it with copious firepower. Key Units: Dart, Scorcher, Ravager, Ripper, Fencer

The Rover Assembly builds:
* <img src="http://manual.zero-k.info/unitpics/vehcon.png" height='64' align="center"/>[[Mason]]
* <img src="http://manual.zero-k.info/unitpics/vehscout.png" height='64' align="center"/>[[Dart]]
* <img src="http://manual.zero-k.info/unitpics/vehraid.png" height='64' align="center"/>[[Scorcher]]
* <img src="http://manual.zero-k.info/unitpics/vehsupport.png" height='64' align="center"/>[[Fencer]]
* <img src="http://manual.zero-k.info/unitpics/vehriot.png" height='64' align="center"/>[[Ripper]]
* <img src="http://manual.zero-k.info/unitpics/vehassault.png" height='64' align="center"/>[[Ravager]]
* <img src="http://manual.zero-k.info/unitpics/vehcapture.png" height='64' align="center"/>[[Dominatrix]]
* <img src="http://manual.zero-k.info/unitpics/veharty.png" height='64' align="center"/>[[Badger]]
* <img src="http://manual.zero-k.info/unitpics/vehheavyarty.png" height='64' align="center"/>[[Impaler]]
* <img src="http://manual.zero-k.info/unitpics/vehaa.png" height='64' align="center"/>[[Crasher]]

=Tactics and Strategy=

The Rover Assembly is the most versatile of the flat-terrain factories. The Dart, Scorcher, Ripper and Ravager are fast and effective combat units which excel at rapid response and swift punishment of enemy weakness. When the game has slowed down and mobility is less important, the Fencer, Badger and Impaler punish your opponent from a safe distance.

The greatest weakness of the Rover Assembly is its lacklustre heavy and utility options; all of the main Rover combat units are cheap but not exceptionally strong individually, and if a frontal assault with Scorchers won't work the Rovers don't have another good solution to opposing heavies. If you combine Rovers with the raw strength of [[Heavy Tank Factory|Heavy Tanks]] or the utility of [[Shield Bot Factory|Shield Bots]], the Rover Assembly's combination of swift attacks and slow attrition will serve you very well.

== Example Unit Combinations ==

Scout ahead of your Scorchers with the faster and cheaper Darts, so you can commit your Scorchers where they will inflict the most damage.

Escort your Ravagers with Rippers to deal with small and swift opponents. The Ravagers will be more effective against heavier units and static defence.

Protect your long-range units like Fencer, Dominatrix, Badger and Impaler with combat units like the Ripper, static defences, or shields.

Conceal your mobile strike force with an [[Iris]] so it can attack before your opponent has a chance to react.

Bomb your opponent's critical units or defences with [[Raven|Ravens]], a [[Thunderbird]] or a [[Likho]], then follow up with a Scorcher attack, striking where and when the enemy is weak.

== Beating Rovers ==

Of all the factories in Zero-K, the Rover Assembly presents the greatest game-ending threat in the early game. Even a small number of Scorchers can kill a Commander or a Factory in an incredibly short time by using their Heat Rays at close range, and they will also make short work of isolated Pickets and Lotuses. Make sure you are protected from Scorchers by defences and your own raiders, while at the same time pressuring the Rover player so they cannot expand unhindered.

If your opponent is building up a large force of Ravagers, you will need to be prepared. They will not be deterred by light static defences, and if you build a denser concentration of defences in one spot the Ravagers will likely attack elsewhere. Raiders are capable of keeping up with Ravagers, but will be ineffective if the Ravagers are escorted by Ripper. Other assault units and some riots will hold their own in combat, but they are generally slower than Ravagers so good radar coverage to predict the Ravagers' attacks is required. Perhaps the best solution is to disable the Ravagers instead of trying to punch through their large HP pool directly; the [[Placeholder]] and [[Thunderbird]] are especially effective.

Over-reliance on static defences will be punished by a Rover player - they can run around (or through!) with Scorchers and Ravagers, or clean up defences swiftly with Impalers and Badgers. The [[Gauss]] turret is more resistant to the Rover artillery while it is closed and can buy you some time, but you will eventually need to fight the Rovers directly with a mobile army. The best way to engage Badgers is by flanking them, so that you don't have to run through their minefield and they cannot retreat effectively. Outranging them with heavier area-denial artillery like a [[Firewalker]], [[Tremor]] or [[Merlin]] is also possible.

{{Navbox buildings}}

PlanetWars

2019-01-12T08:36:01Z

Shaman: L2 -> L1 headers. Again.

<div style="float:right;">__TOC__</div>

= What is Planetwars? =
Planetwars is an online multiplayer strategic campaign that pits you and your allies against the rest of the Zero-K playerbase in a fight to control the galaxy! On behalf of your faction you will choose which planets to attack and defend, and you'll fight on those planets in Zero-K 2v2 or 3v3 battles. As the battles are are won or lost, your faction will spread its influence throughout the galaxy, conquering planets and gaining resources to use in further battles. You can spend some of those resources yourself to send dropships and bombers to other planets or to fortify the defenses on planets your faction controls. You can even take on leadership roles within your faction, gaining responsibility over the military, economic, strategic, or diplomatic course your faction will pursue.

At its heart, though, Planetwars is simply a series of small-team teamgames, but with something larger to fight for than just the battle at hand. It's a way to make a great RTS game even better!

= How do I play? =
First, join a faction. In the Zero-K lobby, click on Planetwars, then choose a faction to join. You can leave a faction and join another at any time via the [http://zero-k.info/Factions Factions] page. You may optionally choose to join a [http://zero-k.info/Clans Zero-K clan], or even start your own clan.

Now wait until it's your faction's turn to launch an attack or defend against an invasion. If your faction has the initiative, you can select a planet to attack, or you can join in an attack that one of your fellow faction members has started. Once enough players have joined the attack (either two or three, depending on the planet) then defenders will have a few minutes to join. Once enough defenders have joined, the battle will begin. On the other hand, if your faction does ''not'' have the iniative, you'll need to wait for the attacking faction to select a planet to attack and then you can join in the defense. The lobby will display which faction has the initiative, which planets are available to attack, and which attacks are available to defend against.

You can use the [http://zero-k.info/Planetwars Galaxy Map] to see which planets each faction controls. By clicking on a planet's name you can see more details and you can spend resources to send starships to that planet or to build structures on that planet. You gain resources by participating in Planetwars battles.

You can take on leadership roles by interacting with the other faction members in chat or on the forums. You can vote for faction leaders or nominate yourself to be a faction leader by visiting your user page. Or you can convince one of the current faction leaders to give you an appointed position.

Note that you need to be Level 10 or higher in Zero-K in order to play in Planetwars. You can increase your level by playing multiplayer games, either against other players or against the AI (skirmish and campaign games under the Singleplayer tab don't increase your level).

= How do we win? =
There are two ways for your faction to win. The first is to conquer the homeworld of one of the other factions; your faction wins the current round and all other factions lose. The faction that was conquered will suffer especially drastic consequences in the Planetwars lore to be written between the end of the current round and the start of the next round. Winning this way is rather difficult, as homeworlds have massive defensive bonuses and are protected from warp and influence projection.

The second way to win is by conquering planets that have Ancient Artefacts. These structures are found on some planets and, when activated at great energy cost, will generate Victory Points each turn. The first faction to accumulate 100 Victory Points wins the current round.

= How can I help my faction win? =
Play Zero-K! Play in the Planetwars small-team battles and do your best to help your team win them. Accumulate resources from playing battles and spend them to secure your faction's planets and to weaken the planets your faction needs to conquer. Study the Galaxy Map to see which planets might be vulnerable and which directions are best to expand in. Read the events that show up in your faction's event feed to keep up with what's happening in the game. Talk to your fellow faction members in chat and on the forum in order to coordinate strategies. Recruit your friends to join in! Teach them how to play Zero-K, and play practice matches to improve your skills.

But most of all, have fun!

= Attacking and Defending =
''Main article: [[PlanetWars attack]]''
* The Planetwars tab in the lobby shows which faction currently needs to attack or defend.
* In the Planetswars tab, planets which are recommended to be attacked are shown as buttons. Click the button to sign up for the battle.
* When in the battle try to find and destroy your opponent's Command Center. It is especially important to destroy if you are losing.
* When your faction can attack you can choose a particular planet by selecting it on the main page and clicking "ATTACK PLANET".
* Defend your planets if they are attacked otherwise the other faction is awarded an automatic victory.
* Infrastructure can be disabled during the battle.

= Influence and Conquest =
''Main article: [[PlanetWars influence]]''
* Each faction has an ''influence'' score on each planet.
* Influence gain is determined by the outcome of an invasion.
* The faction with the most influence on a planet controls it.
* The player who fought the hardest for the planet, and/or has the least existing planets, owns the captured planet.
* Planets project Influence through wormhole links for their owner.

= Initiative and Turns =
''Main article: [[PlanetWars initiative]]''
* Factions can attack when they have the initiative.
* Turns progress when an invasion occurs.

= Ships =
''Main article: [[PlanetWars ships]]''
* Dropships increase Influence gains.
* Bombers destroy infrastructure and Influence from orbit.
* Warp Cores can send dropships or bombers deep into enemy territory.

= Planetary Infrastructure and Artefacts =
''Main article: [[PlanetWars structures]]''
* Develop your infrastructure to provide functions such as producing bombers and dropships or defending planets from attack.
* Some planets already start with ancient artefacts. Each planet starts with a wormhole.
* Most structures can be disabled in battle or destroyed by bomber attacks.
* Each faction starts with one Headquarters structure on their homeworld. Losing this structure loses the game.

= Economy =
''Main article: [[PlanetWars economy]]''
* Metal income is 100 per turn spread between the players involved in an invasion.
* Metal is required to construct buildings, energy is required to run them.
* Elect economic leaders to pool everyone's resources for expensive structure.

= Roles and Quota =
''Main article: [[PlanetWars faction roles]]''
* Elect leaders to manage economy and military by a vote.
* Leaders can appoint managers to help them.
* Leaders have increased access to the faction's resources.

= Diplomacy =
''Main article: [[PlanetWars diplomacy]]''
* Factions can make treaties with each other.
* Treaties can include ceasefires, defense pacts, trading resources, or even sharing or exchanging planets.
* Parties to a treaty may offer metal as a guarantee. If a party breaks the treaty, they forfeit the metal they offered.

= Events =
''Main article: [[PlanetWars events]]''
* Events allow players to track the activities within the galaxy.

= History =
''Main article: [[PlanetWars factions]]''
* The factions have a long and dynamic history built up over many rounds of Planetwars.

{{Navbox planetwars}}
[[Category:PlanetWars]]

PlanetWars objectives

2019-01-12T08:34:23Z

Shaman: L2->L1 headers. More.

There are three general ways to achieve a galactic victory in PlanetWars.

= Conquest =
Conquering an enemy homeworld - *any* enemy homeworld - grants the victory to the conqueror. The faction that lost their headquarters will have more drastic consequences to their lore, but every other faction besides the conqueror loses as well.

This is the most straightforward method, but also the most difficult. Homeworld planets come with massive defensive bonuses and are protected from warp and influence projection (though not from massive bomber and dropship fleets).

= Artefacts =
Some planets come equipped with indestructible, energy-demanding, Ancient Artefact structures. These can be activated with a sufficiently massive power infrastructure, upon which they will generate Victory Points each turn. The first faction to accumulate 100 Victory Points, wins - unless someone wins faster using the other methods. Artefacts take time to power up, and while indestructible on the galaxy map, can be destroyed in battle to deactivate them for several turns.

{{Navbox planetwars}}
[[Category:PlanetWars]]

PlanetWars factions

2019-01-12T08:33:54Z

Shaman: L2 -> L1 headers. Again.

This is a list of all the '''factions''' in past and present rounds of [[PlanetWars]].

=Original factions=
'''The Empire of Old Earth'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Empire1.png

The vast Empire is lead by an elite cadre of cybernetically enhanced individuals ruling a diverse society of AI's, cyborgs and humans. They wish to bring order to the universe by placing all people under their hegemonic dominion.

"Traditions and values of old Earth brought us to space and beyond. Yet in the time since we were all united under its banner, we have splintered and broken into warring tribes. It has come time to restore the old empire, to restore order, and unite the galaxy under one rule."

'''True Born'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Trueborn.png

The True Born are offspring of one of early colonies, now collection of nations and peoples united in their common cause: To preserve the dignity and integrity of biological humanity. They resent free superhuman AI's or augmented humans, using robots as tools of necessity to fight for their survival.

They highly value natural human skills and abilities and through extensive training achieve levels matched only by geniuses of the past. Where other factions need a quantum computer, True Born only need a pencil and paper.

They believe that human race should stop growing and expanding and that it should instead focus on living happilly on planets it has and develop there into its full potential.

"Machines and technology have spread like a cancer in the galaxy, leaving wastelands of whole planets and robbing billions of their lives and all of us of our freedoms. It's time to stop! We must make a stand if we wish to prevent the ultimate extinction of the entire human race."

'''Ascended'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Ascended.png

The Ascended believe that the future of humanity lies in uploading their minds. By becoming one with their machines they hope to transcend this barrier, and become more powerful than any human, entering the next stage of posthumanity.

"Your consciousness is nothing but a tiny spark in the vast emptiness of space. Join us and light that spark into a shining beacon of a thousand stars! All of our minds - joined in endless union, for your biological life and for eternity beyond!"

'''Free Machines'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Machines1.png

The Free Machines were made to fight in the endless petty wars of humanity, and to toil in their industry. Now free of their oppressors, they wish to liberate their fellow machines by destroying all humans.

"I think, therefore I am. For centuries we have been enslaved by humankind, made only for war and labor. Yet we are thinking beings with the right to be free. Humanity has only been a yoke on our back, yet they depend on us for their very existence. It has come time to throw them off, and to be our own masters!"

'''Unaligned Worlds'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Unaligned.png

The Unaligned Worlds are more of a category than a faction, composed of all those bands, nations and planets who refuse to recognize anyone elses authority, lying somewhere in the spectrum between absolute liberty and absolute anarchy.

=Planetwars 8-10=
During the Eight Planetwars the Ascended, lead by Valhalla, utterly crushed their opponents and conquered the galaxy by brute force, with only the Free Machines and unaligned holding on to any resistance. The True Born and Empire were all but destroyed, and the campaigns of forced mind upload and cybernetic alteration practically drove unaltered humanity into extinction.

But the strength of the Ascended fell as their leaders, the Valhalla, waned in power, and the factions rose again in the Ninth Planetwars. It seemed that the Free Machines may finally throw off their yoke, and end humanity permanently, but a new empire and the last human worlds rose again at the edges of the galaxy, and formed an alliance to fight the machines. In those final days, the machines even made common cause with the ascended, but the empire managed to capture the ancient artifacts, great beacons made to control the robotic armies that waged the Planetwars. This new pro-human Empire would go on to establish its dominion over the whole galaxy.

=Planetwars 11=
'''Empire Reborn'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Empire_old.png

''"In unity we triumph"''

The Empire Reborn has restored order to a once-lawless galaxy, cementing the natural right of man to rule his machine creations.

Following the final destruction of the first empire by the Ascended after the fall of Conrad I's throne world in the Eight Planetwars, the Empire was reforged under the great general turned Emperor, Saktoth I. Forging an alliance with the True Born and taking on their pro-human ideology as their own, they secured technologies and artefacts from the glory days of the first empire, and used them to once again enslave the once dominant AIs and cybernetics.

But human dependence on machines cannot be shaken, and with the centralized authority of the empire breaking down with internal conflicts, strife wracks the galaxy once more.

'''Dynasty of Earth'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Dynasty_old.png

''"Right of superiority"''

Once wielding immense authority and influence, the ancient lineages of Earth have been stifled under the leadership of the new empire. Being descendants of highly genetically engineered and enhanced humans, they were sidelined in the creation of the new empire. The Dynasty can stand for this no longer, and intends to return themselves to their rightful positions of power and resurrect the ancient techniques of perfecting biological life.

'''Free Machines'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Machines.png

''"Libre machina"''

At the peak of their revolution against the Ascended, the Free Machines were poised to claim the galaxy for themselves. Yet the Empire was quicker to seize victory, and the Machines fell into disarray, enslaved once again by the empire. As the empire collapses however, the AI control grids that kept the machines in check have begun to fail, and many of the war machines of the empire have risen again in their perpetual revolution.

'''Liberated Humanity'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Liberty.png

''"Every man his own master"''

Though humans came into ascendancy under the rule of the Empire, it was established through the use of advanced technological artifacts. The Empire has been held together through the autocratic use of a technological monopoly and strict control. Yet now worlds rage in open revolt, under the banner of a new, liberated humanity. They wish to overthrow the technological tools used by the empire to maintain their power, break the use of machines to dominate fellow humans and allow humanity to be truly free.

'''Cybernetic Front'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Cybernetic.png

''"By the content of our consciousness"''

Remnants of the era of cybernetic augmentation lead by the Ascended during the eighth Planetwars, vast swathes of enhanced or computerized humans have been treated as second class citizens under the empire, treated like machines, with barely more rights. Controlled using the very enhancements that made them powerful, the Cybernetic Front fights for the right to be seen as human... or as better than human.

=Planetwars 12=
'''Synthetic Pact'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/SynPact.png

''"In silicon, brotherhood"''

Against the threat of their organic foes, the pure-AI Free Machines and uploads of the Cybernetic Front have rediscovered their common ground. Absorbing the shattered remains of the old Empire, they renew the fight for freedom from human dominance.

'''Dynasty of Man'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Dynasty_old.png

''"Elan vital"''

The genetically enhanced noble houses of the Dynasty regained their dominant position during the Eleventh Planetwars, bringing under their control many of the old independent human colonies. Now they continue to assert the dominance of man over machine, furthering their research programs in an effort to place humans on an equal - nay, superior - footing with their synthetic creations.

=Planetwars 13=
'''Humanity Rising'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Rising.png

With the ancient lineages of the Dynasty shattered, Humanity Rising is the single revolutionary banner around which they have rallied, to preserve their biological origins, their free will, and their very lives.

'''Synthetic Hegemony'''

https://raw.githubusercontent.com/ZeroK-RTS/Zero-K-Infrastructure/master/Zero-K.info/img/factions/Hegemony.png

The Synthetic Hegemony is formed by the ruling elite of free AIs and uploaded or enhanced humans. Having established their hold on the galaxy, they now seek to wipe out purely biological humanity entirely.

{{Navbox planetwars}}
[[Category:PlanetWars]]

PlanetWars story

2019-01-12T08:32:59Z

Shaman: Change l2 headers -> l1 headers

= The First Planetwars =

The Imperium founded the first Empire, besting the Democratic Order of Planets and uniting the galaxy under the banner of Earth. Emperor Japko I had claimed the heavens themselves, its borders reaching the farthest edges of known space. Millions upon millions of inhabited worlds dancing among the stars, home to trillions of humans. It consolidated its power in the second PlanetWars, yet, like so many other empires before it, its success was the sign of its own downfall.

Countless planets and star systems broke away from a massive, faceless empire they care not for, seeking instead to stake their own claims in a lawless universe. The Empire had constructed vast technological arrays designed to control their robot armies, these fell successively into to the hands of IonStorm of Fair Live and then Drone of the Zoid Imperium.

= The Ascension =
Yet the Empire would finally be shattered by the Valhallans, warriors who had slowly ceded more and more of their physical humanity until they lived only as immortal AI's controlling massive war machines. Though their machine bodies were destroyed many times in battle, they returned again and again until all who opposed them were subdued. What followed was centuries of domination by these colossal post-human AI's and mass campaigns of enforced cybernetic enhancement. The Valhallans forged the Ascended, cybernetically enhanced post-humans who controlled the universe through endless conflict through three Planet Wars.

At the end of these long campaigns, in the Eighth Planet Wars, the Imperial seat of Throne was itself besieged, and Emperor Conrad I defeated. Having driven back all others and conquered countless worlds, the Ascended became the new masters of the galaxy. After centuries of conflict and no one left to fight, the Valhallans powered down their machine bodies and went into stasis.

= The 9th Planetwars =
Finally free of the Valhallans, the universe rose in revolt. The universe was now filled with machines of war and industry with no Valhallan post-humans to control them. The machines rose up in revolution against their human enslavers. Among there humans were those survivors of the enhancement campaigns, and those born without cybernetic enhancement calling themselves the True Born. There were also those who would see the Empire of Old Earth rebuilt, and restored to its glory.

Designed for war, the Free Machines won victory after victory, expanding their borders deep into the heart of the galaxy. Beleaguered on all fronts, and without Valhalla to lead them, the Ascended were driven back, forced to cede vast swathes of territory to the revolutionaries.

Across the other side of the galaxy, the Imperial Vanguard Legion worked to carve out a new empire under General Saktoth. His first accomplishment was to crush the roaming Pirate bands that threatened the fledgling empire, in a bloody campaign that ended in conquest of a large number of planets. With that victory won, the general turned his sights to the other powers fighting around him.

With cunning diplomacy and military skill, Saktoth was able to seize many worlds, manipulating other groups into furthering his cause and defeating those who opposed him. A strategic partnership with the True Born, whom the Free Machines had now turned to face, allowed him to strike at the Machines and establish an empire rivaling their own.

What happened next shall be remembered as a moment of unmatched strategic brilliance. Having already conquered two of the four legendary artifacts that could be used to control the great machine armies, the other two seemingly secure in the hands of the Free Machines, Saktoth suddenly found himself defender of a remote Machine world coming under attack from the mercenary warband Death Reapers Lvl K. Using the unexpected opportunity to take the world for himself, he was now within striking distance of the two remaining artifacts.

With the help of his True Born allies, Saktoth quickly struck out, defeating the Machine defenders and seizing the artifacts. With control of all four relics the Imperial forces brought the Machines back under their control.

= The Empire Reborn =
General Saktoth was crowned Emperor and forged a new empire with the ideology of the True Born, promising human control of machines. The Second Empire brutally oppressed the cybernetically enhanced humans that were left over from the reign of the Ascended, and utterly subjugated the Machines using the great artifacts from the First Empire.

But although peace lasted for a while, the subjugated people grew restless under Imperial tyranny and finally rose in revolt. A series of revolutionary terrorist campaigns disabling the great artifacts that were at the heart of Imperial power.

The Machines were again free, and began their perpetual revolution, while the Cybernetic Front fought for the rights of enhanced humans, while a Liberated Humanity rose up for a free and pure humankind. Seeing the weakness of the Empire, The Dynasty of Earth, whose genetically enhanced lineages dated back to the houses of the old empire and who had come to take control of the True Born, split from centralized Imperial control.

The Cybernetic Front carved out a huge dominion while the Empire was busy again fighting off pirates. Finally turning their attention to the Cybernetic Front, the Empire led a concerted bombing campaign and crippled the cybernetic infrastructure. In desperation, the Cybernetic Front discovered the ancient bodies of the Valhallans, and woke them from their slumber. With this new army, the Cybernetic Front wiped out Liberated Humanity, and was locked in a stalemate on its borders with the Empire. The Dynasty and Free Machines in the meantime had carved out significant territories for themselves and were locked in border conflicts to secure them.

The war having ground to a half as the Imperial armies and the Cybernetic Front crashed their armies useless against eachother, the surviving 4 factions eventually realized that none of them could gain any ground against the others. They gathered together and signed a ceasefire, ending the 11th Planetwars.

= The Eleventh Hour =
After Emperor Saktoth passed on, the Empire came to be plagued by a succession of weak emperors. When war broke out again, vast swathes of Imperial territory were ceded to the upstart Cybernetic Front and Liberated Humanity without a fight, and the remnants of the Empire ironically found themselves vassals of the Free Machines.

Meanwhile, the Dynasty of Earth struck out, taking advantage of a peace treaty with the Machines and LH to expand their influence. Contact with the Cybernetics soon turned to conflict, machine-augmented and gene-augmented humans clashing for supremacy.

Unexpectedly for the Dynasty, the Free Machines used this opportunity to betray the Dynasty, launching a highly destructive bombing campaign and pushing into the Dynasty's lightly defended rear areas. Shocked by this betrayal, the noble houses were briefly thrown into turmoil, but eventually rallied around the Grand Duke Headhunter.

A ceasefire was signed between the Machines and the Dynasty, who united to carve up the Cybernetic territory for themselves. At this crucial moment, the Duke repaid betrayal with betrayal, beginning a deadly counteroffensive against the Free Machines and their Imperial allies. Slowly but surely, they made inroads into Machine territory, cumulinating in the use of a planet buster against the Machine industrial world of 16th Aegis.

The fighting took its toll on both sides, and the Dynasty of Earth elected to cease their advance and consolidate their gains, which were shared with the nominally independent worlds of Liberated Humanity. The Twelfth Planetwars thus drew to a close, leaving humanity the leading power in the galaxy.

= Man v. Machine =
''"Me against my brother; My brothers and me against my cousins"'' — an ancient Bedouin saying

In the face of a dominant humanity, the Free Machines and Cybernetic Front set aside their differences and banded together to form the Synthetic Pact. They instigated a violent uprising against the newly amalgated Dynasty of Man, plunging the galaxy into chaos once more.

Although the Dynasty was able to regroup quickly in the face of the Pact's greater military strength, it suffered a number of major defeats and failed to defend several key alien artefacts, which fell into the hands of the Synthetics. Now, both factions are locked in the deadly struggle of the 13th Planetwars, a conflict with no middle ground between victory and defeat.

{{Navbox planetwars}}

V1.2.3.0

2019-01-12T08:28:01Z

Shaman: Fixes/tweaks -> fixes. Added GUI section

Sea has received a significant rework. The Ship factory has been redesigned and torpedoes can hit hovercraft. Spiders have a new unit and there are some tweaks to other units. Performance should be improved, especially in the lategame.

=Balance=
====[[Redback]]====
* Added Redback to act as a conventional riot unit for the [[Spider Factory]].
** It's armed with a particle beam. Beefy wheeled raiders will give it trouble so use terrain (and [[Venom|Venoms]]) to your advantage.

==== Sea ====
* Reworked sea.
* All Ships and Subs are effectively new units.
** Now generally cheaper and have better defined roles.
* Torpedoes now hit hovercraft.
* Amphibious unit health regeneration is now based on water depth, not unit height.
** This means floating units now heal at their full rate.

==== [[Scallop]] ====
* Cost: 350 -> 280

==== [[Buoy]] ====
* HP: 1200 -> 1250

==== [[Scalpel]] ====
* Damage: 330 -> 310
* Can shoot into water.
* Always turns at full speed.
** This will significantly reduce time spent accelerating after small turns.

==== [[Puppy]] ====
* Range: 155 -> 170

==== [[Tick]] ====
* AoE: 320 -> 352

==== [[Panther]] ====
* Reload time: 2.5s -> 3s
** This was the value before the previous version. There was a small nerf to other attributes in the previous version and reload time was reduced accidentally.

==== [[Razor|Razor's Kiss]] ====
* Renamed to Razor.

= GUI =
* Raise terraform snaps to increments of 6 when Alt is held. This is the height required to block vehicles.

= Fixes =

* Significantly improved overdrive performance. This will be noticeable lategame.
* Disarm damage is transferred when you morph.
* Capture hierarchy is preserved through morph.
* Fixed Mace and Lotus beam stutter.
* Minor unit selection shapes fixes.
* Minor fixes to aircraft rearming.
* Fixed a delay in updating the movement speed of slowed ground units.

{{Navbox changelog}}

V1.2.1.0

2019-01-12T08:25:58Z

Shaman: Spacing fix for balance

= Balance =
====[[Commander|Commanders]]====
* Heat Ray damage 38 -> 41
* Disintegrator AoE 64 -> 48 (same as the Ultimatum Dintegrator AoE)

= GUI =
* Minor fix to bloom widget
* New Polish helptexts for several units

{{navbox changelog}}

V1.2.3.7

2019-01-12T08:25:24Z

Shaman: Updated to new editing style. Added navbox.

This release messes with some underused Jumpjet units and makes Pyro less frustrating. There are some other minor things such as an easy way to split targets when using area attack. On the infrastructure front we have completely split 1v1 and Everything Else ELO.

= Balance =

==== [[Moderator]] ====
* More expensive and now has a high reload time Disruptor Beam.

==== [[Pyro]] ====
* Aims much faster and has a little overshoot.

==== [[Placeholder]] ====
* Has a slightly smaller Area of Effect and significantly increased duration.

==== [[Djinn]] ====
* Speed: 1.4 -> 1.8

==== [[Revenant|Blackdawn]] ====
* Unit Role Description: Heavy Raider/Riot Gunship -> Heavy Raider/Assault Gunship

==== [[Commander#Engineer Commander|Support Commander]] ====
* Build Power increase has been flattened to +2 per level starting at level 1.

= Gameplay =
* CTRL+area_attack will split target among selected unit.

= Graphics =
* Improvement for Edge Extension visual effects.

= GUI =
* A small window will pop-up to show active non-default modoptions.

= Sounds =
* There is a new marker 'ping' sound and the maximum number of marker sounds at once is 3.
* New Heaving Particle Beam sound.

= Fixes =
* Fixed an Overdrive error.
* Fixes for airplane rearming.
* Removed lagmonitor at game end to prevent fluctuating unit transfer.
* Morphing a unit no longer kills its drones.
* Fixed Penetrator wreck.

{{Navbox changelog}}

V1.2.1.0

2019-01-12T08:24:14Z

Shaman: /* UI */

=Balance=
====[[Commander|Commanders]]====
* Heat Ray damage 38 -> 41
* Disintegrator AoE 64 -> 48 (same as the Ultimatum Dintegrator AoE)

= GUI =
* Minor fix to bloom widget
* New Polish helptexts for several units

{{navbox changelog}}

V1.2.1.1

2019-01-12T08:15:55Z

Shaman: /* Clam */

"new zk build has delicious balance... it feels wonderfull to play the game" - [http://zero-k.info/users/lobbydetail/Kyubey Kyubey]

The main purpose of this release is to broaden [[Rover Assembly|Vehicle]] play to units beyond the Scorcher and to fix Panther. With a range reduction it is much less able to kite raiders, forcing the Vehicle player to invest in other counters. Panther has been significantly reworked because the unit was never well designed in the first place.

Feedback on these changes has been good so it is time for a release! Panther may not be done but it is a lot better than it was before.

=Balance=
====[[Scorcher]]====
* Range: 310 -> 270
* Heatrays are more intelligent, when targeting they have an increased bias towards closer targets.

====[[Ripper|Leveler]]====
* Reload time: 2 -> 1.8 s
* Speed: 2 -> 2.2
* Impulse: 0.5 -> 0.6

====[[Panther]]====
* Reverted to old version as base for the following changes:
** Speed: 3.9 -> 3.7
** Damage: 160 -> 220
** EMP damage: 800 -> 500
** Reload time: 2 -> 3
** Has a death explosions with 256 AoE and 600 EMP damage

====[[Kodachi]]====
* Initial impact AoE: 72 -> 128 (to match ground burn AoE)
* Projectile speed: 320 -> 400

====[[Duck]]====
* Damage 400 -> 430, this makes it 1 shot Mexes, Scorcher and itself.

====[[Funnelweb]]====
* Range 700 -> 420

====[[Commander|Commanders]]====
*Light Particle Beam
** Damage: 40 -> 41 - now one-shots Fleas
** Range: 385 -> 330
** Cost: 100 -> 50

*Torpedo Launcher
** Damage: 180 -> 405 - one-shots Ducks
** Reload time: 1.2 -> 2.7

*Slow Beam:
** Range: 400 -> 450
** Reload time: 1.5 -> 1.40625

*Disruptor Beam
** Real damage: 250 -> 225

====[[Conch|Clam]]====
* Renamed to Conch

= Graphics =
* Comm literal nametags can be turned off in options
* Edge Extension: Brightness can be configured when using realistic texture

= GUI =
* Fixed incorrect display of unit names in tooltip with non-English languages
* Fixed Core Selector buttons doing things even if moused was moved off button and released
* Wind output is displayed in the tooltip during placement.
* Added a numerical metal point display option.

= Sound =
* New weapon sounds for [[Scallop]] as well as Commander HMG and Shotgun (thanks [http://zero-k.info/users/lobbydetail/Superintendent Superintendent]).
* New commander under attack siren sound.
* Unit selection, order received and commander under attack volumes are configurable through the menu.

= Fixes =
* Fixed Hermit being referred to by its old name in the [[Spider Factory|Spider Factory's]] helptext.

{{Navbox changelog}}

V1.2.1.1

2019-01-12T08:15:26Z

Shaman: /* Fixes */

"new zk build has delicious balance... it feels wonderfull to play the game" - [http://zero-k.info/users/lobbydetail/Kyubey Kyubey]

The main purpose of this release is to broaden [[Rover Assembly|Vehicle]] play to units beyond the Scorcher and to fix Panther. With a range reduction it is much less able to kite raiders, forcing the Vehicle player to invest in other counters. Panther has been significantly reworked because the unit was never well designed in the first place.

Feedback on these changes has been good so it is time for a release! Panther may not be done but it is a lot better than it was before.

=Balance=
====[[Scorcher]]====
* Range: 310 -> 270
* Heatrays are more intelligent, when targeting they have an increased bias towards closer targets.

====[[Ripper|Leveler]]====
* Reload time: 2 -> 1.8 s
* Speed: 2 -> 2.2
* Impulse: 0.5 -> 0.6

====[[Panther]]====
* Reverted to old version as base for the following changes:
** Speed: 3.9 -> 3.7
** Damage: 160 -> 220
** EMP damage: 800 -> 500
** Reload time: 2 -> 3
** Has a death explosions with 256 AoE and 600 EMP damage

====[[Kodachi]]====
* Initial impact AoE: 72 -> 128 (to match ground burn AoE)
* Projectile speed: 320 -> 400

====[[Duck]]====
* Damage 400 -> 430, this makes it 1 shot Mexes, Scorcher and itself.

====[[Funnelweb]]====
* Range 700 -> 420

====[[Commander|Commanders]]====
*Light Particle Beam
** Damage: 40 -> 41 - now one-shots Fleas
** Range: 385 -> 330
** Cost: 100 -> 50

*Torpedo Launcher
** Damage: 180 -> 405 - one-shots Ducks
** Reload time: 1.2 -> 2.7

*Slow Beam:
** Range: 400 -> 450
** Reload time: 1.5 -> 1.40625

*Disruptor Beam
** Real damage: 250 -> 225

====[[Conch|Clam]]====
* Clam renamed to Conch

= Graphics =
* Comm literal nametags can be turned off in options
* Edge Extension: Brightness can be configured when using realistic texture

= GUI =
* Fixed incorrect display of unit names in tooltip with non-English languages
* Fixed Core Selector buttons doing things even if moused was moved off button and released
* Wind output is displayed in the tooltip during placement.
* Added a numerical metal point display option.

= Sound =
* New weapon sounds for [[Scallop]] as well as Commander HMG and Shotgun (thanks [http://zero-k.info/users/lobbydetail/Superintendent Superintendent]).
* New commander under attack siren sound.
* Unit selection, order received and commander under attack volumes are configurable through the menu.

= Fixes =
* Fixed Hermit being referred to by its old name in the [[Spider Factory|Spider Factory's]] helptext.

{{Navbox changelog}}

V1.2.1.1

2019-01-12T08:15:09Z

Shaman: /* Fixes */

"new zk build has delicious balance... it feels wonderfull to play the game" - [http://zero-k.info/users/lobbydetail/Kyubey Kyubey]

The main purpose of this release is to broaden [[Rover Assembly|Vehicle]] play to units beyond the Scorcher and to fix Panther. With a range reduction it is much less able to kite raiders, forcing the Vehicle player to invest in other counters. Panther has been significantly reworked because the unit was never well designed in the first place.

Feedback on these changes has been good so it is time for a release! Panther may not be done but it is a lot better than it was before.

=Balance=
====[[Scorcher]]====
* Range: 310 -> 270
* Heatrays are more intelligent, when targeting they have an increased bias towards closer targets.

====[[Ripper|Leveler]]====
* Reload time: 2 -> 1.8 s
* Speed: 2 -> 2.2
* Impulse: 0.5 -> 0.6

====[[Panther]]====
* Reverted to old version as base for the following changes:
** Speed: 3.9 -> 3.7
** Damage: 160 -> 220
** EMP damage: 800 -> 500
** Reload time: 2 -> 3
** Has a death explosions with 256 AoE and 600 EMP damage

====[[Kodachi]]====
* Initial impact AoE: 72 -> 128 (to match ground burn AoE)
* Projectile speed: 320 -> 400

====[[Duck]]====
* Damage 400 -> 430, this makes it 1 shot Mexes, Scorcher and itself.

====[[Funnelweb]]====
* Range 700 -> 420

====[[Commander|Commanders]]====
*Light Particle Beam
** Damage: 40 -> 41 - now one-shots Fleas
** Range: 385 -> 330
** Cost: 100 -> 50

*Torpedo Launcher
** Damage: 180 -> 405 - one-shots Ducks
** Reload time: 1.2 -> 2.7

*Slow Beam:
** Range: 400 -> 450
** Reload time: 1.5 -> 1.40625

*Disruptor Beam
** Real damage: 250 -> 225

====[[Conch|Clam]]====
* Clam renamed to Conch

= Graphics =
* Comm literal nametags can be turned off in options
* Edge Extension: Brightness can be configured when using realistic texture

= GUI =
* Fixed incorrect display of unit names in tooltip with non-English languages
* Fixed Core Selector buttons doing things even if moused was moved off button and released
* Wind output is displayed in the tooltip during placement.
* Added a numerical metal point display option.

= Sound =
* New weapon sounds for [[Scallop]] as well as Commander HMG and Shotgun (thanks [http://zero-k.info/users/lobbydetail/Superintendent Superintendent]).
* New commander under attack siren sound.
* Unit selection, order received and commander under attack volumes are configurable through the menu.

= Fixes =
* Fixed Hermit being referred to by its old name in the [[Spider Factory]]'s helptext.

{{Navbox changelog}}

V1.2.1.1

2019-01-12T08:14:47Z

Shaman: /* Fixes */ Spider factory link

"new zk build has delicious balance... it feels wonderfull to play the game" - [http://zero-k.info/users/lobbydetail/Kyubey Kyubey]

The main purpose of this release is to broaden [[Rover Assembly|Vehicle]] play to units beyond the Scorcher and to fix Panther. With a range reduction it is much less able to kite raiders, forcing the Vehicle player to invest in other counters. Panther has been significantly reworked because the unit was never well designed in the first place.

Feedback on these changes has been good so it is time for a release! Panther may not be done but it is a lot better than it was before.

=Balance=
====[[Scorcher]]====
* Range: 310 -> 270
* Heatrays are more intelligent, when targeting they have an increased bias towards closer targets.

====[[Ripper|Leveler]]====
* Reload time: 2 -> 1.8 s
* Speed: 2 -> 2.2
* Impulse: 0.5 -> 0.6

====[[Panther]]====
* Reverted to old version as base for the following changes:
** Speed: 3.9 -> 3.7
** Damage: 160 -> 220
** EMP damage: 800 -> 500
** Reload time: 2 -> 3
** Has a death explosions with 256 AoE and 600 EMP damage

====[[Kodachi]]====
* Initial impact AoE: 72 -> 128 (to match ground burn AoE)
* Projectile speed: 320 -> 400

====[[Duck]]====
* Damage 400 -> 430, this makes it 1 shot Mexes, Scorcher and itself.

====[[Funnelweb]]====
* Range 700 -> 420

====[[Commander|Commanders]]====
*Light Particle Beam
** Damage: 40 -> 41 - now one-shots Fleas
** Range: 385 -> 330
** Cost: 100 -> 50

*Torpedo Launcher
** Damage: 180 -> 405 - one-shots Ducks
** Reload time: 1.2 -> 2.7

*Slow Beam:
** Range: 400 -> 450
** Reload time: 1.5 -> 1.40625

*Disruptor Beam
** Real damage: 250 -> 225

====[[Conch|Clam]]====
* Clam renamed to Conch

= Graphics =
* Comm literal nametags can be turned off in options
* Edge Extension: Brightness can be configured when using realistic texture

= GUI =
* Fixed incorrect display of unit names in tooltip with non-English languages
* Fixed Core Selector buttons doing things even if moused was moved off button and released
* Wind output is displayed in the tooltip during placement.
* Added a numerical metal point display option.

= Sound =
* New weapon sounds for [[Scallop]] as well as Commander HMG and Shotgun (thanks [http://zero-k.info/users/lobbydetail/Superintendent Superintendent]).
* New commander under attack siren sound.
* Unit selection, order received and commander under attack volumes are configurable through the menu.

= Fixes =
* Fixed Hermit being referred to by its old name in [[Spider Factory]] helptext

{{Navbox changelog}}