ThemeCfg.wiki
author Wuzzy
Fri, 19 Apr 2019 23:42:45 +0100
changeset 1840 37d979124fc4
parent 1318 57078c02a42e
child 1870 6679e0e8a7b4
permissions -rw-r--r--
LuaGameplay: Add label
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
     1
#summary Structure of the theme.cfg file
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
     2
1315
7368027d526f ThemeCfg: upd headers
Wuzzy
parents: 1314
diff changeset
     3
= Structure of `theme.cfg` =
1316
1a612c26c5f7 ThemeCfg: Ad intro
Wuzzy
parents: 1315
diff changeset
     4
1a612c26c5f7 ThemeCfg: Ad intro
Wuzzy
parents: 1315
diff changeset
     5
== Introduction ==
1a612c26c5f7 ThemeCfg: Ad intro
Wuzzy
parents: 1315
diff changeset
     6
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].
1a612c26c5f7 ThemeCfg: Ad intro
Wuzzy
parents: 1315
diff changeset
     7
1313
fa362f7bacbd ThemeCfg: Move TOC
Wuzzy
parents: 1312
diff changeset
     8
<wiki:toc max_depth="3" />
fa362f7bacbd ThemeCfg: Move TOC
Wuzzy
parents: 1312
diff changeset
     9
1310
c84f7dd4a919 ThemeCfg: add TOC
Wuzzy
parents: 1309
diff changeset
    10
== Syntax ==
1316
1a612c26c5f7 ThemeCfg: Ad intro
Wuzzy
parents: 1315
diff changeset
    11
A `theme.cfg` is a text file which is structured with a list of keys, each separated by line breaks. Each key is followed by an equals sign followed a value. Values can be numbers, strings, or comma-separated lists of these.
815
69b8476b4bb2 Theme: Better example
Wuzzy
parents: 814
diff changeset
    12
69b8476b4bb2 Theme: Better example
Wuzzy
parents: 814
diff changeset
    13
Example:
69b8476b4bb2 Theme: Better example
Wuzzy
parents: 814
diff changeset
    14
<code>sky = 23, 8, 33
69b8476b4bb2 Theme: Better example
Wuzzy
parents: 814
diff changeset
    15
border = 7, 72, 102
69b8476b4bb2 Theme: Better example
Wuzzy
parents: 814
diff changeset
    16
music = Art.ogg</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    17
814
f0c338d954cb Theme: grammar fix
Wuzzy
parents: 813
diff changeset
    18
There are 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 the graphics quality is reduced.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    19
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    20
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.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    21
1124
b37c99c55365 ThemeCfg: convert color numbers to hexadecimal form, consistently
Wuzzy
parents: 1123
diff changeset
    22
The values red, green, blue and opacity are in the range of one byte and can be specified in both decimal or hexadecimal form. A hexadecimal number must be prepended with a dollar sign. The range is `0` - `255` or `$00` - `$FF`.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    23
463
35d43dbb99ad Clarified comments
almikes@aol.com
parents: 462
diff changeset
    24
Any line can be made into a comment line by having a semicolon (“`;`”) at the beginning. Comments are ignored by Hedgewars.
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    25
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    26
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.
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    27
1315
7368027d526f ThemeCfg: upd headers
Wuzzy
parents: 1314
diff changeset
    28
== General configuration keys ==
1317
3e33196a7312 ThemeCfg: remove version numbers from headers
Wuzzy
parents: 1316
diff changeset
    29
=== `hidden` ===
1266
427e63ea7539 ThemeCfg: Add hidden key
Wuzzy
parents: 1201
diff changeset
    30
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.
427e63ea7539 ThemeCfg: Add hidden key
Wuzzy
parents: 1201
diff changeset
    31
1318
57078c02a42e ThemeCfg: whole sentence
Wuzzy
parents: 1317
diff changeset
    32
This key has been added in 0.9.24.
1317
3e33196a7312 ThemeCfg: remove version numbers from headers
Wuzzy
parents: 1316
diff changeset
    33
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
    34
