TrainzUtil

2010-10-31T10:10:37Z

Kris76: /* Usage */

[[TrainzUtil]] is a command line [[Content Management]] tool.

=Functionality=

[[TrainzUtil]] is capable of performing some content management tasks including:
* Installation, removal and editing of custom content.
* Limited searching of local content.
* Packaging local content for distribution.
[[TrainzUtil]] provides a small subset of the available content management functions, for most operations [[Content Manager]] should be used.

=Usage=

[[TrainzUtil]] is a command line utility and cannot be started from the [[Trainz Launcher]]. To start [[TrainzUtil]] open a command prompt and navigate to your Trainz "bin" directory (e.g. C:\Program Files\Auran\TS2010\Bin). You can then launch [[TrainzUtil]] with command arguments as below.

* TrainzUtil help
:''Display TrainzUtil help text.''
* TrainzUtil version
:''Display the TrainzUtil build version.''
* TrainzUtil echo <TEXT>
:''Echo the supplied text.''
* TrainzUtil setlanguage <langCode>
:''Set the Trainz language to the language code supplied (eg. US, FR, RU, etc).''
* TrainzUtil installCDP <PATH>
:''Install an asset from a CDP file.''
* TrainzUtil installfrompath <PATH>
:''Install an asset from a directory.''
* TrainzUtil installfromdls <KUID>
:''Install an asset from the Auran Download Station.''
* TrainzUtil edit <KUID>
:''Open an asset for editing.''
* TrainzUtil printconfig <KUID>
:''Print the contents of an assets config file to the console.''
* TrainzUtil backupkeywords
:''Backup all the keywords of your assets.''
* TrainzUtil importkeywords
:''Import keywords into the Trainz Asset Database.''
* TrainzUtil commit <KUID>
:''Commit any edits that have been made to the specified asset.''
* TrainzUtil revert <KUID>
:''Discard any edits that have been made to the specified asset.''
* TrainzUtil delete <KUID>
:''Delete the specified asset from disk.''
* TrainzUtil generateKUID
:''Generate a new KUID number in the local user's KUID range.''
* TrainzUtil createCDP <OUTPUT PATH> <KUID1> <KUID2> ... <KUIDX>
:''Export assets to a CDP file.''
* TrainzUtil repairdatabase
:''Repairs the Trainz Asset Database.''
* TrainzUtil authors
:''List of all the authorIDs that have content in the game.''
* TrainzUtil searchbycategory [-a] <CatgoryList>
:''List all the local assets with a category set in this format, "CMP;MESH|BD;-ACTV|VE|SCEN". Use the -a parameter if you want to search the [[Download Station]] as well.''
* TrainzUtil importconsists <PATH>
:''Import an old style Surveyor consist list, creating consist assets for any unknown entries.''
* TrainzUtil status <KUID>
:''Print the status of the specified asset.''
:''This will output <KUID> : <Flags> : <category> : <username> where flags are a series of letters with case indicating boolean state. (capital letters are flagged true and lowercase are flagged false.)''
:*''Ee - The asset is open for edit.''
:*''Ii - The asset is installed locally.''
:*''Aa - The asset is archived.''
:*''Dd - The asset is on the download station.''
:*''Ll - The asset is locally modified.''
:*''Mm - The asset has missing dependencies.''
:*''Ee - The asset has errors.''
* TrainzUtil validate <KUID>
:''Perform validation and display any errors or warnings relating to this asset.''
* TrainzUtil compile <PATH>
:''Compile a script file.''
:*''<-d> Display gamescript documentation.''
:*''<-s> Silent mode.''
:*''<-bPATH> Specify a file path for the compile log.''
:*''<-pPATH> Specify the output directory.''
:*''<-oPATH> Specify the output library filename.''
:*''<PATH> Input source file.''
:*''<-iPATH> Additional include path.''
* TrainzUtil encrypt <PATH>
:''Encrypt a script file (gs --> gse).''
* TrainzUtil listbuilds <PATH>
:''Print the list of installed build numbers to a file.''
* TrainzUtil @<file.txt>
:''Batch-execute a series of commands from the specified text file (every argument must be between double quotes). Every line of that text file will be processed like a separate call to TrainzUtil''

=Notes=
Due to the Windows command prompt treating the '<' and '>' characters as pipe operators, be sure to include quotes around any KUID parameters.

TrainzOnline - User contributions [en]

TrainzUtil