ThemeCfg.wiki
author Wuzzy
Wed, 04 Oct 2017 11:48:28 +0100
changeset 1054 0de5837d0fc5
parent 1019 0f9e43961b7e
child 1121 0a7925ca59e3
permissions -rw-r--r--
LuaAPI: Add EndLuaTest
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
434
1ce0c043a837 More typography improvements
almikes@aol.com
parents: 433
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. The range are `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
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    22
== `sky` ==
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    23
The colour of the sky.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    24
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    25
<code>Values: red, green, blue</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    26
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
    27
<code>Default: 0, 0, 0</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    28
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    29
== `rq-sky` ==
462
4416c2ed13d8 Clarify rq-sky.
almikes@aol.com
parents: 451
diff changeset
    30
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
    31
4416c2ed13d8 Clarify rq-sky.
almikes@aol.com
parents: 451
diff changeset
    32
<code>Values: red, green, blue</code>
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    33
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    34
== `border` ==
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    35
The colour of the outline of explosions.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    36
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    37
<code>Values: red, green, blue</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    38
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
    39
<code>Default: 80, 80, 80</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    40
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    41
== `water-top` ==
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    42
The colour of the topmost part of the water (under the `BlueWater.png`) before Sudden Death.
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    43
This makes a gradient together with `water-bottom`. The default color
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    44
is black which is usually not what you want.
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    45
In combination with the default `BlueWater.png`, the recommended value is `$54, $5C, $9D`.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    46
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    47
<code>Values: red, green, blue</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    48
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
    49
<code>Default: 0, 0, 0</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    50
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    51
== `water-bottom` ==
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    52
The colour of the lowest part of the water before Sudden Death.
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    53
This makes a gradient together with `water-top`. The default color
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    54
is black which is usually not what you want.
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    55
In combination with the default `BlueWater.png`, the recommended value is `$34, $3C, $7D`.
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    56
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    57
<code>Values: red, green, blue</code>
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    58
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
    59
<code>Default: 0, 0, 0</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    60
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    61
== `sd-water-bottom` ==
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    62
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
    63
This makes a gradient together with `sd-water-top`.
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    64
The default color neatly matches the default `SDWater.png`.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    65
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    66
<code>Values: red, green, blue</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    67
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
    68
<code>Default: 150, 112, 169</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    69
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    70
== `sd-water-top` ==
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    71
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
    72
This makes a gradient together with `sd-water-bottom`.
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    73
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
    74
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    75
<code>Values: red, green, blue</code>
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    76
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
    77
<code>Default: 182, 144, 201</code>
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    78
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    79
== `water-opacity` ==
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    80
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
    81
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    82
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
    83
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    84
<code>Values: opacity</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    85
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    86
<code>Default: $80</code>
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
    87
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
    88
== `sd-water-opacity` ==
953
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
    89
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
    90
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
    91
== `water-animation` (0.9.23) ==
954
d1d33abc6377 Theme: Clarify water-aimation
Wuzzy
parents: 953
diff changeset
    92
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
    93
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
    94
<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
    95
954
d1d33abc6377 Theme: Clarify water-aimation
Wuzzy
parents: 953
diff changeset
    96
 * `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
    97
 * `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
    98
 * `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
    99
953
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
   100
<code>Default: 1, 0, 1</code>
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
   101
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
   102
== `sd-water-animation` (0.9.23) ==
2237b516213b Theme: Add water-animation and sd-water-animation
Wuzzy
parents: 952
diff changeset
   103
Sudden Death equivalent of `water-animation`, uses `SDWater.png`.
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   104
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   105
== `music` ==
812
1538e98a4d03 Theme: music defaults
Wuzzy
parents: 808
diff changeset
   106
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
   107
804
ed22ff58ac55 Theme: music/sd-music fix
Wuzzy
parents: 803
diff changeset
   108
<code>Values: filename</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   109
812
1538e98a4d03 Theme: music defaults
Wuzzy
parents: 808
diff changeset
   110
No music is played by default.
1538e98a4d03 Theme: music defaults
Wuzzy
parents: 808
diff changeset
   111
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   112
== `sd-music` (0.9.21) ==
812
1538e98a4d03 Theme: music defaults
Wuzzy
parents: 808
diff changeset
   113
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
   114
804
ed22ff58ac55 Theme: music/sd-music fix
Wuzzy
parents: 803
diff changeset
   115
<code>Values: filename</code>
ed22ff58ac55 Theme: music/sd-music fix
Wuzzy
parents: 803
diff changeset
   116
812
1538e98a4d03 Theme: music defaults
Wuzzy
parents: 808
diff changeset
   117
Default: `sdmusic.ogg` (only if `music` was specified, no music otherwise)
1538e98a4d03 Theme: music defaults
Wuzzy
parents: 808
diff changeset
   118
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   119
== `clouds` ==
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   120
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
   121
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
   122