=== `ice` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    35
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.
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    36
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
    37
=== `snow` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    38
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.
462
4416c2ed13d8 Clarify rq-sky.
almikes@aol.com
parents: 451
diff changeset
    39
1315
7368027d526f ThemeCfg: upd headers
Wuzzy
parents: 1314
diff changeset
    40
== Land keys ==
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
    41
=== `border` ===
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    42
The colour of the outline of explosions.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    43
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    44
<code>Values: red, green, blue</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    45
1124
b37c99c55365 ThemeCfg: convert color numbers to hexadecimal form, consistently
Wuzzy
parents: 1123
diff changeset
    46
<code>Default: $50, $50, $50</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    47
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
    48
=== `object` ===
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    49
There may be multiple object keys in the file, each one representing one land object.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    50
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    51
 * `filename`: The object’s filename (without the “.png”). Case-sensitive.
1142
eba210749526 ThemeCfg: fix bracket
Wuzzy
parents: 1141
diff changeset
    52
 * `max`: The maximum number of this object that may be generated in a map (must by between 1 and 32)
1121
0a7925ca59e3 ThemeCfg: update buried rects
Wuzzy
parents: 1019
diff changeset
    53
 * `buriedrects_num`: (optional): Number of rectangles that must be buried in the terrain. If this value is ommitted, a value of 1 is assumed
0a7925ca59e3 ThemeCfg: update buried rects
Wuzzy
parents: 1019
diff changeset
    54
 * `buriedrects`: A rectangle that must be buried in the terrain (`left, top, width, height`). If all 4 values are 0, the object will be placed on top of the water
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    55
 * `minvisible`: The minimum amount of rectangles that must be visible
990
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
    56
 * `visiblerects`: List of the rectangles for being visible (`left, top, width, height`)
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
    57
1121
0a7925ca59e3 ThemeCfg: update buried rects
Wuzzy
parents: 1019
diff changeset
    58
Syntax when you only need 1 buried rectangle:
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    59
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    60
<code>Values: filename, max, buriedrec, minvisible, visiblerec</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    61
1121
0a7925ca59e3 ThemeCfg: update buried rects
Wuzzy
parents: 1019
diff changeset
    62
Syntax when you want to use multiple buried rectangles:
990
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
    63
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
    64
<code>Values: filename, max, buriedrects_num, buriedrects, minvisible, visiblerects</code>
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
    65
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
    66
Here's an example where `visiblerects` and the `buriedrects` are visualized on an ancient picture:
808
a6c6a92dc83f Theme: fix image align
Wuzzy
parents: 807
diff changeset
    67
798
30c5f1ebd552 global replace of http with https for hedgewars.org wiki links
nemo
parents: 746
diff changeset
    68
https://hedgewars.org/images/avematantheme/hw-avematan.rects.png
448
e419fde32f07 Adding picture (blashphemy?)
sheepyluva@gmail.com
parents: 438
diff changeset
    69
990
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
    70
The large rectangle shows a `visiblerects` and the small one shows a `buriedrects`.
808
a6c6a92dc83f Theme: fix image align
Wuzzy
parents: 807
diff changeset
    71
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
    72
=== `spray` ===
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    73
There may be several spray keys in the file, each one representing one spray object.
472
52bd8ea08f4f Better explanation for the number of sprays.
almikes@aol.com
parents: 466
diff changeset
    74
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.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    75
464
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
    76
<code>Values: name, number</code>
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
    77
1315
7368027d526f ThemeCfg: upd headers
Wuzzy
parents: 1314
diff changeset
    78
== Water keys ==
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
    79
=== `water-top` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    80
The colour of the topmost part of the water (under the `BlueWater.png`) before Sudden Death.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    81
This makes a gradient together with `water-bottom`. The default color is blue and matches the default `BlueColor.png`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    82
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    83
<code>Values: red, green, blue</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    84
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    85
<code>Default: $54, $5C, $9D</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    86
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
    87
