*currently under construction*

This page describes the technically relevant aspects of preset maps in Hedgewars

<wiki:toc max_depth="3" />

----

= Introduction =

One of the map types Hedgewars supports are maps that were previously drawn by an artist.

The looks of such maps are distinctly defined and are not subject to randomized values.

Additionally these maps allow [LuaGuide Lua-script] to be associated with them in order to enable adding specific gameplay changes and map behavior.

----

= Location =
All maps are automatically loaded from the [HedgewarsDataDir Hedgewars data directory].

In this directory there has to be a folder for every map, named after the desired map name.

*Examples:*
  * _Data/Maps/!MyVeryOwnMap_
  * _Data/Maps/Ropes_
  * _Data/Maps/Sheep_
  * etc.

----

= Files =

Within the folder of every map the following files are expected to be there:

== Basic files ==
=== map.cfg ===
Configuration file.

  * First line is max. number of hedgehogs supported
  * Second line is the name of the [Theme] used by the map (for background and clouds, flakes, water, etc)




=== map.png ===
Image of visible land area.
  * Usually _width/length ratio_ of 2:1
  * Typical size: 2048 x 1024
  * Max size: 4096 x 2048
  * If there is no _mask.png_, this image will also be used for deciding what pixels are subject to collision: _alpha value_ not equal to 0 (so below max transparency) will be considered land

=== preview.png ===
Preview image of the map
  * size: 256 x 128_

== Optional files (for advanced features and adjustments) ==
=== mask.png ===
Image defining the collision areas of the map.

  * Pixels with _alpha value_ = 0 will not be subject to collision
  * White pixels will be terrain
  * Red pixels will be indestructable terrain (regardless of game mode settings)

*Examples:*
  * [http://hedgewars.googlecode.com/hg/share/hedgewars/Data/Maps/Blizzard/mask.png Mask]  of [http://hedgewars.googlecode.com/hg/share/hedgewars/Data/Maps/Blizzard/map.png Blizzard Map]
(Transparent areas may not be recognizeable as such in your browser/image preview program, so open e.g. in [http://www.gimp.org/ Gimp])


=== map.lua ===
A Lua-script to be used together with the map.

See the LuaGuide for more information on Hedgewars' scripting support.

== Image format ==
  * PNG, 8-bit/color RGBA (so 32 bit)

----
= Editing software recommendations =
== Images ==
A vector based drawing software is recommended for creating the maps.

(Reasons for that: Edges are usually automatically smoothed on export; Easier to meet [http://www.hedgewars.org/node/704 Hedgewars Graphics rules, style constraints, guidelines]; Images are easier to change, adjust and maintain style)

If you don't have one, check out the free open-source [http://inkscape.org Inkscape]: There are various [http://lmgtfy.com/?q=inkscape+tutorial Inkscape tutorials] online, so you should be able to get started easily.