author | Wuzzy |
Tue, 17 Jul 2018 13:32:36 +0100 | |
changeset 1483 | 26ce5d1ea7c1 |
parent 1209 | fac5831027bd |
child 1624 | fd7919693076 |
permissions | -rw-r--r-- |
279
1d9a5422d1b9
Edited wiki page PresetMaps through web user interface.
sheepyluva@gmail.com
parents:
264
diff
changeset
|
1 |
#summary This page describes the technically relevant aspects of preset maps in Hedgewars |
96 | 2 |
|
747 | 3 |
= Image maps and mission maps = |
4 |
||
96 | 5 |
<wiki:toc max_depth="3" /> |
6 |
||
747 | 7 |
== Introduction == |
96 | 8 |
|
9 |
One of the map types Hedgewars supports are maps that were previously drawn by an artist. |
|
10 |
||
11 |
The looks of such maps are distinctly defined and are not subject to randomized values. |
|
12 |
||
13 |
Additionally these maps allow [LuaGuide Lua-script] to be associated with them in order to enable adding specific gameplay changes and map behavior. |
|
14 |
||
15 |
---- |
|
16 |
||
747 | 17 |
== Location == |
96 | 18 |
All maps are automatically loaded from the [HedgewarsDataDir Hedgewars data directory]. |
19 |
||
20 |
In this directory there has to be a folder for every map, named after the desired map name. |
|
21 |
||
22 |
*Examples:* |
|
23 |
* _Data/Maps/!MyVeryOwnMap_ |
|
24 |
* _Data/Maps/Ropes_ |
|
25 |
* _Data/Maps/Sheep_ |
|
26 |
* etc. |
|
27 |
||
747 | 28 |
=== Mission maps === |
329
21830c0b19f3
Edited wiki page PresetMaps and added section for .hwp mission maps.
pntanasis@gmail.com
parents:
323
diff
changeset
|
29 |
|
21830c0b19f3
Edited wiki page PresetMaps and added section for .hwp mission maps.
pntanasis@gmail.com
parents:
323
diff
changeset
|
30 |
Missions may use preset maps that aren't located in the *Data/Maps* directory. |
21830c0b19f3
Edited wiki page PresetMaps and added section for .hwp mission maps.
pntanasis@gmail.com
parents:
323
diff
changeset
|
31 |
|
21830c0b19f3
Edited wiki page PresetMaps and added section for .hwp mission maps.
pntanasis@gmail.com
parents:
323
diff
changeset
|
32 |
A mission may contain in the same directory with mission's lua script a .hwp file. |
21830c0b19f3
Edited wiki page PresetMaps and added section for .hwp mission maps.
pntanasis@gmail.com
parents:
323
diff
changeset
|
33 |
|
21830c0b19f3
Edited wiki page PresetMaps and added section for .hwp mission maps.
pntanasis@gmail.com
parents:
323
diff
changeset
|
34 |
This file is a zip file with an altered extension from *.zip* to *.hwp* and it contains the directory *Maps/some_name*. |
21830c0b19f3
Edited wiki page PresetMaps and added section for .hwp mission maps.
pntanasis@gmail.com
parents:
323
diff
changeset
|
35 |
|
21830c0b19f3
Edited wiki page PresetMaps and added section for .hwp mission maps.
pntanasis@gmail.com
parents:
323
diff
changeset
|
36 |
In the *some_name* directory the files map.cfg, map.png and mask.png are located. See the Basic Files section for more on these files. |
21830c0b19f3
Edited wiki page PresetMaps and added section for .hwp mission maps.
pntanasis@gmail.com
parents:
323
diff
changeset
|
37 |
|
21830c0b19f3
Edited wiki page PresetMaps and added section for .hwp mission maps.
pntanasis@gmail.com
parents:
323
diff
changeset
|
38 |
The name of the *.hwp* file should be the same with the mission script. |
21830c0b19f3
Edited wiki page PresetMaps and added section for .hwp mission maps.
pntanasis@gmail.com
parents:
323
diff
changeset
|
39 |
|
436
0afdd1b1042c
Some basic clarifications about mask, add link to nemo’s mask guide, add link to Pngcrush, some typographic improvements.
almikes@aol.com
parents:
372
diff
changeset
|
40 |
In the mission script’s `onGameInit`, map should be set to *some_name*. See [LuaAPI] for more about `onGameInit`. |
329
21830c0b19f3
Edited wiki page PresetMaps and added section for .hwp mission maps.
pntanasis@gmail.com
parents:
323
diff
changeset
|
41 |
|
96 | 42 |
---- |
43 |
||
747 | 44 |
== Files == |
96 | 45 |
|
46 |
Within the folder of every map the following files are expected to be there: |
|
47 |
||
747 | 48 |
=== Basic files === |
49 |
==== `map.cfg` ==== |
|
96 | 50 |
Configuration file. |
51 |
||
1160 | 52 |
* First line is the name of the [Themes theme] used by the map (for background and clouds, flakes, water, etc). As of 0.9.19 (or later), this theme may be overridden when setting up the game. |
53 |
* Second line is max. number of hedgehogs supported. If the second line is not provided, it is assumed to be 18. Note that Hedgewars currently does not support games with more than 48 hedgehogs |
|
96 | 54 |
|
747 | 55 |
==== `map.png` ==== |
96 | 56 |
Image of visible land area. |
1007 | 57 |
* 32-bit PNG with alpha channel |
96 | 58 |
* Usually _width/length ratio_ of 2:1 |
59 |
* Typical size: 2048 x 1024 |
|
339
1664d3e63c05
Geek out a bit on map dimension constraints.
kyberneticist@gmail.com
parents:
336
diff
changeset
|
60 |
* Max size: no limit, 0.9.18+. 4096 x 2048 or less in 0.9.17 and earlier. There are a few practical limits to map size that should be examined for people trying to make very large maps. |
371
3f01f1fd7bb3
Edited wiki page PresetMaps through web user interface.
kyberneticist@gmail.com
parents:
370
diff
changeset
|
61 |
* SDL 1.2 - SDL 1.2 can only load maps that are <=16,384px wide, and <=65,536px high. SDL 1.2 rect is only capable of handling a map that is <=32768 high, while behaviour in Hedgewars 0.9.20 or lower forces <=16,384 if using a mask.png without a map.png. |
344 | 62 |
* SDL 2.0 - SDL 2.0 failed to load a 999,936x512 map. A 499,968x512 map succeeded. Those would use ~244MiB/~122MiB of your graphics card with Blurry Land enabled, and ~977MiB/~488MiB without it. |
341
763c9378cb7f
No. Wait # is numbers. It actually uses indentation..
kyberneticist@gmail.com
parents:
340
diff
changeset
|
63 |
* GIMP. GIMP 2.8 can only create PNGs that are 262,144px wide or high - is an arbitrary hardcoded sanity check. GIMP 2.10 allows 524,288 wide or high. |
343
eaa95eb40e0f
Edited wiki page PresetMaps through web user interface.
kyberneticist@gmail.com
parents:
342
diff
changeset
|
64 |
* libpng - libpng can only load maps that are < 1 million px wide or high, with default configuration. |
341
763c9378cb7f
No. Wait # is numbers. It actually uses indentation..
kyberneticist@gmail.com
parents:
340
diff
changeset
|
65 |
* Graphics card. This is the big one. Your graphics card probably has anywhere from 256MiB to 2GiB of vRAM. If blurry land is enabled and the map has a typical amount of empty space, you can make a map w/ ~2x the pixels as a card has vRAM. But. Most people don't like using Blurry Land, so best to limit to ~½ the pixels as a card has vRAM. Targetting support for people on 256MiB of vRAM, that means a 2:1 rectangular map should not be larger than 16,384x8192 which coincidentally fits in the SDL 1.2 width limit. |
763c9378cb7f
No. Wait # is numbers. It actually uses indentation..
kyberneticist@gmail.com
parents:
340
diff
changeset
|
66 |
* There is also a completely arbitrary check in game for widths/height < ~billion pixels which avoids possible integer issues, and a limit on size in pixels of 6 billion or so, which was just a basic sanity limit. However given the limitations above, these are not likely to be reached. |
96 | 67 |
* 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 |
345
3027ad3155d5
Edited wiki page PresetMaps through web user interface.
kyberneticist@gmail.com
parents:
344
diff
changeset
|
68 |
* As of 0.9.19+, map.png is optional if a mask.png is provided. If there is no map.png, the theme will be used to decorate the map. No objects will be added to white areas. Use black if you want objects. |
96 | 69 |
|
747 | 70 |
==== `preview.png` ==== |
1209 | 71 |
Preview image of the map. The preferred preview is created by simply downscaling your map. Please don't abuse the preview by adding things which don't actually exist in the map. Exceptions may apply for maps with unusual dimenions or other maps which are somehow special. |
72 |
||
73 |
* Size: 256 × 128 |
|
96 | 74 |
|
747 | 75 |
=== Optional files (for advanced features and adjustments) === |
76 |
==== `mask.png` ==== |
|
96 | 77 |
Image defining the collision areas of the map. |
78 |
||
79 |
* Pixels with _alpha value_ = 0 will not be subject to collision |
|
436
0afdd1b1042c
Some basic clarifications about mask, add link to nemo’s mask guide, add link to Pngcrush, some typographic improvements.
almikes@aol.com
parents:
372
diff
changeset
|
80 |
* White (255, 255, 255) pixels will be terrain, no background texture will be shown when it is destroyed. |
0afdd1b1042c
Some basic clarifications about mask, add link to nemo’s mask guide, add link to Pngcrush, some typographic improvements.
almikes@aol.com
parents:
372
diff
changeset
|
81 |
* Black (0, 0, 0) pixels will be terrain with background texture applied (Note: Adding any black pixels removes erasure protection from areas where the map.png is solid but the mask.png is transparent) - 0.9.17+ |
0afdd1b1042c
Some basic clarifications about mask, add link to nemo’s mask guide, add link to Pngcrush, some typographic improvements.
almikes@aol.com
parents:
372
diff
changeset
|
82 |
* Red (255, 0, 0) pixels will be indestructible terrain (regardless of game mode settings) |
0afdd1b1042c
Some basic clarifications about mask, add link to nemo’s mask guide, add link to Pngcrush, some typographic improvements.
almikes@aol.com
parents:
372
diff
changeset
|
83 |
* Blue (0, 0, 255) pixels will be ice - 0.9.17+ |
559
43337323f97a
Clarified the instructions for non-portal surfaces without bouncy
almikes@aol.com
parents:
436
diff
changeset
|
84 |
* Green (0, 255, 0) pixels are bouncy (since 0.9.20) and block portals (since 0.9.18). This mask can be used normally for maps or theme objects. If bouncing is implemented and the green pixels should only block portals, place a dotted line of single red or black or white pixels 3 pixels above the green, spaced 3 pixels apart each. This will keep most objects from interacting with the green, but prevent portal spawning. |
436
0afdd1b1042c
Some basic clarifications about mask, add link to nemo’s mask guide, add link to Pngcrush, some typographic improvements.
almikes@aol.com
parents:
372
diff
changeset
|
85 |
|
798
30c5f1ebd552
global replace of http with https for hedgewars.org wiki links
nemo
parents:
747
diff
changeset
|
86 |
It is recommended that your file _only_ consists of pixels which have one of the values above. This ensures that the masks works properly for your map and avoids unexpected behaviour. Also, it makes your file significantly smaller. [https://www.hedgewars.org/node/3339 Here] is a simple guide describing how you can ensure that. |
96 | 87 |
|
88 |
*Examples:* |
|
798
30c5f1ebd552
global replace of http with https for hedgewars.org wiki links
nemo
parents:
747
diff
changeset
|
89 |
* [https://hg.hedgewars.org/hedgewars/raw-file/default/share/hedgewars/Data/Maps/portal/mask.png Mask] of [https://hg.hedgewars.org/hedgewars/raw-file/default/share/hedgewars/Data/Maps/portal/map.png Portal Map] |
96 | 90 |
(Transparent areas may not be recognizeable as such in your browser/image preview program, so open e.g. in [http://www.gimp.org/ Gimp]) |
91 |
||
97
0803dadcc229
Edited wiki page PresetMaps through web user interface.
sheepyluva
parents:
96
diff
changeset
|
92 |
|
747 | 93 |
==== `map.lua` ==== |
436
0afdd1b1042c
Some basic clarifications about mask, add link to nemo’s mask guide, add link to Pngcrush, some typographic improvements.
almikes@aol.com
parents:
372
diff
changeset
|
94 |
A Lua script to be used together with the map. |
96 | 95 |
|
436
0afdd1b1042c
Some basic clarifications about mask, add link to nemo’s mask guide, add link to Pngcrush, some typographic improvements.
almikes@aol.com
parents:
372
diff
changeset
|
96 |
See the LuaGuide for more information on Hedgewars’ scripting support. |
96 | 97 |
|
747 | 98 |
=== Image format === |
96 | 99 |
* PNG, 8-bit/color RGBA (so 32 bit) |
436
0afdd1b1042c
Some basic clarifications about mask, add link to nemo’s mask guide, add link to Pngcrush, some typographic improvements.
almikes@aol.com
parents:
372
diff
changeset
|
100 |
* 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 in the command-line (requires Pngcrush): |
0afdd1b1042c
Some basic clarifications about mask, add link to nemo’s mask guide, add link to Pngcrush, some typographic improvements.
almikes@aol.com
parents:
372
diff
changeset
|
101 |
<code language="bash">pngcrush -rem gAMA -rem cHRM -rem iCCP -rem sRGB old/map.png new/map.png</code> |
0afdd1b1042c
Some basic clarifications about mask, add link to nemo’s mask guide, add link to Pngcrush, some typographic improvements.
almikes@aol.com
parents:
372
diff
changeset
|
102 |
(Pngcrush is a command-line tool which can be found on [http://pmt.sourceforge.net/pngcrush/]) |
106
ee13fb16ebb5
Edited wiki page PresetMaps through web user interface.
kyberneticist
parents:
105
diff
changeset
|
103 |
|
105
5aafdbd7206f
Edited wiki page PresetMaps through web user interface.
kyberneticist
parents:
97
diff
changeset
|
104 |
or be sure your image editing software has these options disabled. |
96 | 105 |
|
106 |
---- |
|
747 | 107 |
== Editing software recommendations == |
108 |
=== Images === |
|
96 | 109 |
A vector based drawing software is recommended for creating the maps. |
110 |
||
798
30c5f1ebd552
global replace of http with https for hedgewars.org wiki links
nemo
parents:
747
diff
changeset
|
111 |
(Reasons for that: Edges are usually automatically smoothed on export; Easier to meet [https://www.hedgewars.org/node/704 Hedgewars Graphics rules, style constraints, guidelines]; Images are easier to change, adjust and maintain style) |
96 | 112 |
|
667 | 113 |
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. |
114 |
||
747 | 115 |
== Sharing image maps == |
667 | 116 |
You can only play a game with a custom image map against other players online if all participating players have the image map installed under the same name. |
117 |
||
118 |
If any player does not have the image map installed, the game will fail to start and an error message is displayed. |
|
119 |
||
1011
399ca0374984
Rename Theme page to ThemeCfg to avoid confusion
Wuzzy <almikes@aol.com>
parents:
1007
diff
changeset
|
120 |
If you wish, you can post your custom-made image map in the [https://www.hedgewars.org/forum/19 Content Creations] forum. |