TrainzOnline - User contributions [en]

KIND Interior

2016-06-10T23:42:44Z

Sailordan: Add interior-controls-type

[[KIND Interior]] provides the basis for a building or vehicle interior, with or without control levers and dials.

This asset type inherits all mesh display characteristics, and adds interior-specific functionality such as control levers. Please read [[HowTo/Build a cab interior]] for a step-by-step guide to creating an Interior asset.

==KIND Hierarchy==
===Parent Classes===
* [[KIND Mesh]]
===Child Classes===
* ''none.''

==Supported Tags==
Each interior asset supports the following tags. Each tag is shown here with its default value.

kind "interior"
[[%22cameralist%22_Container|cameralist]]
{
camera0 0,0,0,0,0
}
[[%22soundscript%22_Container|soundscript]]
{
}
cameradefault 0
cabin-visible-from-outside 0
outside-visible-from-cabin 0
controlset ""
[[%22mesh-table%22_container_(interior_version)|mesh-table]]
{
}

====cameralist====
:Type: [[%22cameralist%22_Container|CameraList Container]]
:Desc: Lists the different camera view positions and orientations this interior has.
====soundscript====
:Type: [[%22soundscript%22_Container|SoundScript Container]]
:Desc: Details sounds that a cab interior can produce. Sounds may be triggered by the asset script, or by object animations.
====cameradefault====
:Type: Integer
:Desc: Defines which of the cameras in 'cameralist' is the default camera (the one selected when the user first goes into cab view mode). e.g. "cameradefault 3" will make "camera3" the default camera view.
====cabin-visible-from-outside====
:Type: Boolean
:Desc: If true, makes the cab mesh visible from the outside view.
This is intended for objects with simple but obviously visible cab controls that are not enclosed - e.g. the controls to operate a transfer table. It would be far too much of a performance impact to use this on locomotive models, as locomotive cabs are very performance intensive.
====outside-visible-from-cabin====
:Type: Boolean
:Desc: If true, makes the loco body mesh visible while in the cab interior view.
This is intended to be used with an interior where the cab controls that are not in an enclosed space - e.g. a transfer table.
While using this on a traincar is not considered problematic from a performance perspective, please note this will require a very carefully designed cab and loco asset - both the inside of the loco mesh and the cab interior will be visible at the same time, and unless done very carefully, this is likely to cause graphical problems with overlapping polygons and unexpectedly visible or opaque surfaces.
====controlset====
:Type: [[KUID]]
:Desc: Specifies a [[KIND_Controlset|controlset]] asset used to send script messages to this interiors custom script. Optional.

====interior-controls-type====
:Type: Text String
:Desc: Specifies the type of the control. Types are
:* none (non-powered car)
:* hostler (driveable B unit or cab car)
:* full (loco)
:Compulsory from 3.8.

====mesh-table====
:Type: [[%22mesh-table%22_container_(interior_version)|MeshTable Container (Interior version)]]
:Desc: All the meshes for the cab interior (the shell itself, along with all the controls and gauges) are listed here. A mesh table for an interior has a number of additional options that a normal mesh table does not.

==Example Config.txt==
Sample [[config.txt file]] for a interior asset, with the Standard Tags excluded for brevity:

kind "interior"

cameralist
{
camera0 -1.236,0.173,0.392,0.511,-0.155
camera1 -1.278,-0.176,0.392,0.511,-0.155
camera2 -1.247,0.344,0.52,6.708,-0.403
camera3 -0.113,0.965,0.52,6.312,-0.377
camera4 1.35,0.15,0.52,5.71,-0.265
camera5 1.374,0.208,0.205,6.048,-0.06
camera6 -0.754,0.926,1.011,6.636,-0.516
camera7 -1.293,0.449,0.459,6.757,-0.342
}
cameradefault 0

