PresetMaps.wiki
author RedGrinner@gmail.com
Sun, 25 Sep 2011 14:41:10 +0000
changeset 148 f343b50d5619
parent 106 ee13fb16ebb5
child 151 33266ae95c27
permissions -rw-r--r--
Edited wiki page LuaAPI through web user interface.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
96
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
     1
*currently under construction*
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
     2
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
     3
This page describes the technically relevant aspects of preset maps in Hedgewars
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
     4
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
     5
<wiki:toc max_depth="3" />
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
     6
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
     7
----
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
     8
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
     9
= Introduction =
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    10
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    11
One of the map types Hedgewars supports are maps that were previously drawn by an artist.
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    12
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    13
The looks of such maps are distinctly defined and are not subject to randomized values.
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    14
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    15
Additionally these maps allow [LuaGuide Lua-script] to be associated with them in order to enable adding specific gameplay changes and map behavior.
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    16
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    17
----
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    18
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    19
= Location =
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    20
All maps are automatically loaded from the [HedgewarsDataDir Hedgewars data directory].
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    21
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    22
In this directory there has to be a folder for every map, named after the desired map name.
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    23
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    24
*Examples:*
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    25
  * _Data/Maps/!MyVeryOwnMap_
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    26
  * _Data/Maps/Ropes_
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    27
  * _Data/Maps/Sheep_
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    28
  * etc.
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    29
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    30
----
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    31
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    32
= Files =
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    33
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    34
Within the folder of every map the following files are expected to be there:
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    35
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    36
== Basic files ==
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    37
=== map.cfg ===
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    38
Configuration file.
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    39
105
5aafdbd7206f Edited wiki page PresetMaps through web user interface.
kyberneticist
parents: 97
diff changeset
    40
  * First line is the name of the [Theme] used by the map (for background and clouds, flakes, water, etc)
5aafdbd7206f Edited wiki page PresetMaps through web user interface.
kyberneticist
parents: 97
diff changeset
    41
  * Second line is max. number of hedgehogs supported. If the second line is not provided, it is assumed to be 18
96
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    42
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    43
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    44
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    45
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    46
=== map.png ===
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    47
Image of visible land area.
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    48
  * Usually _width/length ratio_ of 2:1
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    49
  * Typical size: 2048 x 1024
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    50
  * Max size: 4096 x 2048
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    51
  * 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
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    52
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    53
=== preview.png ===
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    54
Preview image of the map
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    55
  * size: 256 x 128_
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    56
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    57
== Optional files (for advanced features and adjustments) ==
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    58
=== mask.png ===
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    59
Image defining the collision areas of the map.
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    60
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    61
  * Pixels with _alpha value_ = 0 will not be subject to collision
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    62
  * White pixels will be terrain
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    63
  * Red pixels will be indestructable terrain (regardless of game mode settings)
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    64
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    65
*Examples:*
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    66
  * [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]
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    67
(Transparent areas may not be recognizeable as such in your browser/image preview program, so open e.g. in [http://www.gimp.org/ Gimp])
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    68
97
0803dadcc229 Edited wiki page PresetMaps through web user interface.
sheepyluva
parents: 96
diff changeset
    69
96
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    70
=== map.lua ===
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    71
A Lua-script to be used together with the map.
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    72
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    73
See the LuaGuide for more information on Hedgewars' scripting support.
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    74
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    75
== Image format ==
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    76
  * PNG, 8-bit/color RGBA (so 32 bit)
105
5aafdbd7206f Edited wiki page PresetMaps through web user interface.
kyberneticist
parents: 97
diff changeset
    77
  * Gamma correction and colour profiles should not be applied, in order to ensure the map is loaded identically on OSX as it is on other operating systems by SDL.  To ensure this happens, please run:
5aafdbd7206f Edited wiki page PresetMaps through web user interface.
kyberneticist
parents: 97
diff changeset
    78
pngcrush -rem gAMA -rem cHRM -rem iCCP -rem sRGB old/map.png new/map.png
106
ee13fb16ebb5 Edited wiki page PresetMaps through web user interface.
kyberneticist
parents: 105
diff changeset
    79
105
5aafdbd7206f Edited wiki page PresetMaps through web user interface.
kyberneticist
parents: 97
diff changeset
    80
or be sure your image editing software has these options disabled.
96
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    81
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    82
----
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    83
= Editing software recommendations =
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    84
== Images ==
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    85
A vector based drawing software is recommended for creating the maps.
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    86
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    87
(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)
59ea111dd004 Created wiki page through web user interface.
sheepyluva
parents:
diff changeset
    88
97
0803dadcc229 Edited wiki page PresetMaps through web user interface.
sheepyluva
parents: 96
diff changeset
    89
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.