ThemeCfg.wiki
author Wuzzy
Thu, 22 Mar 2018 16:02:38 +0000
changeset 1268 4eeac350c9e1
parent 1266 427e63ea7539
child 1305 43305c6af4bf
permissions -rw-r--r--
ThemeFiles: better describe icon.png stuff
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
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
     3
= `theme.cfg` =
1019
0f9e43961b7e ThemeCfg: link back to Themes
Wuzzy
parents: 1011
diff changeset
     4
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].
816
08e347c81554 Theme: fixes
Wuzzy
parents: 815
diff changeset
     5
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.
815
69b8476b4bb2 Theme: Better example
Wuzzy
parents: 814
diff changeset
     6
69b8476b4bb2 Theme: Better example
Wuzzy
parents: 814
diff changeset
     7
Example:
69b8476b4bb2 Theme: Better example
Wuzzy
parents: 814
diff changeset
     8
<code>sky = 23, 8, 33
69b8476b4bb2 Theme: Better example
Wuzzy
parents: 814
diff changeset
     9
border = 7, 72, 102
69b8476b4bb2 Theme: Better example
Wuzzy
parents: 814
diff changeset
    10
music = Art.ogg</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    11
814
f0c338d954cb Theme: grammar fix
Wuzzy
parents: 813
diff changeset
    12
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
    13
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    14
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
    15
1124
b37c99c55365 ThemeCfg: convert color numbers to hexadecimal form, consistently
Wuzzy
parents: 1123
diff changeset
    16
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
    17
463
35d43dbb99ad Clarified comments
almikes@aol.com
parents: 462
diff changeset
    18
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
    19
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    20
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
    21
1266
427e63ea7539 ThemeCfg: Add hidden key
Wuzzy
parents: 1201
diff changeset
    22
== `hidden` (0.9.24) ==
427e63ea7539 ThemeCfg: Add hidden key
Wuzzy
parents: 1201
diff changeset
    23
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
    24
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    25
== `sky` ==
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    26
The colour of the sky.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    27
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    28
<code>Values: red, green, blue</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    29
1124
b37c99c55365 ThemeCfg: convert color numbers to hexadecimal form, consistently
Wuzzy
parents: 1123
diff changeset
    30
<code>Default: $00, $00, $00</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    31
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    32
== `rq-sky` ==
462
4416c2ed13d8 Clarify rq-sky.
almikes@aol.com
parents: 451
diff changeset
    33
The sky color in reduced quality mode. If present, it is used instead of `sky` on low quality.
4416c2ed13d8 Clarify rq-sky.
almikes@aol.com
parents: 451
diff changeset
    34
4416c2ed13d8 Clarify rq-sky.
almikes@aol.com
parents: 451
diff changeset
    35
<code>Values: red, green, blue</code>
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    36
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    37
== `border` ==
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    38
The colour of the outline of explosions.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    39
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    40
<code>Values: red, green, blue</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    41
1124
b37c99c55365 ThemeCfg: convert color numbers to hexadecimal form, consistently
Wuzzy
parents: 1123
diff changeset
    42
<code>Default: $50, $50, $50</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    43
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    44
== `water-top` ==
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    45
The colour of the topmost part of the water (under the `BlueWater.png`) before Sudden Death.
1123
02863856f674 ThemeCfg: update default water color in 0.9.23
Wuzzy
parents: 1122
diff changeset
    46
This makes a gradient together with `water-bottom`. The default color is blue and matches the default `BlueColor.png`.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    47
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    48
<code>Values: red, green, blue</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    49
1123
02863856f674 ThemeCfg: update default water color in 0.9.23
Wuzzy
parents: 1122
diff changeset
    50
<code>Default: $54, $5C, $9D</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    51
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    52
== `water-bottom` ==
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    53
The colour of the lowest part of the water before Sudden Death.
1123
02863856f674 ThemeCfg: update default water color in 0.9.23
Wuzzy
parents: 1122
diff changeset
    54
This makes a gradient together with `water-top`. The default color is blue and matches the default `BlueColor.png`.
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    55
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    56
<code>Values: red, green, blue</code>
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    57
1123
02863856f674 ThemeCfg: update default water color in 0.9.23
Wuzzy
parents: 1122
diff changeset
    58
