Spring - User contributions [en]

Mapdev:Main

2016-04-07T21:50:46Z

Eronoobos: /* Technical Documentation */

= Map Development =
Maps are the fields on which the battles are fought, made with the implicit contract that they shall not alter game mechanics. They are made up of images and text files which describe the environment and its features, such as height, colour, background, details features, atmosphere and lighting etc. These images and text files are then compressed into a 7zip archive for distribution.

<center>
{| class="wikitable"
|+In-Game Screenshot
|[[File:Screen00364.jpg|640px]]
|}</center>

= Beginners Tutorial =
This beginners tutorial is split into three parts, the basic stuff, the more advanced basic stuff, and how to compile and create a map archive for distribution. It is intended to get you started, when you are comfortable with the concepts, please look over the technical documentation to further your knowledge.
* [[Mapdev:Tutorial_Simple|Stage 1]]
* [[Mapdev:Tutorial_Intermediate|Stage 2]]
* [[Mapdev:Tutorial_Finalizing|Finalizing]]

= Blueprint =
Due to the amount of boiler plate files needed to create a fairly feature complete map, [[User:Jk|Jk]] has created a blueprint map to get things started
* [https://github.com/jk3064/Map-Blueprint/archive/master.zip Link to blueprint zip]

= Technical Documentation =
; '''General'''
* [[Mapdev:mapinfo.lua|mapinfo.lua]]
* [[Mapdev:set.lua|set.lua]] - feature set
* [[Mapdev:SMT format|SMT format]]
* [[Mapdev:SMF format|SMF format]]
* [[Gamedev:Archives]]
* [[Mapdev:sounds]]
* [[Mapdev:performance]]
* [[springignore.txt]]

; '''Terrain Shading'''
* [[Mapdev:diffuse]]
* [[Mapdev:detail]]
* [[Mapdev:splatdetail]]
* [[Mapdev:splatdetailnormals]]
* [[Mapdev:specular]]
* [[Mapdev:normal]]
* [[Mapdev:parallax]]
* [[Mapdev:skyreflectmod]]
* [[Mapdev:lightemission]]

; '''Terrain Features'''
* [[Mapdev:height]]
* [[Mapdev:metal]]
* [[Mapdev:terraintype]]
* [[Mapdev:grass]]
* [[Mapdev:features]]
* [[Mapdev:water]]
* [[Mapdev:borders]]
* [[Mapdev:minimap]]

; '''Environment'''
* [[Mapdev:skybox]]
* [[Mapdev:lighting]]
* [[Mapdev:atmosphere]]

= Scripting =
* [[Mapdev:MapOptions]]
* [[Mapdev:LuaShaders]]
* [[Mapdev:Mutators]] [http://springrts.com/phpbb/viewtopic.php?f=13&t=21808 forum discussion]

= Howto's =
* [[Mapdev:Howto_voidwater/space]]
* [[Mapdev:Howto_spring_features_v1]]
* [[Mapdev:Howto_skybox]]
* [[Mapdev:howto_height_blender|Making a height map with Blender]]

= Tools =
A big list of tools used in developing spring games and assets:
* [[Map,_Game,_And_Unit_Development_Programs]]

= Resources =
* [https://github.com/eronoobos/spring-metal-spot-resources Metal Spot Resources]

== Specific to Map Development ==
{| class="wikitable"
|+ Tools vs Platform
! Tool !! Windows !! Linux !! MacOS
|-
| [[MapConv]]
| style="background:green;text-align:center"| Yes
|-
| [[MapConvNG]]
| style="background:green;text-align:center"| Yes
| style="background:green;text-align:center"| Yes
|-
| [[Mapdeconv]]
| style="background:green;text-align:center"| Yes
|-
| [[smf_decompiler]]
| style="background:green;text-align:center"| Yes
| style="background:green;text-align:center"| Yes
| style="background:green;text-align:center"| Yes
|-
| Start Position Editor
| style="background:green;text-align:center"| [http://springfiles.com/spring/tools/mapping-tools Yes]
|-
| Das Bruce's Mapconv Frontend
| style="background:green;text-align:center"| [http://springfiles.com/spring/tools/mapping-tools Yes]
|-
| FrostRegen's [[Maps:SpringMapEdit|SpringMapEdit]]
| style="background:green;text-align:center"| yes
| style="background:green;text-align:center"| yes
| style="background:green;text-align:center"| yes
|-
| [https://github.com/enetheru/smf_tools/releases Enetheru's smf_tools]
| style="text-align:center" |
| style="background:green;text-align:center" | yes
|}

== Spring Add-Ons ==
* [[Map_Making:_Feature_Placer|FeaturePlacer]]
* [[ToolBox]]
* [http://springfiles.com/spring/tools/spring-features Spring Features V1.0]

= Common Problems =
== Pink Map ==
Renaming the SMT file and not defining the new name in mapinfo.lua will result in a map with a pink texture. Also don't put any spaces in the name.

== Map doesn't show in spring after compressing with 7zip==
The most likely cause is that it was compressed using the solid archive option.

{{FIXME}}Add windows and MacOS solutions.

For linux the option <code>-ms=off</code> needs to be given on the command line. eg.
: <code> 7z a -ms=off myarchivename.sd7 dem files I want to archive</code>

== Flipped Images ==
Heightmap images compiled into map files are inverted. It is necessary to use the -i parameter of Mapconv to vertically flip the image so that it matches the texture.

== smt name defined in smf ==
The SMT file name is hardcoded in the SMF, and renaming the SMT used to cause pink map issues, but the SMT can now be manually defined in mapinfo.lua thereby bypassing the entire issue altogether.

= Map Development Wiki =
* [[Mapdev:WikiGuide|Mapdev Wiki Guide]]

= Deprecated but not Deleted =
We plan on integrating any and all useful knowledge from these pages into the rest of the wiki, they are kept here so that they are not hidden away.
== Full Guides For Map Making (Outdated) ==
The guides listed below are outdated and scheduled for archival.
*[[Create maps|aGorm's map creating Guide]]
*[[Map Making Guide|aGorms Ultimate Map Making Guide(unfinished)]]
*[[IceXuick Map Design Help|IceXuicks Map creating Guide]]
*[http://springrts.com/phpbb/viewtopic.php?t=3941 Forboding Angel's map creating Tutorial]
*[[Maps:Tutorial|Another tutorial from a designing point of view]]
*[[A Complete Map Making Tutorial|A Complete Map Making Tutorial (under construction)]]
*[[Runecrafter|Runecrafter's Map Tutorial]]
*[http://springrts.com/phpbb/viewtopic.php?f=13&t=15390 Beherith's map creating tutorial using the World in Conflict map editor]

== Specific Guides (Extremely Outdated!) ==
The linked pages below are scheduled for archival.
*[[Maps:SMD|Spring Map Definition(smd) reference]]
*[[Maps:Compiling|Everything about Compiling your map]]
*[[MapsBalance|Some things about map balance]]
*[[MapSizes|Map sizes in pixels]] and memory information about map sizes
*[[Height Map Tutorial|RogerN's height map tutorial]]
*[[Create map texture with povray|Basic howto: create map texture with Povray]]

[[Spring_Features]] is an Archive which contains Stones, rocks, trees, and can be used for your map.

[[Category:Map Dev]]

Springignore.txt

2016-04-07T21:49:38Z

Eronoobos: /* Purpose */

==Location==
springignore.txt is a file in the root directory of a Spring archive (game or map)

==Purpose==
Tells Spring which directories and files to ignore within an archive when calculating checksums. Useful for multiplayer with archives that are git or svn repositories.

==Links==
http://imolarpg.dyndns.org/trac/balatest/browser/branches/BAR/springignore.txt

Springignore.txt

2016-04-07T21:49:11Z

Eronoobos: /* Purpose */

==Location==
springignore.txt is a file in the root directory of a Spring archive (game or map)

==Purpose==
Tells Spring which files to ignore within an archive when calculating checksums. Useful for multiplayer with archives that are git or svn repositories.

==Links==
http://imolarpg.dyndns.org/trac/balatest/browser/branches/BAR/springignore.txt

Springignore.txt

2016-04-07T21:47:47Z

Eronoobos: Created page with "==Purpose== Tells Spring which files to ignore within an archive when calculating checksums. Useful for multiplayer with archives that are git or svn repositories. ==Links== ..."

==Purpose==
Tells Spring which files to ignore within an archive when calculating checksums. Useful for multiplayer with archives that are git or svn repositories.

==Links==
http://imolarpg.dyndns.org/trac/balatest/browser/branches/BAR/springignore.txt

Gamedev:Structure

2016-04-07T21:41:19Z

Eronoobos: /* root of game folder */

= Game Structure =
== .sd7 or .sdz ==

A mod is presented as an [[sd7]] or sdz file. This is just a zip file of the individual files comprising the game.

You can unzip the sd7 or sdz file by renaming it to .zip, and using a zip tool to unzip it.

sd7 / sdz files are created using 7zip.

== .sdd directories ==
You can avoid using the archives altogether by storing the whole mod directory structure in an .sdd directory. This is useful for game development because the changes you make are visible without any additional step.

On Linux one can also symlink the development directories from the Spring's mod directory:
ln -s ~/projects/caspring/games/zk ~/.spring/games/zk.sdd

== Directory Structure ==
==='''<code>root of game folder</code>'''===

[[Modinfo.lua]] and can also contain [[Modoptions.lua]], [[AI:Development:Lang:Lua|LuaAI.lua]], and [[springignore.txt]]

==='''<code>anims\</code>''' ===
image files for [[MouseCursors|mouse cursors]]

==='''<code>bitmaps\</code>''' ===

===='''<code>bitmaps\loadpictures</code>''' ====
pictures that will be displayed when the game loads.

===='''<code>bitmaps\tracks</code>''' ====
images that are used for the [[Gamedev:UnitDefs#Decals|unit tracks]]

==='''<code>features\</code>''' ===
.lua [[Gamedev:FeatureDefs|FeatureDef]] files
: Corpse and map-static feature definitions. The corpse files are similar to [[Gamedev:UnitDefs|UnitDefs]] but usually contain a less data, such as what model to use as the wreckage, how much metal the wreck will give if reclaimed, etc. Some games choose to subsume these into the [[Gamedev:UnitDefs|UnitDef]] instead of having separate files.Subfolders are allowed.

==='''<code>gamedata\</code>''' ===
[[:Category:Gamedata|Various files]] that control global things or setup graphic & sound resources.

==='''<code>icons\</code>''' ===
images for [[Icontypes.lua|unit symbols and radar icons]]

==='''<code>LuaRules\</code>''' ===
various files to make Lua scripts work such as gadget handler
===='''<code>LuaRules\Gadgets</code>''' ====
[[Lua_Scripting|Lua gadgets]]: scripts that control the gameplay
===='''<code>LuaRules\Configs</code>''' ====
config files read by Lua gadgets

==='''<code>LuaUI\</code>''' ===
===='''<code>LuaUI\widgets</code>''' ====
[[Lua_Scripting|Lua widget]]: scripts that make up the user interface or do other unsynced things

==='''<code>objects3d\</code>''' ===
.3do, [[About_s3o|.s3o]] or [[Assimp]] compatible 3D model files
: This contains the actual 3D model that units and features use in-game. Most units have a variety of different pieces that are put together in a hierarchy type form (for instance, a tank has a hull, a turret attached to that, and a barrel attached to that). The {{xtaglink|Gamedev:UnitDefs|model}} tag determines what model is used.

==='''<code>scripts\</code>''' ===
[[Animation-LuaScripting|.lua]] or [[Animation-CobOverview|.cob ]] animation script files
: This contains all of the animation scripting for the units. Scripts work by calling on pieces of the unit's model to do things, such as rotate a turret to aim at a target, or emit smoke when the unit is damaged. The pieces named in the script file must reflect actual parts of the unit's.

==='''<code>sidepics\</code>''' ===
[[Sidedata.lua|Faction icons]] read by lobby etc.

==='''<code>sounds\</code>''' ===
[[Sounds.lua|sound files]]

==='''<code>units\</code>''' ===
.lua [[Gamedev:UnitDefs|UnitDef]] files
: Contains most of the active data that a unit uses, such as its health, a list of which weapons it has, speed, metal/energy cost, whether it is a construction unit or not, so on and so forth. Subfolders are allowed.

==='''<code>unitpics\</code>''' ===
.dds or .png [[Gamedev:Buildpics|buildmenu pictures]]
:Unit pictures are those little thumbnails which show up in the build menus of units in-game. They're just a little graphical representation of the unit so people know what they're building when they click it. Assigned via the {{xtaglink|Gamedev:UnitDefs|buildpic}} tag.

==='''<code>unittextures\</code>''' ===
.dds, .tga or .png image [[3DModels:Textures|texture]] files.
: Image files which are stretched over the unit. Texture 1 contains the diffuse and team colour and texture 2 controls reflectivity, specular, glow and 1-bit transparency. Subfolders are allowed.

==='''<code>weapons\</code>''' ===
.lua [[Gamedev:WeaponDefs|WeaponDef]] files
: Most units have weapons. The characteristics of these weapons, from its behaviour to how it acts in the air, is determined in the weapon file. Some games choose to subsume these into the [[Gamedev:UnitDefs|UnitDef]] instead of having separate files. Subfolders are allowed.

[[Category:Game Dev]]

Spring on a LAN

2015-10-15T22:34:02Z

Eronoobos: /* Joining the local lobby server */

=Playing on a LAN=

==Introduction==
Hosting a LAN game of Spring is very simple.

First, you must have a working LAN. Obviously this is not within the scope of this article, so you are on your own there.

Once you have your network working, you can proceed. You must first install the [http://springrts.com/download.php Latest version of Spring].

We will now discuss startup and configuration.

=Running the Server=

currently there are two lobby server available:
-[[uberserver]] (recommonded, is used for official server)
-[[SpringLS]] (unmaintained, broken with current lobby clients)

=Joining the local lobby server=

After the server has successfully been started, the players have to log in the local lobby server by entering its IP followed by ":8200" (to specify the port) in the server field of their lobby clients (SpringLobby by default). The player hosting the lobby server can use "localhost:8200" or "127.0.0.1:8200" instead of his own IP. If running uberserver, you must first register your nickname. The nickname must not contain space nor special characters. Once the IP & port are entered in the server field, go to the register tab, enter a nickname and password, and click "Ok". Accept the terms of use by clicking "Yes" when they pop up. Then log in using the registered nickname.

[[Image:Connect_to_lan_lobby-withnote.png]]
[[Image:Register_on_lan_lobby.png]]

Once every one is logged into the local lobby server you can host battle in the usual way and play spring in your LAN.

=How to get the lobby server IP=

The player hosting the lobby server has to give his IP to all the players in the LAN. He can retrieve his IP by doing this:
==Windows==
* Press ''Windows Key + R''
[[Image:Windows-run-start-menu.gif]]
* Type "cmd"
* Click "run"
* In the terminal window, type "ipconfig"
[[Image:lan_hostip.gif]]

==Linux==
* Open a terminal and type: ifconfig

[[Category:Lobby]]

File:Connect to lan lobby-withnote.png

2015-10-15T22:31:56Z

Eronoobos: connect to a locally hosted lobby server

connect to a locally hosted lobby server

File:Register on lan lobby.png

2015-10-15T22:30:53Z

Eronoobos: register a nickname on a lobby server

Spring on a LAN

2015-10-15T22:29:18Z

Eronoobos: /* Joining the local lobby server */

=Playing on a LAN=

==Introduction==
Hosting a LAN game of Spring is very simple.

First, you must have a working LAN. Obviously this is not within the scope of this article, so you are on your own there.

Once you have your network working, you can proceed. You must first install the [http://springrts.com/download.php Latest version of Spring].

We will now discuss startup and configuration.

=Running the Server=

currently there are two lobby server available:
-[[uberserver]] (recommonded, is used for official server)
-[[SpringLS]] (unmaintained, broken with current lobby clients)

=Joining the local lobby server=

After the server has successfully been started, the players have to log in the local lobby server by entering its IP followed by ":8200" (to specify the port) in the server field of their lobby clients (SpringLobby by default). The player hosting the lobby server can use "localhost:8200" or "127.0.0.1:8200" instead of his own IP. If running uberserver, you must first register your nickname. The nickname must not contain space nor special characters. Once the IP & port are entered in the server field, go to the register tab, enter a nickname and password, and click "Ok". Accept the terms of use by clicking "Yes" when they pop up. Then log in using the registered nickname.

Once every one is logged into the local lobby server you can host battle in the usual way and play spring in your LAN.

=How to get the lobby server IP=

The player hosting the lobby server has to give his IP to all the players in the LAN. He can retrieve his IP by doing this:
==Windows==
* Press ''Windows Key + R''
[[Image:Windows-run-start-menu.gif]]
* Type "cmd"
* Click "run"
* In the terminal window, type "ipconfig"
[[Image:lan_hostip.gif]]

==Linux==
* Open a terminal and type: ifconfig

[[Category:Lobby]]

Mapdev:Main

2015-04-07T22:47:55Z

Eronoobos:

= Map Development =
Maps are the fields on which the battles are fought, made with the implicit contract that they shall not alter game mechanics. They are made up of images and text files which describe the environment and its features, such as height, colour, background, details features, atmosphere and lighting etc. These images and text files are then compressed into a 7zip archive for distribution.

<center>
{| class="wikitable"
|+In-Game Screenshot
|[[File:Screen00364.jpg|640px]]
|}</center>

= Beginners Tutorial =
This beginners tutorial is split into three parts, the basic stuff, the more advanced basic stuff, and how to compile and create a map archive for distribution. It is intended to get you started, when you are comfortable with the concepts, please look over the technical documentation to further your knowledge.
* [[Mapdev:Tutorial_Simple|Stage 1]]
* [[Mapdev:Tutorial_Intermediate|Stage 2]]
* [[Mapdev:Tutorial_Finalizing|Finalizing]]

= Blueprint =
Due to the amount of boiler plate files needed to create a fairly feature complete map, [[User:Jk|Jk]] has created a blueprint map to get things started
* [https://github.com/jk3064/Map-Blueprint/archive/master.zip Link to blueprint zip]

= Technical Documentation =
; '''General'''
* [[Mapdev:mapinfo.lua|mapinfo.lua]]
* [[Mapdev:set.lua|set.lua]] - feature set
* [[Mapdev:SMT format|SMT format]]
* [[Mapdev:SMF format|SMF format]]
* [[Gamedev:Archives]]
* [[Mapdev:sounds]]
* [[Mapdev:performance]]

; '''Terrain Shading'''
* [[Mapdev:diffuse]]
* [[Mapdev:detail]]
* [[Mapdev:splatdetail]]
* [[Mapdev:specular]]
* [[Mapdev:normal]]
* [[Mapdev:parallax]]
* [[Mapdev:skyreflectmod]]
* [[Mapdev:lightemission]]

; '''Terrain Features'''
* [[Mapdev:height]]
* [[Mapdev:metal]]
* [[Mapdev:terraintype]]
* [[Mapdev:grass]]
* [[Mapdev:features]]
* [[Mapdev:water]]
* [[Mapdev:borders]]
* [[Mapdev:minimap]]

; '''Environment'''
* [[Mapdev:skybox]]
* [[Mapdev:lighting]]
* [[Mapdev:atmosphere]]

= Scripting =
* [[Mapdev:MapOptions]]
* [[Mapdev:LuaShaders]]
* [[Mapdev:Mutators]] [http://springrts.com/phpbb/viewtopic.php?f=13&t=21808 forum discussion]

= Howto's =
* [[Mapdev:Howto_voidwater/space]]
* [[Mapdev:Howto_spring_features_v1]]
* [[Mapdev:Howto_skybox]]
* [[Mapdev:howto_height_blender|Making a height map with Blender]]

= Tools =
A big list of tools used in developing spring games and assets:
* [[Map,_Game,_And_Unit_Development_Programs]]

= Resources =
* [https://github.com/eronoobos/spring-metal-spot-resources Metal Spot Resources]

== Specific to Map Development ==
{| class="wikitable"
|+ Tools vs Platform
! Tool !! Windows !! Linux !! MacOS
|-
| [[MapConv]]
| style="background:green;text-align:center"| Yes
|-
| [[MapConvNG]]
| style="background:green;text-align:center"| Yes
| style="background:green;text-align:center"| Yes
|-
| [[Mapdeconv]]
| style="background:green;text-align:center"| Yes
|-
| Start Position Editor
| style="background:green;text-align:center"| [http://springfiles.com/spring/tools/mapping-tools Yes]
|-
| Das Bruce's Mapconv Frontend
| style="background:green;text-align:center"| [http://springfiles.com/spring/tools/mapping-tools Yes]
|-
| FrostRegen's [[Maps:SpringMapEdit|SpringMapEdit]]
| style="background:green;text-align:center"| yes
| style="background:green;text-align:center"| yes
| style="background:green;text-align:center"| yes
|-
| [https://github.com/enetheru/smf_tools Enetheru's smf_tools]
| style="background:green;text-align:center" | Yes
| style="background:green;text-align:center" | yes
| style="background:yellow;text-align:center" | ?
|}

== Spring Add-Ons ==
* [[Map_Making:_Feature_Placer|FeaturePlacer]]
* [[ToolBox]]
* [http://springfiles.com/spring/tools/spring-features Spring Features V1.0]

= Common Problems =
== Pink Map ==
Renaming the SMT file and not defining the new name in mapinfo.lua will result in a map with a pink texture. Also don't put any spaces in the name.

== Map doesn't show in spring after compressing with 7zip==
The most likely cause is that it was compressed using the solid archive option.

{{FIXME}}Add windows and MacOS solutions.

For linux the option <code>-ms=off</code> needs to be given on the command line. eg.
: <code> 7z a -ms=off myarchivename.sd7 dem files I want to archive</code>

== Flipped Images ==
Heightmap images compiled into map files are inverted. It is necessary to use the -i parameter of Mapconv to vertically flip the image so that it matches the texture.

== smt name defined in smf ==
The SMT file name is hardcoded in the SMF, and renaming the SMT used to cause pink map issues, but the SMT can now be manually defined in mapinfo.lua thereby bypassing the entire issue altogether.

= Map Development Wiki =
* [[Mapdev:WikiGuide|Mapdev Wiki Guide]]

= Deprecated but not Deleted =
We plan on integrating any and all useful knowledge from these pages into the rest of the wiki, they are kept here so that they are not hidden away.
== Full Guides For Map Making (Outdated) ==
The guides listed below are outdated and scheduled for archival.
*[[Create maps|aGorm's map creating Guide]]
*[[Map Making Guide|aGorms Ultimate Map Making Guide(unfinished)]]
*[[IceXuick Map Design Help|IceXuicks Map creating Guide]]
*[http://springrts.com/phpbb/viewtopic.php?t=3941 Forboding Angel's map creating Tutorial]
*[[Maps:Tutorial|Another tutorial from a designing point of view]]
*[[A Complete Map Making Tutorial|A Complete Map Making Tutorial (under construction)]]
*[[Runecrafter|Runecrafter's Map Tutorial]]
*[http://springrts.com/phpbb/viewtopic.php?f=13&t=15390 Beherith's map creating tutorial using the World in Conflict map editor]

== Specific Guides (Extremely Outdated!) ==
The linked pages below are scheduled for archival.
*[[Maps:SMD|Spring Map Definition(smd) reference]]
*[[Maps:Compiling|Everything about Compiling your map]]
*[[MapsBalance|Some things about map balance]]
*[[MapSizes|Map sizes in pixels]] and memory information about map sizes
*[[Height Map Tutorial|RogerN's height map tutorial]]
*[[Create map texture with povray|Basic howto: create map texture with Povray]]

[[Spring_Features]] is an Archive which contains Stones, rocks, trees, and can be used for your map.

[[Category:Map Dev]]

Mapdev:Main

2015-04-07T22:46:12Z

Eronoobos: /* Tools */

= Map Development =
Maps are the fields on which the battles are fought, made with the implicit contract that they shall not alter game mechanics. They are made up of images and text files which describe the environment and its features, such as height, colour, background, details features, atmosphere and lighting etc. These images and text files are then compressed into a 7zip archive for distribution.

<center>
{| class="wikitable"
|+In-Game Screenshot
|[[File:Screen00364.jpg|640px]]
|}</center>

= Beginners Tutorial =
This beginners tutorial is split into three parts, the basic stuff, the more advanced basic stuff, and how to compile and create a map archive for distribution. It is intended to get you started, when you are comfortable with the concepts, please look over the technical documentation to further your knowledge.
* [[Mapdev:Tutorial_Simple|Stage 1]]
* [[Mapdev:Tutorial_Intermediate|Stage 2]]
* [[Mapdev:Tutorial_Finalizing|Finalizing]]

= Blueprint =
Due to the amount of boiler plate files needed to create a fairly feature complete map, [[User:Jk|Jk]] has created a blueprint map to get things started
* [https://github.com/jk3064/Map-Blueprint/archive/master.zip Link to blueprint zip]

= Technical Documentation =
; '''General'''
* [[Mapdev:mapinfo.lua|mapinfo.lua]]
* [[Mapdev:set.lua|set.lua]] - feature set
* [[Mapdev:SMT format|SMT format]]
* [[Mapdev:SMF format|SMF format]]
* [[Gamedev:Archives]]
* [[Mapdev:sounds]]
* [[Mapdev:performance]]

; '''Terrain Shading'''
* [[Mapdev:diffuse]]
* [[Mapdev:detail]]
* [[Mapdev:splatdetail]]
* [[Mapdev:specular]]
* [[Mapdev:normal]]
* [[Mapdev:parallax]]
* [[Mapdev:skyreflectmod]]
* [[Mapdev:lightemission]]

; '''Terrain Features'''
* [[Mapdev:height]]
* [[Mapdev:metal]]
* [[Mapdev:terraintype]]
* [[Mapdev:grass]]
* [[Mapdev:features]]
* [[Mapdev:water]]
* [[Mapdev:borders]]
* [[Mapdev:minimap]]

; '''Environment'''
* [[Mapdev:skybox]]
* [[Mapdev:lighting]]
* [[Mapdev:atmosphere]]

= Scripting =
* [[Mapdev:MapOptions]]
* [[Mapdev:LuaShaders]]
* [[Mapdev:Mutators]] [http://springrts.com/phpbb/viewtopic.php?f=13&t=21808 forum discussion]

= Howto's =
* [[Mapdev:Howto_voidwater/space]]
* [[Mapdev:Howto_spring_features_v1]]
* [[Mapdev:Howto_skybox]]
* [[Mapdev:howto_height_blender|Making a height map with Blender]]

= Tools =
A big list of tools used in developing spring games and assets:
* [[Map,_Game,_And_Unit_Development_Programs]]

== Specific to Map Development ==
{| class="wikitable"
|+ Tools vs Platform
! Tool !! Windows !! Linux !! MacOS
|-
| [[MapConv]]
| style="background:green;text-align:center"| Yes
|-
| [[MapConvNG]]
| style="background:green;text-align:center"| Yes
| style="background:green;text-align:center"| Yes
|-
| [[Mapdeconv]]
| style="background:green;text-align:center"| Yes
|-
| Start Position Editor
| style="background:green;text-align:center"| [http://springfiles.com/spring/tools/mapping-tools Yes]
|-
| Das Bruce's Mapconv Frontend
| style="background:green;text-align:center"| [http://springfiles.com/spring/tools/mapping-tools Yes]
|-
| FrostRegen's [[Maps:SpringMapEdit|SpringMapEdit]]
| style="background:green;text-align:center"| yes
| style="background:green;text-align:center"| yes
| style="background:green;text-align:center"| yes
|-
| [https://github.com/enetheru/smf_tools Enetheru's smf_tools]
| style="background:green;text-align:center" | Yes
| style="background:green;text-align:center" | yes
| style="background:yellow;text-align:center" | ?
|}

== Spring Add-Ons ==
* [[Map_Making:_Feature_Placer|FeaturePlacer]]
* [[ToolBox]]
* [http://springfiles.com/spring/tools/spring-features Spring Features V1.0]

= Common Problems =
== Pink Map ==
Renaming the SMT file and not defining the new name in mapinfo.lua will result in a map with a pink texture. Also don't put any spaces in the name.

== Map doesn't show in spring after compressing with 7zip==
The most likely cause is that it was compressed using the solid archive option.

{{FIXME}}Add windows and MacOS solutions.

For linux the option <code>-ms=off</code> needs to be given on the command line. eg.
: <code> 7z a -ms=off myarchivename.sd7 dem files I want to archive</code>

== Flipped Images ==
Heightmap images compiled into map files are inverted. It is necessary to use the -i parameter of Mapconv to vertically flip the image so that it matches the texture.

== smt name defined in smf ==
The SMT file name is hardcoded in the SMF, and renaming the SMT used to cause pink map issues, but the SMT can now be manually defined in mapinfo.lua thereby bypassing the entire issue altogether.

= Map Development Wiki =
* [[Mapdev:WikiGuide|Mapdev Wiki Guide]]

= Deprecated but not Deleted =
We plan on integrating any and all useful knowledge from these pages into the rest of the wiki, they are kept here so that they are not hidden away.
== Full Guides For Map Making (Outdated) ==
The guides listed below are outdated and scheduled for archival.
*[[Create maps|aGorm's map creating Guide]]
*[[Map Making Guide|aGorms Ultimate Map Making Guide(unfinished)]]
*[[IceXuick Map Design Help|IceXuicks Map creating Guide]]
*[http://springrts.com/phpbb/viewtopic.php?t=3941 Forboding Angel's map creating Tutorial]
*[[Maps:Tutorial|Another tutorial from a designing point of view]]
*[[A Complete Map Making Tutorial|A Complete Map Making Tutorial (under construction)]]
*[[Runecrafter|Runecrafter's Map Tutorial]]
*[http://springrts.com/phpbb/viewtopic.php?f=13&t=15390 Beherith's map creating tutorial using the World in Conflict map editor]

== Specific Guides (Extremely Outdated!) ==
The linked pages below are scheduled for archival.
*[[Maps:SMD|Spring Map Definition(smd) reference]]
*[[Maps:Compiling|Everything about Compiling your map]]
*[[MapsBalance|Some things about map balance]]
*[[MapSizes|Map sizes in pixels]] and memory information about map sizes
*[[Height Map Tutorial|RogerN's height map tutorial]]
*[[Create map texture with povray|Basic howto: create map texture with Povray]]

[[Spring_Features]] is an Archive which contains Stones, rocks, trees, and can be used for your map.

[[Category:Map Dev]]

Mapdev:Main

2015-04-07T22:45:39Z

Eronoobos: /* Tools */

= Map Development =
Maps are the fields on which the battles are fought, made with the implicit contract that they shall not alter game mechanics. They are made up of images and text files which describe the environment and its features, such as height, colour, background, details features, atmosphere and lighting etc. These images and text files are then compressed into a 7zip archive for distribution.

<center>
{| class="wikitable"
|+In-Game Screenshot
|[[File:Screen00364.jpg|640px]]
|}</center>

= Beginners Tutorial =
This beginners tutorial is split into three parts, the basic stuff, the more advanced basic stuff, and how to compile and create a map archive for distribution. It is intended to get you started, when you are comfortable with the concepts, please look over the technical documentation to further your knowledge.
* [[Mapdev:Tutorial_Simple|Stage 1]]
* [[Mapdev:Tutorial_Intermediate|Stage 2]]
* [[Mapdev:Tutorial_Finalizing|Finalizing]]

= Blueprint =
Due to the amount of boiler plate files needed to create a fairly feature complete map, [[User:Jk|Jk]] has created a blueprint map to get things started
* [https://github.com/jk3064/Map-Blueprint/archive/master.zip Link to blueprint zip]

= Technical Documentation =
; '''General'''
* [[Mapdev:mapinfo.lua|mapinfo.lua]]
* [[Mapdev:set.lua|set.lua]] - feature set
* [[Mapdev:SMT format|SMT format]]
* [[Mapdev:SMF format|SMF format]]
* [[Gamedev:Archives]]
* [[Mapdev:sounds]]
* [[Mapdev:performance]]

; '''Terrain Shading'''
* [[Mapdev:diffuse]]
* [[Mapdev:detail]]
* [[Mapdev:splatdetail]]
* [[Mapdev:specular]]
* [[Mapdev:normal]]
* [[Mapdev:parallax]]
* [[Mapdev:skyreflectmod]]
* [[Mapdev:lightemission]]

; '''Terrain Features'''
* [[Mapdev:height]]
* [[Mapdev:metal]]
* [[Mapdev:terraintype]]
* [[Mapdev:grass]]
* [[Mapdev:features]]
* [[Mapdev:water]]
* [[Mapdev:borders]]
* [[Mapdev:minimap]]

; '''Environment'''
* [[Mapdev:skybox]]
* [[Mapdev:lighting]]
* [[Mapdev:atmosphere]]

= Scripting =
* [[Mapdev:MapOptions]]
* [[Mapdev:LuaShaders]]
* [[Mapdev:Mutators]] [http://springrts.com/phpbb/viewtopic.php?f=13&t=21808 forum discussion]

= Howto's =
* [[Mapdev:Howto_voidwater/space]]
* [[Mapdev:Howto_spring_features_v1]]
* [[Mapdev:Howto_skybox]]
* [[Mapdev:howto_height_blender|Making a height map with Blender]]

= Tools =
A big list of tools used in developing spring games and assets:
* [[Map,_Game,_And_Unit_Development_Programs]]

== Specific to Map Development ==
{| class="wikitable"
|+ Tools vs Platform
! Tool !! Windows !! Linux !! MacOS
|-
| [[MapConv]]
| style="background:green;text-align:center"| Yes
|-
| [[MapConvNG]]
| style="background:green;text-align:center"| Yes
| style="background:green;text-align:center"| Yes
|-
| [[Mapdeconv]]
| style="background:green;text-align:center"| Yes
|-
| Start Position Editor
| style="background:green;text-align:center"| [http://springfiles.com/spring/tools/mapping-tools Yes]
|-
| Das Bruce's Mapconv Frontend
| style="background:green;text-align:center"| [http://springfiles.com/spring/tools/mapping-tools Yes]
|-
| FrostRegen's [[Maps:SpringMapEdit|SpringMapEdit]]
| style="background:green;text-align:center"| yes
| style="background:green;text-align:center"| yes
| style="background:green;text-align:center"| yes
|-
| [https://github.com/enetheru/smf_tools Enetheru's smf_tools]
| style="background:green;text-align:center" | Yes
| style="background:green;text-align:center" | yes
| style="background:yellow;text-align:center" | ?
|}

== Spring Add-Ons ==
* [[Map_Making:_Feature_Placer|FeaturePlacer]]
* [[ToolBox]]
* [http://springfiles.com/spring/tools/spring-features Spring Features V1.0]

== Resources ==
* [https://github.com/eronoobos/spring-metal-spot-resources Metal Spot Resources]

= Common Problems =
== Pink Map ==
Renaming the SMT file and not defining the new name in mapinfo.lua will result in a map with a pink texture. Also don't put any spaces in the name.

== Map doesn't show in spring after compressing with 7zip==
The most likely cause is that it was compressed using the solid archive option.

{{FIXME}}Add windows and MacOS solutions.

For linux the option <code>-ms=off</code> needs to be given on the command line. eg.
: <code> 7z a -ms=off myarchivename.sd7 dem files I want to archive</code>

== Flipped Images ==
Heightmap images compiled into map files are inverted. It is necessary to use the -i parameter of Mapconv to vertically flip the image so that it matches the texture.

== smt name defined in smf ==
The SMT file name is hardcoded in the SMF, and renaming the SMT used to cause pink map issues, but the SMT can now be manually defined in mapinfo.lua thereby bypassing the entire issue altogether.

= Map Development Wiki =
* [[Mapdev:WikiGuide|Mapdev Wiki Guide]]

= Deprecated but not Deleted =
We plan on integrating any and all useful knowledge from these pages into the rest of the wiki, they are kept here so that they are not hidden away.
== Full Guides For Map Making (Outdated) ==
The guides listed below are outdated and scheduled for archival.
*[[Create maps|aGorm's map creating Guide]]
*[[Map Making Guide|aGorms Ultimate Map Making Guide(unfinished)]]
*[[IceXuick Map Design Help|IceXuicks Map creating Guide]]
*[http://springrts.com/phpbb/viewtopic.php?t=3941 Forboding Angel's map creating Tutorial]
*[[Maps:Tutorial|Another tutorial from a designing point of view]]
*[[A Complete Map Making Tutorial|A Complete Map Making Tutorial (under construction)]]
*[[Runecrafter|Runecrafter's Map Tutorial]]
*[http://springrts.com/phpbb/viewtopic.php?f=13&t=15390 Beherith's map creating tutorial using the World in Conflict map editor]

== Specific Guides (Extremely Outdated!) ==
The linked pages below are scheduled for archival.
*[[Maps:SMD|Spring Map Definition(smd) reference]]
*[[Maps:Compiling|Everything about Compiling your map]]
*[[MapsBalance|Some things about map balance]]
*[[MapSizes|Map sizes in pixels]] and memory information about map sizes
*[[Height Map Tutorial|RogerN's height map tutorial]]
*[[Create map texture with povray|Basic howto: create map texture with Povray]]

[[Spring_Features]] is an Archive which contains Stones, rocks, trees, and can be used for your map.

[[Category:Map Dev]]