# HG changeset patch
# User Wuzzy
# Date 1459105033 -3600
# Node ID 366d41a07472bf901e9f1679ac6b88cbfd19797b
# Parent d7bee302f736b1598399c072b22e794330cf2d16
Theme: More about default values
diff -r d7bee302f736 -r 366d41a07472 Theme.wiki
--- a/Theme.wiki Sun Mar 27 14:29:09 2016 +0100
+++ b/Theme.wiki Sun Mar 27 19:57:13 2016 +0100
@@ -14,11 +14,15 @@
Any line can be made into a comment line by having a semicolon (“`;`”) at the beginning. Comments are ignored by Hedgewars.
+Literally all lines in the `theme.cfg` file are optional, thus an empty file is valid. Everything has a default value. However, some default values are not really useful (e.g. the water or sky color) and you should therefore explicitly specify enough values.
+
== `sky` ==
The colour of the sky.
Values: red, green, blue
+Default: 0, 0, 0 (black)
+
== `rq-sky` ==
The sky color in reduced quality mode. If present, it is used instead of `sky` on low quality.
@@ -29,59 +33,80 @@
Values: red, green, blue
+Default: 80, 80, 80 (gray)
+
== `water-top` ==
The colour of the topmost part of the water (under the `BlueWater.png`) before Sudden Death.
-This makes a gradient together with `water-bottom`.
+This makes a gradient together with `water-bottom`. The default color
+is black which is usually not what you want.
+In combination with the default `BlueWater.png`, the recommended value is `$54, $5C, $9D`.
Values: red, green, blue
+Default: 0, 0, 0 (black)
+
== `water-bottom` ==
The colour of the lowest part of the water before Sudden Death.
-This makes a gradient together with `water-top`.
+This makes a gradient together with `water-top`. The default color
+is black which is usually not what you want.
+In combination with the default `BlueWater.png`, the recommended value is `$34, $3C, $7D`.
Values: red, green, blue
+Default: 0, 0, 0 (black)
+
== `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`.
-If unspecified, it has a default value.
+If unspecified, the default value `150, 112, 169` is used,
+The default color neatly matches the default `SDWater.png`.
Values: red, green, blue
+Default: 150, 112, 169 (purple)
+
== `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`.
-If unspecified, it has a default value.
+The default color neatly matches the default `SDWater.png`.
Values: red, green, blue
+Default: 182, 144, 201 (purple)
+
== `water-opacity` ==
-The water opacity before Sudden Death. Opacity of the water affects how visible gears in the water are. `0` makes it fully transparent, whereas `255` makes it fully opaque. If the water is fully opaque, the drowning animation is skipped when a hedgehog drowns.
+The water opacity before Sudden Death. Opacity of the water affects how visible gears in the water are. `0` makes it fully transparent, whereas `255` or `$FF` makes it fully opaque. If the water is fully opaque, the drowning animation is skipped when a hedgehog drowns.
+
+In combination with the default `BlueWater.png`, the recommended value for this is `$80`, which also is the default.
Values: opacity
+Default: $80
+
== `sd-water-opacity` ==
The water opacity while in Sudden Death. By default, it has the same value as `water-opacity`.
Values: opacity
+Default: $80
+
== `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!
Values: filename
== `sd-music` (0.9.21) ==
-Name of the music file to be played in the theme while in Sudden Death, e.g. `hell.ogg`. By default, `sdmusic.ogg` is played in Sudden Death. You find music tracks in `Data/Music` of the Hedgewars installation directory. The file name is case-sensitive!
+Name of the music file to be played in the theme while in Sudden Death, e.g. `hell.ogg`. By default, `sdmusic.ogg` is played in Sudden Death, but only, if `music` has been specified. If `music` was not specified, the Sudden Death has no default music as well. You find music tracks in `Data/Music` of the Hedgewars installation directory. The file name is case-sensitive!
Values: filename
== `clouds` ==
-The number of clouds to create, before Sudden Death. Uses `Clouds.png`.
+The number of clouds to create, before Sudden Death. Uses `Clouds.png`. By default, 9 clouds are used.
Values: number
== `sd-clouds` ==
-Number of clouds while in Sudden Death, uses the file `SDClouds.png`. By default it is the same number as `clouds`.
+Number of clouds while in Sudden Death, uses the file `SDClouds.png`. By default it is the same number as `clouds`. If `clouds` was not specified, 9 clouds are used.
Values: number
@@ -93,7 +118,7 @@
== `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.
- * `number`: Number of visible flakes
+ * `number`: Number of visible 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.
@@ -103,11 +128,17 @@
Values: number, frames, frame ticks, speed, fall speed
+Default: 0, 4, 0, 10, 100 (In other words, no flakes are used)
+
== `sd-flakes` ==
-Sudden death version of `flakes`, the parameters are the same as in `flakes`. This uses `SDFlake.png`. By default, the flakes are skulls and bones.
+Sudden death version of `flakes`, the parameters are the same as in `flakes`. This uses `SDFlake.png`.
Values: number, frames, frame ticks, speed, fall speed
+Default: X, 4, 0, 15, 250
+
+(The “X” means the default number of Sudden Death flakes is variable. It depends on the window size and the terrain width.)
+
== `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.