<code>Default: $34, $3C, $7D</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    59
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    60
== `sd-water-bottom` ==
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    61
The colour of the lowest part of the water while in Sudden Death.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    62
This makes a gradient together with `sd-water-top`.
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    63
The default color neatly matches the default `SDWater.png`.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    64
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    65
<code>Values: red, green, blue</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    66
1124
b37c99c55365 ThemeCfg: convert color numbers to hexadecimal form, consistently
Wuzzy
parents: 1123
diff changeset
    67
<code>Default: $96, $70, $A9</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    68
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    69
== `sd-water-top` ==
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    70
The colour of the topmost part of the water (under the `SDWater.png`) while in Sudden Death.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    71
This makes a gradient together with `sd-water-bottom`.
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    72
The default color neatly matches the default `SDWater.png`.
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    73
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    74
<code>Values: red, green, blue</code>
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    75
1124
b37c99c55365 ThemeCfg: convert color numbers to hexadecimal form, consistently
Wuzzy
parents: 1123
diff changeset
    76
<code>Default: $B9, $72, $C9</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    77
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    78
== `water-opacity` ==
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    79
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.
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    80
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    81
In combination with the default `BlueWater.png`, the recommended value for this is `$80`, which also is the default.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    82
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    83
<code>Values: opacity</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    84
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    85
<code>Default: $80</code>
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    86
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    87
== `sd-water-opacity` ==
953
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
    88
The water opacity while in Sudden Death. Syntax and default value is equivalent to `water-opacity`.
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
    89
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
    90
== `water-animation` (0.9.23) ==
954
d1d33abc6377 Theme: Clarify water-aimation
Wuzzy
parents: 953
diff changeset
    91
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.
953
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
    92
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
    93
<code>Values: frames, frame ticks, movement speed</code>
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    94
954
d1d33abc6377 Theme: Clarify water-aimation
Wuzzy
parents: 953
diff changeset
    95
 * `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`
955
9fb2a1738685 Theme: clarify anim once again
Wuzzy
parents: 954
diff changeset
    96
 * `frame ticks`: Duration of a single frame. Must be >0 if `frames`>1, otherwise it is ignored
