Theme.wiki
changeset 806 366d41a07472
parent 805 d7bee302f736
child 807 66e7208703e3
equal deleted inserted replaced
805:d7bee302f736 806:366d41a07472
    12 
    12 
    13 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`.
    13 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`.
    14 
    14 
    15 Any line can be made into a comment line by having a semicolon (“`;`”) at the beginning. Comments are ignored by Hedgewars.
    15 Any line can be made into a comment line by having a semicolon (“`;`”) at the beginning. Comments are ignored by Hedgewars.
    16 
    16 
       
    17 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.
       
    18 
    17 == `sky` ==
    19 == `sky` ==
    18 The colour of the sky.
    20 The colour of the sky.
    19 
    21 
    20 <code>Values: red, green, blue</code>
    22 <code>Values: red, green, blue</code>
       
    23 
       
    24 <code>Default: 0, 0, 0</code> (black)
    21 
    25 
    22 == `rq-sky` ==
    26 == `rq-sky` ==
    23 The sky color in reduced quality mode. If present, it is used instead of `sky` on low quality.
    27 The sky color in reduced quality mode. If present, it is used instead of `sky` on low quality.
    24 
    28 
    25 <code>Values: red, green, blue</code>
    29 <code>Values: red, green, blue</code>
    27 == `border` ==
    31 == `border` ==
    28 The colour of the outline of explosions.
    32 The colour of the outline of explosions.
    29 
    33 
    30 <code>Values: red, green, blue</code>
    34 <code>Values: red, green, blue</code>
    31 
    35 
       
    36 <code>Default: 80, 80, 80</code> (gray)
       
    37 
    32 == `water-top` ==
    38 == `water-top` ==
    33 The colour of the topmost part of the water (under the `BlueWater.png`) before Sudden Death.
    39 The colour of the topmost part of the water (under the `BlueWater.png`) before Sudden Death.
    34 This makes a gradient together with `water-bottom`.
    40 This makes a gradient together with `water-bottom`. The default color
       
    41 is black which is usually not what you want.
       
    42 In combination with the default `BlueWater.png`, the recommended value is `$54, $5C, $9D`.
    35 
    43 
    36 <code>Values: red, green, blue</code>
    44 <code>Values: red, green, blue</code>
    37 
    45 
       
    46 <code>Default: 0, 0, 0</code> (black)
       
    47 
    38 == `water-bottom` ==
    48 == `water-bottom` ==
    39 The colour of the lowest part of the water before Sudden Death.
    49 The colour of the lowest part of the water before Sudden Death.
    40 This makes a gradient together with `water-top`.
    50 This makes a gradient together with `water-top`. The default color
       
    51 is black which is usually not what you want.
       
    52 In combination with the default `BlueWater.png`, the recommended value is `$34, $3C, $7D`.
    41 
    53 
    42 <code>Values: red, green, blue</code>
    54 <code>Values: red, green, blue</code>
       
    55 
       
    56 <code>Default: 0, 0, 0</code> (black)
    43 
    57 
    44 == `sd-water-bottom` ==
    58 == `sd-water-bottom` ==
    45 The colour of the lowest part of the water while in Sudden Death.
    59 The colour of the lowest part of the water while in Sudden Death.
    46 This makes a gradient together with `sd-water-top`.
    60 This makes a gradient together with `sd-water-top`.
    47 If unspecified, it has a default value.
    61 If unspecified, the default value `150, 112, 169` is used,
       
    62 The default color neatly matches the default `SDWater.png`.
    48 
    63 
    49 <code>Values: red, green, blue</code>
    64 <code>Values: red, green, blue</code>
       
    65 
       
    66 <code>Default: 150, 112, 169</code> (purple)
    50 
    67 
    51 == `sd-water-top` ==
    68 == `sd-water-top` ==
    52 The colour of the topmost part of the water (under the `SDWater.png`) while in Sudden Death.
    69 The colour of the topmost part of the water (under the `SDWater.png`) while in Sudden Death.
    53 This makes a gradient together with `sd-water-bottom`.
    70 This makes a gradient together with `sd-water-bottom`.
    54 If unspecified, it has a default value.
    71 The default color neatly matches the default `SDWater.png`.
    55 
    72 
    56 <code>Values: red, green, blue</code>
    73 <code>Values: red, green, blue</code>
    57 
    74 
       
    75 <code>Default: 182, 144, 201</code> (purple)
       
    76 
    58 == `water-opacity` ==
    77 == `water-opacity` ==
    59 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` makes it fully opaque. If the water is fully opaque, the drowning animation is skipped when a hedgehog drowns.
    78 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.
       
    79 
       
    80 In combination with the default `BlueWater.png`, the recommended value for this is `$80`, which also is the default.
    60 
    81 
    61 <code>Values: opacity</code>
    82 <code>Values: opacity</code>
       
    83 
       
    84 <code>Default: $80</code>
    62 
    85 
    63 == `sd-water-opacity` ==
    86 == `sd-water-opacity` ==
    64 The water opacity while in Sudden Death. By default, it has the same value as `water-opacity`.
    87 The water opacity while in Sudden Death. By default, it has the same value as `water-opacity`.
    65 
    88 
    66 <code>Values: opacity</code>
    89 <code>Values: opacity</code>
       
    90 
       
    91 <code>Default: $80</code>
    67 
    92 
    68 == `music` ==
    93 == `music` ==
    69 Name of the music file to be played in the theme before Sudden Death, e.g. `Nature.ogg`. If missing, no music is played before Sudden Death. You find music tracks in `Data/Music` of the Hedgewars installation directory. The file name is case-sensitive!
    94 Name of the music file to be played in the theme before Sudden Death, e.g. `Nature.ogg`. If missing, no music is played before Sudden Death. You find music tracks in `Data/Music` of the Hedgewars installation directory. The file name is case-sensitive!
    70 
    95 
    71 <code>Values: filename</code>
    96 <code>Values: filename</code>
    72 
    97 
    73 == `sd-music` (0.9.21) ==
    98 == `sd-music` (0.9.21) ==
    74 Name of the music file to be played in the theme while in Sudden Death, e.g. `hell.ogg`. By default, `sdmusic.ogg` is played in Sudden Death. You find music tracks in `Data/Music` of the Hedgewars installation directory. The file name is case-sensitive!
    99 Name of the music file to be played in the theme while in Sudden Death, e.g. `hell.ogg`. By default, `sdmusic.ogg` is played in Sudden Death, but only, if `music` has been specified. 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!
    75 
   100 
    76 <code>Values: filename</code>
   101 <code>Values: filename</code>
    77 
   102 
    78 == `clouds` ==
   103 == `clouds` ==
    79 The number of clouds to create, before Sudden Death. Uses `Clouds.png`.
   104 The number of clouds to create, before Sudden Death. Uses `Clouds.png`. By default, 9 clouds are used.
    80 
   105 
    81 <code>Values: number</code>
   106 <code>Values: number</code>
    82 
   107 
    83 == `sd-clouds` ==
   108 == `sd-clouds` ==
    84 Number of clouds while in Sudden Death, uses the file `SDClouds.png`. By default it is the same number as `clouds`.
   109 Number of clouds while in Sudden Death, uses the file `SDClouds.png`. By default it is the same number as `clouds`. If `clouds` was not specified, 9 clouds are used.
    85 
   110 
    86 <code>Values: number</code>
   111 <code>Values: number</code>
    87 
   112 
    88 == `flatten-clouds` ==
   113 == `flatten-clouds` ==
    89 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).
   114 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).
    91 The value of this key does not matter, the key must only be present to take effect.
   116 The value of this key does not matter, the key must only be present to take effect.
    92 
   117 
    93 == `flakes` ==
   118 == `flakes` ==
    94 Values for the flakes of this theme before Sudden Death. Uses `Flake.png`. If this field is left out, then there are no flakes.
   119 Values for the flakes of this theme before Sudden Death. Uses `Flake.png`. If this field is left out, then there are no flakes.
    95 
   120 
    96  * `number`: Number of visible flakes
   121  * `number`: Number of visible flakes.
    97  * `frames`: Number of frames used in `Flake.png`
   122  * `frames`: Number of frames used in `Flake.png`
    98  * `frame ticks`: Number of ticks a frame is shown, after that the next frame is shown (a tick currently equals 1 millisecond).
   123  * `frame ticks`: Number of ticks a frame is shown, after that the next frame is shown (a tick currently equals 1 millisecond).
    99 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.
   124 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.
   100 *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.
   125 *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.
   101  * `speed`: Rotation speed of flake
   126  * `speed`: Rotation speed of flake
   102  * `fall speed`: Falling speed of flake
   127  * `fall speed`: Falling speed of flake
   103 
   128 
   104 <code>Values: number, frames, frame ticks, speed, fall speed</code>
   129 <code>Values: number, frames, frame ticks, speed, fall speed</code>
   105 
   130 
       
   131 <code>Default: 0, 4, 0, 10, 100</code> (In other words, no flakes are used)
       
   132 
   106 == `sd-flakes` ==
   133 == `sd-flakes` ==
   107 Sudden death version of `flakes`, the parameters are the same as in `flakes`. This uses `SDFlake.png`. By default, the flakes are skulls and bones.
   134 Sudden death version of `flakes`, the parameters are the same as in `flakes`. This uses `SDFlake.png`.
   108 
   135 
   109 <code>Values: number, frames, frame ticks, speed, fall speed</code>
   136 <code>Values: number, frames, frame ticks, speed, fall speed</code>
       
   137 
       
   138 <code>Default: X, 4, 0, 15, 250</code>
       
   139 
       
   140 (The “X” means the default number of Sudden Death flakes is variable. It depends on the window size and the terrain width.)
   110 
   141 
   111 == `flatten-flakes` ==
   142 == `flatten-flakes` ==
   112 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.
   143 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.
   113 
   144 
   114 The value of this key does not matter, the key must only be present to take effect.
   145 The value of this key does not matter, the key must only be present to take effect.