mesh-table
{
default
{
mesh "c_interior.im"
auto-create 1
}

wheelslip_light
{
kind "light"
mesh "wheelslip_light.im"
auto-create 0
}

bptrainbrakepipe_needle2
{
kind "digital-dial-prs"
mesh "brakeneedle.im"
att "a.brakepipe2"
limits 0,55
font "arial"
fontsize 0.007
fontcolor 80,240,120
auto-create 1
}

speedo_needle2
{
kind "digital-dial-spd"
mesh "brakeneedle.im"
att "a.digispeedo"
limits 0,55
font "arial"
fontsize 0.01
fontcolor 0,0,0
auto-create 1
}

throttle_lever
{
kind "lever"
mesh "throttle.im"
att "a.throttle"
limits 0,8
angles 0,1.69
notches 0,0.125,0.25,0.375,0.5,0.625,0.75,0.875,1
notchheight 1,2,2,2,2,2,2,2,1
radius 0.35
mousespeed -1
auto-create 1
}

dynamicbrake_lever
{
kind "lever"
mesh "dynamic_handle.im"
att "a.dynamic"
limits 0,2
angles 0,-1.69
notches 0,1
notchheight 0.1,1
mousespeed -1
radius 0.35
auto-create 1
}

trainbrakelap_lever
{
kind "lever"
auto-create 1
mesh "trainbrake_handle.im"
att "a.trainbrake_handle"
limits 0,4
angles 0,-2
notches 0,0.25,0.5,0.75,1
notchheight 2,2,2,2,2
mousespeed 1
}

independantbrake_lever
{
kind "lever"
mesh "indy_handle.im"
att "a.ind"
limits 0,32
angles 0.94,0
notches 0,0.5,1
notchheight 1,1,1
radius 0.35
mousespeed 1
auto-create 1
}

flow_needle
{
kind "needle"
mesh "flowneedle.im"
att "a.bpflow"
limits 0,1050
auto-create 1
}

bplocomain_needle
{
kind "needle"
mesh "brakeneedlered.im"
att "a.mainres"
limits 0,1240
auto-create 1
}

bploco_equaliser
{
kind "needle"
mesh "brakeneedle.im"
att "a.eqres"
limits 0,1240
auto-create 1
}

bptrainbrakecylinder_needle
{
kind "needle"
mesh "brakeneedlered.im"
att "a.brakecyl"
limits -50,1390
auto-create 1
}

bptrainbrakepipe_needle
{
kind "needle"
mesh "brakeneedle.im"
att "a.brakepipe"
limits 0,1240
auto-create 1
}

speedo_needle
{
kind "needle"
mesh "speedo_pointer.im"
att "a.speedo"
limits 0,43
auto-create 1
}

ampmeter_needle
{
kind "needle"
mesh "needleamps.im"
att "a.ampmeter"
limits 0,1700
angles 0,3.02058
auto-create 1
}

reverser_lever
{
kind "lever"
mesh "reverser_handle.im"
att "a.throttle01"
limits 0,2
angles -0.55,0.55
notches 0,0.5,1
notchheight 1,1,1
mousespeed -1
auto-create 1
}

right_sliding_window
{
mesh "window1.im"
auto-create 1
att "a.window1"
att-parent "default"
limits 0,1
angles 0,-0.009
notches 0,1
notchheight 1,1
kind "lever"
}

right_sliding_window2
{
mesh "window2.im"
auto-create 1
att "a.window2"
att-parent "default"
limits 0,1
angles 0,0.009
notches 0,1
notchheight 1,1
kind "lever"
mousespeed -1
}

left_sliding_window
{
mesh "window3.im"
auto-create 1
att "a.window3"
att-parent "default"
limits 0,1
angles 0,-0.009
notches 0,1
notchheight 1,1
kind "lever"
mousespeed -1
}

left_sliding_window2
{
mesh "window4.im"
auto-create 1
att "a.window4"
att-parent "default"
limits 0,1
angles 0,0.009
notches 0,1
notchheight 1,1
kind "lever"
mousespeed 1
}

light_switch
{
kind "lever"
att "a.hdlt"
mesh "hdltswtch.im"
limits 0,1
angles 0,2
notches 0,1
notchheight 0.1,0.1
mousespeed -1
auto-create 1
}

horn
{
kind "pulllever"
mesh "horn.im"
att "a.horn"
auto-create 1
angles 0,-0.55
limits 0,1
mousespeed -1
radius -0.02
notches 0,1
notchheight 0,0
}
}

'''Note:''' Mesh table entry speedo_needle is required to update speed information on a RailDriver console.

==Custom Sounds==
===Overview===
It is possible to assign custom sounds to cabin controls without using a custom script. This can be performed via the addition of a 'cabin.txt' configuration file to an interior asset. The cabin.txt and custom sounds files must be placed in the an asset sub-directory named 'sounds'.

