ThemeFiles.wiki
author Wuzzy
Thu, 11 Jul 2019 15:28:36 +0100
changeset 1945 b7b0b2a78d8d
parent 1890 6a96ed7b345d
permissions -rw-r--r--
ThemeFiles: Demand transparent border for Splash
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
     1
#summary File structure of themes
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
     2
= File structure of themes =
460
751f58cf9ca6 Add caption to introduction.
almikes@aol.com
parents: 459
diff changeset
     3
== Introduction ==
809
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
     4
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.
455
e1f401fc74bb Clarify image format of image files.
almikes@aol.com
parents: 454
diff changeset
     5
1011
399ca0374984 Rename Theme page to ThemeCfg to avoid confusion
Wuzzy <almikes@aol.com>
parents: 1008
diff changeset
     6
To create a theme, you need a bunch of graphics and a `theme.cfg` (explained under [ThemeCfg]). All graphics mentioned here have to in the PNG format.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
     7
1014
62a12df7934c ThemeFiles: Start at [Themes].
Wuzzy
parents: 1011
diff changeset
     8
Please note that this is not a tutorial, it is a reference page designed to look up how to do stuff. Start at [Themes].
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
     9
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    10
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.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    11
1008
98c4c6f80a09 ThemeFiles: move TOC
Wuzzy
parents: 951
diff changeset
    12
<wiki:toc max_depth="3" />
98c4c6f80a09 ThemeFiles: move TOC
Wuzzy
parents: 951
diff changeset
    13
809
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    14
== Mandatory files ==
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    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.
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    16
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    17
All themes need at least `theme.cfg`.
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    18
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    19
`icon.png` or `icon@2x.png` are required for the theme to show up in the list of selectable themes in Hedgewars.
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    20
811
3a8c1d98ac43 ThemeFiles: fix link
Wuzzy
parents: 810
diff changeset
    21
Full themes, that is, themes which can be used on random maps or hand-drawn maps, also require `LandTex.png` and `Border.png`.
809
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    22
811
3a8c1d98ac43 ThemeFiles: fix link
Wuzzy
parents: 810
diff changeset
    23
But those files are not required if you only want to use a theme in combination with an [PresetMaps image map] or in fort mode, but not for random maps or hand-drawn maps.
809
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    24
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    25
== Basic files ==
458
cd792ad85f3c Rename header “Icon” to “`icon.png` and `icon@2x.png`”
almikes@aol.com
parents: 457
diff changeset
    26
=== `icon.png` and `icon@2x.png` ===
1268
4eeac350c9e1 ThemeFiles: better describe icon.png stuff
Wuzzy
parents: 1137
diff changeset
    27
A preview icon for the theme. It is used in the frontend. This is not mandatory for the theme to work. But if the icon is missing, the theme will be automatically hidden from the theme selection dialog. The icon comes in two sizes.
452
0985b61ce412 Add icon.png.
almikes@aol.com
parents: 450
diff changeset
    28
0985b61ce412 Add icon.png.
almikes@aol.com
parents: 450
diff changeset
    29
==== `icon.png` ====
0985b61ce412 Add icon.png.
almikes@aol.com
parents: 450
diff changeset
    30
Small version of the icon. It must be of size 33×32 pixels.
0985b61ce412 Add icon.png.
almikes@aol.com
parents: 450
diff changeset
    31
0985b61ce412 Add icon.png.
almikes@aol.com
parents: 450
diff changeset
    32
==== `icon@2x.png` ====
470
b79cdaf6be94 Corrected size of icon@2x.png.
almikes@aol.com
parents: 460
diff changeset
    33
Large version of the icon. It must be of size 65×64 pixels.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    34
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    35
=== `theme.cfg` ===
1011
399ca0374984 Rename Theme page to ThemeCfg to avoid confusion
Wuzzy <almikes@aol.com>
parents: 1008
diff changeset
    36
A text file which configures various aspects of the theme. The structure of this file is explained in [ThemeCfg].
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    37
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    38
== Terrain ==
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    39
=== `LandTex.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    40
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.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    41
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    42
Ideally, you would want to make sure this texture tiles well and is seamless in both axes.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    43
809
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    44
This file is mandatory for full themes but not for themes only to be used as background for maps.
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    45
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    46
=== `LandBackTex.png` ===
809
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    47
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.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    48
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    49
=== `Border.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    50
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.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    51
809
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    52
This file is mandatory for full themes but not for themes only to be used as background for maps.
dc80e414585a ThemeFiles: mandatory files
Wuzzy
parents: 802
diff changeset
    53
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    54
=== `Girder.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    55
An optional image for the landscape girders, large horizontal constructions which are added to the landscape when it is enabled in the game scheme.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    56
This image will be repeated horizontally, so for a better theme quality, make sure this image has no seams horizontally.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    57
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    58
If unspecified, `Data/Graphics/Girder.png` is used.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    59
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    60
=== `Chunk.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    61
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.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    62
802
9ec4666eed9e ThemeFiles: Mention more default files
Wuzzy
parents: 779
diff changeset
    63