954
d1d33abc6377 Theme: Clarify water-aimation
Wuzzy
parents: 953
diff changeset
    97
 * `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
803
ef44649bd9df Theme: Explain values syntax everywhere
Wuzzy
parents: 801
diff changeset
    98
953
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
    99
<code>Default: 1, 0, 1</code>
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
   100
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
   101
== `sd-water-animation` (0.9.23) ==
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
   102
Sudden Death equivalent of `water-animation`, uses `SDWater.png`.
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   103
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   104
== `music` ==
812
1538e98a4d03 Theme: music defaults
Wuzzy
parents: 808
diff changeset
   105
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!
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   106
1198
b29cfb69ac93 ThemeCfg: fix bracket
Wuzzy
parents: 1197
diff changeset
   107
If you choose a custom music (i.e. a music which does not come with Hedgewars by default), you should also set `fallback-music`.
1196
2fe37599857f ThemeCfg: More fallback stuff
Wuzzy
parents: 1195
diff changeset
   108
804
ed22ff58ac55 Theme: music/sd-music fix
Wuzzy
parents: 803
diff changeset
   109
<code>Values: filename</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   110
812
1538e98a4d03 Theme: music defaults
Wuzzy
parents: 808
diff changeset
   111
No music is played by default.
1538e98a4d03 Theme: music defaults
Wuzzy
parents: 808
diff changeset
   112
1141
9d37cc22ae9b ThemeCfg: remove .21 note
Wuzzy
parents: 1138
diff changeset
   113
== `sd-music` ==
812
1538e98a4d03 Theme: music defaults
Wuzzy
parents: 808
diff changeset
   114
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!
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   115
1196
2fe37599857f ThemeCfg: More fallback stuff
Wuzzy
parents: 1195
diff changeset
   116
If you choose a custom music, you should also set `fallback-sd-music`.
2fe37599857f ThemeCfg: More fallback stuff
Wuzzy
parents: 1195
diff changeset
   117
804
ed22ff58ac55 Theme: music/sd-music fix
Wuzzy
parents: 803
diff changeset
   118
<code>Values: filename</code>
ed22ff58ac55 Theme: music/sd-music fix
Wuzzy
parents: 803
diff changeset
   119
812
1538e98a4d03 Theme: music defaults
Wuzzy
parents: 808
diff changeset
   120
Default: `sdmusic.ogg` (only if `music` was specified, no music otherwise)
1538e98a4d03 Theme: music defaults
Wuzzy
parents: 808
diff changeset
   121
1194
d20d8214bb67 ThemeCfg: Add fallback-music and fallback-sd-music
Wuzzy
parents: 1193
diff changeset
   122
== `fallback-music` ==
d20d8214bb67 ThemeCfg: Add fallback-music and fallback-sd-music
Wuzzy
parents: 1193
diff changeset
   123
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.
1197
a429f011e687 ThemeCfg: fix asterisk
Wuzzy
parents: 1196
diff changeset
   124
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.
1194
d20d8214bb67 ThemeCfg: Add fallback-music and fallback-sd-music
Wuzzy
parents: 1193
diff changeset
   125
d20d8214bb67 ThemeCfg: Add fallback-music and fallback-sd-music
Wuzzy
parents: 1193
diff changeset
   126
Note that if Hedgewars fails to find a music, it defaults to silence.
d20d8214bb67 ThemeCfg: Add fallback-music and fallback-sd-music
Wuzzy
parents: 1193
diff changeset
   127
d20d8214bb67 ThemeCfg: Add fallback-music and fallback-sd-music
Wuzzy
parents: 1193
diff changeset
   128
Fallback music is not yet supported in 0.9.23, but it will be supported in 0.9.24. You can already add this setting safely, Hedgewars 0.9.23 (and earlier) will just ignore it.
d20d8214bb67 ThemeCfg: Add fallback-music and fallback-sd-music
Wuzzy
parents: 1193
diff changeset
   129
d20d8214bb67 ThemeCfg: Add fallback-music and fallback-sd-music
Wuzzy
parents: 1193
diff changeset
   130
== `fallback-sd-music` ==
d20d8214bb67 ThemeCfg: Add fallback-music and fallback-sd-music
Wuzzy
parents: 1193
diff changeset
   131
Like `fallback-music`, except it's for `sd-music`.
d20d8214bb67 ThemeCfg: Add fallback-music and fallback-sd-music
Wuzzy
parents: 1193
diff changeset
   132
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   133
== `clouds` ==
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   134
The number of clouds to create, before Sudden Death. Uses `Clouds.png`.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   135
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
   136
<code>Values: number</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   137
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   138
<code>Default: 9</code>
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   139
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   140
== `sd-clouds` ==
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   141
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.
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   142
803
ef44649bd9df Theme: Explain values syntax everywhere
Wuzzy
parents: 801
diff changeset
   143
<code>Values: number</code>
ef44649bd9df Theme: Explain values syntax everywhere
Wuzzy
parents: 801
diff changeset
   144
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   145
<code>Default: 9</code>
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   146
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   147
== `flatten-clouds` ==
464
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
   148
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).
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
   149
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   150
== `flakes` ==
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   151
Values for the flakes of this theme before Sudden Death. Uses `Flake.png`.
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   152
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   153
 * `number`: Number of visible flakes.
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   154
 * `frames`: Number of frames used in `Flake.png`
1122
e6d120deeae9 ThemeCfg: rising flakes
Wuzzy
parents: 1121
diff changeset
   155
 * `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.
