Tue, 04 Jun 2013 04:47:09 +0000
changeset 320 91a3a47a1615
parent 319 e5542ee81444
child 433 0661855ab04a
permissions -rw-r--r--
Clarity of object. (New lines need an extra new line to show as a new line)

#summary Structure of the theme.cfg file

== Theme.cfg ==
This file gives the engine the values associated with a certain theme, to complement the graphics.
It is structured with a key followed by a number of values. Example:
<code>sky = 120, 40, 80</code>

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.

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.

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.

Comments may be added by prefixing a semicolon(;) to the comment.

=== sky ===
The colour of the sky.

<code>Values: red, green, blue</code>

=== border ===
The colour of the outline of explosions.

<code>Values: red, green, blue</code>

=== water-top ===
The colour of the topmost part of the water (under the BlueWater.png).
This makes a gradient together with water-bottom.

<code>Values: red, green, blue</code>

=== water-bottom ===
The colour of the lowest part of the water.
This makes a gradient together with water-top.

<code>Values: red, green, blue</code>

=== water-opacity ===
Opacity of the water affects how visible gears in the water are.

<code>Values: opacity</code>

=== music ===
Name of the track to be played in the theme, e.g. Nature.ogg

<code>Values: name</code>

=== clouds ===
The number of clouds to create.

<code>Values: number</code>

=== object ===
There may be multiple object keys in the file, each one representing one land object.

filename: The objects' filename (without the .png)

max: The maximum number of this object that may be generated in a map

buriedrec: A rectangle that must be buried in the terrain (left, top, width, height)

minvisible: The minimum amount of rectangles that must be visible

visiblerec: list of the rectangles for being visible(left, top, width, height)

<code>Values: filename, max, buriedrec, minvisible, visiblerec</code>

=== spray ===
There may be several spray keys in the file, each one representing one spray object.
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.

<code>Values: name, number</code>

=== flakes ===
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.
If left out there are no flakes.

<code>Values: number, frames, frame ticks, speed, fall speed</code>

=== sd-water-top ===
Sudden death version of water-top. Has a default value.

=== sd-water-bottom ===
Sudden death version of water-bottom. Has a default value.

=== sd-water-opacity ===
Sudden death version of water-opacity. Has default same as water-opacity.

=== sd-clouds ===
Sudden death version of clouds. Has default same as clouds.

=== sd-flakes ===
Sudden death version of flakes. Has a default value.

=== rq-sky ===
Reduced quality version of sky. If present used instead of sky on low quality.