This image is optional. If missing, no chunks are used.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    64
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    65
=== `Dust.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    66
A dust particle animation which appear when something hits the ground hard. This is a sprite sheet with a size of 22×176 pixels, each image has a size of 22×22 pixels. The topmost image shows the start of the animation, the lowest image the end of the animation.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    67
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    68
By default this is `Data/Graphics/Dust.png`.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    69
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    70
=== Objects ===
453
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    71
Objects are single images of any size, they will be “attached” to the landscape and so become part of the landscape themselves. The name has to follow the following rules:
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    72
 * It must have the suffix “`.png`”
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    73
 * It must not end with “`_mask.png`”
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    74
 * It must not be equal with any other file name mentioned on this page
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    75
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    76
Objects have to be configured in `theme.cfg`.
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    77
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    78
=== Object masks ===
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    79
Object masks are images which are applied to objects. They determine the terrain type of the pixels of an object. The image has to be of the same dimensions of the object in question. The masks work like `mask.png` of image maps, see [PresetMaps#mask.png].
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    80
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    81
The name of an object mask file has to follow the pattern “`<object name>_mask.png`”, where “`<object name>`” is the file name of the object the mask is applied to, minus the suffix. For example, the mask of `cheese.png` would be `cheese_mask.png`. (See the Cheese theme in `Data/Themes/Cheese` in the Hedgewars installation directory for an example.)
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    82
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    83
If an object mask is not provided, the object in question can be destroyed but will, unlike the main terrain, not leave the terrain background texture behind.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    84
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    85
=== Sprays ===
454
aa8bbe01c9bb Clarify file names of sprays
almikes@aol.com
parents: 453
diff changeset
    86
Sprays are single images of any size, they will be drawn onto the land texture (by `LandTex.png`). You can choose the file name by yourselves, but it must follow the following rules:
aa8bbe01c9bb Clarify file names of sprays
almikes@aol.com
parents: 453
diff changeset
    87
aa8bbe01c9bb Clarify file names of sprays
almikes@aol.com
parents: 453
diff changeset
    88
 * It must have the suffix “`.png`”
aa8bbe01c9bb Clarify file names of sprays
almikes@aol.com
parents: 453
diff changeset
    89
 * It must not be equal with any other file name mentioned on this page
aa8bbe01c9bb Clarify file names of sprays
almikes@aol.com
parents: 453
diff changeset
    90
aa8bbe01c9bb Clarify file names of sprays
almikes@aol.com
parents: 453
diff changeset
    91
Sprays have to be configured in `theme.cfg`.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    92
456
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
    93
== Weapons and utilities ==
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
    94
You can replace certain images of weapons and utilities. All these images are optional and have default images. The default images often serve as a good template to create your own graphics.
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
    95
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
    96
=== `amGirder.png` ===
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
    97
You can create a custom image for manually built girders (from the  “Construction” utility) by adding this file to your theme. Don’t confuse this with `Girder.png`! If unspecified, `Data/Graphics/amGirder.png` is used.
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
    98
457
5df5b8a103af Update text for amGirder.png, it should be clearer now. There is also a neat table for the sub-images now.
almikes@aol.com
parents: 456
diff changeset
    99
The image is of size 480×480 pixels and consists of 9 sub-images of size 160×160 each in a 3×3 grid, but only 8 sub-images are used. This table shows the starting and ending coordinates of the squares which make the sub-images:
5df5b8a103af Update text for amGirder.png, it should be clearer now. There is also a neat table for the sub-images now.
almikes@aol.com
parents: 456
diff changeset
   100
5df5b8a103af Update text for amGirder.png, it should be clearer now. There is also a neat table for the sub-images now.
almikes@aol.com
parents: 456
diff changeset
   101
|| *x minimum* || *y minimum* || *x maximum* || *y maximum* || *Orientation* || *Length* ||
5df5b8a103af Update text for amGirder.png, it should be clearer now. There is also a neat table for the sub-images now.
almikes@aol.com
parents: 456
diff changeset
   102
|| 0 || 0 || 160 || 160 || Horizontal || Short ||
5df5b8a103af Update text for amGirder.png, it should be clearer now. There is also a neat table for the sub-images now.
almikes@aol.com
parents: 456
diff changeset
   103
|| 0 || 160 || 160 || 320 || Falling right || Short ||
5df5b8a103af Update text for amGirder.png, it should be clearer now. There is also a neat table for the sub-images now.
almikes@aol.com
parents: 456
diff changeset
   104
|| 0 || 320 || 160 || 480 || Vertical || Short ||
5df5b8a103af Update text for amGirder.png, it should be clearer now. There is also a neat table for the sub-images now.
almikes@aol.com
parents: 456
diff changeset
   105
|| 160 || 0 || 320 || 160 || Rising right || Short ||
5df5b8a103af Update text for amGirder.png, it should be clearer now. There is also a neat table for the sub-images now.
almikes@aol.com
parents: 456
diff changeset
   106
|| 160 || 160 || 320 || 320 || Horizontal || Long ||
5df5b8a103af Update text for amGirder.png, it should be clearer now. There is also a neat table for the sub-images now.
almikes@aol.com
parents: 456
diff changeset
   107
|| 160 || 320 || 320 || 480 || Falling right || Long ||
5df5b8a103af Update text for amGirder.png, it should be clearer now. There is also a neat table for the sub-images now.
almikes@aol.com
parents: 456
diff changeset
   108
|| 320 || 0 || 480 || 160 || Vertical || Long ||
5df5b8a103af Update text for amGirder.png, it should be clearer now. There is also a neat table for the sub-images now.
almikes@aol.com
parents: 456
diff changeset
   109
|| 320 || 160 || 480 || 320 || Rising right || Long ||
5df5b8a103af Update text for amGirder.png, it should be clearer now. There is also a neat table for the sub-images now.
almikes@aol.com
parents: 456
diff changeset
   110
779
2d1e44c79b8e ThemeFiles: amGirder warning
Wuzzy
parents: 470
diff changeset
   111
*Important*: Please make sure to test your custom girder image in-game with all orientations to make sure it works correctly.
2d1e44c79b8e ThemeFiles: amGirder warning
Wuzzy
parents: 470
diff changeset
   112
456
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
   113
=== `Snowball.png` ===
459
58113a41283f Recommendations regarding Snowball.png and amSnowball.png
almikes@aol.com
parents: 458
diff changeset
   114
This is the image of the mudball when thrown. It has a size of 16×16 pixels. If you specifiy this image in your theme, you should specify `amSnowball.png` as well.
58113a41283f Recommendations regarding Snowball.png and amSnowball.png
almikes@aol.com
parents: 458
diff changeset
   115
58113a41283f Recommendations regarding Snowball.png and amSnowball.png
almikes@aol.com
parents: 458
diff changeset
   116
By default, `Data/Graphics/Snowball.png` is used.
456
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
   117
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
   118
=== `amSnowball.png` ===
459
58113a41283f Recommendations regarding Snowball.png and amSnowball.png
almikes@aol.com
parents: 458
diff changeset
   119
This is the image of the mudball with the hand of a hedgehog. It has a size of 128×128 pixels. If you specifiy this image in your theme, you should specify `Snowball.png` as well.
456
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
   120
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
   121
By default, `Data/Graphics/amSnowball.png` is used.
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
   122
1890
6a96ed7b345d ThemeFiles: Add RopeNode.png
Wuzzy
parents: 1586
diff changeset
   123
=== `RopeNode.png` (1.0.0) ===
6a96ed7b345d ThemeFiles: Add RopeNode.png
Wuzzy
parents: 1586
diff changeset
   124
A piece of the rope. Use this to customize the rope. The default image has a size of 16×16 pixels. You can use this in combination with `rope-step` in `theme.cfg`.
6a96ed7b345d ThemeFiles: Add RopeNode.png
Wuzzy
parents: 1586
diff changeset
   125
6a96ed7b345d ThemeFiles: Add RopeNode.png
Wuzzy
parents: 1586
diff changeset
   126
Default image: `Data/Graphics/RopeNode.png
6a96ed7b345d ThemeFiles: Add RopeNode.png
Wuzzy
parents: 1586
diff changeset
   127
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   128
== Background ==
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   129
=== `Sky.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   130
This image will be drawn far in the background behind the water, the horizont images and the landscape.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   131
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   132
It is repeated horizontally, unless you use `SkyL.png` and/or `SkyR.png`, then it is just the center image. It is recommended that you make sure that this images blends well with the sky color as specified in the `sky` variable in `theme.cfg. You also would want to make sure this image has no horizontal seams.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   133
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   134
If not present, there will be no sky.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   135
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   136
=== `SkyL.png` and `SkyR.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   137
If both are present, `Sky.png` will only be drawn once in the center, `SkyL.png` will be drawn left of `Sky.png` and will be repeated into the left direction. `SkyR.png` will be drawn right of `Sky.png` and is repeated to the right direction.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   138
If only `SkyL.png` is present, this image will be drawn and repeated both left and right of `Sky.png`.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   139
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   140
=== `horizont.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   141
This image is drawn behind the water and the landscape, but in front of the “sky” images. There is also a slight parrallax scrolling effect, this means, if the player moves the view to the left, the horizont will appear to move faster than the sky.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   142
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   143
It is repeated horizontally, unless you use `horizontL.png` and/or `horizontR.png`, then it is just the center image. You also would want to make sure this image has no horizontal seams.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   144
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   145
If not present, there will be no horizont.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   146
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   147
=== `horizontL.png` and `horizontR.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   148
These images are completely analogous to `SkyL.png` and `SkyR.png`.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   149
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   150
=== `Clouds.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   151
A sprite sheet of one or more cloud images for the clouds before Sudden Death. Each in size of 256×128. The cloud images have to be stacked vertically, so if you have 5 clouds, you have to use an image of size 256×640.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   152
802
9ec4666eed9e ThemeFiles: Mention more default files
Wuzzy
parents: 779
diff changeset
   153
