ThemeFiles.wiki
author almikes@aol.com
Tue, 28 Jul 2015 15:08:20 +0000
changeset 569 1aa6e97b8c1a
parent 470 b79cdaf6be94
child 779 2d1e44c79b8e
permissions -rw-r--r--
Link to [Voicepacks].
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
<wiki:toc max_depth="3" />
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
     3
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
     4
= File structure of themes =
460
751f58cf9ca6 Add caption to introduction.
almikes@aol.com
parents: 459
diff changeset
     5
== Introduction ==
455
e1f401fc74bb Clarify image format of image files.
almikes@aol.com
parents: 454
diff changeset
     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.
e1f401fc74bb Clarify image format of image files.
almikes@aol.com
parents: 454
diff changeset
     7
e1f401fc74bb Clarify image format of image files.
almikes@aol.com
parents: 454
diff changeset
     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.
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
Please note that this is not a tutorial, it is a reference page designed to look up how to do stuff.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    11
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    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.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    13
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    14
== Basic files ==
458
cd792ad85f3c Rename header “Icon” to “`icon.png` and `icon@2x.png`”
almikes@aol.com
parents: 457
diff changeset
    15
=== `icon.png` and `icon@2x.png` ===
452
0985b61ce412 Add icon.png.
almikes@aol.com
parents: 450
diff changeset
    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.
0985b61ce412 Add icon.png.
almikes@aol.com
parents: 450
diff changeset
    17
0985b61ce412 Add icon.png.
almikes@aol.com
parents: 450
diff changeset
    18
==== `icon.png` ====
0985b61ce412 Add icon.png.
almikes@aol.com
parents: 450
diff changeset
    19
Small version of the icon. It must be of size 33×32 pixels.
0985b61ce412 Add icon.png.
almikes@aol.com
parents: 450
diff changeset
    20
0985b61ce412 Add icon.png.
almikes@aol.com
parents: 450
diff changeset
    21
==== `icon@2x.png` ====
470
b79cdaf6be94 Corrected size of icon@2x.png.
almikes@aol.com
parents: 460
diff changeset
    22
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
    23
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    24
=== `theme.cfg` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    25
A text file which configures various aspects of the theme. The structure of this file is explained in [Theme].
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    26
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    27
== Terrain ==
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    28
=== `LandTex.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    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.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    30
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    31
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
    32
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    33
=== `LandBackTex.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    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.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    35
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    36
=== `Border.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    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.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    38
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    39
=== `Girder.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    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.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    41
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
    42
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    43
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
    44
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    45
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    46
=== `Chunk.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    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.
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
This image has a default.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    50
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    51
=== `Dust.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    52
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
    53
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    54
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
    55
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    56
=== Objects ===
453
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    57
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
    58
 * It must have the suffix “`.png`”
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    59
 * It must not end with “`_mask.png`”
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    60
 * 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
    61
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    62
Objects have to be configured in `theme.cfg`.
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    63
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    64
=== Object masks ===
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    65
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
    66
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    67
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
    68
fd4ae402ff13 Add object masks.
almikes@aol.com
parents: 452
diff changeset
    69
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
    70
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    71
=== Sprays ===
454
aa8bbe01c9bb Clarify file names of sprays
almikes@aol.com
parents: 453
diff changeset
    72
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
    73
aa8bbe01c9bb Clarify file names of sprays
almikes@aol.com
parents: 453
diff changeset
    74
 * It must have the suffix “`.png`”
aa8bbe01c9bb Clarify file names of sprays
almikes@aol.com
parents: 453
diff changeset
    75
 * 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
    76
aa8bbe01c9bb Clarify file names of sprays
almikes@aol.com
parents: 453
diff changeset
    77
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
    78
456
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
    79
== Weapons and utilities ==
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
    80
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
    81
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
    82
=== `amGirder.png` ===
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
    83
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
    84
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
    85
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
    86
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
    87
|| *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
    88
|| 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
    89
|| 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
    90
|| 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
    91
|| 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
    92
|| 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
    93
|| 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
    94
|| 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
    95
|| 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
    96
456
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
    97
=== `Snowball.png` ===
459
58113a41283f Recommendations regarding Snowball.png and amSnowball.png
almikes@aol.com
parents: 458
diff changeset
    98
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
    99
58113a41283f Recommendations regarding Snowball.png and amSnowball.png
almikes@aol.com
parents: 458
diff changeset
   100
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
   101
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
   102
=== `amSnowball.png` ===
459
58113a41283f Recommendations regarding Snowball.png and amSnowball.png
almikes@aol.com
parents: 458
diff changeset
   103
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
   104
1c362eb39bdd Add Snowball.png and amSnowball.png. Move amGirder.png into new section.
almikes@aol.com
parents: 455
diff changeset
   105
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
   106
437
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   107
== Background ==
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   108
=== `Sky.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   109
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
   110
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   111
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
   112
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   113
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
   114
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   115
=== `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
   116
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
   117
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
   118
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   119
=== `horizont.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   120
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
   121
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   122
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
   123
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   124
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
   125
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   126
=== `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
   127
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
   128
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   129
=== `Clouds.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   130
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
   131
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   132
This has a default image.
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
=== `SDClouds.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
   135
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
   136
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   137
=== `Flake.png` ===
450
2dce97d0a8fd updated flakes
sheepyluva@gmail.com
parents: 447
diff changeset
   138
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
   139
The game will cycle through each frame in order (for each individual flake).
2dce97d0a8fd updated flakes
sheepyluva@gmail.com
parents: 447
diff changeset
   140
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
   141
Flakes can 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
   142
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   143
=== `SDFlake.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
   144
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
   145
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   146
== Water ==
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   147
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
   148
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   149
=== `BlueWater.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   150
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
   151
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   152
By default, this image is a single blue wave.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   153
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   154
=== `Splash.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   155
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. 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.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   156
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   157
=== `Droplet.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   158
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
   159
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   160
=== `SDWater.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
   161
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
   162
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   163
=== `SDSplash.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
   164
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
   165
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   166
=== `SDDroplet.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
   167
Sudden Death version of `Droplet.png`. If missing, `Data/Graphics/SuddenDeath/SDDroplet.png` is used.