===Cabin.txt File Format===
The cabin.txt file lists 1 sound even per row, with each sound event defined by three space separated values. Empty rows are permitted and will be safely ignored. Each sound event requires the following three values:

====Target====
The name of the mesh-table entry for the mesh of the cabin control.
====Event====
The name of a cabin control event which will trigger the sound. The full list of supported events is as follows: 
'''mouseenter''' :- Triggered when the players mouse hovers over the control 
'''mouseleave''' :- Triggered when the players mouse was over the control but no longer is 
'''mousedown''' :- Triggered when the player presses a mouse button while over the control 
'''beginselect''' :- Triggered when the player actives a control, i.e. selects it 
'''mouseup''' :- Triggered when the player releases a mouse button while over the control 
'''endselect''' :- Triggered when the player deselects a control 
'''change-notch''' :- Triggered on notched controls only, whenever the player moves the control one notch 
'''lever-low''' :- Triggered on lever type controls, when the lever is moved to the lowest position 
'''lever-high''' :- Triggered on lever type controls, when the lever is moved to the highest position 
'''looping''' :- Triggered when a control is moved to notch 1, this sound will play in a loop until the control is changed. A typical use for this would be a fire sound while the firedoor of a steam train is open. 
====Sound File====
The file-name of the sound to play (relative to the 'sound' sub-directory)

Below is an example of a cabin.txt file which will assign custom sounds to the reverser and windows of the example config.txt file above.

reverser_lever lever-low reverser_notch.wav
reverser_lever lever-high reverser_throw.wav

right_sliding_window change-notch window_open.wav
right_sliding_window2 change-notch window_open.wav
left_sliding_window change-notch window_open.wav
left_sliding_window2 change-notch window_open.wav

==Downloads==
''Attach sample files here?''

==Categories==
[[Category:Asset KIND|I]]

LM.txt file

2016-05-24T00:34:55Z

Sailordan: Add note re alternative to :cull

'''LM.txt files''' are ASCII text format files describing a single model with multiple levels of detail. LM.txt files have a ".LM.txt" name extension, however when a LM.txt file is specified within a [[config.txt file]] or similar, the ".txt" must be omitted, leaving the ".LM" extension.

==Usage==

[[Level of Detail]] (or 'LOD') is a technique used for asset mesh reduction. Trainz uses a different mesh dependant on the viewing distance. For objects further away a simpler, less detailed mesh is used. [[LM.txt file]]s provide one LOD technique, which is commonly used for [[KIND Traincar]] and [[KIND Bogey]] assets. For other asset types, other [[Level of Detail|LOD techniques]] are generally more suitable.

In the example of the PB15 loco below there are four meshes, the closest being a highly detailed [[normal map]]ped model of the loco body, and the farthest being a simple mesh of the shape with the texture and, in this case, with very simple low poly representations of the bogeys. ''(more on this below)''

Do not use separate textures for each LOD mesh; the same texture can be used for all because textures have their own built-in LOD reduction.

Assets with LOD reduction must be made with 'indexed meshes' or [[IM files]] only (exported from 3DSMax, Blender, etc.)

Trainz locates these .im files through paths specified in the .lm.txt (LOD mesh file) which is in turn referenced via the asset's config.txt file.

The following images show the four meshes used for the PB15 loco.

Note: Only Figure 4, the hi-res version, is normal-mapped.

'''Figure 1'''
[[Image:Lod1_PB15.jpg]]
PB_15_body_lowest.im (600 polys)
bogey attachments flagged ':Cull',
bogeys represented in mesh ''(see below)''

'''Figure 2'''
[[Image:Lod2_PB15.jpg]]
PB_15_body_low.im (1947 polys)

'''Figure 3'''
[[Image:Lod3_PB15.jpg]]
PB_15_body_med.im (5066 polys)

'''Figure 4'''
[[Image:Lod4_PB15.jpg]]
PB_15_body.im
(10578 polys, and normal-mapped)

==File Format==
The user-editable *.lm.txt files are ASCII text formatted . Please note that this format is not the same (despite some similarities) as other text-based formats used by Trainz. Please be aware of the [[filename character restrictions]] when naming [[LM.txt file]]s and [[IM files]].

Use only non-formated text to create the .lm.txt file i.e. Use a simple text editor such as notepad.

