#summary Structure of the theme.cfg file

= `theme.cfg` =

The file `theme.cfg` gives the engine the values associated with a certain theme, to complement the graphics. To learn more about the general file structure of themes, see [ThemeFiles].

It is structured with a key followed by an equals sign followed a value. The value depends on the key.

 Example:

<code>sky = 120, 40, 80</code>

There is also keys that replace existing keys under certain conditions, all keys preceding with “`sd-`” are used during sudden death and all keys with “`rq-`” are used when quality is reduced. These keys must be placed after the regular keys and they are all optional.

Following is the list of all current keys and their values, it is important to have the right number of values. Most keys may only be used once.

The values red, green, blue and opacity are in the range of one byte and can be specified in both decimal or hexadecimal form. The range are `0` - `255` or `$00` - `$FF`.

Any line can be made into a comment line by having a semicolon (“`;`”) at the beginning. Comments are ignored by Hedgewars.

== `sky` ==

The colour of the sky.

<code>Values: red, green, blue</code>

== `rq-sky` ==

The sky color in reduced quality mode. If present, it is used instead of `sky` on low quality.

<code>Values: red, green, blue</code>

== `border` ==

The colour of the outline of explosions.

<code>Values: red, green, blue</code>

== `water-top` ==

The colour of the topmost part of the water (under the `BlueWater.png`) before Sudden Death.

<code>Values: red, green, blue</code>

== `water-bottom` ==

The colour of the lowest part of the water before Sudden Death.

<code>Values: red, green, blue</code>

== `sd-water-bottom` ==

The colour of the lowest part of the water while in Sudden Death.

This makes a gradient together with `sd-water-top`.

<code>Values: red, green, blue</code>

== `sd-water-top` ==

The colour of the topmost part of the water (under the `SDWater.png`) while in Sudden Death.

This makes a gradient together with `sd-water-bottom`.

<code>Values: red, green, blue</code>

== `water-opacity` ==

<code>Values: opacity</code>

== `sd-water-opacity` ==

The water opacity while in Sudden Death. By default, it has the same value as `water-opacity`.

<code>Values: opacity</code>

== `music` ==

Name of the music file to be played in the theme before Sudden Death, e.g. `Nature.ogg`. If missing, no music is played before Sudden Death. You find music tracks in `Data/Music` of the Hedgewars installation directory. The file name is case-sensitive!

<code>Values: filename</code>

== `sd-music` (0.9.21) ==

<code>Values: filename</code>

== `clouds` ==

<code>Values: number</code>

== `sd-clouds` ==

<code>Values: number</code>

== `flatten-clouds` ==

Normally, the clouds vary in size and are drawn on different layers. But if this key is present (any value) in `theme.cfg`, all clouds have the same size and are on the same layer (background).

The value of this key does not matter, the key must only be present to take effect.

== `flakes` ==

Values for the flakes of this theme before Sudden Death. Uses `Flake.png`. If this field is left out, then there are no flakes.

 * `frames`: Number of frames used in `Flake.png`

 * `frame ticks`: Number of ticks a frame is shown, after that the next frame is shown (a tick currently equals 1 millisecond).

Since 0.9.21: A value of 0 indicates that each flake should keep displaying the exact frame that was selected randomly when the flake was created.

*Tip*: If you want to have multiple static flakes in 0.9.20 or earlier, you can set the animation length to a ridiculous high value. Sometimes, a flake will still change the displayed frame, but it will rarely happen.

 * `speed`: Rotation speed of flake

 * `fall speed`: Falling speed of flake

<code>Values: number, frames, frame ticks, speed, fall speed</code>

== `sd-flakes` ==

<code>Values: number, frames, frame ticks, speed, fall speed</code>

== `flatten-flakes` ==

Normally, the flakes vary in size and are drawn on different layers, some of them even in front of the terrain. But if this key is present (any value) in `theme.cfg`, all flakes have the same size and are on the same layer: In front of the sky and horizont and behind the terrain.

The value of this key does not matter, the key must only be present to take effect.

== `object` ==

There may be multiple object keys in the file, each one representing one land object.

 * `filename`: The object’s filename (without the “.png”). Case-sensitive.

 * `max`: The maximum number of this object that may be generated in a map

 * `buriedrec`: A rectangle that must be buried in the terrain (`left, top, width,  height`)

 * `minvisible`: The minimum amount of rectangles that must be visible

 * `visiblerec`: list of the rectangles for being visible (`left, top, width, height`)

<code>Values: filename, max, buriedrec, minvisible, visiblerec</code>

`visiblerec` and the `buriedrec` visualized on an ancient picture:

https://hedgewars.org/images/avematantheme/hw-avematan.rects.png

== `spray` ==

There may be several spray keys in the file, each one representing one spray object.

The `name` is the case-sensitive name of the PNG file (without the file name suffix) of the graphics file, and `number` is the rough number of instances of this spray that may be added to the map. The number is the average number of sprays that are normally placed on a random medium-sized island. For larger and smaller landscapes, this number will be automatically scaled up or down. Please note that this number only specifies a rough goal, the actual number of created sprays may vary and you may have to play a bit with this number in order to find a good value.

<code>Values: name, number</code>

== `ice` ==

If this key is present (any value), girders become slippery like ice. This also applies to placed girders. This significantly changes the gameplay of your theme, so use wisely. If this key is not present, the terrain is not slippery.

The value of this key does not matter, the key must only be present to take effect.

== `snow` ==

If this key is present (any value), the flakes which are normally purely decorational now behave like snowflakes. When they collide with terrain, they become a part of the landscape. This significantly changes the gameplay of your theme, so use wisely. If this key is not present, the flakes are purely decorational.

The value of this key does not matter, the key must only be present to take effect.