config.TXT

Directory Structures

Naming Conventions

Directory Structures

The 'custom content' directory structures in SP3 are different from those in previous versions of Trainz. This is in order to facilitate a ' clean' changeover from pre- SP3 content to post- SP3 content. By keeping the directory structures isolated we intend to be able to maintain the content in their distinct areas and allow a future version of Trainz to remove the pre- SP3 directory structures, thereby completing the upgrade process.

In order for this process to work correctly it is therefore very important that no pre-SP3 content is manually moved into the new SP3 directory structures.

We do however realize that content creators need to test their own masterpieces in SP3 before packaging with Content Dispatcher takes place. Only in this instance should there be any manual transfer.

The default location for all SP3 custom content is:

C:\Program Files\Auran\Trainz\World\custom\
Bogeys
Displacements
Environment Sky
Water
Ground
Interior
Maps
Pants
Scenery
w/ Night Lights
w/ Animation
w/ Sound
Level Crossing
Turntable
Scenarios
Splines
Track Bridges
Rails
Tunnels
Trackside
Junction
Signals
Speedboard
Trains

Naming Conventions:

Typical directory structure for custom Trains should be:

World\
custom\
trains\
Custom_traincar\
Config.TXT
Custom_traincar_art\ (Texture for Graphical User Interface)
traincar_art_512.TGA (512x512 32-bit.TGA) Primary=traincar_art_512.TGA
Tile=st
Hint=Dynamic
Alpha=traincar_art_512.TGA
traincar_art_512.texture.TXT

<--------

traincar_icon_art.TGA (128x32 32-bit.TGA)
traincar_icon_art.texture.TXT
Custom_traincar_body\
Custom_traincar.PM (Trainz Mesh file exported from 3DS Max or GMax)
x.TGA (16-bit)
y.BMP (8-bit grayscale opacity map - if required)
env_metal.BMP (16-bit color environment/reflection map)
*.texture.TXT  (Exporter Generated)
digit_1.TGA (to digit_6.TGA) (24-bit)
Custom_traincar_shadow\
Custom_traincar_shadow.PM
black.TGA (Default Texture for Shadow)
black.texture.TXT (Exporter Generated)
Custom_traincar_alpha_numbers\ (Automatically replacing Digit Textures)
alphanumber_0.TGA (to alphanumber_9.TGA) (32-Bit)
Refer: Locomotive Numbering

 

config.TXT File

Each item of content that you create is required to have a config.TXT file. This file is a simple text file that is used to describe the item of content to Trainz. The contents of a typical confg.TXT file may look like this:

Config.TXT File Example

Blue indicates Required Tags

Green indicates Optional Tags

kuid <KUID:1234:5678>

kuid-table {
           0 <KUID:1234:6000>
           1 <KUID:1234:6001>
           2 <KUID:1234:6002>
}
(kuid-table must be included where the configuration references additional KUIDs, such as a bogey, or a pantograph. The Download Station performs a search, and those found are added to the download pack.)
obsolete-table {
         0 <KUID:1234:5676>
         1 <KUID:1234:5677>
}
username "My locomotive"
description "This is an example Asset.
Note that you can have multiple lines but no double quote characters in here."
region Australia
trainz-build 1.3
kind engine
category-class AD
category-region-0 US
category-region-1 UK
category-region-2 AU
cateogry-region-3 NZ
category-era-0 1960s
category-era-1 1970s
author "Greg Lane"
organisation "Trainz Thingz"
contact-email "helpdesk@ auran. com"
contact-website "< http://www.auran.com>"

TAGS DISCRIPTION
kuid Unique ID of this asset. Any subsequent versions of this asset MUST have a different KUID. The KUID contains basic creator information.
kuid-table A list of KUIDs required for this asset to function correctly.
obsolete-table A history of this asset. Each KUID listed is a previous version of this asset. If there are no previous versions display as follows:
obsolete-table {
}
username The human-readable English name of this asset.
description The human-readable multi-line English description of this asset.
region The country region to which this asset belongs. This should be one of the Auran-supplied region names
trainz-build The Trainz build number for which this asset was created.
kind The Kind. Must be one of the Auran-supplied asset kinds.
category-class The Class code for this asset. Classes are unique per kind of asset but may not be across all assets.
category-region-0 A list of Region codes or Region Group codes, starting at category-region-0 and progressing category-region-1, etc. with one code per tag.
category-era-0 A list of Era codes, starting at category-era-0 and progressing category-era-1, etc. with one code per tag.

Content Creation Guide Table of Content

Paint Shed Guide