The use of upper and lower case letters, and semi colons in the file data is important, please follow the example.

==An LM.TXT Example==
 
'''LOD Mesh File (PB_15_body.lm.txt) Auran's steam loco:'''
version 1.0 
offset = 0.01;
calcpoint = center;
multiplier = 1.0;
animationCutOff = 0.00;
renderCutOff = 0.00;
attachmentCutOff = 0.06;
mesh("0.07")
{
name="PB_15_body_lowest.im";
}
mesh("0.30")
{
name="PB_15_body_low.im";
}
mesh("0.52")
{
name="PB_15_body_med.im";
}
mesh("1.0")
{
name="PB_15_body.im";
}

==Breakdown of LOD Mesh File==

version 1.0 ''must be included but for internal use only;leave value as 1.0''

offset = 0.01; ''The offset that prevents "popping" between two levels of of detail repeatedly''

calcPoint = center; ''The position where the level of detail is calculated from (center,near,far)''

multiplier = 1.0; ''A level of detail multiplier (leave as 1.0)''

animationCutOff = 0.0; ''The level of detail where animation stops''
'' (to screen width) 1.00 = full width,''
'' 0.5 = half screen, 0.00 = never stop animation''

renderCutOff = 0.0; ''The level (to screen width) where rendering stops (no longer visible)''

attachmentCutOff = 0.06; ''The level where Cull flagged attachments are dropped (to screen width) *See note below''

'' ''' Note:''' Meshes referenced within a LOD file must be in ascending width order.''

mesh("0.07")
{
name="PB_15_body_lowest.im";
}
'' When the mesh is displayed at 0.07 of the screen, the mesh "PB_15_body_lowest.im" is displayed.''
'' Note the figure is just bigger than the attachment cut off figure above. This ensures the ''
'' modeled bogeys in this LOD mesh are rendered before the actual bogeys are culled.''

mesh("0.30")
{
name ="PB_15_body_low.im";
}
'' mesh "PB_15_body_low.im" is displayed when the mesh is at 0.3 of screen width.''

mesh("0.52")
{
name = "PB_15_body_med.im";
}

mesh("1.0")
{
name = "PB_15_body.im";
}

'''''Note:''''' 
'''attachmentCutOff = 0.1;''' Attachment cutoff specifies the level where attachments with the flag ":Cull" are dropped. ie To stop drawing the bogeys of the trains at a specific level of detail, append "''':Cull'''" to the bogey attachment point name in 3DSMax, or Blender. (ie "a.bog0:Cull" ). This can apply to any attachment eg passenger or driver attachments.

Where the above applies (bogeys culled) the body mesh will need a low poly representation of the bogeys, as in '''Figure 1''' above

Attachment culling cannot be made to work by modifying the config.txt file; you must modify the model's attachment names.

'''''Note:''''' 
As of build 4.1 an alternative to the use of the ":Cull" appendage to the attachment point name is to simply omit the attachment point from the lower-detail mesh. If the attachment point does not exist in the mesh then no attempt is made to render an attachment when the mesh is rendered. It is possible to use the cull method and the missing attachment point method in the same asset, which might be relevant when creating a new low-detail mesh for an existing asset.

'''''Note:''''' 
The [[LM.txt file]]s, .im meshes, and textures must be located within the same directory.

The LOD Mesh file is referenced from the config.txt file as follows.

;Config.txt file extract