=== `water-bottom` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    88
The colour of the lowest part of the water before Sudden Death.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    89
This makes a gradient together with `water-top`. The default color is blue and matches the default `BlueColor.png`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    90
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    91
<code>Values: red, green, blue</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    92
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    93
<code>Default: $34, $3C, $7D</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    94
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
    95
=== `sd-water-bottom` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    96
The colour of the lowest part of the water while in Sudden Death.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    97
This makes a gradient together with `sd-water-top`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    98
The default color neatly matches the default `SDWater.png`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
    99
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   100
<code>Values: red, green, blue</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   101
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   102
<code>Default: $96, $70, $A9</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   103
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   104
=== `sd-water-top` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   105
The colour of the topmost part of the water (under the `SDWater.png`) while in Sudden Death.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   106
This makes a gradient together with `sd-water-bottom`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   107
The default color neatly matches the default `SDWater.png`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   108
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   109
<code>Values: red, green, blue</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   110
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   111
<code>Default: $B9, $72, $C9</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   112
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   113
=== `water-opacity` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   114
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.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   115
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   116
In combination with the default `BlueWater.png`, the recommended value for this is `$80`, which also is the default.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   117
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   118
<code>Values: opacity</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   119
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   120
<code>Default: $80</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   121
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   122
=== `sd-water-opacity` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   123
The water opacity while in Sudden Death. Syntax and default value is equivalent to `water-opacity`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   124
1317
3e33196a7312 ThemeCfg: remove version numbers from headers
Wuzzy
parents: 1316
diff changeset
   125
=== `water-animation` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   126
Specified a custom water animation and flowing speed before Sudden Death. By default, the water just moves to the right and has no special animation.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   127
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   128
<code>Values: frames, frame ticks, movement speed</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   129
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   130
 * `frames`: Number of frames in `BlueWater.png`. The frames in this image should be stacked horizontally. The height of this image must be divisible by `frames`
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   131
 * `frame ticks`: Duration of a single frame. Must be >0 if `frames`>1, otherwise it is ignored
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   132
 * `movement speed`: How fast the water moves to the right. Higher values means faster movement. If negative, it moves to the left. Use 0 to stop movement
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   133
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   134
<code>Default: 1, 0, 1</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   135
1317
3e33196a7312 ThemeCfg: remove version numbers from headers
Wuzzy
parents: 1316
diff changeset
   136
This key has been added in 0.9.23.
3e33196a7312 ThemeCfg: remove version numbers from headers
Wuzzy
parents: 1316
diff changeset
   137
3e33196a7312 ThemeCfg: remove version numbers from headers
Wuzzy
parents: 1316
diff changeset
   138
=== `sd-water-animation` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   139
Sudden Death equivalent of `water-animation`, uses `SDWater.png`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   140
1315
7368027d526f ThemeCfg: upd headers
Wuzzy
parents: 1314
diff changeset
   141
== Background keys ==
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   142
=== `sky` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   143
The colour of the sky.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   144
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   145
<code>Values: red, green, blue</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   146
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   147
<code>Default: $00, $00, $00</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   148
1317
3e33196a7312 ThemeCfg: remove version numbers from headers
Wuzzy
parents: 1316
diff changeset
   149
