How to Create a Driver Character

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m
m (The Config.txt File)
 
(2 intermediate revisions by one user not shown)
Line 19: Line 19:
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:BlueDot10x10.png|link=]]</td>
 
<td>[[image:BlueDot10x10.png|link=]]</td>
<td>'''Driver Character Icons''' are small graphic icons or images that can be selected to represent locomotive drivers in the [[file:WikiLink.PNG|link=]] '''[[How to Use Driver Setup Rule|Driver Setup Rule]]'''</td>
+
<td>'''Driver Character Icons''' are small graphic icons or images that can be selected to represent locomotive drivers in the [[image:WikiLink.PNG|link=]] '''[[How to Use Driver Setup Rule|Driver Setup Rule]]'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 35: Line 35:
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
<td width=729><span id="stepCreateImage"></span>&nbsp;</td>
+
<td width=729><span id="stepCreateImage"></span>&#160;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>&nbsp;</td>
+
<td width=75>&#160;</td>
<td width=75>[[file:NextDown.png|link=#stepCreateAsset|alt=Next Down|Next Down]]</td>
+
<td width=75>[[image:NextDown.png|link=#stepCreateAsset|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
+
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
Line 105: Line 105:
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
<td width=729><span id="stepCreateAsset"></span>&nbsp;</td>
+
<td width=729><span id="stepCreateAsset"></span>&#160;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepCreateImage|alt=Next Up|Top]]</td>
+
<td width=75>[[image:NextUp.png|link=#stepCreateImage|alt=Next Up|Top]]</td>
<td width=75>[[file:NextDown.png|link=#stepConfig|alt=Next Down|Next Down]]</td>
+
<td width=75>[[image:NextDown.png|link=#stepConfig|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
+
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
Line 117: Line 117:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=50><span style="font-weight: 700; font-size: 15px;">Steps:</span></td>
 
<td width=50><span style="font-weight: 700; font-size: 15px;">Steps:</span></td>
<td>[[image:DotPoint1.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Create the Asset:</span><br>
+
<td>[[image:DotPoint1.JPG|link=]]&#160;<span style="font-size: 17px; font-weight: 700;">Create the Asset:</span><br>
 
<table> <!-- BEGIN Step 1 table -->
 
<table> <!-- BEGIN Step 1 table -->
 
<tr valign="top">
 
<tr valign="top">
Line 132: Line 132:
 
<tr valign="top">
 
<tr valign="top">
 
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;1&#160;</span></td>
 
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;1&#160;</span></td>
<td>select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Manage Content&nbsp;</span></td>
+
<td>select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Manage Content&#160;</span></td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
Line 171: Line 171:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=50>&#160;</td>
 
<td width=50>&#160;</td>
<td>[[image:DotPoint2.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Find the New Asset:</span><br>
+
<td>[[image:DotPoint2.JPG|link=]]&#160;<span style="font-size: 17px; font-weight: 700;">Find the New Asset:</span><br>
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
Line 201: Line 201:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=50>&#160;</td>
 
<td width=50>&#160;</td>
<td>[[image:DotPoint3.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Open the Asset in Windows File Explorer:</span><br>
+
<td>[[image:DotPoint3.JPG|link=]]&#160;<span style="font-size: 17px; font-weight: 700;">Open the Asset in Windows File Explorer:</span><br>
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
Line 236: Line 236:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=50>&#160;</td>
 
<td width=50>&#160;</td>
<td>[[image:DotPoint4.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Open Config.txt File in Notepad:</span>
+
<td>[[image:DotPoint4.JPG|link=]]&#160;<span style="font-size: 17px; font-weight: 700;">Open Config.txt File in Notepad:</span>
 
<table> <!-- BEGIN Step 4 table -->
 
<table> <!-- BEGIN Step 4 table -->
 
<tr valign="top">
 
<tr valign="top">
Line 266: Line 266:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=50>&#160;</td>
 
<td width=50>&#160;</td>
<td>[[image:DotPoint5.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Edit the Config.txt File:</span><br>
+
<td>[[image:DotPoint5.JPG|link=]]&#160;<span style="font-size: 17px; font-weight: 700;">Edit the Config.txt File:</span><br>
 
<table> <!-- BEGIN Step 5 table -->
 
<table> <!-- BEGIN Step 5 table -->
 
<tr valign="top">
 
<tr valign="top">
Line 310: Line 310:
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:Stop.PNG|link=]]</td>
 
<td>[[image:Stop.PNG|link=]]</td>
<td>Unless you know '''exactly''' what you are doing'''*''',&nbsp;<span style="color: white; background-color: red; font-weight: 700; font-size: 17px;">&nbsp;DO NOT ALTER THE KUID NUMBER&nbsp;</span>&nbsp;that has been added to the file<br>
+
<td>Unless you know '''exactly''' what you are doing'''*''',&#160;<span style="color: white; background-color: red; font-weight: 700; font-size: 17px;">&#160;DO NOT ALTER THE KUID NUMBER&#160;</span>&#160;that has been added to the file<br>
 
'''*''' but even if you do, think <span style="font-weight: 700; text-decoration: underline">twice</span> before you change it !
 
'''*''' but even if you do, think <span style="font-weight: 700; text-decoration: underline">twice</span> before you change it !
 
</td>
 
</td>
Line 325: Line 325:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=50>&#160;</td>
 
<td width=50>&#160;</td>
<td>[[image:DotPoint6.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Add Any Extras:</span><br>
+
<td>[[image:DotPoint6.JPG|link=]]&#160;<span style="font-size: 17px; font-weight: 700;">Add Any Extras:</span><br>
 
<table>  
 
<table>  
 
<tr valign="top">
 
<tr valign="top">
Line 339: Line 339:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>a thumbnail image as described in the section [[file:PageLink.PNG|link=]] '''[[#The Thumbnail Image|The Thumbnail Image]]'''</td>
+
<td>a thumbnail image as described in the section [[image:PageLink.PNG|link=]] '''[[#The Thumbnail Image|The Thumbnail Image]]'''</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>the icon image as described in the section [[file:PageLink.PNG|link=]] '''[[#The Icon Image|The Icon Image]]'''</td>
+
<td>the icon image as described in the section [[image:PageLink.PNG|link=]] '''[[#The Icon Image|The Icon Image]]'''</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>texture text file as described in the section [[file:PageLink.PNG|link=]] '''[[#The Texture File|The Texture File]]'''</td>
+
<td>texture text file as described in the section [[image:PageLink.PNG|link=]] '''[[#The Texture File|The Texture File]]'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 362: Line 362:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>[[file:DriverIconFiles.png|link=]]</td>
+
<td>[[image:DriverIconFiles.png|link=]]</td>
 
<td><br><br>
 
<td><br><br>
 
This is the '''minimum''' number of files needed for a '''Driver Character'''</td>
 
This is the '''minimum''' number of files needed for a '''Driver Character'''</td>
Line 374: Line 374:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=50>&#160;</td>
 
<td width=50>&#160;</td>
<td>[[image:DotPoint7.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Finish Up:</span>
+
<td>[[image:DotPoint7.JPG|link=]]&#160;<span style="font-size: 17px; font-weight: 700;">Finish Up:</span>
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
Line 470: Line 470:
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
<td width=729><span id="stepConfig"></span>&nbsp;</td>
+
<td width=729><span id="stepConfig"></span>&#160;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepCreateAsset|alt=Next Up|Top]]</td>
+
<td width=75>[[image:NextUp.png|link=#stepCreateAsset|alt=Next Up|Top]]</td>
<td width=75>[[file:NextDown.png|link=#stepThumbIcon|alt=Next Down|Next Down]]</td>
+
<td width=75>[[image:NextDown.png|link=#stepThumbIcon|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
+
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
Line 544: Line 544:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>entries in&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;red&nbsp;</span>&nbsp;must not be changed</td>
+
<td>entries in&#160;<span style="background-color: red; color: white; font-weight: 700;">&#160;red&#160;</span>&#160;must not be changed</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
Line 552: Line 552:
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>the use of the '''{}''' braces is to group tags into common "containers". These containers must not be broken up and the number of '''{''' characters must match the number of '''}''' characters</td>
+
<td>the use of the '''{&#160;}''' braces is to group tags into common "containers". These containers must not be broken up and the number of '''{''' characters must match the number of '''}''' characters</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
Line 596: Line 596:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Gears.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 
'''For the above example:'''
 
'''For the above example:'''
Line 602: Line 602:
 
<tr valign="top">
 
<tr valign="top">
 
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
<td>The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> kuid </span>&nbsp;is unique to every asset so it is&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;not a good idea to choose your own&nbsp;</span>. This will be automatically generated by the '''Content Manager''' program when a new asset is created</td>
+
<td>The&#160;<span style="background-color: black; color: white; font-weight: 700;"> kuid </span>&#160;is unique to every asset so it is&#160;<span style="background-color: red; color: white; font-weight: 700;">&#160;not a good idea to choose your own&#160;</span>. This will be automatically generated by the '''Content Manager''' program when a new asset is created</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:BlackDot10x10.png|link=]]</td>
 
<td>[[image:BlackDot10x10.png|link=]]</td>
<td>The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> kind </span>&nbsp;identifies the ''type'' of asset and the types of files that '''Trainz''' will expect to find in the asset. It also tells '''Trainz''' how to render and error check the asset. For '''Driver Character''' assets, the category class is <span style="font-weight: 700; color: white; background-color: red;">&#160;drivercharacter&#160;</span>. A list of asset kinds can be found at [[file:WikiLink.PNG|link=]] '''[[KIND_TrainzBaseSpec#KIND_Hierarchy|KIND Hierarchy]]'''</td>
+
<td>The&#160;<span style="background-color: black; color: white; font-weight: 700;"> kind </span>&#160;identifies the ''type'' of asset and the types of files that '''Trainz''' will expect to find in the asset. It also tells '''Trainz''' how to render and error check the asset. For '''Driver Character''' assets, the category class is <span style="font-weight: 700; color: white; background-color: red;">&#160;drivercharacter&#160;</span>. A list of asset kinds can be found at [[image:WikiLink.PNG|link=]] '''[[KIND_TrainzBaseSpec#KIND_Hierarchy|KIND Hierarchy]]'''</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:BlackDot10x10.png|link=]]</td>
 
<td>[[image:BlackDot10x10.png|link=]]</td>
<td>The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> face-texture </span>&nbsp;is the name of the assets '''texture''' file. This will be a simple text file and will have the name '''<span style="color: black;">asset_name</span>.texture''' where '''<span style="color: black;">asset_name</span>''' will be a name you have selected for this asset - e.g. "'''driverlillian'''". The actual texture file itself will be named '''<span style="color: black;">asset_name</span>.texture.txt''' (e.g. "'''driverlillian.texture.txt'''") but the filename ending "'''.txt'''" is not added to the name in the '''face-texture''' tag so it would appear as "'''driverlillian.texture'''"</td>
+
<td>The&#160;<span style="background-color: black; color: white; font-weight: 700;"> face-texture </span>&#160;is the name of the assets '''texture''' file. This will be a simple text file and will have the name '''<span style="color: black;">asset_name</span>.texture''' where '''<span style="color: black;">asset_name</span>''' will be a name you have selected for this asset - e.g. "'''driverlillian'''". The actual texture file itself will be named '''<span style="color: black;">asset_name</span>.texture.txt''' (e.g. "'''driverlillian.texture.txt'''") but the filename ending "'''.txt'''" is not added to the name in the '''face-texture''' tag so it would appear as "'''driverlillian.texture'''"</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:BlackDot10x10.png|link=]]</td>
 
<td>[[image:BlackDot10x10.png|link=]]</td>
<td>The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> username </span>&nbsp;is your name for the asset and the name that other users will see. It is also the name that will appear in the '''Driver Setup Rule''' when the driver is being selected. It is a good idea to make it short and meaningful</td>
+
<td>The&#160;<span style="background-color: black; color: white; font-weight: 700;"> username </span>&#160;is your name for the asset and the name that other users will see. It is also the name that will appear in the '''Driver Setup Rule''' when the driver is being selected. It is a good idea to make it short and meaningful</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:BlackDot10x10.png|link=]]</td>
 
<td>[[image:BlackDot10x10.png|link=]]</td>
<td>The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> category-class </span>&nbsp;identifies the ''intent'' of the asset and is important in classifying it for filtering and searching. For '''driver character''' assets, the category class is <span style="font-weight: 700; color: white; background-color: red;">&#160;OHD&#160;</span>. A list of category classes can be found at [[file:WikiLink.PNG|link=]] '''[[Category-class]]'''</td>
+
<td>The&#160;<span style="background-color: black; color: white; font-weight: 700;"> category-class </span>&#160;identifies the ''intent'' of the asset and is important in classifying it for filtering and searching. For '''driver character''' assets, the category class is <span style="font-weight: 700; color: white; background-color: red;">&#160;OHD&#160;</span>. A list of category classes can be found at [[image:WikiLink.PNG|link=]] '''[[Category-class]]'''</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:BlackDot10x10.png|link=]]</td>
 
<td>[[image:BlackDot10x10.png|link=]]</td>
<td>The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> trainz-build </span>&nbsp;identifies the ''minimum'' Trainz version needed for this asset. A list of asset trainz-build numbers and their corresponding Trainz versions can be found at [[file:WikiLink.PNG|link=]] '''[["Trainz-build"_number]]'''</td>
+
<td>The&#160;<span style="background-color: black; color: white; font-weight: 700;"> trainz-build </span>&#160;identifies the ''minimum'' Trainz version needed for this asset. A list of asset trainz-build numbers and their corresponding Trainz versions can be found at [[image:WikiLink.PNG|link=]] '''[["Trainz-build"_number]]'''</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:BlackDot10x10.png|link=]]</td>
 
<td>[[image:BlackDot10x10.png|link=]]</td>
<td>The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> thumbnails </span>&nbsp;container holds the ''preview'' images of the asset shown by the '''Content Manager''' program, the Web version of the ''DLS'' and, for '''some assets''', the Surveyor main menu image(s) and, in this case, the asset texture itself. Information on thumbnails can be found at [[file:WikiLink.PNG|link=]] '''[[Thumbnails]]'''
+
<td>The&#160;<span style="background-color: black; color: white; font-weight: 700;"> thumbnails </span>&#160;container holds the ''preview'' images of the asset shown by the '''Content Manager''' program, the Web version of the ''DLS'' and, for '''some assets''', the Surveyor main menu image(s) and, in this case, the asset texture itself. Information on thumbnails can be found at [[image:WikiLink.PNG|link=]] '''[[Thumbnails]]'''
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPointBlack.JPG|10px|link=]]</td>
 +
<td>The first thumbnail&#160;<span style="background-color: black; color: white; font-weight: 700;">&#160;Default&#160;</span>&#160;is the '''container ID''' or '''placeholder''' for the thumbnail used by CM and the Web based DLS. While its ''exact label'' (or number - eg. "Default", "00", "01", etc) is not important, it must be different from any other labels. '''Default''' and '''0''' are commonly used placeholder labels for the 240 x 180 thumbnail image
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
 
<td width=10>[[image:BlackCircle10x10.png|link=]]</td>
 
<td width=10>[[image:BlackCircle10x10.png|link=]]</td>
<td>The first thumbnail&nbsp;<span style="background-color: black; color: white; font-weight: 700;">&nbsp;Default&nbsp;</span>&nbsp;is the '''container ID''' or '''placeholder''' for the thumbnail used by CM and the Web based DLS. While its ''exact label'' (or number - eg. "Default", "00", "01", etc) is not important, it must be different from any other labels. '''Default''' and '''0''' are commonly used placeholder labels for the 240 x 180 thumbnail image
+
<td>The '''image''' is the name of the thumbnail image. It does not have to be called '''thumbnail.jpg''' but it '''must''' be a JPG format image</td>
*The '''image''' is the name of the thumbnail image. It does not have to be called '''thumbnail.jpg''' but it '''must''' be a JPG format image
+
*The '''width''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;240&#160;</span>
+
*The '''height''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;180&#160;</span></td>
+
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:BlackCircle10x10.png|link=]]</td>
 
