--- a/ThemeCfg.wiki Tue Apr 17 01:36:18 2018 +0100
+++ b/ThemeCfg.wiki Tue Apr 17 01:39:24 2018 +0100
@@ -1,8 +1,12 @@
#summary Structure of the theme.cfg file
= `theme.cfg` =
+
+<wiki:toc max_depth="2" />
+
+== Syntax ==
The file `theme.cfg` gives the engine the values associated with a certain theme, to complement the graphics. To understand themes in general, start at [Themes]. To learn more about the general file structure of themes, see [ThemeFiles].
-It is structured with a list of keys, each seperated by line breaks. Each key is followed by an equals sign followed a value. The value depends on the key.
+It is structured with a list of keys, each separated by line breaks. Each key is followed by an equals sign followed a value. The value depends on the key.
Example:
<code>sky = 23, 8, 33
@@ -19,7 +23,7 @@
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.
-== General configuration ==
+== General configuration keys ==
=== `hidden` (0.9.24) ===
If this key is present in `theme.cfg` (the value does not matter), the theme will be hidden from the theme selection menu. Background themes *must* be hidden.
@@ -29,7 +33,7 @@
=== `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.
-== Land ==
+== Land keys ==
=== `border` ===
The colour of the outline of explosions.
@@ -67,7 +71,7 @@
<code>Values: name, number</code>
-== Water ==
+== Water keys ==
=== `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`. The default color is blue and matches the default `BlueColor.png`.
@@ -128,7 +132,7 @@
=== `sd-water-animation` (0.9.23) ===
Sudden Death equivalent of `water-animation`, uses `SDWater.png`.
-== Background ==
+== Background keys ==
=== `sky` ===
The colour of the sky.
@@ -193,7 +197,7 @@
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.
-== Music ==
+== Music keys ==
=== `music` ===
Name of the music file 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!