<code>Values: number</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   123
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   124
<code>Default: 9</code>
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   125
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   126
== `sd-clouds` ==
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   127
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
   128
803
ef44649bd9df Theme: Explain values syntax everywhere
Wuzzy
parents: 801
diff changeset
   129
<code>Values: number</code>
ef44649bd9df Theme: Explain values syntax everywhere
Wuzzy
parents: 801
diff changeset
   130
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   131
<code>Default: 9</code>
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   132
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   133
== `flatten-clouds` ==
464
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
   134
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
   135
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   136
== `flakes` ==
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   137
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
   138
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   139
 * `number`: Number of visible flakes.
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   140
 * `frames`: Number of frames used in `Flake.png`
451
4e3ad1dc80af updated flakes
sheepyluva@gmail.com
parents: 448
diff changeset
   141
 * `frame ticks`: Number of ticks a frame is shown, after that the next frame is shown (a tick currently equals 1 millisecond).
4e3ad1dc80af updated flakes
sheepyluva@gmail.com
parents: 448
diff changeset
   142
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.
4e3ad1dc80af updated flakes
sheepyluva@gmail.com
parents: 448
diff changeset
   143
*Tip*: If you want to have multiple static flakes in 0.9.20 or earlier, you can set the animation length to a ridiculous high value. Sometimes, a flake will still change the displayed frame, but it will rarely happen.
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   144
 * `speed`: Rotation speed of flake
948
f86223a924c4 Theme: Rising flakes
Wuzzy
parents: 945
diff changeset
   145
 * `fall speed`: Falling speed of flake. Since 0.9.23, this can be negative for rising flakes
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   146
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   147
<code>Values: number, frames, frame ticks, speed, fall speed</code>
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   148
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   149
No flakes are used by default.
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   150
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   151
== `sd-flakes` ==
807
66e7208703e3 Theme: Default cleanup
Wuzzy
parents: 806
diff changeset
   152
Sudden death version of `flakes`, the parameters are the same as in `flakes`. This uses `SDFlake.png`. If `flakes` was unspecified, then there are no Sudden Death flakes by default, the default shown below only applies if `flakes` has been specified.
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   153
803
ef44649bd9df Theme: Explain values syntax everywhere
Wuzzy
parents: 801
diff changeset
   154
<code>Values: number, frames, frame ticks, speed, fall speed</code>
ef44649bd9df Theme: Explain values syntax everywhere
Wuzzy
parents: 801
diff changeset
   155
806
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   156
<code>Default: X, 4, 0, 15, 250</code>
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   157
366d41a07472 Theme: More about default values
Wuzzy
parents: 805
diff changeset
   158
(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
   159
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   160
== `flatten-flakes` ==
464
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
   161
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
   162
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   163
== `object` ==
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
   164
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
   165
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   166
 * `filename`: The object’s filename (without the “.png”). Case-sensitive.
990
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
   167
 * `max`: The maximum number of this object that may be generated in a map (must by between 1 and 32
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
   168
 * `buriedrects_num`: (optional): Number of rectangles that must be buried in the terrain. If this value is ommitted, a value of 1 is assumed. Only available in version 0.9.23 or later
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
   169
 * `buriedrects`: A rectangle that must be buried in the terrain (`left, top, width, height`). In version 0.9.23, 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
   170
 * `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
   171
 * `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
   172
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
   173
Syntax for version 0.9.22, or 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
   174
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
   175
<code>Values: filename, max, buriedrec, minvisible, visiblerec</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   176
990
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
   177
Syntax when using multiple buried rectangles in 0.9.23:
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
   178
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
   179
<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
   180
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
   181
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
   182
798
30c5f1ebd552 global replace of http with https for hedgewars.org wiki links
nemo
parents: 746
diff changeset
   183
https://hedgewars.org/images/avematantheme/hw-avematan.rects.png
448
e419fde32f07 Adding picture (blashphemy?)
sheepyluva@gmail.com
parents: 438
diff changeset
   184
990
606b2d0c5a09 Theme: Explain multiple buried rectangles in 0.9.23
Wuzzy
parents: 955
diff changeset
   185
The large rectangle shows a `visiblerects` and the small one shows a `buriedrects`.
808
a6c6a92dc83f Theme: fix image align
Wuzzy
parents: 807
diff changeset
   186
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   187
== `spray` ==
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   188
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
   189
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
   190
464
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
   191
<code>Values: name, number</code>
9a18697ec4ad Add flatten-clouds and flatten-flakes
almikes@aol.com
parents: 463
diff changeset
   192
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   193
== `ice` ==
803
ef44649bd9df Theme: Explain values syntax everywhere
Wuzzy
parents: 801
diff changeset
   194
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
   195
746
d53a01a00832 Theme: Reduce header level by 1
Wuzzy
parents: 490
diff changeset
   196
== `snow` ==
813
f3d77338c4c2 Theme: remove redundant sentences
Wuzzy
parents: 812
diff changeset
   197
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.