If missing, `Data/Graphics/Clouds.png` is used.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   154
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   155
=== `SDClouds.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
   156
Sudden Death version of `Clouds.png`. If missing, `Data/Graphics/SuddenDeath/SDClouds.png` is used.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   157
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   158
=== `Flake.png` ===
450
2dce97d0a8fd updated flakes
sheepyluva@gmail.com
parents: 447
diff changeset
   159
Contains a sprite sheet of 64×64 images. A flake is a background image which rotates and falls from the cloud line, flows with the wind and it can optionally be animated. This file is only for the flakes before Sudden Death. Each image in `Flake.png` is also called a “frame” (as in “animation frame”).
2dce97d0a8fd updated flakes
sheepyluva@gmail.com
parents: 447
diff changeset
   160
The game will cycle through each frame in order (for each individual flake).
2dce97d0a8fd updated flakes
sheepyluva@gmail.com
parents: 447
diff changeset
   161
As alternative to having one kind of animated flake, you can use frames to have static, but visually different kinds of flakes
2dce97d0a8fd updated flakes
sheepyluva@gmail.com
parents: 447
diff changeset
   162
Flakes can be configured in `theme.cfg`.
802
9ec4666eed9e ThemeFiles: Mention more default files
Wuzzy
parents: 779
diff changeset
   163
If this file is missing, no flakes are shown before Sudden Death.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   164
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   165
=== `SDFlake.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
   166
