CCG/Common Tags
From TrainzOnline
< CCG(Difference between revisions)
| Line 2: | Line 2: | ||
The following tags are present in all kinds. | The following tags are present in all kinds. | ||
| − | + | ====kuid==== | |
:The "unique identifier" number for the asset. When creating new assets with Content Creator Plus, the asset kuid will be automatically generated. | :The "unique identifier" number for the asset. When creating new assets with Content Creator Plus, the asset kuid will be automatically generated. | ||
:See Page 4 for more information on kuids. | :See Page 4 for more information on kuids. | ||
| Line 8: | Line 8: | ||
| − | + | ====trainz-build==== | |
:The Trainz build number for which the asset was created. TC assets will have a trainz-build number of 2.7, automatically generated from CCP. | :The Trainz build number for which the asset was created. TC assets will have a trainz-build number of 2.7, automatically generated from CCP. | ||
TS2010 3.1 | TS2010 3.1 | ||
| Line 35: | Line 35: | ||
| − | + | ====category-class==== | |
:The class code for this asset. A full list of class codes is provided in the Chapter 11 Category Class appendix. | :The class code for this asset. A full list of class codes is provided in the Chapter 11 Category Class appendix. | ||
| Line 43: | Line 43: | ||
| − | + | ====category-region==== | |
:The region code for this asset. A full list of region codes is provided in the Chapter 11 Region Codes appendix. | :The region code for this asset. A full list of region codes is provided in the Chapter 11 Region Codes appendix. | ||
:This is similar in function to the category-region-XX tags which have been in use since Trainz SP3, however category-region has been reformatted to allow multiple regions on a single line. A semicolon is used to separate individual values. White space is not permitted. | :This is similar in function to the category-region-XX tags which have been in use since Trainz SP3, however category-region has been reformatted to allow multiple regions on a single line. A semicolon is used to separate individual values. White space is not permitted. | ||
| Line 49: | Line 49: | ||
:Example Value: "AD;AE;AU" | :Example Value: "AD;AE;AU" | ||
| − | + | ====category-era==== | |
:The era code for this asset. A full list of era codes is provided in the Chapter 11 Era Codes appendix. This is similar in function to the category-era-XX tags which have been in use since Trainz SP3, however category-era has been reformatted to allow multiple eras on a single line. | :The era code for this asset. A full list of era codes is provided in the Chapter 11 Era Codes appendix. This is similar in function to the category-era-XX tags which have been in use since Trainz SP3, however category-era has been reformatted to allow multiple eras on a single line. | ||
| Line 57: | Line 57: | ||
| − | + | ====Username cn, cz, de, es,fr, it, pl, ru==== | |
| − | + | ||
:The human-readable name of the asset. The username tag is mandatory. To compliment the English username, a variety of additional optional tags allow for equivalent usernames to be supported across other languages. These are as follows: | :The human-readable name of the asset. The username tag is mandatory. To compliment the English username, a variety of additional optional tags allow for equivalent usernames to be supported across other languages. These are as follows: | ||
| − | |||
:username-cn - Chinese | :username-cn - Chinese | ||
:username-cz - Czech | :username-cz - Czech | ||
| Line 74: | Line 72: | ||
| − | + | ====kind==== | |
| − | + | ||
:The asset kind, chosen in CCP and must be one of the Auran-supplied asset kinds. i.e. kind industry. Once you have selected a Kind, it cannot be changed from within the CCP editor. For example, you are making a Kind Scenery asset and have entered some data, and then realise you would like to have trains pick up products at the model, and this option is not available for Kind Scenery. You need to scrap the asset and select Kind Buildable and re-enter the data in this Kind. | :The asset kind, chosen in CCP and must be one of the Auran-supplied asset kinds. i.e. kind industry. Once you have selected a Kind, it cannot be changed from within the CCP editor. For example, you are making a Kind Scenery asset and have entered some data, and then realise you would like to have trains pick up products at the model, and this option is not available for Kind Scenery. You need to scrap the asset and select Kind Buildable and re-enter the data in this Kind. | ||
| − | See Chapter 2 for a complete list of kinds. | + | :See Chapter 2 for a complete list of kinds. |
:Example Value: "MOSignal" | :Example Value: "MOSignal" | ||
| − | + | ====description cn, cz, de, es, fr, it, pl, ru==== | |
| − | + | :The human readable description of the asset. This is an optional tag. To compliment the English description, a variety of additional tags allow for equivalent descriptions to be supported across other languages. These are as follows: | |
| − | :The human readable description of the asset. This is an optional tag. To compliment the English description, a | + | |
| − | variety of additional tags allow for equivalent descriptions to be supported across other languages. These are as follows: | + | |
| − | + | ||
:description-cn - Chinese | :description-cn - Chinese | ||
:description-cz - Czech | :description-cz - Czech | ||
| Line 99: | Line 93: | ||
| − | + | ====author==== | |
| − | + | ||
:The human-readable author name text. This is an optional tag. | :The human-readable author name text. This is an optional tag. | ||
| Line 106: | Line 99: | ||
| − | + | ====organisation==== | |
| − | + | ||
:The organisation name as specified by the asset author. This is an optional tag. | :The organisation name as specified by the asset author. This is an optional tag. | ||
| Line 113: | Line 105: | ||
| − | + | ====contact-email==== | |
| − | + | ||
:Email address specified by the asset author. This is an optional tag. | :Email address specified by the asset author. This is an optional tag. | ||
| Line 120: | Line 111: | ||
| − | + | ====contact-website==== | |
| − | + | ||
:Website URL specified by the asset author. This is an optional tag. | :Website URL specified by the asset author. This is an optional tag. | ||
| Line 127: | Line 117: | ||
| − | + | ====category-keywords==== | |
| − | + | ||
:To improve the search-ability of assets, generic search keywords may be included in the config.txt file. | :To improve the search-ability of assets, generic search keywords may be included in the config.txt file. | ||
:Each keyword should be a lowercase word with no punctuation. Keywords should be English and as neutral as possible. | :Each keyword should be a lowercase word with no punctuation. Keywords should be English and as neutral as possible. | ||
| Line 135: | Line 124: | ||
:Example Value: "scott;auran;example;ccg;test" | :Example Value: "scott;auran;example;ccg;test" | ||
| − | + | ||
| + | ====license==== | ||
:The asset's license agreement as written by the author. This is an optional tag. | :The asset's license agreement as written by the author. This is an optional tag. | ||
Revision as of 10:34, 6 June 2011
Contents |
Common Tags
The following tags are present in all kinds.
kuid
- The "unique identifier" number for the asset. When creating new assets with Content Creator Plus, the asset kuid will be automatically generated.
- See Page 4 for more information on kuids.
- Example value: "56113:1107:0"
trainz-build
- The Trainz build number for which the asset was created. TC assets will have a trainz-build number of 2.7, automatically generated from CCP.
TS2010 3.1
TS2009 SP1 3.0
TS2009 2.9
TC3 2.8
TC & TC2 2.7
TRS2006 SP1 2.6
TRS2006 2.5
TRS2004 SP4 2.4
TRS2004 SP3 2.3
TRS2004 SP2 2.2
TRS2004 SP1 2.1
TRS2004 2.0
UTC 1.5
Trainz SP3 1.3
Trainz 1.2 1.2
Trainz 1.1.1 1.11
Trainz 1.1 1.1
Trainz CE 1.0
- Note: When editing an asset in Content Creator Plus, the trainz-build will automatically be upgraded to 2.7 in order to support newly added tags and functions. Note, TRS2006 with the Service patch 1 shows a build of 2.6 however CCP will generate config.txt files with a build of 2.5. for that version.
- Example Value: "2.5"
category-class
- The class code for this asset. A full list of class codes is provided in the Chapter 11 Category Class appendix.
- The category-class has been in use since Trainz SP3.
- Example Value: "LM" - Monorail Vehicles
category-region
- The region code for this asset. A full list of region codes is provided in the Chapter 11 Region Codes appendix.
- This is similar in function to the category-region-XX tags which have been in use since Trainz SP3, however category-region has been reformatted to allow multiple regions on a single line. A semicolon is used to separate individual values. White space is not permitted.
- Example Value: "AD;AE;AU"
category-era
- The era code for this asset. A full list of era codes is provided in the Chapter 11 Era Codes appendix. This is similar in function to the category-era-XX tags which have been in use since Trainz SP3, however category-era has been reformatted to allow multiple eras on a single line.
- A semicolon is used to separate individual values. White space is not permitted.
- Example Value: "1990s;2000s"
Username cn, cz, de, es,fr, it, pl, ru
- The human-readable name of the asset. The username tag is mandatory. To compliment the English username, a variety of additional optional tags allow for equivalent usernames to be supported across other languages. These are as follows:
- username-cn - Chinese
- username-cz - Czech
- username-de - German
- username-es - Spanish
- username-fr - French
- username-it - Italian
- username-nl - Dutch
- username-pl - Polish
- username-ru - Russian
- Example Value: "testActivity”
kind
- The asset kind, chosen in CCP and must be one of the Auran-supplied asset kinds. i.e. kind industry. Once you have selected a Kind, it cannot be changed from within the CCP editor. For example, you are making a Kind Scenery asset and have entered some data, and then realise you would like to have trains pick up products at the model, and this option is not available for Kind Scenery. You need to scrap the asset and select Kind Buildable and re-enter the data in this Kind.
- See Chapter 2 for a complete list of kinds.
- Example Value: "MOSignal"
description cn, cz, de, es, fr, it, pl, ru
- The human readable description of the asset. This is an optional tag. To compliment the English description, a variety of additional tags allow for equivalent descriptions to be supported across other languages. These are as follows:
- description-cn - Chinese
- description-cz - Czech
- description-de - German
- description-es - Spanish
- description-fr - French
- description-it - Italian
- description-pl - Polish
- description-ru - Russian
- Example Value: "This is a test activity written for the 2006 CCG."
author
- The human-readable author name text. This is an optional tag.
- Example Value: "Scott Cameron"
organisation
- The organisation name as specified by the asset author. This is an optional tag.
- Example Value: "Auran"
contact-email
- Email address specified by the asset author. This is an optional tag.
- Example Value: "helpdesk@auran.com"
contact-website
- Website URL specified by the asset author. This is an optional tag.
- Example Value: "www.auran.com"
category-keywords
- To improve the search-ability of assets, generic search keywords may be included in the config.txt file.
- Each keyword should be a lowercase word with no punctuation. Keywords should be English and as neutral as possible.
- Keywords are separated by a semicolon. White space is not permitted within the category-keywords tag.
- Example Value: "scott;auran;example;ccg;test"
license
- The asset's license agreement as written by the author. This is an optional tag.
- Example Value "This is an example license."