<td>[[image:BlackCircle10x10.png|link=]]</td>
<td>The second thumbnail&nbsp;<span style="background-color: black; color: white; font-weight: 700;">'''&nbsp;01&nbsp;'''</span>&nbsp;is the placeholder label for the 64 x 64 icon image used by the '''Driver Character''' for this asset. Its ''exact label'' does not matter but it must be different from the first thumbnail image placeholder label
+
<td>The '''width''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;240&#160;</span></td>
*The '''image''' is the assets '''<span style="color: black;">asset_name</span>.texture.txt''' file (but without the ".txt" at the end)
+
</tr>
*The '''width''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;64&#160;</span>
+
<tr valign="top">
*The '''height''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;64&#160;</span></td>
+
<td>[[image:BlackCircle10x10.png|link=]]</td>
 +
<td>The '''height''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;180&#160;</span></td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPointBlack.JPG|10px|link=]]</td>
 +
<td>The second thumbnail&#160;<span style="background-color: black; color: white; font-weight: 700;">'''&#160;01&#160;'''</span>&#160;is the placeholder label for the 64 x 64 icon image used by the '''Driver Character''' for this asset. Its ''exact label'' does not matter but it must be different from the first thumbnail image placeholder label
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackCircle10x10.png|link=]]</td>
 +
