Difference between revisions of "Map Creation"

From Zero-K
Jump to navigation Jump to search
(Fixed 7zip link, autoplacer link, increased heading level, moved additional links to the bottom of the page, gave springrts links some descriptions (so at least you think you know why you're clicking).)
Line 1: Line 1:
Also see:
+
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:
 
 
* [[ZK Map Making Guide]]
 
* [https://docs.google.com/document/d/1PL8U2bf-c5HuSVAihdldDTBA5fWKoeHKNb130YDdd-w/edit# Advanced guide using WorldMachine], by Beherith
 
 
 
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 unziped with [https://www.7-zip.org/download.html| 7zip]. Maps can contain more than their three image files, including:
 
 
* Metal spot layout.
 
* Metal spot layout.
 
* Start area configuration.
 
* Start area configuration.
Line 10: Line 5:
 
* Arbitrary code and units changes that can arbitrarily modify the game. See [[Mod Creation]].
 
* Arbitrary code and units changes that can arbitrarily modify the game. See [[Mod Creation]].
  
= Creating maps =
+
== Creating maps ==
Beginner mapping tutorial for SpringRTS is located here: https://springrts.com/wiki/Mapdev:Tutorial_Simple
+
Beginner mapping tutorial for SpringRTS (the engine) is located here: [https://springrts.com/wiki/Mapdev:Tutorial_Simple Simple tutorial].
 
 
Ask for help in #zkmap in on the [https://discord.gg/xCUAvnQT4Z| Zero-K Discord server].
 
 
 
Here are some SpringRTS (the engine) links [https://springrts.com/wiki/Mapdev:Main] [https://springrts.com/wiki/Map,_Game,_And_Unit_Development_Programs#Map_Creation]
 
  
== Startboxes ==
+
SpringRTS site contains other useful information for [https://springrts.com/wiki/Mapdev:Main map development] and lists some [https://springrts.com/wiki/Map,_Game,_And_Unit_Development_Programs#Map_Creation tools to help with map creation].
  
Startboxes are loaded from /mapconfig/map_startboxes.lua and can be generated ingame with the Startbox Editor widget included with the game. Alt-F11 to toggle.
+
Ask for help in #zkmap in on the [//discord.gg/xCUAvnQT4Z| Zero-K Discord server].
  
Full guide for the startbox editor here: [[Startbox API]]
+
=== Startboxes ===
 +
{{See|Startbox API}}
  
== Metal Configuration and Spot Graphics  ==
+
Startboxes are loaded from /mapconfig/map_startboxes.lua and can be generated ingame with the Startbox Editor widget included with the game. {{key combo|Alt|F11}} to toggle.
  
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 [https://github.com/The-Yak/mexes_grounddecal_autoplacer | TheMooseIsLoose's github.]
+
=== Metal Configuration and Spot Graphics  ===
  
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 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 /mapconfig/map_metal_layout.lua
+
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.
  
= Running maps =
+
=== Multiplayer ===
== Local testing ==
 
To run a map locally put it in <code>Zero-K/Maps</code> then start the game. Untick 'Only featured maps' 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.
 
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.
  
= Links =
+
== 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]]
 
* [[User:Aquanim/WaterMapDesign|Some subjective comments on design of sea maps, by Aquanim]]
  
 
{{Navbox manual}} [[Category: Development]]
 
{{Navbox manual}} [[Category: Development]]

Revision as of 19:11, 22 July 2023

Maps are 7z archives which, at their most basic, consist of three image files packaged in a particular way. They can be found in Zero-K/Maps and be zipped or unzipped with 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

Beginner mapping tutorial for SpringRTS (the engine) is located here: Simple tutorial.

SpringRTS site contains other useful information for map development and lists some tools to help with map creation.

Ask for help in #zkmap in on the Zero-K Discord server.

Startboxes

Further information: Startbox API

Startboxes are loaded from /mapconfig/map_startboxes.lua and can be generated ingame with the Startbox Editor widget included with the game. ‎Alt + F11‎ to toggle.

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 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 ‎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 /mapconfig/map_metal_layout.lua.

Running maps

Local testing

To run a map locally put it in Zero-K/Maps then start the game. Untick 'Only featured maps' in Settings → Lobby 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