1200
14b9aad5e21c ThemeCfg: Rename flakes values
Wuzzy
parents: 1199
diff changeset
   156
 * `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
1201
9eb10c4d6f5b ThemeCfg: Typo fixes
Wuzzy
parents: 1200
diff changeset
   157
 * `vertical speed`: Vertical speed of the flakes. A positive value makes the flakes fall, while a negative value makes them rise
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   158
1200
14b9aad5e21c ThemeCfg: Rename flakes values
Wuzzy
parents: 1199
diff changeset
   159
<code>Values: number, frames, frame ticks, rotation speed, vertical speed</code>
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   160
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   161
No flakes are used by default.
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   162
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   163
== `sd-flakes` ==
1145
006a65f86b5c ThemeCfg: Fix sd-flakes default
Wuzzy
parents: 1142
diff changeset
   164
Sudden Death version of `flakes`, the parameters are the same as in `flakes`. This uses `SDFlake.png`.
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   165
1200
14b9aad5e21c ThemeCfg: Rename flakes values
Wuzzy
parents: 1199
diff changeset
   166
<code>Values: number, frames, frame ticks, rotation speed, vertical speed</code>
803
ef44649bd9df Theme: Explain values syntax everywhere
Wuzzy
parents: 801
diff changeset
   167
1146
518cb4e4dc76 ThemeCfg: update sd-flakes text
Wuzzy
parents: 1145
diff changeset
   168
If `sd-flakes` is unspecified, skulls and bones are used as images and the following default values are used:
1145
006a65f86b5c ThemeCfg: Fix sd-flakes default
Wuzzy
parents: 1142
diff changeset
   169
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   170
<code>Default: X, 4, 0, 15, 250</code>
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   171
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   172
(The “X” means the default number of Sudden Death flakes is variable. It depends on the window size and the terrain width.)
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   173
1138
b32441125bb8 ThemeCfg: Add sd-tint
Wuzzy
parents: 1124
diff changeset
   174
== `sd-tint` ==
1193
4e4e0725777d ThemeCfg: Explain sd-tint in more detail
Wuzzy
parents: 1146
diff changeset
   175
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.
1138
b32441125bb8 ThemeCfg: Add sd-tint
Wuzzy
parents: 1124
diff changeset
   176
b32441125bb8 ThemeCfg: Add sd-tint
Wuzzy
parents: 1124
diff changeset
   177
<code>Values: red, green, blue, opacity</code>
b32441125bb8 ThemeCfg: Add sd-tint
Wuzzy
parents: 1124
diff changeset
   178
b32441125bb8 ThemeCfg: Add sd-tint
Wuzzy
parents: 1124
diff changeset
   179
<code>Default: $80, $80, $80, $FF</code>
b32441125bb8 ThemeCfg: Add sd-tint
Wuzzy
parents: 1124
diff changeset
   180
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   181
== `flatten-flakes` ==
464
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
   182
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.
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
   183
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   184
== `object` ==
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
   185
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
   186
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   187
 * `filename`: The object’s filename (without the “.png”). Case-sensitive.
1142
eba210749526 ThemeCfg: fix bracket
Wuzzy
parents: 1141
diff changeset
   188
 * `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
   189
 * `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
   190
 * `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
   191
 * `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
   192
 * `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
   193
1121
0a7925ca59e3 ThemeCfg: update buried rects
Wuzzy
parents: 1019
diff changeset
   194
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
   195
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
   196
<code>Values: filename, max, buriedrec, minvisible, visiblerec</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   197
1121
0a7925ca59e3 ThemeCfg: update buried rects
Wuzzy
parents: 1019
diff changeset
   198
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
   199
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
   200
<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
   201
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
   202
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
   203
798
30c5f1ebd552 global replace of http with https for hedgewars.org wiki links
nemo
parents: 746
diff changeset
   204
https://hedgewars.org/images/avematantheme/hw-avematan.rects.png
448
e419fde32f07 Adding picture (blashphemy?)
sheepyluva@gmail.com
parents: 438
diff changeset
   205
990
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
   206
The large rectangle shows a `visiblerects` and the small one shows a `buriedrects`.
808
a6c6a92dc83f Theme: fix image align
Wuzzy
parents: 807
diff changeset
   207
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   208
== `spray` ==
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   209
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
   210
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
   211
464
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
   212
<code>Values: name, number</code>
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
   213
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   214
== `ice` ==
803
ef44649bd9df Theme: Explain values syntax everywhere
Wuzzy
parents: 801
diff changeset
   215
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.
464
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
   216
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   217
== `snow` ==
813
f3d77338c4c2 Theme: remove redundant sentences
Wuzzy
parents: 812
diff changeset
   218
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.