<td>The '''image''' is the assets '''<span style="color: black;">asset_name</span>.texture.txt''' file (but without the ".txt" at the end)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackCircle10x10.png|link=]]</td>
 +
<td>The '''width''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;64&#160;</span></td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackCircle10x10.png|link=]]</td>
 +
<td>The '''height''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;64&#160;</span></td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 660: Line 684:
 
<table width=1000 bgcolor=#ffffe0>
 
<table width=1000 bgcolor=#ffffe0>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PencilTips.PNG|link=]]</td>
+
<td>[[image:PencilTips.PNG|link=]]</td>
 
<td><span style="font-weight: 700; font-size: 17px;">Language Options:</span><br>
 
<td><span style="font-weight: 700; font-size: 17px;">Language Options:</span><br>
 
----
 
----
Line 667: Line 691:
 
<tr valign="top">
 
<tr valign="top">
 
<td></td>
 
<td></td>
<td>All Trainz assets have a language facility built into their config.txt files that allows other language translations to be added for certain tags, such as the '''username''' and '''description''' tags. A full description of the process can be found on the Trainz Wiki at [[file:WikiLink.PNG|link=]]&nbsp;'''[[HowTo/Localize_an_Asset|Localize an Asset]]''' and a list of all the supported languages with their two character codes at [[file:WikiLink.PNG|link=]]&nbsp;'''[[Localization_code|Localization (country) Codes]]'''.<br>
+
<td>All Trainz assets have a language facility built into their config.txt files that allows other language translations to be added for certain tags, such as the '''username''' and '''description''' tags. A full description of the process can be found on the Trainz Wiki at [[image:WikiLink.PNG|link=]]&#160;'''[[HowTo/Localize_an_Asset|Localize an Asset]]''' and a list of all the supported languages with their two character codes at [[image:WikiLink.PNG|link=]]&#160;'''[[Localization_code|Localization (country) Codes]]'''.<br>
  
 
At the very basic level any creator can easily provide other language translations for the '''username''' and '''description''' tags in the assets they create. Examples are shown below for this sample asset.</td>
 
