Annotations to a track map are specified by text commands inserted into the annotations text area of the viewer. A particular set of commands might look like this:
Car @15.5 10 ^105 #aliceblue "Alan Rotoi" {'S *1} Split 1 @11 14 ^S *3 'N
There are currently three types of annotations available: Car
,
Seg
and Split
. These keywords inform the program the
following values should be taken as styling options of an annotation of the
corresponding kind. Most of the options are identified by leading symbols
(@
, ^
etc.), which have roughly equivalent meanings
for the different annotations. In most cases, the options can be omitted (thus
being replaced by sensible defaults) and reordered freely. The syntax is quite
liberal about whitespace and linebreaks.
The syntax and meaning of the
fields for each sort of annotation is described below. Mandatory fields are
highlighted
; fields whose
position can not be changed are underlined
.
Car
Car
@15.5 10
^45 *0.5 #orange
"Mark Nailwood" { #yellow $50 ^0 *0.5 'N }
Car
adds a car annotation, similar to the one used for the
0x02/0x03 ghost car track elements.
Syntax | Option | Notes |
---|---|---|
@ | Position | Position of the car, in tile units with @0 0 being the
southwestern (i.e. lower left) corner of the map. To center the car in,
say, the tile (15, 23) as displayed by the grid indices of the map, use
@15.5 23.5 |
^ | Angle | Angle in degrees of the direction the car points to, starting from east and growing counterclockwise (as per the usual convention in maths). |
* | Size | Length of the car relative to tile size. The default value, 0.5, is the same used for the ghost car track elements. |
# | Colour | Colour of the body of the car. Must be either one of the 147 colour
names listed
here and typed as shown there (lower case, no spaces) or a hex
RGB triplet (thus #yellow and #ff00ff are
equivalent). |
"..." { } | Caption | Text to be used as a caption, drawn beside the car. Within the (optional) curly braces styling options for the caption can be set. |
Syntax | Option | Notes |
---|---|---|
# | Colour | Colour of the caption text. All observations done just above apply here. |
$ | Background opacity | Opacity of the caption background, from 0 to 100 (percent). The default is zero, thus making the background invisible. Set a higher value in case the map colours make the caption hard to read. |
^ | Angle | Angle in degrees of the direction the text goes. |
* | Size | Font size, relative to the tile size. |
' | Caption and car alignment | Alignment of the caption in relation to the car. The value must be one
of E , N , W and S
(which stand for the four cardinal directions). |
Seg
Seg
@17.5 10.25
^90
*3.5
#orange "Start of braking zone" { #ffa500 $25 ^30 *0.5 'N }
Seg
adds a line segment over the map.
Syntax | Option | Notes |
---|---|---|
@ | Position | Position of one of the ends of the segment. |
^ | Angle | Angle in degrees of the direction of the segment, starting from the
coordinates defined by @ . |
* | Length | Length of the segment, in tiles. |
Other options work as described for Car
above.
Split
Split
1
@22 14
^E
*5
#yellow $40 'W
Split
adds a split / section marker, drawn as a segment with
specialised properties.
Syntax | Option | Notes |
---|---|---|
An integer | Section number | Number of the track section. Drawn as an identifying caption beside the split line. Must be an integer. |
@ | Position | Coordinates of the tile where the split line begins. The values must be integer. The actual starting point of the line is southwestern corner of the tile. |
^ | Split direction | Direction of the split line. One of E , N ,
W and S . |
* | Length | Length of the split line, in tiles. The value must be integer. |
# | Colour | Colour of the both the split line and its caption. |
$ | Caption background opacity | Opacity of the caption background, from 0 to 100 (percent). |
' | Caption and split alignment | Alignment of the caption in relation to the split line. Must be one
of E , N , W and S .
|