Theme.wiki
author almikes@aol.com
Wed, 03 Dec 2014 19:54:57 +0000
changeset 427 31f5fef2c30a
parent 320 91a3a47a1615
child 433 0661855ab04a
permissions -rw-r--r--
Add summary
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
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    14
Comments may be added by prefixing a semicolon(;) to the comment.
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    15
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    16
=== sky ===
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
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    19
<code>Values: red, green, blue</code>
83
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
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    24
<code>Values: red, green, blue</code>
83
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 ===
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    27
The colour of the topmost part of the water (under the BlueWater.png).
83
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
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    30
<code>Values: red, green, blue</code>
83
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
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    36
<code>Values: red, green, blue</code>
83
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 ===
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    39
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
    40
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    41
<code>Values: opacity</code>
83
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
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    46
<code>Values: name</code>
83
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
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    51
<code>Values: number</code>
83
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 ===
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    54
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
    55
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    56
filename: The objects' filename (without the .png)
320
91a3a47a1615 Clarity of object. (New lines need an extra new line to show as a new line)
Caironater@gmail.com
parents: 319
diff changeset
    57
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    58
max: The maximum number of this object that may be generated in a map
320
91a3a47a1615 Clarity of object. (New lines need an extra new line to show as a new line)
Caironater@gmail.com
parents: 319
diff changeset
    59
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    60
buriedrec: A rectangle that must be buried in the terrain (left, top, width, height)
320
91a3a47a1615 Clarity of object. (New lines need an extra new line to show as a new line)
Caironater@gmail.com
parents: 319
diff changeset
    61
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    62
minvisible: The minimum amount of rectangles that must be visible
320
91a3a47a1615 Clarity of object. (New lines need an extra new line to show as a new line)
Caironater@gmail.com
parents: 319
diff changeset
    63
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    64
visiblerec: list of the rectangles for being visible(left, top, width, height)
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    65
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    66
<code>Values: filename, max, buriedrec, minvisible, visiblerec</code>
83
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
=== spray ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    69
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
    70
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
    71
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    72
<code>Values: name, number</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    73
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    74
=== flakes ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    75
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
    76
If left out there are no flakes.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    77
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    78
<code>Values: number, frames, frame ticks, speed, fall speed</code>
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    79
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    80
=== sd-water-top ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    81
Sudden death version of water-top. Has a default value.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    82
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    83
=== sd-water-bottom ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    84
Sudden death version of water-bottom. Has a default value.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    85
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    86
=== sd-water-opacity ===
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    87
Sudden death version of water-opacity. Has default same as water-opacity.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    88
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    89
=== sd-clouds ===
319
e5542ee81444 Fixed the object entry, as well as some minor fixes.
Caironater@gmail.com
parents: 83
diff changeset
    90
Sudden death version of clouds. Has default same as clouds.
83
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    91
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    92
=== sd-flakes ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    93
Sudden death version of flakes. Has a default value.
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    94
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    95
=== rq-sky ===
b9fe713d7c27 Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
    96
Reduced quality version of sky. If present used instead of sky on low quality.