Content Configuration
(fmt, new user notes) |
|||
(10 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
− | + | {{ORP-top}} | |
− | :''For a new-user walk-through explaining how to create various types of content, see the [[ | + | :''For a new-user walk-through explaining how to create various types of content, see the [[HowTo]] Guides page instead.'' |
==Overview of Trainz Content== | ==Overview of Trainz Content== | ||
− | This page acts as reference manual for all Trainz content, and | + | 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 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]] | + | 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== | ||
Line 37: | 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 Interlocking-Tower|KIND Interlocking-Tower]] | ||
* [[KIND Library]] - Script Libraries. | * [[KIND Library]] - Script Libraries. | ||
* [[KIND Map]] - Routes. | * [[KIND Map]] - Routes. | ||
Line 64: | Line 60: | ||
==Category Tags== | ==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 Class]] - For Category search. | ||
*[[Category Region]] - For Region search | *[[Category Region]] - For Region search | ||
Line 77: | Line 73: | ||
*[[:Category:Config Container]] | *[[:Category:Config Container]] | ||
*[[:Category:Config Tag]] | *[[:Category:Config Tag]] | ||
− | *[[Category:Content configuration]] | + | *[[:Category:Content configuration]] |
+ | |||
==See also== | ==See also== | ||
The following category pages will list and index Trainz specific articles throughout this Wiki | The following category pages will list and index Trainz specific articles throughout this Wiki | ||
Line 84: | Line 81: | ||
*[[:Category:Trainz Wiki]] | *[[:Category:Trainz Wiki]] | ||
{{ORP-bot}} | {{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