kuid <KUID:-3:10024>
kuid-table
{
}
obsolete-table
{
}
mesh-table
{
default
{
mesh "PB_15_body/PB_15_body.lm" <---- ''Note the "lm" file extension here (lowercase of "LM")''
auto-create 1
}
shadow
{
mesh "PB_15_shadow/PB_15_shadow.im"
}
reverser
{
mesh "PB_15_body/reverser/reverser.im"
anim "PB_15_body/reverser/reverser.kin"
auto-create 1
att a.bog2
att-parent default
}

==.txt file extension==
[[LM.txt file]]s have a ".LM.txt" name extension, however when a model file is specified within a [[config.txt file]] or similar, the ".txt" must be omitted, leaving the ".LM" extension. For example, a model file named ''box.LM.txt'' is specified in a [[KIND Traincar]] config file using the syntax ''mesh "box.lm"''.

[[Category:File formats]]
[[Category:Modeling]]

HowTo/Reskin an Asset using an alias

2016-05-07T23:09:15Z

Sailordan: /* How To Reskin an Asset using an alias - A step-by-step guide */

== Introduction ==

The usual method of reskinning an asset is to copy the whole asset and change the images. This process is relatively simple, but creates issues of copyright, so that if the reskinned asset is to be distributed to the community the permission of the creator of the original asset is required. In some cases it is not possible to obtain permission, or perhaps it is not clear that the original content creator has the right to approve distribution. In these cases it is possible to reskin an asset without copying it first by creating a new asset but referring to the mesh in the original asset using the alias facility.

Note that this method has some drawbacks:

1. The procedure for using the asset in game is not as efficient - it requires changing the mesh textures after the mesh is loaded and processed.

2. The original asset becomes a dependency of the reskin - anyone using the reskin must have both the reskin and the original asset installed on their system.

3. Udates to the original asset might affect the reskin.

Despite these issues, reskinning using an alias has been used for a large number of assets.

This Howto describes the procedure for reskinning an asset using the aliasing feature as of build 3.5.

== How To Reskin an Asset using an alias - A step-by-step guide ==

From build 3.5 the procedure for reskinning an asset using an alias has changed. 'Alias' is no longer available as a top-level tag in config.sys. Instead, the aliasing is accomplished through a process that involves nominating an aliased mesh (not just the asset) and then specifying texture replacement rules for each aliased mesh. Scripting is then used to do the texture replacement.

'''1.''' Select the asset to use as the source for the reskinning. This example is the simplest possible case - one texture, no attachments and no existing scripting.

'''Config.txt:'''

kuid <kuid:12345:1000>
username "Alias Sample - Original"
kind "scenery"
trainz-build 3.5
mesh-table {
default {
mesh "alias_sample.im"
auto-create 1
}
}
category-class "BS"
category-era "2000s"
category-region "00"
thumbnails {
0 {
image "$screenshot$.jpg"
width 240
height 180
}
}
kuid-table { }
'''Files:'''
$screenshot$.jpg
alias_sample.im
config.txt
top.texture.txt
top.tga

Note that nothing in particular is required in the original asset to support the rekinning - all the reskin information is in the reskin asset. The important items to note from the original are the kuid, the mesh-table container name ("default"), the mesh name ("alias_sample") and the image name ("top.texture").

'''2.''' Create the reskin version
'''config.txt:'''

kuid <kuid:12345:1001>
username "Alias Sample - Reskinned"
kind "scenery"
trainz-build 3.5
script "reskin"
class "reskin"
mesh-table {
default {
mesh-asset <kuid:12345:1000>
mesh "alias_sample.im"
effects {
main {
kind "texture-replacement"
texture "top.texture"
}
}
auto-create 1
}
}
category-class "BS"
category-era "2000s"
category-region "00"
thumbnails {
0 {
image "$screenshot$.jpg"
width 240
height 180
}
}
kuid-table {
0 <kuid:12345:1000>
}

'''Files:'''

$screenshot$.jpg
config.txt
new.texture.txt
new.tga

'new.texture.txt' references 'new.tga', as for a typical texture file. There is no '.im' file for the reskin asset.
The mesh-table container in the config file is where the texturing is defined.
1 mesh-table {
2 default {
3 mesh-asset <kuid:12345:1000>
4 mesh "alias_sample.im"
5 effects {
6 main {
7 kind "texture-replacement"
8 texture "top.texture"
9 }
10 }
11 auto-create 1
12 }
2. The subcontainer name(s) should match the names used in the original.

3. The mesh-asset is the KUID of the asset where the mesh to be reskinned is located.

4. The mesh is the '.im' file from the original asset.

5. The effects subcontainer is used to control the reskinning.

6. The effect subcontainer name is an arbitrary name used by the script to identify the texture.

7. The kind for the effect is always "texture-replacement".

8. The texture to be replaced is the texture used in the original asset.

This arrangment sets out the details for the reskinning, but it does not actually do anything. That happens in the script that needs to be attached to the reskin asset - in this case "reskin". From config:
1 script "reskin"
2 class "reskin"
1. This is the name of the script as it exists in the reskin asset. The name is arbitrary, but the script tag value must match the file name exactly. The file must have a .gs extension.

2. This is the script class, as defined within the script. This name is arbitrary, but the tag must match the name used in the script 'class' statement. See script details below.

'''reskin.gs'''

<nowiki>include "MapObject.gs"
// Script: reskin
// Function: reskin aliased asset
// Author:
// Revision: 0.1 July 2015
//
// Comments
// For assets at build 3.5 and higher, 'alias' is no longer available as a tag.
// It is replaced by the 'mesh-asset' tag in the mesh table. However, for
// reskining using an alias, the mesh-asset tag must be supported by a texture replacement
// script so that the replacement texture is applied to the aliased mesh.
class reskin isclass MapObject {
public void Init(void)
//The Init function is called when the object is created
{
// call the parent
inherited();
// ! This will change the texture name that have to be replaced on the effects mesh.
// WARNING: This will typically cause Trainz to freeze for a short period when called
// and/or when the mesh in question first becomes visible.
//
// Param: effectName the name of the effect that we want to apply the texture to
// Param: textureName the name of the texture that we want to apply
//
// Sets the specified texture onto the named effect.
SetFXTextureReplacementTexture("main", "new.texture");
}
};</nowiki>

MapObject.gs must be included to enable access to the mesh object that is to be reskinned.

Any line starting with // is a comment and can be changed or deleted as required.

"class reskin isclass MapObject" defines the class for the script (this must match the class tag in config) and defines the object to be skinned as a MapObject.

The init procedure and the inherited method create the object to be reskinned.

The "SetFXTextureReplacementTexture" function does the replacing. The texture-replacement container name ("main" in this example) must match the effect name from the config, and the texture name ("new.texture") must match the texture file name (without the .txt extension).

If there are multiple textures to be reskinned for this mesh, repeat the effects subcontainer using appropriate names, and repeat the SetFXTextureReplacementTexture statements with the required effects subcontainer name and the matching replacement texture.

If there are multiple meshes to be reskinned for the asset, repeat the mesh-table subcontainer using the correct name, insert the required effects containers with unique subcontainer names, and repeat the SetFXTextureReplacementTexture statements with those additional names.

== Notes ==
1. If the mesh and texture in the original asset are located in a subfolder, the full path must be specified for the mesh, but the textures will be located relative to that mesh. For instance, for a locomotive it is common to put the main mesh and textures in a 'body' folder - the mesh requires the folder name in the path, but the textures do not. Also, there might be more than one texture.
mesh-asset <kuid:12345:1000>
mesh "body/alias_sample.im"
effects {
reskin1 {
kind "texture-replacement"
texture "map1.texture"
}
reskin2 {
kind "texture-replacement"
texture "map2.texture"
}
}
The texture replacement line in the script will be repeated accordingly.

2. The example above is a simple scenery object. For other types of assets it might be necessary to use the script class specific to that asset. In that case, the MeshObject script must be included in order to provide access to the replacement function. For instance, an engine is type Locomotive, so the script file include statements are
include "Locomotive.gs"
include "MeshObject.gs"
and the class definition is
alias_reskin isclass Locomotive
Similar considerations may apply to other kinds of assets.

3. Numbering of locomotives. If the original asset supports running numbers then the skin asset can also be set up to support it. The skin asset does not require the digit_xx texture files that were previously required (when the 'alias' tag was used) in order to suppress error message about missing textures. The number images that are used are from the skin asset, not the original, but obviously they must match for size. Note that if the reskinning has overridden the running number feature with the running numbers embedded in the texture, then the running number for the loco should be left blank.

4. If upgrading an asset that previously used the 'alias' tag, those textures and their image file that are not changed from the original should be removed from the skin asset and should not be included in the texture replacement.

== TBD ==

Reskinning using an alias and scripted assets.

==Related Links==

* [[HowToGuides]]

[[Category:How-to guides]]

TrainzUtil

2014-03-29T22:12:12Z

Sailordan: Status report errors

[[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.''
:*''Ff - The asset is faulty.''
* 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, or omit the '<' and '>' characters. For example:

trainzutil delete kuid:87854:982511580

trainzutil delete "<kuid:87854:982511580>"

TrainzUtil

2014-03-29T22:06:07Z

Sailordan: /* Notes */

[[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, or omit the '<' and '>' characters. For example:

trainzutil delete kuid:87854:982511580

trainzutil delete "<kuid:87854:982511580>"