Theme.wiki
author almikes@aol.com
Wed, 03 Dec 2014 20:20:36 +0000
changeset 433 0661855ab04a
parent 320 91a3a47a1615
child 434 1ce0c043a837
permissions -rw-r--r--
Reorganize the page, improve typography, add sd-music.
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
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
     3
== Theme.cfg ==
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
     4
This file gives the engine the values associated with a certain theme, to complement the graphics.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
     5
It is structured with a key followed by a number of values. Example:
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
     6
<code>sky = 120, 40, 80</code>
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
     7
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
     8
There is 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 quality is reduced. These keys must be placed after the regular keys and they are all optional.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
     9
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    10
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
    11
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    12
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 0 - $FF.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    13
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    14
Comments may be added by prefixing a semicolon (“`;`”) to the comment.
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    15
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    16
=== `sky` ===
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    17
The colour of the sky.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    18
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    19
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    20
<code>Values: red, green, blue</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    21
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    22
=== `rq-sky` ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    23
Reduced quality version of sky. If present used instead of `sky` on low quality.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    24
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    25
=== `border` ===
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    26
The colour of the outline of explosions.
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
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    30
=== `water-top` ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    31
The colour of the topmost part of the water (under the `BlueWater.png`) before Sudden Death.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    32
This makes a gradient together with `water-bottom`.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    33
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    34
<code>Values: red, green, blue</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    35
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    36
=== `water-bottom` ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    37
The colour of the lowest part of the water before Sudden Death.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    38
This makes a gradient together with `water-top`.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    39
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    40
<code>Values: red, green, blue</code>
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    41
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    42
=== `sd-water-bottom` ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    43
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
    44
This makes a gradient together with `sd-water-top`.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    45
If unspecified, it has a default value.
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
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    49
=== `sd-water-top` ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    50
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
    51
This makes a gradient together with `sd-water-bottom`.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    52
If unspecified, it has a default value.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    53
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    54
<code>Values: red, green, blue</code>
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
=== `water-opacity` ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    57
The water opacity before Sudden Death. Opacity of the water affects how visible gears in the water are.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    58
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    59
<code>Values: opacity</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    60
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    61
=== `sd-water-opacity` ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    62
The water opacity while in Sudden Death. By default, it has the same value as `water-opacity`.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    63
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    64
=== `music` ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    65
Name of the track 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
    66
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    67
<code>Values: name</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    68
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    69
=== `sd-music` (0.9.21) ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    70
Name of the track to be played in the theme while in Sudden Death, e.g. `hell.ogg`. By default, no music is played. You find music tracks in `Data/Music` of the Hedgewars installation directory. The file name is case-sensitive!
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    71
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    72
=== `clouds` ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    73
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
    74
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    75
<code>Values: number</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    76
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    77
=== `sd-clouds` ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    78
Number of clouds while in Sudden Death, uses the file `SDClouds.png`. By default it is the same number as `clouds`.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    79
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    80
=== `flakes` ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    81
Values for the flakes of this theme before Sudden Death. Uses `Flake.png`. If this field is left out, then there are no flakes.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    82
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    83
 * `number`: Number of visible flakes
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    84
 * `frames`: Number of frames used in `Flake.png`
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    85
 * `frame ticks`: Number of ticks a frame is shown, after that the next frame is shown (a tick currently equals 1 millisecond)
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    86
 * `speed`: Rotation speed of flake
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    87
 * `fall speed`: Falling speed of flake
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    88
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    89
<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
    90
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    91
=== `sd-flakes` ===
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    92
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.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    93
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    94
=== `object` ===
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    95
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
    96
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    97
 * `filename`: The object’s filename (without the “.png”). Case-sensitive.
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    98
 * `max`: The maximum number of this object that may be generated in a map
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
    99
 * `buriedrec`: A rectangle that must be buried in the terrain (`left, top, width,  height`)
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   100
 * `minvisible`: The minimum amount of rectangles that must be visible
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   101
 * `visiblerec`: list of the rectangles for being visible (`left, top, width, height`)
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
   102
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
   103
<code>Values: filename, max, buriedrec, minvisible, visiblerec</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   104
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   105
=== `spray` ===
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   106
There may be several spray keys in the file, each one representing one spray object.
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   107
The `name` is the case-sensitive name of the PNG file (without the file name suffix) of the graphics file, and `number` is the number of instances of this spray that may be added.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
   108
433
0661855ab04a Reorganize the page, improve typography, add sd-music.
almikes@aol.com
parents: 320
diff changeset
   109
<code>Values: name, number</code>