Theme.wiki
author jacoberen@gmail.com
Wed, 23 Nov 2011 17:51:49 +0000
changeset 164 f9ced3436b10
parent 83 b9fe713d7c27
child 319 e5542ee81444
permissions -rw-r--r--
Edited wiki page ConfigurationFiles through web user interface.
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
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    14
=== sky ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    15
The colour of the sky.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    16
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    17
Values: red, green, blue
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    18
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    19
Values: red, green, blue
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    20
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    21
=== border ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    22
The colour of the outline of explosions.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    23
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    24
Values: red, green, blue
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    25
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    26
=== water-top ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    27
The colour of the topmost part of the water (under the water.png).
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    28
This makes a gradient together with water-bottom.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    29
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    30
Values: red, green, blue
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    31
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    32
=== water-bottom ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    33
The colour of the lowest part of the water.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    34
This makes a gradient together with water-top.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    35
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    36
Values: red, green, blue
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    37
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    38
=== water-opacity ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    39
Opacity of the water, how visible gears in the water are.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    40
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    41
Values: opacity
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    42
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    43
=== music ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    44
Name of the track to be played in the theme, e.g. Nature.ogg
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    45
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    46
Values: name
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    47
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    48
=== clouds ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    49
The number of clouds to create.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    50
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    51
Values: number
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    52
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    53
=== object ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    54
There may be several object keys in the file, each one representing one land object.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    55
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    56
unfinished, values are the file name and then the old values
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    57
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    58
=== spray ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    59
There may be several spray keys in the file, each one representing one spray object.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    60
The name is the name of the .png (without the extension) of the graphics file, and the number is the number of instances of this spray that may be added.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    61
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    62
Values: name, number
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    63
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    64
=== flakes ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    65
Values for the flakes of this theme. First the number of flakes, then number of frames and ticks per frame. Lastly the speed and fall speed of the flakes.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    66
If left out there are no flakes.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    67
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    68
Values: number, frames, frame ticks, speed, fall speed
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    69
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    70
=== sd-water-top ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    71
Sudden death version of water-top. Has a default value.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    72
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    73
=== sd-water-bottom ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    74
Sudden death version of water-bottom. Has a default value.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    75
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    76
=== sd-water-opacity ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    77
Sudden death version of water-opacity. As default same as water-opacity.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    78
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    79
=== sd-clouds ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    80
Sudden death version of clouds. As default same as clouds.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    81
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    82
=== sd-flakes ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    83
Sudden death version of flakes. Has a default value.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    84
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    85
=== rq-sky ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    86
Reduced quality version of sky. If present used instead of sky on low quality.