Cold Takes is a series of design blog posts started by GoogleFrog in December 2023. Links are below, but someone should probably copy them to the wiki before Steam reorganises itself (hint hint).

* {{blog post link|//store.steampowered.com/news/app/334920/view/3868091084290486602|Cold Take|1 - Why Zero-K}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/3875973926280115016|Cold Take|2 - Quant's Rule}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/3887234011192023190|Cold Take|3 - Fight your opponent, not the UI}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/3887234011247278813|Cold Take|4 - Factories as Factions}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/3990819338898810107|Cold Take|5 - Making Metal}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/3958168875487633267|Cold Take|6 - Physics vs. Formulas}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/6001679204174153483|Cold Take|7 - Jumpjets and Jumplegs}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/4102287868180887053|Cold Take|8 - Smoothly Flowing Economy}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/5969030636156442045|Cold Take|9 - Energy as Supply}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/4205874461249023268|Cold Take|10 - The Smartest Unit in Zero-K}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/4202498029349040781|Cold Take|11 - The Atomic Solution to Monospam}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/6398004206839876250|Cold Take|12 - Mighty Morphing}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/4155212770698415116|Cold Take|13 - Pro-Simplicity, Anti-Nuke}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/4268931197552327328|Cold Take|14 - Free Factories For All}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/4356753927297880954|Cold Take|15 - Experiences With Veterancy}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/4356753927297594043|Cold Take|16 - Aim and Fire}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/4268936271617655343|Cold Take|17 - Tactical and Strategic Cloaking}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/4577434114386644037|Cold Take|18 - Terrain Matters}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/4683271241468857961|Cold Take|19 - Game Jams}}
* {{blog post link|//store.steampowered.com/news/app/334920/view/4518891123292895731|Cold Take|20 - Teamwork By Default}}
* [https://store.steampowered.com/news/app/334920/view/542221535791809338 Cold Take #21 - To See What You Can See]
* [https://store.steampowered.com/news/app/334920/view/714486304366133275 Cold Take #22 - Radar and the Limits of Vision]
* [https://store.steampowered.com/news/app/334920/view/524210941165831358 Cold Take #23 - Against Space]
* [https://store.steampowered.com/news/app/334920/view/507324341817443814 Cold Take #24 - Balancing Burst Breakpoints]
* [https://store.steampowered.com/news/app/334920/view/507326244048601493 Cold Take #25 - Completely Free]
* [https://store.steampowered.com/news/app/334920/view/507328146461165192 Cold Take #26 - Reliable Raven]
* [https://store.steampowered.com/news/app/334920/view/507330049932789813 Cold Take #27 - Widgets and Gadgets]
* [https://store.steampowered.com/news/app/334920/view/507331952079012159 Cold Take #28 - Vehicles and Bots]
* [https://store.steampowered.com/news/app/334920/view/833845096900198411 Cold Take #29 - Aircraft, Ammo, and AA]
* [https://store.steampowered.com/news/app/334920/view/507335756658771149 Cold Take #30 - Base Building Blocks]
* [https://store.steampowered.com/news/app/334920/view/507337659552629023 Cold Take #31 - Terraform]
* [https://store.steampowered.com/news/app/334920/view/526480042764534121 Cold Take #32 - Stun and Lightning]
* [https://store.steampowered.com/news/app/334920/view/516348030198220274 Cold Take #33 - Give It Slow]
* [https://store.steampowered.com/news/app/334920/view/503965668093200937 Cold Take #34 - Build a Navy]
* [https://store.steampowered.com/news/app/334920/view/607550616118493223 Cold Take #35 - Shields as Spherical Shells]
* [https://store.steampowered.com/news/app/334920/view/518611248440410918 Cold Take #36 - Bounding the Strategic Triangle]
* [https://store.steampowered.com/news/app/334920/view/534375749569742658 Cold Take #37 - Scouting Trouble]
* [https://store.steampowered.com/news/app/334920/view/535503548435137211 Cold Take #38 - Avoid State Toggles]
* [https://store.steampowered.com/news/app/334920/view/505106153175254923 Cold Take #39 - Special Abilities]

[[Category:Cold Takes|#]]

Cold Takes

2026-03-15T00:24:12Z

GoogleFrog:

Cold Takes

2026-02-22T00:52:31Z

GoogleFrog:

Cold Takes

2026-01-31T22:54:38Z

GoogleFrog:

Model Guidelines

2025-11-24T11:43:59Z

GoogleFrog:

Here are some things to be aware of when creating new models for ZK.

== General Guidelines ==

* Aim for some consistency with the best models of a given class. Eg among units of a factory, or the set of turrets. A remodel of multiple things at once can get around this, but that is not where people tend to start.
* Try to maintain a consistent sense of scale. This is by no means uniform across ZK, but there is a rough absolute scale for things like flat plates, body molding, and greebles. The complexity of the model should try to match its contemporaries.
* Weapons should be large. Weapon orientation is the primary information and source of dynamism for a model. Units are viewed from a distance so even weapons that look too large close up in modelling software are probably fine.
* When creating a new model, consider the position of its weapons. Horizontally offset weapons can be tricky and end up firing at allies (eg Chainsaw).
* Ground cannot be wider or longer than Cyclops, which is why Striders mostly extend upwards.
* Structure footprints are rectangular. This should be accepted and even communicated to the player, but it can be communicated subtly. Eg Disco Rave Party is mostly round but has an octagonal base. Models should not hide the underlying mechanics.
* Fast units look fast, high health:cost units look tough, etc...

== Remake Guidelines ==

Be aware that models have a direct impact on game balance. We are not looking to rebalance Zero-K around new models at this point, so it can be good to ask around about a unit to determine its important characteristics. More care has to be taken for cheaper units as their balance tends to be tighter. Striders have quite a bit of room to move.
* The collision box of the model determines how easy it is to hit, so a remodel should be approximately the same size and shape.
* The footprint of a structure impacts how well raiders can dance around it, as well as how expensive it is to wall or put on a platform.
* Projectiles really come from the weapons they are fired from. The height and offset from which a weapon fires can be quite important.
* Aiming is a physical process that involves turning the model. It is safest to stick to he same skeleton if possible.
* If a unit has a special ability, such as gaining armour, then this should be reflected on the model.
* Don't add things to a unit that implies the existence of a non-existent special ability.

Models also imply things about the character of units. This is also good to maintain as balance shifts towards the visuals of the previous model to some degree.
* Healthy units are usually bulky.
* Units that turn or aim slowly should look cumbersome.

Model Guidelines

2025-11-24T11:41:47Z

GoogleFrog:

Here are some things to be aware of when creating new models for ZK.

== General Guidelines ==

* Aim for some consistency with the best models of a given class. Eg among units of a factory, or the set of turrets. A remodel of multiple things at once can get around this, but that is not where people tend to start.
* Try to maintain a consistent sense of scale. This is by no means uniform across ZK, but there is a rough absolute scale for things like flat plates, body molding, and greebles. The complexity of the model should try to match its contemporaries.
* Weapons should be large. Weapon orientation is the primary information and source of dynamism for a model. Units are viewed from a distance so even weapons that look too large close up in modelling software are probably fine.
* When creating a new model, consider the position of its weapons. Horizontally offset weapons can be tricky and end up firing at allies (eg Chainsaw).
* Ground cannot be wider or longer than Cyclops, which is why Striders mostly extend upwards.
* Structure footprints are rectangular. This should be accepted and even communicated to the player, but it can be communicated subtly. Eg Disco Rave Party is mostly round but has an octagonal base. Models should not hide the underlying mechanics.
* Fast units look fast, high health:cost units look tough, etc...

== Remake Guidelines ==

Be aware that models have a direct impact on game balance. We are not looking to rebalance Zero-K around new models at this point, so it can be good to ask around about a unit to determine its important characteristics. More care has to be taken for cheaper units as their balance tends to be tighter. Striders have quite a bit of room to move.
* The collision box of the model determines how easy it is to hit, so a remodel should be approximately the same size and shape.
* Projectiles really come from the weapons they are fired from. The height and offset from which a weapon fires can be quite important.
* Aiming is a physical process that involves turning the model. It is safest to stick to he same skeleton if possible.
* If a unit has a special ability, such as gaining armour, then this should be reflected on the model.
* Don't add things to a unit that implies the existence of a non-existent special ability.

Models also imply things about the character of units. This is also good to maintain as balance shifts towards the visuals of the previous model to some degree.
* Healthy units are usually bulky.
* Units that turn or aim slowly should look cumbersome.

Model Guidelines

2025-11-24T11:39:15Z

GoogleFrog: Created page with "Here are some things to be aware of when creating new models for ZK. == General Guidelines == * Aim for some consistency with the best models of a given class. Eg among unit..."

Here are some things to be aware of when creating new models for ZK.

== General Guidelines ==

* Aim for some consistency with the best models of a given class. Eg among units of a factory, or the set of turrets. A remodel of multiple things at once can get around this, but that is not where people tend to start.
* Try to maintain a consistent sense of scale. This is by no means uniform across ZK, but there is a rough absolute scale for things like flat plates, body molding, and greebles. The complexity of the model should try to match its contemporaries.
* Weapons should be large. Weapon orientation is the primary information of a unit model, and they are viewed from a distance.
* When creating a new model, consider the position of its weapons. Horizontally offset weapons can be tricky and end up firing at allies (eg Chainsaw).
* Ground cannot be wider or longer than Cyclops, which is why Striders mostly extend upwards.
* Structure footprints are rectangular. This should be accepted and even communicated to the player, but it can be communicated subtly. Eg Disco Rave Party is mostly round but has an octagonal base. Models should not hide the underlying mechanics.

== Remake Guidelines ==

Be aware that models have a direct impact on game balance. We are not looking to rebalance Zero-K around new models at this point, so it can be good to ask around about a unit to determine its important characteristics. More care has to be taken for cheaper units as their balance tends to be tighter. Striders have quite a bit of room to move.
* The collision box of the model determines how easy it is to hit, so a remodel should be approximately the same size and shape.
* Projectiles really come from the weapons they are fired from. The height and offset from which a weapon fires can be quite important.
* Aiming is a physical process that involves turning the model. It is safest to stick to he same skeleton if possible.
* If a unit has a special ability, such as gaining armour, then this should be reflected on the model.
* Don't add things to a unit that implies the existence of a non-existent special ability.

Models also imply things about the character of units. This is also good to maintain as balance shifts towards the visuals of the previous model to some degree.
* Healthy units are usually bulky.
* Units that turn or aim slowly should look cumbersome.

Cold Takes

2025-11-16T00:29:37Z

GoogleFrog:

Cold Takes

2025-10-26T01:12:25Z

GoogleFrog:

Map Creation

2025-10-19T00:13:33Z

GoogleFrog: /* Creating maps */

Maps are 7z archives which, at their most basic, consist of three image files packaged in a particular way. They can be found in <code>Zero-K/Maps</code> and be zipped or unzipped with [https://www.7-zip.org/download.html 7zip]. Maps can contain more than their three image files, including:
* Metal spot layout.
* Start area configuration.
* Tree, rock or any other models to be placed as map features.
* Arbitrary code and units changes that can arbitrarily modify the game. See [[Mod Creation]].

== Creating maps ==
<Removed some links to the old Spring wiki since you would probably get malware if you go there.>

Ask for help in #zkmap in on the [//discord.gg/xCUAvnQT4Z| Zero-K Discord server].

=== Startboxes ===
{{See|Startbox API}}

Startboxes are loaded from /mapconfig/map_startboxes.lua and can be generated ingame with the Startbox Editor widget included with the game. See [[https://zero-k.info/mediawiki/index.php?title=ZK_Map_Making_Guide#Startbox_Editor_Widget Startbox Editor Widget]]

=== Metal Configuration and Spot Graphics ===

Metal spots on maps are done via Lua configs. They can be generated ingame with the dbg_mouse_to_mex_portable.lua widget, available at [//github.com/ForbodingAngel/mexes_grounddecal_autoplacer TheMooseIsLoose's github.]

Download that repo as a zip and extract into your map folder. Load the map in ZK, enable cheats, and then enable Mouse to Mexes in your {{key combo|Alt|F11}} widget menu. Click to create new metal spots, the values and positions will be automatically saved to your game data directory. Copy and paste the content from MexSpots_YourMap to your <code>/mapconfig/map_metal_layout.lua</code>.

== Running maps ==
=== Local testing ===
To run a map locally put it in <code>Zero-K/Maps</code> then start the game. Untick '<samp>Only featured maps</samp>' in <code>Settings → Lobby</code> and start a singleplayer skirmish game. Select 'Advanced', click 'Change Map' and select your map from the list.

=== Multiplayer ===
Upload your map to https://springfiles.springrts.com/upload/ to make it downloadable and playable by others. Some admin action to feature/support the map may also be required.

== See also ==
* [[ZK Map Making Guide]]
* [https://docs.google.com/document/d/1PL8U2bf-c5HuSVAihdldDTBA5fWKoeHKNb130YDdd-w/edit# Advanced guide using WorldMachine], by Beherith
* [[User:Aquanim/WaterMapDesign|Some subjective comments on design of sea maps, by Aquanim]]

{{Navbox manual}} [[Category: Development]]

Startbox API

2025-10-19T00:12:06Z

GoogleFrog:

== Start boxes ==

Each team has a defined starting area in which its players can spawn their commanders—these are called '''start boxes'''. Map makers can define how these areas look by including a configuration file inside their map archive.

== The config file ==

The file that you need to include is
mapconfig/map_startboxes.lua

It consists of Lua code which returns 2 tables: one with the start box layout for the current match and one that contains possible box counts.

For [[#Examples|examples]] see the bottom of this page.

== Box counts ==

Let's start from the last table because it is the simplest. This is just a list of how many teams the map is designed for.

[[File:Throne v1.minimap contrasty.jpg|thumb|High-contrast Throne mini-map showing the map's "rings."]]
Let's take [http://zero-k.info/Maps/Detail/8162 Throne] map as an example. It has an outer ring with 7 starting areas, so it can be played as a 7-team <abbr title="free for all">FFA</abbr>. There are also rings with 3 and 5 areas so 3- and 5-team FFAs are also possible setups. Finally, you could play a duel between any two positions from the same ring. (The real Throne config is a fair bit more complicated than that, but you get the idea.)

Thus, the possible team counts are 2, 3, 5, and 7. Let's define a Lua table for that:
<syntaxhighlight lang="lua">local playercounts = {2, 3, 5, 7}</syntaxhighlight>

This is mostly important for fancy FFA maps. Simple duel/teamgame maps will usually just have 2 as the only value here:
<syntaxhighlight lang="lua">local playercounts = {2}</syntaxhighlight>

== The widget ==
Load your map in ZK, open the ingame menu (F10), untick "Simple Settings" at the bottom, and navigate to "Settings/Toolbox". Click "Toggle Start Zone Editor", this should cause a new submenu to appear. Navigate to "Settings/Toolbox/Startbox Editor" then click "Use Mouse" to enable startbox editing. The startbox editor submenu contains instructions and the buttons have tooltips. The buttons can be clicked or have hotkeys set, like any other menu button, some suggested hotkeys are below.

[[Image:Find_startbox_editor.png]] [[Image:Startbox_editor.png]]

== The boxes ==

Now, the most tedious part. The boxes do not need to actually be boxes, they can be any arbitrary shape (even concave or disjoint). This is achieved by having the boxes defined as a set of polygons.

To draw a polygon using the left mouse button—either drag a line or click points:

[[File:Startbox API 1.jpg]]

Once you draw a full loop, press the right mouse button to close it. Make sure the line does not cross itself. Finished polygons are a bit darker.

[[File:Startbox API 2.jpg]]

Now you can add another polygon if you want. These will all be a part of the same team.

[[File:Startbox API 3.jpg]]

If you want to delete the last created polygon, press {{key press|D}}.
Once you are satisfied with the area, press {{key press|S}}. Now you can draw the area for another team.

Once you create all the boxes, go to your Spring directory and find the infolog. There you will see a bunch of code like
<syntaxhighlight lang="lua">boxes = {
stuff
},</syntaxhighlight>

Each of those tables is a team's start box. The config is an array of each team's start box data. The box data from the generator will go to a team's config entry. Like this:
<syntaxhighlight lang="lua">local main_config = {
{
boxes = {
stuff
},
-- more entries will go there later!
},

-- another team's box data
{
boxes = {
stuff
},
},
}</syntaxhighlight>

The layout is a normal Lua table so you can use all the usual table manipulation methods. For example, you could add more areas based on how many people there are, or generate them dynamically.

== The recommended start points ==

This sub-table defines recommended start points within each box. These are points on which CAI bots will spawn. The first point is special: human players who did not pick start position will also spawn here and so will any extra CAI if there are more of them than the spots; as such having at least one start point in each box is mandatory. These points are also marked on people's UI as circles.

Defining these is very simple. It's very similar to how start areas were defined. In game, you can hold Space over a point to see its coordinates. These are written down for boxes similarly to the areas:
<syntaxhighlight>local main_config = {
{
boxes = {
stuff
},
startpoints = {
{123, 456}, -- X, Z
{654, 321},
-- as many as you want, it's good if there are as many as you want people per team
},
},
{
boxes = {
stuff
},
startpoints = {
{789, 789},
{987, 987},
},
},
}</syntaxhighlight>

Of course, the start positions should match the areas, though they don't have to.

== Team names ==

You can give each team a name, alongside a shorter backup if the first one is too large. Here's how:

<syntaxhighlight lang="lua">{
boxes = { stuff },
startpoints = { stuff },
nameLong = "Southwest",
nameShort = "SW",
}</syntaxhighlight>

It serves to identify the team, so while it's good to use something that describes placement, you can get creative. For example:
* "North", "Southeast"
* "5 o'clock"
* real-world style maps could have names like "Russia" or "America"
* asymmetric maps can use landmarks, for example "Lake" vs "Desert"
* for missions, it's good to use storyline names, e.g. "Empire" vs "Dynasty"

== Summary ==

Now just return the ''config'' table and the ''playercounts'' table.
<syntaxhighlight lang="lua">return main_config, playercounts</syntaxhighlight>

The exact format for the config table that should get returned is

<syntaxhighlight lang="lua">{
{ -- a single team's data
boxes = {
{ -- a polygon
{123, 456}, -- a vertex of the polygon. X, Z.
{234, 567}, -- another vertex
{345, 678},
-- more vertices
},
{ -- another polygon
-- vertices
},
-- more polygons
},
startpoints = {
{123, 456}, -- X, Z
{654, 321},
-- more points
},
nameLong = "longer string with team name",
nameShort = "short",
},
{ -- another team's data
boxes = { ... },
startpoints = { ... },
nameLong = "...",
nameShort = "...",
},
-- more teams
}</syntaxhighlight>

== Advanced stuff ==
The config has access to Spring Lua API, so it is possible to do a lot of dynamic things. In particular, you can use <syntaxhighlight lang="lua" inline>math.random</syntaxhighlight> without worry.

You can make stuff dependent on the game mode. There are functions which return the game type, such as "<syntaxhighlight lang="lua" inline>Spring.Utilities.Gametype.is1v1()</syntaxhighlight>".

An important thing is that <syntaxhighlight lang="lua" inline>#Spring.GetAllTeams()</syntaxhighlight> will return a wrong value due to fake technical teams and Gaia. Instead, use <syntaxhighlight lang="lua" inline>Spring.Utilities.GetTeamCount()</syntaxhighlight> to get the real number of teams.

== Examples ==

* [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Configs/StartBoxes/SpeedMetal.lua SpeedMetal] - the simplest layout, just two squares.
* [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Configs/StartBoxes/DeltaSiegeDry.lua DSD] - huge polygons, but otherwise very simple.
* [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Configs/StartBoxes/Sever%201.lua#L343 Sever] - shows an example of smaller boxes for 1v1 and larger for teams.
* [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Configs/StartBoxes/Isle%20of%20Grief%200.2.lua Isle of Grief] - shows a smart approach, one of the boxes is not defined rigidly but is a mirror of the other (only really feasible for rough boxes or perfectly symmetrical maps).
* [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Configs/StartBoxes/Aum_1.1.lua Aum] - another small trick, this time 5-way radial symmetry.
* [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Configs/StartBoxes/Throne%20v1.lua Throne] - multiple boxes defined, with a system to pick some of them based on how many teams there are.
* [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Configs/StartBoxes/Speed_Ball_10x10.lua Speedball] - shows boxes that are generated completely algorithmically.
* [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Configs/StartBoxes/Mearth_v4.lua#L6 Middle-Earth] - interesting team names.
* [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Configs/StartBoxes/Adansonia%20v2.lua Adansonia v2] - shows synchronizing boxes across map versions.
* [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Configs/StartBoxes/duck.lua Duck] - boxless config for silly maps where everybody can start anywhere.

[[Category:Development]]{{Navbox manual}}

ZK Map Making Guide

2025-10-18T23:53:54Z

GoogleFrog: /* Startbox Editor Widget */

Also see:

* [[Map Creation]]
* [https://docs.google.com/document/d/1PL8U2bf-c5HuSVAihdldDTBA5fWKoeHKNb130YDdd-w/edit# Advanced guide using WorldMachine], by Beherith

DISCLAIMER: This guide is a work in progress (particularly with respect to using particular pieces of software) but the basic framework here should give you a good start.

= Minimal Brief Guide =

For more detail on each of these steps read the later sections of the document.

This guide assumes that you are using a version of Zero-K installed through Steam. You can still make maps if you installed by some other method but you may need to modify some of the later steps.

If you want to see what the map's file structure is meant to look like overall, scroll to the [[https://zero-k.info/mediawiki/index.php?title=ZK_Map_Making_Guide#Skeleton_Of_A_Map Skeleton Of A Map]] section. It's also a good idea to un7zip some existing maps and take a look to see how they are set up (and borrow anything which seems useful for your map).

== Download Tools ==

* 7zip - https://www.7-zip.org/download.html
* pymapconv - clone or download https://github.com/Beherith/springrts_smf_compiler somewhere, then copy pymapconv.exe and nvdxt.exe to a new directory to keep things simple
* map blueprint - clone or download https://github.com/Aquanim/ZKMapBlueprint

[[File:Mapguide_download_aquanim_blueprint.png|Map blueprint download]]

== Create Images ==

For a 10x10 (TitanDuel-size) map, create the following images with a tool of your choice:

* A height map grayscale image with dimensions 641 x 641, saved as an 8-bit ".bmp" or a 16-bit ".png". (The latter is preferred but not all tools offer 16-bit output.) The brighter a pixel is the higher the corresponding part of the map will be.
* A texture map colour image with dimensions 5120 x 5120, saved as a ".bmp" . Using the program provided in the wiki (pymapconv.exe) it is possible to use a regular ".png" file, with alpha channel removed.

For a different size map, multiply the height/width of the map by 64 and add 1 to get the right size for the heightmap; multiply the height/width of the map by 512 to get the right size for the texture map.

Different image formats ''might'' work but are just as likely to cause difficult-to-diagnose errors.

Put these images in the same directory as pymapconv.exe from the previous step (may not strictly be required but keeps things simple).<br />

Useful tools: Spring Map Edit (SME), Springboard, TerreSculptor, World Machine, GIMP, Blender, any image editing software really

== Compile Your Map ==
Run pymapconv.exe and fill in the following fields...
* An output file name - ideally this should be the name of your map, possibly with a version number. File extension .smf, will also generate a .smt. '''IMPORTANT:''' Do not rename these files after compiling!
* Use the buttons to select the texture and heightmap images you made in the previous step.
* I expect the minimum/maximum height values to be overridden by mapinfo.lua later but you might as well set them.
* Scroll down to the NVDXT option and make sure it says "-Sinc -quality_highest". Also probably a good idea to tick the CLEAN option.
* Untick everything else, press "Save options as" if you like, then press the "Compile" button.<br />

Troubleshooting:
* If your map's minimap looks like it is from an old version of your map or a different map entirely, there is probably an old minimap file which the compiler is reading. In the directory where your compiler .exe is, delete any images which look like a minimap (probably something like mini.bmp and/or mini.dds) then recompile.
* If your map texture looks all pinkish ingame you probably renamed the .smf and .smt files. Regenerate them and be extra sure not to rename them this time. If the issue persists there might be other reasons this can happen, consult the #zkmap channel.

== Construct .sdd File ==
* Rename ZKMapBlueprint_v0.0.sdd to have the name of your map. A version identifier is advisable as well. Keep the .sdd extension.
* Copy the .smf and .smt files produced by pymapconv.exe into the /maps subfolder of the .sdd folder. (There should be mapblueprint.smf and mapblueprint.smt files here, you can delete them.)
* In the root of the .sdd folder there should be a file "mapinfo.lua". Open this with a text editor. This file contains a bunch of stuff but there are only a few items we are interested in for now:
** Near the start of the file change the ''author'', ''description'', ''name'', ''shortname'' and ''version'' variables to suit you and your map.
** Scroll down a bit to the "smf" section and change the ''maxheight'' and ''minheight'' numbers to suit your map. Also change the file name after ''smtFileName0'' so that it has your .smt file's name.
* To test your map, copy the .sdd directory into the /maps folder of your Zero-K install. In the settings make sure that "Only featured maps" is disabled. Then open a Skirmish game, click on the current map, select your map from the list, and play. (You might want to make the enemy AI inactive. The minimap in the lobby will be blank, don't worry about this for now.)
* If you want to change your map you will need to replace the files in your ZK maps folder, then restart ZK, in order to load the new version.

== Metal and Startboxes ==
Now that you can look at your height and texturemap ingame this is a good time to sort out your metal spots and start locations.
=== Metal spots ===
In the /mapconfig subfolder of the .sdd file there is a "map_metal_layout.lua" file. The blueprint contains two metal spots as an example; replace them with your own.

=== Startboxes ===
In the /mapconfig subfolder of the .sdd file there is a "map_startboxes.lua" file. This specifies each team's startboxes as well as default start locations.

Some hints for configuring the metal and startbox files:

* Startboxes are specified by their corner points reading clockwise around the polygon. More than one separate box for a given team is possible.
* Holding SPACE ingame will display a dialog box which (among other things) gives the X and Z coordinates of wherever your cursor is.
* The metal and startbox files are just LUA scripts. This means you don't have to write simple numbers to specify locations; you can perform arithmetic to make sure your map setup is symmetric (the startbox of the South-East team in the blueprint is an example). More advanced scripting is also possible, for example to make your startbox configuration dependent on the number of players or allyteams. See the [[http://zero-k.info/mediawiki/index.php?title=Startbox_API#Advanced_stuff Startbox API page]] .

=== Useful Tools ===

[[https://zero-k.info/mediawiki/index.php?title=ZK_Map_Making_Guide#Startbox_Editor_Widget Startbox Editor Widget]]
[[https://zero-k.info/mediawiki/index.php?title=ZK_Map_Making_Guide#Metal_Spot_Placer Metal Spot Placer]]

== Optional Extras ==
Scroll down to section 3 to see how to add...
* Features (geovents, trees, rocks, etc)
* DNTS (fancy map details and specular map)
* Fancy mapinfo stuff (lighting, water effects, etc)
* Skybox
* Other nonsense (particle effects, sound, etc)
* Lava

== Upload ==

Compress the contents of the .sdd file into a 7z, then change the file extension to “.sd7”.

If you remove the .sdd from your game maps directory and put the .sd7 in its place, the map should still work. It is a good idea to test the .sd7 before uploading since there are several *very* easy mistakes to make in the compression process.

'''IMPORTANT:''' Make sure that when you open the archive you see mapinfo.lua and not your .sdd folder! If you get this wrong the map will not work correctly. If you get an error saying that a .smd file is missing this is probably the problem.

'''IMPORTANT:''' When you compress to 7z make sure the compression is “non-solid”. If using 7zip this is done by setting the "Solid Block size" option to "non solid".

=== Uploading to Zero-K Server ===

* Go to https://zero-k.info/Maps
* Scroll down until you find the "Upload map or game (sd7 or sdz):" file on the right-hand side
* Upload your map
* Test your map on the live server so there is a publically accessible replay or two - games against AIs are fine
* Ask a moderator to support/feature your map (they will also tag it as 1v1/teams/hilly/flat/whatever as appropriate)

If the upload step doesn't work there are two potential reasons:
* Your map isn't set up right. Test it locally again and make sure your map works.
* Something on the server has gone wrong. AFTER testing your map locally and finding that it works there, contact an admin. Uploading your map to a file-sharing service so the admin can look at it may help.

=== For use in other Spring/Recoil games ===

Consult the developers of whatever game you play to find out where they keep their maps these days. Then upload there.

= Skeleton Of A Map =

All you *really* need is the stuff in solid grey boxes: mapinfo.lua, .smf and .smt files, a metal layout, and a startbox config.

[[File:Mapskeleton.png|The skeleton of a map]]

(Note: Some of the things labelled as "necessary" probably technically aren't; there are many ways to construct a map that Spring will accept. This guide will walk you through one that should be reasonably coherent and up to date.)

= Tools and Resources =

== Springboard ==

[https://springboard-core.readthedocs.io/en/latest/installing.html Springboard Documentation]

[[Springboard Tutorial]] on this wiki (under construction)

=== Installation ===
[https://github.com/Spring-SpringBoard/SpringBoard-Core/ Github page]
Scroll down to the "Installing" section and get the appropriate installer.

== SpringMapEdit ==

No safe link to this known as of Jul 2023. RIP

== Nobiax Texture Pack ==

== Startbox Editor Widget ==
Load your map in ZK, open the ingame menu (F10), untick "Simple Settings" at the bottom, and navigate to "Settings/Toolbox". Click "Toggle Start Zone Editor", this should cause a new submenu to appear. Navigate to "Settings/Toolbox/Startbox Editor" then click "Use Mouse" to enable startbox editing. The startbox editor submenu contains instructions and the buttons have tooltips. The buttons can be clicked or have hotkeys set, like any other menu button, some suggested hotkeys are below.

[[Image:Find_startbox_editor.png]] [[Image:Startbox_editor.png]]

== Metal Spot Placer ==
Load your map in ZK, press Alt-F11 to access the widget list, press "Search" and enter "Metal Spot". Enable the Metal Spot Placer widget. As per the ingame description:
* Press Alt-M to enable the widget
* Click in locations on the map to place metal points
* Press Alt-M again to disable the widget and print a list of metal points to the infolog

Then open your infolog.txt (in the main zero-k directory) after you exit to retrieve the startbox information for copying into map_metal_layout.lua. Check that the metal point values for each mex point are as you want them to be. It's probably a good idea to turn the widget off after you are done with it.

== Upspring ==

A tool for modifying models like those of tree features, etc. Might be useful if a feature is too large, too small, or not centered properly. I'll leave this guide to somebody who actually understands modelling.

= Other Stuff =

== Features (geovents, trees, rocks, etc) ==

This method of placing features requires you to have some s11n gadgets in /LuaRules/Gadgets and some s11n and lcs stuff in the /libs/ folder. If your map doesn't have these then get them from the blueprint or some other map.

* Put the files defining the features you want in your map file. This includes a definition in the /features subdirectory, model files in the /objects3d directory, and textures in the /unittextures directory. The easiest way to get these is to borrow them from existing maps or from the features library [https://github.com/Spring-Helper-Projects/spring-features here].
* Load your map in Springboard
* Delete any features you have marking mex locations, otherwise you will end up with two copies of them and that is bad.
* Place features using Springboard.
* Open the "Export" window in Springboard, choose a file name, set the file type to "s11n object format" and export the file.
* The file will (probably?) have been exported to <springboard exe directory>/data/springboard/exports - copy this s11n file to the ./mapconfig subdirectory of your map.
* Make sure that in ./libs/s11n/s11n_load_map_features.lua that the "modelPath" variable points at your s11n file.

Troubleshooting:
* IF your features do not move when the ground under them is terraformed (a particular problem for geovents) go to ./libs/s11n/features_s11n.lua, look for the "CreateObject" function, and change it so that SetFeatureMoveCtrl is not being used to set MoveCtrl to true.

== DNTS ==

If you don't use DNTS but you do set detailTex in the "resources" section of mapinfo.lua then you will get some general detail map. This works better than flat colour but we can get fancier.

* Put the .dds or .tga files defining the detail map (commonly grass, pebbles, rocks, etc.) you want in your /maps subdirectory. Again these are most easily found by borrowing from other maps. [http://beherith.eat-peet.net/stuff/nobiax_spring_dnts/nobiax_spring_dnts.html This page] has some that may work (possibly with some effort).
* In mapinfo.lua, in the "resources" section, set splatDetailNormalTex1, splatDetailNormalTex2, splatDetailNormalTex3, splatDetailNormalTex4 to point to your detail files. These will in order be defined by the red, green, blue and alpha channels of your distribution image.
* Set splatDistrTex to point to your distribution image. This defines where each detail type appears on your map. This image will be stretched over your map; powers of two in the resolution are advised.
* Set specularTex to point to your specular image; what colour of light will be reflected from each part of the map. It is easy to go overboard with this so taking your texture map, darkening it significantly (or possibly increasing its transparency), and tuning from there is an okay strategy. Again, this image will be stretched over your map; powers of two in the resolution are advised.
* There is also some lightemission thing that I have not used and don't really understand [https://springrts.com/wiki/Mapdev:lightemission here]. The example image looks like Otago so try asking TheMooseIsLoose for advice?

== Water and lighting settings ==

I'm not an expert, tune these for yourself until it looks good. Try reading [https://springrts.com/wiki/Mapdev:water these] [https://springrts.com/wiki/Mapdev:mapinfo.lua#Lighting pages].

== Skybox ==

Borrow one from some other map then set it in mapinfo.lua, atmosphere section, variable "skyBox". If you want to make one yourself apparently pymapconv can put it in the right format.

== Particle and sound effects ==

Find a map that does the thing you want to do, look at how that map did it. For reference some fairly simple examples can be found in Rogues River (sound effects), Aurelian (precipitation), and Mercurial (plumes from the water).

== Lava ==

Good luck... I'm not sure anybody has come up with an entirely bug-free implementation of this yet. Banana Republic might be your best bet for a reference.

== Lobby/Website minimap image ==

This minimap image is generated from your map's texture, but unlike the ingame minimap does not have water drawn on it. If you would like your map's lobby/website image to be different, you need to create replacement images and provide them to somebody with the appropriate server access to overwrite the existing minimaps (not just any admin can do this; you are probably most likely to get a quick response from Aquanim or Anarchid). Ideally you only want to do this once, so wait until your map is up to a final release version before making the replacement image.

Required images for a map called "map name v1.0":
* A minimap image with the name map_name_v1.0.minimap.jpg with maximum height/width 1024.
* A thumbnail image with the name map_name_v1.0.thumbnail.jpg with maximum height/width 96.
'''IMPORTANT:''' Replace any spaces in your map name with underscores.

Find the default images for your map on the server to figure out reasonable dimensions. Screenshotting your ingame minimap and then rescaling it is a reasonable way to get a minimap image with water on it.

{{Navbox manual}} [[Category: Development]]

ZK Map Making Guide

2025-10-18T23:53:22Z

To do a basic bug report do the following:
# Cause the bug to occur. This will often involve running a battle. If you can, put some unique sentence in the chat after you observe the bug, and tell people about this sentence later on.
# If the bug is a crash to desktop then skip to step 6, otherwise continue.
# Navigate back to the main menu of the lobby.
# In the main menu click Help, then click Report A Bug.
# Describe the bug, give the bug a title, and click Submit.
# Click 'Ok' on the Automated crash report dialogue that appears.
# Check the bug report tracker found [https://github.com/ZeroK-RTS/CrashReports/issues here] and find your report. It should be at the top of the page and recent. If all the reports are too old, then try refreshing the page.
# Tell someone about this bug, perhaps in #support in Discord or on the forum. Paste the bug report link from step 7 when you do so.
Taking and attaching a screenshot is vital for visual bugs.

For crashes rather than bugs, skip straight to Step 7.

For a more advanced bug report create a GitHub account and open an issue on the appropriate issue tracker:
* [https://github.com/ZeroK-RTS/Zero-K Bugs in the game itself]
* [https://github.com/ZeroK-RTS/Chobby Bugs in the main menu]
* [https://github.com/ZeroK-RTS/Zero-K-Infrastructure Bugs on the website]
Describe steps to reproduce the bug. Attaching images or linking a video is very helpful.

= Reporting Desync =

Reports of desync are made much more useful with the inclusion of a few files. The player who desynced needs to supply these files so that they can be checked against normal files from another player. The files, relative to the root Zero-K folder (found in steamapps), are:
# The appropriate <code>ClientGameState</code> file in the root directory. These don't have a naming convention, but the first line of the file is the map name, and the file creation date should match the time of the desync.
# Your locally saved replay of the game, found in <code>demos/</code>. The file name contains the name of the map.
# Your<code>infolog.txt</code> file, if the desync happened since the last time the ZK menu was opened. Older logs are found in <code>log/</code>.
# The two path cache files matching the map name, found in <code>cache/paths/</code>.

The battle link is also useful. This can be found under recent battles on your home page when logged in: https://zero-k.info/

Another great help is running the replay and reporting whether the game you see in the replay is the same as the one that happened the first time around.

Cold Takes

2025-03-29T23:22:02Z

GoogleFrog:

Cold Takes

2025-03-08T23:08:18Z

GoogleFrog:

Cold Takes

2025-02-16T00:08:18Z

GoogleFrog:

2024-08-11T00:40:16Z

GoogleFrog:

Cold Takes is a series of design blog posts started by GoogleFrog in December 2023. A new one is released every second Sunday. Links are below, but someone should probably copy them to the wiki before Steam reorganises itself (hint hint).

* [[{{BASEPAGENAME}}/1 - Why Zero-K|Cold Take #1 - Why Zero-K?]] ([//store.steampowered.com/news/app/334920/view/3868091084290486602 Original post on Steam.])
* [[{{BASEPAGENAME}}/2 - Quant's Rule|Cold Take #2 - Quant's Rule]] ([//store.steampowered.com/news/app/334920/view/3875973926280115016 Original post on Steam.])
* [[{{BASEPAGENAME}}/3 - Fight your opponent, not the UI|Cold Take #3 - Fight your opponent, not the UI]] ([//store.steampowered.com/news/app/334920/view/3887234011192023190 Original post on Steam.])
* [[{{BASEPAGENAME}}/4 - Factories as Factions|Cold Take #4 - Factories as Factions]] ([//store.steampowered.com/news/app/334920/view/3887234011247278813 Original post on Steam.])
* [[{{BASEPAGENAME}}/5 - Making Metal|Cold Take #5 - Making Metal]] ([//store.steampowered.com/news/app/334920/view/3990819338898810107 Original post on Steam.])
* [[{{BASEPAGENAME}}/6 - Physics vs. Formulas|Cold Take #6 - Physics vs. Formulas]] ([//store.steampowered.com/news/app/334920/view/3958168875487633267 Original post on Steam.])
* [https://store.steampowered.com/news/app/334920/view/6001679204174153483 Cold Take #7 - Jumpjets and Jumplegs]
* [https://store.steampowered.com/news/app/334920/view/4102287868180887053 Cold Take #8 - Smoothly Flowing Economy]
* [https://store.steampowered.com/news/app/334920/view/5969030636156442045 Cold Take #9 - Energy as Supply]
* [https://store.steampowered.com/news/app/334920/view/4205874461249023268 Cold Take #10 - The Smartest Unit in Zero-K]
* [https://store.steampowered.com/news/app/334920/view/4202498029349040781 Cold Take #11 - The Atomic Solution to Monospam]
* [https://store.steampowered.com/news/app/334920/view/6398004206839876250 Cold Take #12 - Mighty Morphing]
* [https://store.steampowered.com/news/app/334920/view/4155212770698415116 Cold Take #13 - Pro-Simplicity, Anti-Nuke]
* [https://store.steampowered.com/news/app/334920/view/4268931197552327328 Cold Take #14 - Free Factories For All]
* [https://store.steampowered.com/news/app/334920/view/4356753927297880954 Cold Take #15 - Experiences With Veterancy]
* [https://store.steampowered.com/news/app/334920/view/4356753927297594043 Cold Take #16 - Aim and Fire]

[[Category:Cold Takes]]