Content Configuration
From TrainzOnline
(Difference between revisions)
Jamesmoody (Talk | contribs) m |
|||
| (21 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
| − | This page acts as reference manual for all Trainz content. It is intended to provide accurate and concise description of the capabilities and configuration of current-version content. | + | {{ORP-top}} |
| − | + | :''For a new-user walk-through explaining how to create various types of content, see the [[HowTo]] Guides page instead.'' | |
| + | ==Overview of Trainz Content== | ||
| + | This page acts as reference manual for all Trainz content, and its legal {{wp|data type}}s ([[KIND]]s) and {{wp|data structure}}s (generally, [[:category:Config Container|Containers]]). It is intended to provide accurate and concise description of the capabilities and configuration of Trainz current-version content. To the new user, particularly those with no familiarity with programming language practices, the information in this page can become a starting point to understanding. 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 tag names which begin the definition of the asset found in the [[TrainzBaseSpec]]. | ||
==Structure of a Trainz Asset== | ==Structure of a Trainz Asset== | ||
| − | Each item of Trainz content ("an asset") is | + | 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== | ==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: | 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: | ||
| + | {| | ||
| + | |-valign="top" | ||
| + | | | ||
* [[KIND Achievement-category]] - Achievement category descriptor. | * [[KIND Achievement-category]] - Achievement category descriptor. | ||
* [[KIND Achievement-group]] - Achievement group descriptor. | * [[KIND Achievement-group]] - Achievement group descriptor. | ||
| − | * [[KIND | + | * [[KIND Asset-group]] - Asset group descriptor. |
* [[KIND Behavior]] - Session rules. | * [[KIND Behavior]] - Session rules. | ||
* [[KIND Bogey]] | * [[KIND Bogey]] | ||
* [[KIND Buildable]] - Basic scenery object with attached track. | * [[KIND Buildable]] - Basic scenery object with attached track. | ||
| + | * [[KIND Controlset]] - Defines a set of input controls | ||
* [[KIND Drivercharacter]] | * [[KIND Drivercharacter]] | ||
* [[KIND Drivercommand]] | * [[KIND Drivercommand]] | ||
| Line 21: | Line 26: | ||
* [[KIND Environment]] - Defines a set of skies. | * [[KIND Environment]] - Defines a set of skies. | ||
* [[KIND Fixedtrack]] | * [[KIND Fixedtrack]] | ||
| + | * [[KIND Gameplaymenu]] - Main menu page. | ||
* [[KIND Groundtexture]] - Textures for painting the ground. | * [[KIND Groundtexture]] - Textures for painting the ground. | ||
* [[KIND Hornsound]] | * [[KIND Hornsound]] | ||
| Line 26: | Line 32: | ||
* [[KIND Industry]] - Scenery object with attached track and product processing functionality. | * [[KIND Industry]] - Scenery object with attached track and product processing functionality. | ||
* [[KIND Interior]] | * [[KIND Interior]] | ||
| − | * [[KIND | + | * [[KIND Interlocking-Tower|KIND Interlocking-Tower]] |
| + | * [[KIND Library]] - Script Libraries. | ||
* [[KIND Map]] - Routes. | * [[KIND Map]] - Routes. | ||
* [[KIND Mesh]] | * [[KIND Mesh]] | ||
| + | | | ||
* [[KIND MOCrossing]] - Grade crossings. | * [[KIND MOCrossing]] - Grade crossings. | ||
* [[KIND MOJunction]] - Junction levers. | * [[KIND MOJunction]] - Junction levers. | ||
| Line 36: | Line 44: | ||
* [[KIND Product]] | * [[KIND Product]] | ||
* [[KIND Product-category]] | * [[KIND Product-category]] | ||
| − | * [[KIND Profile]] - Sessions. | + | * [[KIND Profile]] - Sessions.by an older title |
* [[KIND Region]] - Defines the area of the world, as well as traffic style. | * [[KIND Region]] - Defines the area of the world, as well as traffic style. | ||
* [[KIND Scenery]] - A basic object. | * [[KIND Scenery]] - A basic object. | ||
* [[KIND Scenery-trackside]] - Object that attaches to track. | * [[KIND Scenery-trackside]] - Object that attaches to track. | ||
| − | * [[KIND Servlet]] - | + | * [[KIND Servlet]] - An iTrainz servlet daemon. |
* [[KIND Steam-engine]] | * [[KIND Steam-engine]] | ||
* [[KIND Texture]] - A texture defined for use in other objects. | * [[KIND Texture]] - A texture defined for use in other objects. | ||
| Line 49: | Line 57: | ||
* [[KIND Turntable]] | * [[KIND Turntable]] | ||
* [[KIND Water2]] - Water for rivers / seas. | * [[KIND Water2]] - Water for rivers / seas. | ||
| + | |}<!-- careful, part of a wiki-table --> | ||
==Category Tags== | ==Category Tags== | ||
| − | *[[ | + | Category tags are an aid to sorting and selecting appropriate content that would be found in a time or place, or of narrowing down a particular sort of asset (Category Class codes), mainly in filters and when running [[Content Manager]]. |
| + | *[[Category Class]] - For Category search. | ||
*[[Category Region]] - For Region search | *[[Category Region]] - For Region search | ||
*[[Category Era]] - For Era Search | *[[Category Era]] - For Era Search | ||
| − | |||
==Feedback== | ==Feedback== | ||
[[Content Configuration Feature Requests]] - ''ask here for new config.txt files features'' | [[Content Configuration Feature Requests]] - ''ask here for new config.txt files features'' | ||
| Line 60: | Line 69: | ||
==Categories== | ==Categories== | ||
| − | [[:Category:Config Container]] | + | Categories are the sometimes overlooked superhighways of getting around in a Wiki project, and the user will find these listed are index pages to finding things faintly remembered efficiently and effectively: |
| + | *[[:Category:Asset KIND]] | ||
| + | *[[:Category:Config Container]] | ||
| + | *[[:Category:Config Tag]] | ||
| + | *[[:Category:Content configuration]] | ||
| − | [[:Category: | + | ==See also== |
| + | The following category pages will list and index Trainz specific articles throughout this Wiki | ||
| + | *[[:Category:Trainz fundamentals pages]] | ||
| + | *[[:Category:Trainz reference pages]] | ||
| + | *[[:Category:Trainz Wiki]] | ||
| + | {{ORP-bot}} | ||
| − | [[ | + | [[Modeling]] |
| + | [[Content creation]] | ||
Latest revision as of 21:10, 18 February 2022
- For a new-user walk-through explaining how to create various types of content, see the HowTo Guides page instead.
Contents |
[edit] Overview of Trainz Content
This page acts as reference manual for all Trainz content, and its legal data types (KINDs) and data structures (generally, Containers). It is intended to provide accurate and concise description of the capabilities and configuration of Trainz current-version content. To the new user, particularly those with no familiarity with programming language practices, the information in this page can become a starting point to understanding. 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 tag names which begin the definition of the asset found in the TrainzBaseSpec.
[edit] Structure of a Trainz Asset
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.
[edit] 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:
|
|
[edit] Category Tags
Category tags are an aid to sorting and selecting appropriate content that would be found in a time or place, or of narrowing down a particular sort of asset (Category Class codes), mainly in filters and when running Content Manager.
- Category Class - For Category search.
- Category Region - For Region search
- Category Era - For Era Search
[edit] Feedback
Content Configuration Feature Requests - ask here for new config.txt files features
[edit] Categories
Categories are the sometimes overlooked superhighways of getting around in a Wiki project, and the user will find these listed are index pages to finding things faintly remembered efficiently and effectively:
[edit] See also
The following category pages will list and index Trainz specific articles throughout this Wiki
