ThemeFiles.wiki
author sheepyluva@gmail.com
Fri, 05 Dec 2014 14:41:20 +0000
changeset 451 4e3ad1dc80af
parent 450 2dce97d0a8fd
child 452 0985b61ce412
permissions -rw-r--r--
updated flakes
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 =
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
     5
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. To create a theme, you need a bunch of graphics and a `theme.cfg` (explained under [Theme]).
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
     6
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
     7
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
     8
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
     9
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
    10
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    11
== Basic files ==
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    12
=== `icon@2x.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    13
The icon of the theme. It must be of size 59×54 pixels. 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.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    14
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    15
=== `theme.cfg` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    16
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
    17
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    18
== Terrain ==
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    19
=== `LandTex.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    20
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
    21
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    22
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
    23
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    24
=== `LandBackTex.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    25
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
    26
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    27
=== `Border.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    28
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
    29
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    30
=== `Girder.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    31
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
    32
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
    33
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    34
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
    35
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    36
=== `amGirder.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    37
You can create a custom image for manually built girders (from the  “Construction” utility) by adding this file to your theme. 
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    38
If unspecified, `Data/Graphics/amGirder.png` is used (you can use this file as a template).
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    39
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    40
=== `Chunk.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    41
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
    42
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    43
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
    44
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    45
=== `Dust.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    46
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
    47
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    48
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
    49
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    50
=== Objects ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    51
Objects are single images of any size, they will be “attached” to the landscape and so become part of the landscape themselves. They can have any name as long as it is not any of the other names on this page. Objects have to be configured in `theme.cfg`.
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    52
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    53
=== Sprays ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    54
Sprays are single images of any size, they will be drawn onto the land texture (by `LandTex.png`). They can have any name as long as it is not any of the other names on this page. Sprays have to be configured in `theme.cfg`.
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
== Background ==
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    57
=== `Sky.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    58
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
    59
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    60
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
    61
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    62
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
    63
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    64
=== `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
    65
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
    66
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
    67
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    68
=== `horizont.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    69
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
    70
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    71
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
    72
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    73
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
    74
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    75
=== `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
    76
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
    77
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    78
=== `Clouds.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    79
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
    80
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    81
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
    82
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    83
=== `SDClouds.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
    84
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
    85
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    86
=== `Flake.png` ===
450
2dce97d0a8fd updated flakes
sheepyluva@gmail.com
parents: 447
diff changeset
    87
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
    88
The game will cycle through each frame in order (for each individual flake).
2dce97d0a8fd updated flakes
sheepyluva@gmail.com
parents: 447
diff changeset
    89
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
    90
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
    91
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    92
=== `SDFlake.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
    93
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
    94
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    95
== Water ==
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    96
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
    97
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    98
=== `BlueWater.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
    99
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
   100
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   101
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
   102
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   103
=== `Splash.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   104
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
   105
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   106
=== `Droplet.png` ===
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   107
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
   108
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   109
=== `SDWater.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
   110
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
   111
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   112
=== `SDSplash.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
   113
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
   114
a4b6372904c7 Added a fresh new reference page for the several files used by themes.
almikes@aol.com
parents:
diff changeset
   115
=== `SDDroplet.png` ===
447
8d84ca46c2f2 Fix paths to sudden death images.
almikes@aol.com
parents: 437
diff changeset
   116
Sudden Death version of `Droplet.png`. If missing, `Data/Graphics/SuddenDeath/SDDroplet.png` is used.