1 #summary File structure of themes |
1 #summary File structure of themes |
2 <wiki:toc max_depth="3" /> |
2 <wiki:toc max_depth="3" /> |
3 |
3 |
4 = File structure of themes = |
4 = File structure of themes = |
5 == Introduction == |
5 == Introduction == |
6 This page explains the meaning of the several files which are used by themes. Please note that not all files are neccessary to create a theme, many files have default fallback versions with identical names in `Data/Graphics` of your Hedgewars installation. |
6 This page explains the meaning of the several files which are used by themes. Please note that not all files are neccessary to create a theme, many files have default fallback versions with identical names in `Data/Graphics` or `Data/Graphics/SuddenDeath` of your Hedgewars installation. |
7 |
7 |
8 To create a theme, you need a bunch of graphics and a `theme.cfg` (explained under [Theme]). All graphics mentioned here have to in the PNG format. |
8 To create a theme, you need a bunch of graphics and a `theme.cfg` (explained under [Theme]). All graphics mentioned here have to in the PNG format. |
9 |
9 |
10 Please note that this is not a tutorial, it is a reference page designed to look up how to do stuff. |
10 Please note that this is not a tutorial, it is a reference page designed to look up how to do stuff. |
11 |
11 |
12 Careful! All file names are case-sensitive on case-sensitive platforms! Please ensure you used the correct casing if you want to share your theme online. |
12 Careful! All file names are case-sensitive on case-sensitive platforms! Please ensure you used the correct casing if you want to share your theme online. |
13 |
13 |
|
14 == Mandatory files == |
|
15 Only a very few files are mandatory, almost everything has a default image. Of course, using defaults only does not make a good theme, so you should add enough images for your theme until you got a decent theme. |
|
16 |
|
17 All themes need at least `theme.cfg`. |
|
18 |
|
19 `icon.png` or `icon@2x.png` are required for the theme to show up in the list of selectable themes in Hedgewars. |
|
20 |
|
21 For full themes, these additional files are mandatory: |
|
22 |
|
23 * `LandTex.png` |
|
24 * `Border.png` |
|
25 |
|
26 But those files are not required if you use a theme only as in combination with an [[PresetMaps image map]] or in fort mode, as those modes do not require a land texture. |
|
27 |
14 == Basic files == |
28 == Basic files == |
15 === `icon.png` and `icon@2x.png` === |
29 === `icon.png` and `icon@2x.png` === |
16 A preview icon for the theme. It is used in the frontend. The presence of this file also determines wheather the theme is visible in Hedgewars for selection. The theme will only be visible if this file is present. The icon comes in two sizes. |
30 A preview icon for the theme. It is used in the frontend. This is not mandatory for the theme to work, but the presence of it determines wheather the theme is visible in Hedgewars for selection. The theme will only be visible if the icon is present. The icon comes in two sizes. |
17 |
31 |
18 ==== `icon.png` ==== |
32 ==== `icon.png` ==== |
19 Small version of the icon. It must be of size 33×32 pixels. |
33 Small version of the icon. It must be of size 33×32 pixels. |
20 |
34 |
21 ==== `icon@2x.png` ==== |
35 ==== `icon@2x.png` ==== |
28 === `LandTex.png` === |
42 === `LandTex.png` === |
29 This is the basic land texture for the main terrain. It is an image tile which will be simple repeated horizontally and vertically all over the landscape. Theoretically, there are no size constraints. |
43 This is the basic land texture for the main terrain. It is an image tile which will be simple repeated horizontally and vertically all over the landscape. Theoretically, there are no size constraints. |
30 |
44 |
31 Ideally, you would want to make sure this texture tiles well and is seamless in both axes. |
45 Ideally, you would want to make sure this texture tiles well and is seamless in both axes. |
32 |
46 |
|
47 This file is mandatory for full themes but not for themes only to be used as background for maps. |
|
48 |
33 === `LandBackTex.png` === |
49 === `LandBackTex.png` === |
34 This is similar to `LandTex.png`, but this image is for the terrain background. This texture becomes visible when a piece of landscape has been destroyed. |
50 This is similar to `LandTex.png`, but this image is for the terrain background. This texture becomes visible when a piece of landscape has been destroyed. By default, no terrain background is used. |
35 |
51 |
36 === `Border.png` === |
52 === `Border.png` === |
37 Border of the landscape. 128×32 pixels in size. This is used to “paint over” the borders of the landscape. This image consists of two parts: the upper half is used for the floor, the lower half for the ceiling. |
53 Border of the landscape. 128×32 pixels in size. This is used to “paint over” the borders of the landscape. This image consists of two parts: the upper half is used for the floor, the lower half for the ceiling. |
|
54 |
|
55 This file is mandatory for full themes but not for themes only to be used as background for maps. |
38 |
56 |
39 === `Girder.png` === |
57 === `Girder.png` === |
40 An optional image for the landscape girders, large horizontal constructions which are added to the landscape when it is enabled in the game scheme. |
58 An optional image for the landscape girders, large horizontal constructions which are added to the landscape when it is enabled in the game scheme. |
41 This image will be repeated horizontally, so for a better theme quality, make sure this image has no seams horizontally. |
59 This image will be repeated horizontally, so for a better theme quality, make sure this image has no seams horizontally. |
42 |
60 |
43 If unspecified, `Data/Graphics/Girder.png` is used. |
61 If unspecified, `Data/Graphics/Girder.png` is used. |
44 |
|
45 |
62 |
46 === `Chunk.png` === |
63 === `Chunk.png` === |
47 A sprite sheet of 4 images for “chunks”. These images appear and “fall off” when some piece of landscape has been blown away. The image has a size of 64×64 and the images are in a raster of 2×2 images. |
64 A sprite sheet of 4 images for “chunks”. These images appear and “fall off” when some piece of landscape has been blown away. The image has a size of 64×64 and the images are in a raster of 2×2 images. |
48 |
65 |
49 This image is optional. If missing, no chunks are used. |
66 This image is optional. If missing, no chunks are used. |