Sudden Death version of `Flake.png`. If missing, `Data/Graphics/SuddenDeath/SDFlake.png` is used. This image contains skulls and bones.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   167
1584
4229316a34ac ThemeFiles: Add Snow.png
Wuzzy
parents: 1268
diff changeset
   168
=== `Snow.png` ===
1586
f52f7af49831 ThemeFiles: More size update for Snow.png
Wuzzy
parents: 1585
diff changeset
   169
A snowflake. A snowflake is a type of flake which might become part of the terrain. This is used in themes in which snow flakes are enabled (see [ThemeCfg]). The default image size is 3×3, but different sizes might work as well. If missing, `Data/Graphics/Snow.png` is used. The default image works just fine, only override this if you really want to.
1584
4229316a34ac ThemeFiles: Add Snow.png
Wuzzy
parents: 1268
diff changeset
   170
1137
7912322338fa ThemeFiles: remove reference to 0.9.23
Wuzzy
parents: 1136
diff changeset
   171
=== `CloudsL.png`, `SDCloudsL.png`, `FlakeL.png`, `SDFlakeL.png` ===
950
e4f3730f6740 ThemeFiles: Simplify mirrored clouds and flakes
Wuzzy
parents: 949
diff changeset
   172
Optional horizonally mirrored version of `Clouds.png`, `SDClouds.png`, `Flake.png` and `SDFlakeL.png`, respectively. If present, these images instead of the unmirrored ones are used when the wind blows the flakes or clouds to the left.
949
76e0115fd3b6 ThemeFiles: CloudsL, SDCloudsL, FlakeL, SDFlakeL
Wuzzy
parents: 811
diff changeset
   173
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   174
== Water ==
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   175
All water images are optional and all have defaults (in `Data/Graphics`). Water images come in 2 groups of 3 images each, for the time before Sudden Death and for Sudden Death. It is recommended that you edit all images in a group at once, so the colors match neatly. You probably don’t want to have blue water driplets if you have made the water blood-red.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   176
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   177
=== `BlueWater.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   178
This will be drawn on the top of the water, before Sudden Death. The size is 128×48 pixels. It does not have to be blue, despite the name. This image will be repeated horizontally. It is recommended to edit `water-top` and `water-bottom` in `theme.cfg` as well if you use a custom image, so the colors match nicely.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   179
802
9ec4666eed9e ThemeFiles: Mention more default files
Wuzzy
parents: 779
diff changeset
   180
By default, this image is a single blue wave found in `Data/Graphics/BlueWater.png`.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   181
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   182
=== `Splash.png` ===
1945
b7b0b2a78d8d ThemeFiles: Demand transparent border for Splash
Wuzzy
parents: 1890
diff changeset
   183
The water splash animation before Sudden Death. It is shown when something large falls into the water. A sprite sheet containing a splash animation of 20 frames. The image has a total size of 160×500 pixels and the sprites are arranged in a grid 2×10 images. The single images have a size of 80×50 pixels each. In order to avoid rendering problems, the 4 borders of each frame (1 pixel wide) must be fully transparent. The animation starts with the leftmost image and continues downwards, after the 10th image, it continues with the top right image and continues downwards again. 
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   184
802
9ec4666eed9e ThemeFiles: Mention more default files
Wuzzy
parents: 779
diff changeset
   185
If missing, `Data/Graphics/Splash.png` is used.
9ec4666eed9e ThemeFiles: Mention more default files
Wuzzy
parents: 779
diff changeset
   186
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   187
=== `Droplet.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   188
This images contains a few droplets (before Sudden Death) which will be drawn when something walls into the water. A sprite sheet of 4 images of size 16×16 sprites each, total size 16×64 pixels.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   189
802
9ec4666eed9e ThemeFiles: Mention more default files
Wuzzy
parents: 779
diff changeset
   190
