Trainz/refs/Content Configuration

For a new-user walk-through explaining how to create various types of content, see the How-To-Guides index page instead.

Overview of Trainz Content

This page acts as reference manual for all Trainz content, and its legal asset-oriented data types (KINDs) and other aggregate data structures (generally, containers as computer science defines such).

Every Trainz asset from the mighty collection of assets contained in a route to the lowliest scenery item such as imitation grass, the color of a rock or field—all have two things in common: The list of common legal keyword names (tags, kinds and containers) which begin the definition of the asset found in the TrainzBaseSpec and the satisfactory completion of their applicable requisite data elements in a config.txt file.

Unlike the N3V Games controlled Trainz Wiki with the narrow focus mainly intended to provide accurate and concise description of the capabilities and configuration of Trainz current-version content, this work, the TWBK aims to cover the relations of the older data forms to the new and the rationales in their evolution, regrouping, or inception. To the new user, particularly those with no familiarity with programming language practices, the information on this page can become a starting point to understanding.

Structure of a Trainz Asset

Main basics are covered in: Anatomy of an asset, the beginners and AM&C Config.txt files pages linked (respectively) in the paragraph below:

Each item of Trainz content ("an asset") is created as the contents of a single operating system folder, containing a config.txt file and some number of supporting files and/or folders and their files. Files located in the content folder must obey the Filename character restrictions and each item should be directly relevant to the asset in question. When committed or as in newer Trainz releases, tested for validation before commitment, the asset's folder contents and the config.txt file will be validated against one another, the ideal minimum definitions will be bounced against those and each must be in balance and correct with respect to one another.

Content Types

Each asset built for the Trainz environment follows a preset template, which defines what tags can be included in the config.txt file, what capabilities the asset will have, and how the user can manipulate the asset in-game. The following types of custom content are supported by Trainz:

Kinds of KINDs

All Trainz defined data (content) has three required elements: A config.txt file to organize the data, an identity meaning a kuid (username alone will do you no good, a legal asset however can be created without a name!) and last, a legally defined kind tag. The kind is in charge, the conductor of the orchestra, the Platoon Sargeant or CEO giving directions — setting up the requirements for everything that gets processed after. In short, the kinds' value, a small select tightly defined members-only group — tells Trainz software what is to be rendered and displayed in the virtual worlds we create, and how (or where) to find the other parts needed to make those parts of the asset linked together in that config.txt file.
Each of the below Child Classes are considered to have the TrainzBaseSpec as their 'Parent Class' of data.^{[note 1]} A few kinds listed below, those which are underlined, are legacy kinds antedating changes to the Trainz data model in the release of TS2009 (i.e. since late 2008), with only gradual (incremental) changes imposed since by the N3V programmers.
Details for fixing assets based on these legacy kinds can currently be found in the Content Creator's Guide section of the N3V Trainz Wiki TrainzOnline site here with illuminating examples of legacy Kinds here. Perusal of the CCG is highly recommended to any users of the Trainz Download Station or anyone contemplating creating content. The insights gained from understanding of the background history of how older content was defined can then be contrasted with the current TrainzOnline coverage of the same data type and compared, for often this kind of then-vs.-now provides valuable insights to fixing, altering and customizing assets. More to the point, the writing in the CCG was professionally produced and is far more tautological—it will often give you insights as to extended effects if this or that is altered, which the Trainz Wiki just doesn't provide. The CCG put up on TrainzOnline is the TC1&2/TC3 version — the last published of several booklets printed dating back to Trainz in 1999; the TC3 CCG contains the altered Enginespecs Locomotive assets from the TRS2004/TRS2006 AND UTC data models need to be properly updated.

TrainzBaseSpec Child Class KINDs (type asset groups)
kind achievement-category kind achievement-group kind activity - scenarios kind kind asset-group kind behavior kind bogey [] kind buildable kind controlset kind consist^{[note 2]} kind drivercharacter kind drivercommand kind engine [1] kind enginesound [] kind environment kind fixedtrack [] kind gameplaymenu kind groundbrush - undef'd kind groundtexture []	kind hornsound [] kind html-asset [] kind industry [2] kind interior kind library [3] class library kind map - Route kind kind mesh [4] kind module - undef'd kind mocrossing [5] kind mojunction [6] kind mosignal [7] kind mospeedboard kind pantograph kind product [8] kind product-category [9] kind profile [10] - session kind kind region	kind scenariobehavior - undef'd kind scenery [11] kind scenery-trackside [12] kind scenerywithtrack [13] kind servlet kind steam-engine [14] kind texture [15] kind texture-group kind track [16] kind trainzbasespec [17] kind tracksound [18] kind traincar [19] kind turntable kind water2

Category Tags

File:A Category in CM are an aid to sorting and selecting appropriate content varieties which are classified into groups by N3V loosely based on category-class and Kinds

A Category in CM are an aid to sorting and selecting appropriate content varieties which are classified into groups by N3V loosely based on category-class and Kinds.

A list Category in content manager (CM) are implemented as an aid to sorting and selecting appropriate content varieties which are classified into groups by N3V loosely based on category-class and Kinds.

Category-region and category-era are classification tags identifying assets that would be found in a time or place—note they are not searched by using the category dropdown list, but are separate line entries. Each of these tags have the job of classification, which are used in narrowing down a particular sort of asset search when running Content Manager or such searches can be used to group assets, which are then useful mainly in filters inside Surveyor.

category-class tags	For Asset by enumerated categories search. The 'CM search by Category' is defined by N3V's programmers, and does not directly correspond to all asset Kinds and category-class tagses.
category-region tags category-region	For Region (country or countries) searching
category-era tags	For Era Searching

Feedback

Content Configuration Feature Requests - ask here for new config.txt files features