CCG/Modelling: Config.txt File
| Line 2: | Line 2: | ||
The requirements of the config.txt file have already been covered in the this document. | The requirements of the config.txt file have already been covered in the this document. | ||
| − | The commands recognised by Trainz are known as tags and these are gathered into containers. It is advisable to create all config.txt files using '''CCP'''. This will format correctly and determine any errors. | + | The commands recognised by Trainz are known as tags and these are gathered into containers. It is advisable to create all config.txt files using [[Content Creator Plus]] ('''CCP'''). This will format correctly and determine any errors. |
Latest revision as of 23:20, 18 June 2011
[edit] Config.txt File
The requirements of the config.txt file have already been covered in the this document.
The commands recognised by Trainz are known as tags and these are gathered into containers. It is advisable to create all config.txt files using Content Creator Plus (CCP). This will format correctly and determine any errors.
However, if you must manually edit the file, a few important points should be mentioned here:
1. The config.txt file must not include any formatted code or symbols. A simple text editor such as Notepad is to be used, the file must be saved as UTF-8 code, not ANSI. This encoding option is available from the save dialogue box. Do not use a program such as MS Word that can introduce unwanted formatting, including non standard quotation marks.
2. While the order of the tags within containers may be varied, leave the lines in the order as created in CCP.
3. Brackets and quotation marks must be matching pairs (the same number of left and right facing brackets), or tags and information will not be interpreted correctly.
4. Do not include any empty tag data entries even in the Kuid-tables or the obsolete listing. Trainz does not need to process additional blank or empty entries.
5. At the start of a line, any text or symbol that is not a recognised tag in Trainz will be flagged as an error in Content Manager. If you mistype a tag name, you will not be able to correctly commit the asset into the Trainz Asset Data Base. Make sure tags are entered correctly, with no unnecessary spaces, correct hyphens or underscores and full path names as necessary. CCP will also give error messages for any unrecognised names or misspelled tags.
6. The description entry uses a single pair of quotation marks, do not include additional marks within the description or the entry will be truncated. The Description is displayed on the Download Station so make it informative, perhaps including what the model is called and under what directory it is to be found in Trainz. This will assist a user in finding the model in the Surveyor menu.
7. Do not use any form of comment line. The Content Manager does NOT support ";", "//" or "rem" for comments.
8.The CCP program creates the config.txt file, checks for errors and indicates if you have not included necessary mandatory tags and files. It makes the model suitable for the Download Station, and must be used to create the upload file:
- - It places an apparent blank line at the top. This line contains hidden code used by the Download Station process, and should not be removed or the config.txt file will not function;
- - It tabs the entries across the page and inserts quotes around descriptive words. While the tabbing makes the file hard to read sometimes, it can improve the readability for the bracket symbols, making it easier to match pairs, when opening the config.txt file in Explorer.
Previous Page . . . Next Page