At the very basic level any creator can easily provide other language translations for the '''username''' and '''description''' tags in the assets they create. Examples are shown below for this sample asset.</td>
Line 691: Line 715:
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
<td width=729><span id="stepThumbIcon"></span>&nbsp;</td>
+
<td width=729><span id="stepThumbIcon"></span>&#160;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepConfig|alt=Next Up|Top]]</td>
+
<td width=75>[[image:NextUp.png|link=#stepConfig|alt=Next Up|Top]]</td>
<td width=75>[[file:NextDown.png|link=#stepTexture|alt=Next Down|Next Down]]</td>
+
<td width=75>[[image:NextDown.png|link=#stepTexture|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
+
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
Line 754: Line 778:
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:BlueDot10x10.png|link=]]</td>
 
<td>[[image:BlueDot10x10.png|link=]]</td>
<td>See the [[file:PageLink.PNG|link=]] '''[[#Create the Driver Image|Create the Driver Image]]''' section at the top of this page for an example</td>
+
<td>See the [[image:PageLink.PNG|link=]] '''[[#Create the Driver Image|Create the Driver Image]]''' section at the top of this page for an example</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 760: Line 784:
 
<table width=1000>
 
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Texture64Pixels.PNG|link=]]<br>
+
<td>[[image:Texture64Pixels.PNG|link=]]<br>
 
(not to scale)</td>
 
(not to scale)</td>
 
<td>
 
<td>
Line 769: Line 793:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Gears.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 
The image must meet the following specifications:-
 
The image must meet the following specifications:-
Line 820: Line 844:
 
<table bgcolor=#ffffe0>
 
<table bgcolor=#ffffe0>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PencilTips.PNG|link=]]</td>
+
<td>[[image:PencilTips.PNG|link=]]</td>
 
<td>If your image will have a transparency, such as a transparent background, it is usually a lot easier to save the image in a format that supports an '''alpha channel''' ('''bmp''', '''png''' or '''tga''') and either
 
<td>If your image will have a transparency, such as a transparent background, it is usually a lot easier to save the image in a format that supports an '''alpha channel''' ('''bmp''', '''png''' or '''tga''') and either
 
<table>
 
<table>
Line 832: Line 856:
 
</tr>
 
</tr>
 
</table>
 
</table>
... than it is to use a format that does not support an alpha channel. See [[file:PageLink.PNG|link=]] '''[[#The Texture File|The Texture File]]''' below for more details.</td>
+
... than it is to use a format that does not support an alpha channel. See [[image:PageLink.PNG|link=]] '''[[#The Texture File|The Texture File]]''' below for more details.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 841: Line 865:
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
<td width=729><span id="stepTexture"></span>&nbsp;</td>
+
<td width=729><span id="stepTexture"></span>&#160;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepThumbIcon|alt=Next Up|Top]]</td>
+
<td width=75>[[image:NextUp.png|link=#stepThumbIcon|alt=Next Up|Top]]</td>
<td width=75>[[file:NextDown.png|link=#stepUsing|alt=Next Down|Next Down]]</td>
+
<td width=75>[[image:NextDown.png|link=#stepUsing|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
+
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
Line 863: Line 887:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Gears.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Settings:'''</span>
 
<td><span style="font-size: 17px;">'''Settings:'''</span>
 
<table>
 
<table>
Line 913: Line 937:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Gears.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Settings:'''</span>
 
<td><span style="font-size: 17px;">'''Settings:'''</span>
 
<table>
 
<table>
Line 942: Line 966:
 
<table width=1000 cellpadding=4 bgcolor=#ffffb0>
 
<table width=1000 cellpadding=4 bgcolor=#ffffb0>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:NotePad.PNG|link=]]</td>
+
<td>[[image:NotePad.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 
----
 
----
Line 948: Line 972:
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint1Blue.png|link=]]</td>
+
<td width=25>[[image:Ablue.png|link=]]</td>
<td>If the icon has a transparency (an '''alpha channel''') and is saved in a format that supports the '''alpha channel'''</td>
+
<td>If the icon has a transparency (an '''alpha channel''') and is saved in a format that supports the '''alpha channel'''<br>
</tr>
+
</table>
+
 
Then:-
 
Then:-
 
<table>
 
<table>
Line 969: Line 991:
 
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td>the image must contain '''<span style="text-decoration: underline;">both</span>''' the '''RGB''' colour data and the '''Alpha Channel''' (transparency) data (it must have a '''depth''' of '''32 bits''')</td>
 
<td>the image must contain '''<span style="text-decoration: underline;">both</span>''' the '''RGB''' colour data and the '''Alpha Channel''' (transparency) data (it must have a '''depth''' of '''32 bits''')</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 977: Line 1,002:
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint2Blue.png|link=]]</td>
+
<td>[[image:Bblue.png|link=]]</td>
<td>If the icon needs to have transparency (an '''alpha channel''') but an '''alpha channel''' is not available (e.g. it is saved in the jpg file format) or is not suitable</td>
+
<td>If the icon needs to have transparency (an '''alpha channel''') but an '''alpha channel''' is not available (e.g. it is saved in the jpg file format) or is not suitable<br>
</tr>
+
</table>
+
 
Then:-
 
Then:-
 
<table>
 
<table>
Line 1,006: Line 1,029:
 
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 
<td>the '''alpha''' image file should be a greyscale image or just black and white</td>
 
<td>the '''alpha''' image file should be a greyscale image or just black and white</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 1,014: Line 1,040:
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint3Blue.png|link=]]</td>
+
<td>[[image:Cblue.png|link=]]</td>
<td>If the icon image does not have a transparency and no '''alpha channel''' is needed</td>
+
<td>If the icon image does not have a transparency and no '''alpha channel''' is needed<br>
</tr>
+
</table>
+
 
Then:-
 
Then:-
 
<table>
 
<table>
Line 1,039: Line 1,063:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 
Image file formats supported by '''Trainz''' that have an '''alpha channel''' are:-
 
Image file formats supported by '''Trainz''' that have an '''alpha channel''' are:-
 
<table>
 
<table>
Line 1,067: Line 1,095:
 
<table cellpadding=4 bgcolor="Aquamarine">
 
<table cellpadding=4 bgcolor="Aquamarine">
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:LinkWiki.PNG|link=]]</td>
+
<td>[[image:LinkWiki.PNG|link=]]</td>
 
<td>A detailed description of the '''.texture''' file format can be found on the '''Trainz Wiki Page''' at:-<br>
 
<td>A detailed description of the '''.texture''' file format can be found on the '''Trainz Wiki Page''' at:-<br>
 
[[image:BlueDot10x10.png|link=]] '''[[Texture_file|Texture File]]'''</td>
 
[[image:BlueDot10x10.png|link=]] '''[[Texture_file|Texture File]]'''</td>
Line 1,075: Line 1,103:
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
<td width=729><span id="stepUsing"></span>&nbsp;</td>
+
<td width=729><span id="stepUsing"></span>&#160;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepTexture|alt=Next Up|Top]]</td>
+
<td width=75>[[image:NextUp.png|link=#stepTexture|alt=Next Up|Top]]</td>
<td width=75>&nbsp;</td>
+
<td width=75>&#160;</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
+
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
Line 1,089: Line 1,117:
 
<table width=1000>
 
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
<td width=500>[[file:DriverIconSelect.png|500px|link=]]</td>
+
<td width=500>[[image:DriverIconSelect.png|500px|link=]]</td>
 
<td>
 
<td>
 
<table bgcolor=#000000 cellpadding=2>
 
<table bgcolor=#000000 cellpadding=2>
Line 1,099: Line 1,127:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td colspan=2>Open the '''Session Editor''' (see [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''') and open it for editing.</td>
+
<td colspan=2>Open the '''Session Editor''' (see [[image:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''') and open it for editing.</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
Line 1,119: Line 1,147:
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:DotPoint5.JPG|link=]]</td>
 
<td>[[image:DotPoint5.JPG|link=]]</td>
<td>Select the driver name and <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> the [[file:Tick.PNG|link=]] icon</td>
+
<td>Select the driver name and <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> the [[image:Tick.PNG|link=]] icon</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:DotPoint6.JPG|link=]]</td>
 
<td>[[image:DotPoint6.JPG|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> the [[file:Tick.PNG|link=]] on the '''Driver Setup Rule''' window to accept the selection</td>
+
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> the [[image:Tick.PNG|link=]] on the '''Driver Setup Rule''' window to accept the selection</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 1,138: Line 1,166:
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
<td width=729><span id="bottom"></span>&nbsp;</td>
+
<td width=729><span id="bottom"></span>&#160;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepUsing|alt=Next Up|Top]]</td>
+
<td width=75>[[image:NextUp.png|link=#stepUsing|alt=Next Up|Top]]</td>
<td width=75>&nbsp;</td>
+
<td width=75>&#160;</td>
<td width=75>&nbsp;</td>
+
<td width=75>&#160;</td>
 
</tr>
 
</tr>
 
</table> <!-- END Nav Buttons Table -->
 
</table> <!-- END Nav Buttons Table -->
Line 1,150: Line 1,178:
 
<table cellpadding=4 bgcolor=#ffffff>
 
<table cellpadding=4 bgcolor=#ffffff>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:TrainzWiki.png|link=]]</td>
+
<td>[[image:TrainzWiki.png|link=]]</td>
 
<td>
 
<td>
 
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
 
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>

Latest revision as of 09:04, 13 November 2023

          Next Down Bottom

The information in this Wiki Page applies to TANE, TRS19, Trainz Plus and TRS22.

BlueDot10x10.png Driver Characters are avatars that can be assigned to locomotives in sessions. They play the role of train drivers and can be moved between locomotives
BlueDot10x10.png Driver Character Icons are small graphic icons or images that can be selected to represent locomotive drivers in the WikiLink.PNG Driver Setup Rule


Contents

 Workflow Diagram 
Workflow diagram
  Top   Next Down Bottom

[edit] Create the Driver Image

BlueDot10x10.png The final image must be reduced to 64 pixels by 64 pixels in size
The image can be easily created and resized using your favourite image editor. It can start with a photograph, as shown in the example below, a piece of clip art or a drawing. Make sure that there will be no copyright issues so something of your own creation, such as a photograph, would be ideal.


Original photo of a cat If possible use a photograph with a simple background behind the subject, as shown in the image on the left. This keeps the icon simple and can avoid unnecessary "clutter". Most image editors will have tools for removing unwanted backgrounds but this can be time consuming.

You may choose to add some clipart - in this case a train drivers cap and a "traditional" red scarf. Copyright free clipart is strongly recommended.

Driver clip art

The clip art can be added as layers to the image which makes them easier to manipulate (resize and move).

Crop the image to a square with the same number of pixels on each side with the minimum size being 64 pixels. Multiples of 64 (such as 128, 256, 512) would be ideal but not absolutely necessary as long as both the height and the width are the same size.


Cropping the image Final crop of the image

After cropping, reduce the image size to 64 pixels wide and 64 pixels high.

Resizing the image Save the final resized image with a suitable name and in a suitable file format:-
DotPoint.JPG .png (best choice)
DotPoint.JPG .tga (2nd best choice but do not use compression)
DotPoint.JPG .jpg (3rd best choice)
  Top Next Up Next Down Bottom

[edit] Create Driver Character Asset

Steps: DotPoint1.JPG Create the Asset:
NewAsset.PNG

NewAssetCreated.PNG
Steps: From the Trainz Launcher:-
 1  select  Manage Content 
 2  in Content Manager open the  Developer  menu
 3  select  New Content 
DotPoint.JPG This will create a new asset and open it for editing.
DotPoint.JPG A message window will appear that will (hopefully) report on the successful creation of a new asset
 4  Close the message window


  DotPoint2.JPG Find the New Asset:
NewAssetSelectOpen.PNG
 5  Set the Content Manager Search Filter to  Open for Editing 
This will display only those assets that have been opened for editing (hopefully only your new and as yet unnamed asset will be shown)


  DotPoint3.JPG Open the Asset in Windows File Explorer:
NewAssetShowExplorer.PNG
 6  Right Click on the entry New Asset
 7  Select Open...
 8  Select Show in Explorer


  DotPoint4.JPG Open Config.txt File in Notepad:
NewAssetOpenExplorer.PNG
There will only be a single item in the asset, its config.txt file
 9  Double Left Click on the file to open it in Notepad


  DotPoint5.JPG Edit the Config.txt File:
NewAssetOpenNotepad.PNG
You will need to edit the contents of this file.
 10  The next section, PageLink.PNG The Config.txt File, identifies the changes you will need to make. The new name you give to the asset will not take effect until after it has been Submitted
 11  After editing, save the changes and exit Notepad


 
Warning:
Stop.PNG Unless you know exactly what you are doing* DO NOT ALTER THE KUID NUMBER  that has been added to the file

* but even if you do, think twice before you change it !


  DotPoint6.JPG Add Any Extras:
 12  You will need to add:-
DotPoint.JPG a thumbnail image as described in the section PageLink.PNG The Thumbnail Image
DotPoint.JPG the icon image as described in the section PageLink.PNG The Icon Image
DotPoint.JPG texture text file as described in the section PageLink.PNG The Texture File
THIS IS AN EXAMPLE ONLY
DriverIconFiles.png

This is the minimum number of files needed for a Driver Character


  DotPoint7.JPG Finish Up:
NewAssetSubmit.PNG
 13  Close the Asset window
 14  Commit the asset in Content Manager
DotPoint.JPG Right Click on the asset
DotPoint.JPG Select  Submit Edits  Hopefully there will be no errors.


NotePad.PNG Because you still have the Search Filter Open for Editing in operation, the now closed and Submitted asset will vanish from the Content Manager display. To check that your asset has been correctly created and renamed, set the Search Filter to Today.


Bug.png Some of the most common errors that can occur when creating and Submitting a new asset are:-
DotPoint.JPG no thumbnail image in the asset
DotPoint.JPG typing errors in the config.txt file
DotPoint.JPG poorly formatted tags in the config.txt file
DotPoint.JPG incorrect file types added to the asset folder
DotPoint.JPG files missing from the asset folder
DotPoint.JPG an incorrect kuid value (despite the warning you changed it in Step  5 )


  Top Next Up Next Down Bottom

[edit] The Config.txt File

BlueDot10x10.png All assets must have a config.txt file



Gears.PNG Settings:
The Driver Character asset must have a config.txt text file that must include the following tags:-
BlackDot10x10.png kind set to "drivercharacter"
BlackDot10x10.png username set to the asset title or name
BlackDot10x10.png kuid a unique ID code
BlackDot10x10.png thumbnails set to a 240 by 180 pixel JPG image
While not mandatory, the following tag is useful:-
BlackDot10x10.png category-class set to "OHD"


This file should follow the same (or a similar) format as the example below.
DotPoint.JPG entries in  red  must not be changed
DotPoint.JPG the indenting of the lines and the spacing ("tabbing") between the "tags" on the left and their contents on the right are purely to make it easier for humans to read
DotPoint.JPG the use of the { } braces is to group tags into common "containers". These containers must not be broken up and the number of { characters must match the number of } characters
DotPoint.JPG the order of the "tags" is not important
kuid                                    <kuid: this is an auto-generated number >
kind                                    "drivercharacter"
face-texture                            "DriverLillian.texture"
username                                "Driver Lillian"
category-class                          "OHD"
trainz-build                            4.3

thumbnails
{
  Default
  {
    width                               240
    height                              180
    image                               "thumbnail.jpg"
  }
  01
  {
    width                               64
    height                              64
    image                               "driverlillian.texture"
  }
}
description                             "Icon for train driver Lillian"

Gears.PNG Settings:

For the above example:

BlackDot10x10.png The  kuid  is unique to every asset so it is  not a good idea to choose your own . This will be automatically generated by the Content Manager program when a new asset is created
BlackDot10x10.png The  kind  identifies the type of asset and the types of files that Trainz will expect to find in the asset. It also tells Trainz how to render and error check the asset. For Driver Character assets, the category class is  drivercharacter . A list of asset kinds can be found at WikiLink.PNG KIND Hierarchy
BlackDot10x10.png The  face-texture  is the name of the assets texture file. This will be a simple text file and will have the name asset_name.texture where asset_name will be a name you have selected for this asset - e.g. "driverlillian". The actual texture file itself will be named asset_name.texture.txt (e.g. "driverlillian.texture.txt") but the filename ending ".txt" is not added to the name in the face-texture tag so it would appear as "driverlillian.texture"
BlackDot10x10.png The  username  is your name for the asset and the name that other users will see. It is also the name that will appear in the Driver Setup Rule when the driver is being selected. It is a good idea to make it short and meaningful
BlackDot10x10.png The  category-class  identifies the intent of the asset and is important in classifying it for filtering and searching. For driver character assets, the category class is  OHD . A list of category classes can be found at WikiLink.PNG Category-class
BlackDot10x10.png The  trainz-build  identifies the minimum Trainz version needed for this asset. A list of asset trainz-build numbers and their corresponding Trainz versions can be found at WikiLink.PNG "Trainz-build"_number
BlackDot10x10.png The  thumbnails  container holds the preview images of the asset shown by the Content Manager program, the Web version of the DLS and, for some assets, the Surveyor main menu image(s) and, in this case, the asset texture itself. Information on thumbnails can be found at WikiLink.PNG Thumbnails
DotPointBlack.JPG The first thumbnail  Default  is the container ID or placeholder for the thumbnail used by CM and the Web based DLS. While its exact label (or number - eg. "Default", "00", "01", etc) is not important, it must be different from any other labels. Default and 0 are commonly used placeholder labels for the 240 x 180 thumbnail image
BlackCircle10x10.png The image is the name of the thumbnail image. It does not have to be called thumbnail.jpg but it must be a JPG format image
BlackCircle10x10.png The width of the image in pixels must be  240 
BlackCircle10x10.png The height of the image in pixels must be  180 
DotPointBlack.JPG The second thumbnail  01  is the placeholder label for the 64 x 64 icon image used by the Driver Character for this asset. Its exact label does not matter but it must be different from the first thumbnail image placeholder label
BlackCircle10x10.png The image is the assets asset_name.texture.txt file (but without the ".txt" at the end)
BlackCircle10x10.png The width of the image in pixels must be  64 
BlackCircle10x10.png The height of the image in pixels must be  64 
BlackDot10x10.png The  description  provides more details for users than the username

PencilTips.PNG Language Options:

All Trainz assets have a language facility built into their config.txt files that allows other language translations to be added for certain tags, such as the username and description tags. A full description of the process can be found on the Trainz Wiki at WikiLink.PNG Localize an Asset and a list of all the supported languages with their two character codes at WikiLink.PNG Localization (country) Codes.
At the very basic level any creator can easily provide other language translations for the username and description tags in the assets they create. Examples are shown below for this sample asset.
username                    "Driver Lillian"
username-c2                 "司机莉莲"
username-es                 "Conductor Liliana"
username-de                 "Fahrer Lilian"
username-fr                 "Chauffeur Lilianen"
username-nl                 "Chauffeur Lillian"
username-ru                 "Драйвер Лилиан"
Translations to Chinese (simplified), Spanish, French, German, Dutch and Russian, perfect or not, were provided by Google Translate.


  Top Next Up Next Down Bottom

[edit] The Thumbnail Image

BlueDot10x10.png A thumbnail image MUST be present in the asset


NotePad.PNG Notes:

The thumbnail image:-

DotPoint.JPG must be in JPG format
DotPoint.JPG must be 240 pixels wide by 180 pixels tall
DotPoint.JPG does not have to be named thumbnail.jpg as long as the name used is in the Thumbnails container in the config.txt file
Thumbnail


[edit] The Icon Image

BlueDot10x10.png You will need image editing software to create the icon image or to change an existing image to the required dimensions and format
BlueDot10x10.png See the PageLink.PNG Create the Driver Image section at the top of this page for an example


Texture64Pixels.PNG
(not to scale)

Gears.PNG Settings:

The image must meet the following specifications:-

BlackDot10x10.png 64 pixels wide and 64 pixels tall
BlackDot10x10.png bit depth should be 24 (no alpha channel or transparency) or 32 (if an alpha channel is used)
BlackDot10x10.png image file format can be any of:-
BlackCircle10x10.png bmp
BlackCircle10x10.png jpg (jpg does not support transparency)
BlackCircle10x10.png png
BlackCircle10x10.png tga (tga compression should not be used)


PencilTips.PNG If your image will have a transparency, such as a transparent background, it is usually a lot easier to save the image in a format that supports an alpha channel (bmp, png or tga) and either
DotPoint.JPG convert the background to a transparency OR
DotPoint.JPG remove the background and add a transparent layer to the image as its background
... than it is to use a format that does not support an alpha channel. See PageLink.PNG The Texture File below for more details.


  Top Next Up Next Down Bottom

[edit] The Texture File

BlueDot10x10.png The .texture.txt file controls how an image icon is displayed, particularly its Alpha Channel (or transparency) data. The file must be present even if no transparency is used in the icon.



Gears.PNG Settings:
BlackDot10x10.png the Texture File is a standard text file
BlackDot10x10.png the filename is composed of:-
BlackCircle10x10.png a user selected asset_name followed by a period (.)
BlackCircle10x10.png the word texture followed by a period (.)
BlackCircle10x10.png the letters txt


A sample Texture File, "driverlillian.texture.txt", is shown below:-

primary=Lillian64.png
alpha=Lillian64.png
tile=st

Gears.PNG Settings:
BlackDot10x10.png primary - this is the name of the icon image file that contains the RGB colour image. Any alpha channel in this file will be ignored
BlackDot10x10.png alpha - this is the name of the icon image file that contains the Alpha Channel (transparency) image (see Notes: below)
BlackDot10x10.png tile=st - instructs Trainz to tile the image both horizontally and vertically. This has no effect on the Driver Character icon but must be included for validation purposes
No "white spaces" between the text characters is allowed.

NotePad.PNG Notes:

There are 3 general "scenarios" for the structure of the Texture File in a Driver Character asset.

Ablue.png If the icon has a transparency (an alpha channel) and is saved in a format that supports the alpha channel

Then:-

primary=Lillian64.png
alpha=Lillian64.png
tile=st
DotPoint.JPG the primary and alpha images are the same file, as in the example shown left
DotPoint.JPG the image must contain both the RGB colour data and the Alpha Channel (transparency) data (it must have a depth of 32 bits)
Bblue.png If the icon needs to have transparency (an alpha channel) but an alpha channel is not available (e.g. it is saved in the jpg file format) or is not suitable

Then:-

primary=Lillian64.jpg
alpha=Lillian64_alpha.jpg
tile=st
DotPoint.JPG two different files (different file names or different image file formats) must be used as in the example shown left
DotPoint.JPG both images must be the same size (64 pixels x 64 pixels)
DotPoint.JPG both images must have a depth of 24 bits - so no alpha channel must be present in either image
DotPoint.JPG the alpha image file should be a greyscale image or just black and white
Cblue.png If the icon image does not have a transparency and no alpha channel is needed

Then:-

primary=Lillian64.jpg
tile=st
DotPoint.JPG the alpha= line in the .texture.txt file is not needed, as in the example shown left
DotPoint.JPG the primary file contains the RGB colour data and can be in any supported image format. If it also has alpha channel data then the alpha channel data will be ignored so the icon will be shown without any transparency

Image file formats supported by Trainz that have an alpha channel are:-

DotPoint.JPG bmp
DotPoint.JPG png
DotPoint.JPG tga (do not use compression)

Image file formats supported by Trainz that DO NOT have an alpha channel are:-

DotPoint.JPG jpg


LinkWiki.PNG A detailed description of the .texture file format can be found on the Trainz Wiki Page at:-
BlueDot10x10.png Texture File


  Top Next Up   Bottom

[edit] Using the Asset

Once the new asset has been committed it will be available for use in a Driver Setup Rule.

DriverIconSelect.png
Steps: To use the Driver Character:-
Open the Session Editor (see WikiLink.PNG Session Editor) and open it for editing.
DotPoint1.JPG Select the Driver Setup Rule and Left Click the Edit button
DotPoint2.JPG Select a driver icon to change to your new icon, or add a new driver
DotPoint3.JPG Left Click on the icon for the selected (or new) driver
DotPoint4.JPG Scroll down the list to find your newly created driver character
DotPoint5.JPG Select the driver name and Left Click the Tick.PNG icon
DotPoint6.JPG Left Click the Tick.PNG on the Driver Setup Rule window to accept the selection


The finished product as a Driver.
DriverIconLillian.png

  Top Next Up    


[edit] Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz


This page was created by Trainz user pware in November 2022 and was last updated as shown below.


Personal tools