If missing, `Data/Graphics/Droplet.png` is used.
9ec4666eed9e ThemeFiles: Mention more default files
Wuzzy
parents: 779
diff changeset
   191
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   192
=== `SDWater.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
   193
Sudden Death version of `BlueWater.png`. By default, this is a single purple wave. If missing, `Data/Graphics/SuddenDeath/SDWater.png` is used.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   194
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   195
=== `SDSplash.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
   196
Sudden Death version of `Splash.png`. If missing, `Data/Graphics/SuddenDeath/SDSplash.png` is used.
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   197
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   198
=== `SDDroplet.png` ===
1011
399ca0374984 Rename Theme page to ThemeCfg to avoid confusion
Wuzzy <almikes@aol.com>
parents: 1008
diff changeset
   199
Sudden Death version of `Droplet.png`. If missing, `Data/Graphics/SuddenDeath/SDDroplet.png` is used.
1136
385636c9e7fa ThemeFiles: Add sounds
Wuzzy
parents: 1014
diff changeset
   200
385636c9e7fa ThemeFiles: Add sounds
Wuzzy
parents: 1014
diff changeset
   201
== Sounds ==
385636c9e7fa ThemeFiles: Add sounds
Wuzzy
parents: 1014
diff changeset
   202
A few custom water-related sounds can be added, they will override the default ones. The following files can be added (see [Sounds] to learn what they mean):
385636c9e7fa ThemeFiles: Add sounds
Wuzzy
parents: 1014
diff changeset
   203
385636c9e7fa ThemeFiles: Add sounds
Wuzzy
parents: 1014
diff changeset
   204
 * `splash.ogg`
385636c9e7fa ThemeFiles: Add sounds
Wuzzy
parents: 1014
diff changeset
   205
 * `Droplet1.ogg`
385636c9e7fa ThemeFiles: Add sounds
Wuzzy
parents: 1014
diff changeset
   206
 * `Droplet2.ogg`
385636c9e7fa ThemeFiles: Add sounds
Wuzzy
parents: 1014
diff changeset
   207
 * `Droplet3.ogg`
385636c9e7fa ThemeFiles: Add sounds
Wuzzy
parents: 1014
diff changeset
   208
 * `skip.ogg`