This key has been added in 0.9.23.
3e33196a7312 ThemeCfg: remove version numbers from headers
Wuzzy
parents: 1316
diff changeset
   150
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   151
=== `rq-sky` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   152
The sky color in reduced quality mode. If present, it is used instead of `sky` on low quality.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   153
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   154
<code>Values: red, green, blue</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   155
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   156
=== `sd-tint` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   157
Custom tinting of the background in Sudden Death. The background color will be multiplied by the RGB and opacity values. With `$FF, $FF, $FF, $FF`, there is no change, while with `$00, $00, $00, $FF`, the backgroun turns completely black. The opacity value controls how visible the background image will still be. With an opacity of `$00`, the background image is not visible, only the `sd-tint` color can be seen.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   158
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   159
<code>Values: red, green, blue, opacity</code>
464
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
   160
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   161
<code>Default: $80, $80, $80, $FF</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   162
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   163
=== `clouds` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   164
The number of clouds to create, before Sudden Death. Uses `Clouds.png`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   165
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   166
<code>Values: number</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   167
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   168
<code>Default: 9</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   169
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   170
=== `sd-clouds` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   171
Number of clouds while in Sudden Death, uses the file `SDClouds.png`. By default it is the same number as `clouds` or `9` if `clouds` was not specified as well.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   172
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   173
<code>Values: number</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   174
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   175
<code>Default: 9</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   176
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   177
=== `flatten-clouds` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   178
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).
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   179
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   180
=== `flakes` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   181
Values for the flakes of this theme before Sudden Death. Uses `Flake.png`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   182
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   183
 * `number`: Number of visible flakes.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   184
 * `frames`: Number of frames used in `Flake.png`
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   185
 * `frame ticks`: Number of ticks a frame is shown, after that the next frame is shown (a tick currently equals 1 millisecond). A value of 0 indicates that each flake should keep displaying the exact frame that was selected randomly when the flake was created.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   186
 * `rotation speed`: How fast the flakes rotate. `0` = no rotation, and all flakes spawn unrotated. With any other value, flakes also spawn with a random rotation
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   187
 * `vertical speed`: Vertical speed of the flakes. A positive value makes the flakes fall, while a negative value makes them rise
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   188
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   189
<code>Values: number, frames, frame ticks, rotation speed, vertical speed</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   190
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   191
No flakes are used by default.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   192
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   193
=== `sd-flakes` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   194
Sudden Death version of `flakes`, the parameters are the same as in `flakes`. This uses `SDFlake.png`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   195
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   196
<code>Values: number, frames, frame ticks, rotation speed, vertical speed</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   197
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   198
If `sd-flakes` is unspecified, skulls and bones are used as images and the following default values are used:
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   199
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   200
<code>Default: X, 4, 0, 15, 250</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   201
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   202
(The “X” means the default number of Sudden Death flakes is variable. It depends on the window size and the terrain width.)
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   203
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   204
=== `flatten-flakes` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   205
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.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   206
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   207
1315
7368027d526f ThemeCfg: upd headers
Wuzzy
parents: 1314
diff changeset
   208
== Music keys ==
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   209
=== `music` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   210
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!
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   211
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   212
If you choose a custom music (i.e. a music which does not come with Hedgewars by default), you should also set `fallback-music`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   213
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   214
<code>Values: filename</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   215
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   216
No music is played by default.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   217
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   218
Example:
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   219
<code>music = Nature.ogg</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   220
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   221
=== `sd-music` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   222
Name of the music file to be played in the theme while in Sudden Death, e.g. `hell.ogg`. 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!
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   223
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   224
If you choose a custom music, you should also set `fallback-sd-music`.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   225
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   226
<code>Values: filename</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   227
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   228
Default: `sdmusic.ogg` (only if `music` was specified, no music otherwise)
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   229
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   230
=== `fallback-music` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   231
Fallback music for the `music` setting. This setting should be added whenever you use a custom music which is not part of the official Hedgewars install. Otherwise you don't need to set this.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   232
If the music specified in `music` is missing, Hedgewars attempts to use this fallback music istead. *Only* use tracks which come with the official Hedgewars install.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   233
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   234
Note that if Hedgewars fails to find a music, it defaults to silence.
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   235
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   236
Example usage (in combination with `music`):
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   237
<code>music = My_Custom_Music.ogg
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   238
fallback-music = Nature.ogg</code>
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   239
1314
fa3ef0be3f4e ThemeCfg: flatten headers
Wuzzy
parents: 1313
diff changeset
   240
=== `fallback-sd-music` ===
1308
c92c204db09f ThemeCfg: add a new header layer
Wuzzy
parents: 1307
diff changeset
   241
Like `fallback-music`, except it's for `sd-music`.