Difference between revisions of "Extensions.cfg"

Latest revision as of 19:27, 6 February 2015

The extensions.cfg file allows to define properties for individual cars, like length, axle positions and exterior objects.

Overview

The file is a plain text file encoded in any arbitrary encoding, however, UTF-8 with a byte order mark is the preferred choice. The parsing model for numbers is Strict. The file is required to be located inside the train folder and is expected to be named extensions.cfg. The file is interpreted on a per-line basis, from top to bottom.

Car indices

All cars in the extensions.cfg are enumerated from 0 (front car) to n-1 (rear car), where n is the number of cars the train has in total, according to the train.dat file. For example, on a train with 10 cars, the front car has index 0 and the rear car index 9.

Coupler indices

A coupler in this document refers to the space between neighboring cars. All couplers in the extensions.cfg are enumerated from 0 (front-most coupler) to n-2 (rear-most coupler), where n is the number of cars the train has in total, according to the train.dat file. Coupler index i corresponds to the coupler between the cars with indices i and i+1, so the coupler between the first two cars (0 and 1) in the train has index 0. Likewise, if a train has 10 cars, the coupler between the last two cars (8 and 9) would have index 8.

Syntax

Each line in the file can be empty (or solely consist of white spaces) and will be ignored, can mark the beginning of a new section or contain key-value pairs inside a section. All key-value pairs relate to the last section opened.

A new section is opened by starting the line with an opening bracket (U+005B) and ending it with a closing bracket (U+005D). The text in-between the brackets indicates the name of the section and is case-insensitive. White spaces at the beginning and the end of the line are ignored, as well as at the beginning and the end of the name of the section. Thus, the beginning of the section has the following form:

[NameOfTheSection]

Example for the indication of a new section:

[exterior]

A key-value pair is indicated by giving the key, an equals sign (U+003D) and then the value. The key is case-insensitive. White spaces at the beginning and the end of the line are ignored, as well as in front and after the equals sign. Alternatively phrased, white spaces surrounding the key and the value are ignored. Thus, a key-value pair as the following form:

NameOfTheKey = Value

Example of a key-value pair:

0 = train.csv

You can use comments anywhere at the end of a line. A comment is started by a semicolon (U+003B). Comments, if present, are stripped away from all lines before these are processed.

The Car/Exterior section

Only one of the two options should be used.

The Cari section is especially handy if your train will use pivoting trucks, or different rail-cars with different lengths. This newer method allows one to define properties specific to a certain car.

The Exterior section provides an easy way of adding exterior objects to the particular train, if the Cari section won't be used.

The [Cari] Section

The Cari section allows to define properties specific to a certain car.

[Cari]

This starts the section for car i, which is an integer between 0 and n-1, where n is the number of cars the train has.

Object = File

file: The relative file name of the exterior object to use for this car, relative to the train folder.

This key-value pair defines the exterior object for this car. Within the object file, the coordinate (0,0,0) (x, y, z) corresponds to the center of the car, both horizontally (x) and forward/backward (z), while y=0 corresponds to the top of the rails.

Length = Value

Value: A positive floating-point number representing the length of the car.

This key-value pair defines the length for this car. This overrides the length as defined in the train.dat for this particular car. If not used, this car will have the default length as defined in the train.dat.

Axles = Rear, Front

Rear: A floating-point number indicating the z-position of the rear axle measured from the center of the car. Usually a negative value.

Front: A floating-point number indicating the z-position of the front axle measured from the center of the car. Usually a positive value.

This key-value pair defines the positions of the axles. While Rear and Front can take any values, the condition Rear < Front must hold.

Reversed = Value

Value: Either True or False to indicate whether to reverse the car.

With this setting, you can reverse the car in the consist. Please note that axle positions are given as if the car was not reversed.

Example of a Cari section:

[Car0]
Object = locomotive.b3d
Length = 16
Axles = -6, 6
Reversed = False

The [Exterior] Section

The Exterior section provides an easy way of adding exterior objects to the particular train. For more control on the setting of axle positions and individual car lengths, the Cari section has been introduced and should be used instead.

[Exterior]

This starts the Exterior section.

i = File

i: An integer between 0 and n-1, where n is the number of cars the train has. Index 0 corresponds to the front car and index n-1 to the last car in the train.

File: The relative file name of the exterior object to use for car i, relative to the train folder.

This key-value pair can be used to set up the exterior objects for each individual car. Within the object file, the coordinate (0,0,0) (x, y, z) corresponds to the center of the car, both horizontally (x) and forward/backward (z), while y=0 corresponds to the top of the rails.

Example of an [Exterior] section:

[Exterior]
0 = cars\engine.csv
1 = cars\passenger_mk1.b3d
2 = cars\passenger_mk1.b3d
3 = cars\passenger_bistro.b3d
4 = cars\passenger_mk2.b3d
5 = cars\postal.x

The [Coupleri] Section

The Coupleri section allows to define properties specific to a certain coupler.

[Coupleri]

This starts the section for coupler i, which is an integer between 0 and n-2, where n is the number of cars the train has.

Distances = Minimum, Maximum

Minimum: A floating-point number indicating the minimum allowed distance between the cars.

Maximum: A floating-point number indicating the maximum allowed distance between the cars.

This key-value pair defines the lowest and highest allowed distances between the cars, resembling a buffer and chain coupler. The condition Minimum ≤ Maximum must hold.

Example of a Coupleri section:

[Coupler0]
Distances = 0.30, 0.35