--- a/Theme.wiki Wed Dec 03 19:57:54 2014 +0000
+++ b/Theme.wiki Wed Dec 03 20:20:36 2014 +0000
@@ -11,86 +11,99 @@
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 0 - $FF.
-Comments may be added by prefixing a semicolon(;) to the comment.
+Comments may be added by prefixing a semicolon (“`;`”) to the comment.
-=== sky ===
+=== `sky` ===
The colour of the sky.
+
<code>Values: red, green, blue</code>
-=== border ===
+=== `rq-sky` ===
+Reduced quality version of sky. If present used instead of `sky` on low quality.
+
+=== `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).
-This makes a gradient together with water-bottom.
+=== `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`.
<code>Values: red, green, blue</code>
-=== water-bottom ===
-The colour of the lowest part of the water.
-This makes a gradient together with water-top.
+=== `water-bottom` ===
+The colour of the lowest part of the water before Sudden Death.
+This makes a gradient together with `water-top`.
+
+<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`.
+If unspecified, it has a default value.
<code>Values: red, green, blue</code>
-=== water-opacity ===
-Opacity of the water affects how visible gears in the water are.
+=== `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.
+
+<code>Values: red, green, blue</code>
+
+=== `water-opacity` ===
+The water opacity before Sudden Death. Opacity of the water affects how visible gears in the water are.
<code>Values: opacity</code>
-=== music ===
-Name of the track to be played in the theme, e.g. Nature.ogg
+=== `sd-water-opacity` ===
+The water opacity while in Sudden Death. By default, it has the same value as `water-opacity`.
+
+=== `music` ===
+Name of the track to be played in the theme before Sudden Death, e.g. `Nature.ogg`. You find music tracks in `Data/Music` of the Hedgewars installation directory. The file name is case-sensitive!
<code>Values: name</code>
-=== clouds ===
-The number of clouds to create.
+=== `sd-music` (0.9.21) ===
+Name of the track to be played in the theme while in Sudden Death, e.g. `hell.ogg`. By default, no music is played. You find music tracks in `Data/Music` of the Hedgewars installation directory. The file name is case-sensitive!
+
+=== `clouds` ===
+The number of clouds to create, before Sudden Death. Uses `Clouds.png`.
<code>Values: number</code>
-=== object ===
+=== `sd-clouds` ===
+Number of clouds while in Sudden Death, uses the file `SDClouds.png`. By default it is the same number as `clouds`.
+
+=== `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
+ * `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)
+ * `speed`: Rotation speed of flake
+ * `fall speed`: Falling speed of flake
+
+<code>Values: number, frames, frame ticks, speed, fall speed</code>
+
+=== `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.
+
+=== `object` ===
There may be multiple object keys in the file, each one representing one land object.
-filename: The objects' filename (without the .png)
-
-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)
+ * `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>
-=== spray ===
+=== `spray` ===
There may be several spray keys in the file, each one representing one spray object.
-The name is the name of the .png (without the extension) of the graphics file, and the number is the number of instances of this spray that may be added.
-
-<code>Values: name, number</code>
-
-=== flakes ===
-Values for the flakes of this theme. First the number of flakes, then number of frames and ticks per frame. Lastly the speed and fall speed of the flakes.
-If left out there are no flakes.
-
-<code>Values: number, frames, frame ticks, speed, fall speed</code>
-
-=== sd-water-top ===
-Sudden death version of water-top. Has a default value.
+The `name` is the case-sensitive name of the PNG file (without the file name suffix) of the graphics file, and `number` is the number of instances of this spray that may be added.
-=== sd-water-bottom ===
-Sudden death version of water-bottom. Has a default value.
-
-=== sd-water-opacity ===
-Sudden death version of water-opacity. Has default same as water-opacity.
-
-=== sd-clouds ===
-Sudden death version of clouds. Has default same as clouds.
-
-=== sd-flakes ===
-Sudden death version of flakes. Has a default value.
-
-=== rq-sky ===
-Reduced quality version of sky. If present used instead of sky on low quality.
\ No newline at end of file
+<code>Values: name, number</code>
\ No newline at end of file