How to Create a Driver Character

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m
m (The Config.txt File)
 
(22 intermediate revisions by one user not shown)
Line 1: Line 1:
 +
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
 +
<tr valign="top">
 +
<td width=729>&#160;</td>
 +
<td width=50>&#160;</td>
 +
<td width=50>&#160;</td>
 +
<td width=46>&#160;</td>
 +
<td width=75>&#160;</td>
 +
<td width=75>[[image:NextDown.png|link=#stepCreateImage|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 +
 
The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''.<br>
 
The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''.<br>
<table cellpadding=4 bgcolor=#c1e7e7>
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
<td>'''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<td>
+
<td>'''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</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|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>
 
<br>
 
<br>
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>
 
__TOC__
 
__TOC__
 +
</td>
 +
<td align="center"><span style="font-weight: 700; font-size: 17px; color: white; background-color: black;">&#160;Workflow Diagram&#160;</span><br>
 +
[[image:DriverCharacterWorkflow.png|link=|alt=Workflow diagram]]</td>
 +
</tr>
 +
</table>
  
<table> <!-- 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 -->
 
='''Create the Driver Image'''=
 
='''Create the Driver Image'''=
  
<table cellpadding=4 bgcolor=#c1e7e7>
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 
<td>'''The final image must be reduced to 64 pixels by 64 pixels in size'''</td>
 
<td>'''The final image must be reduced to 64 pixels by 64 pixels in size'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
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.<br>
+
<table width=1000>
 
+
<tr valign="top">
<table>
+
<td>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.</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:DriverIconOriginal.png|link=|alt=Original photo of a cat]]</td>
 
<td>[[image:DriverIconOriginal.png|link=|alt=Original photo of a cat]]</td>
Line 42: Line 66:
 
[[image:DriverIconClipArt.png|link=|alt=Driver clip art]]
 
[[image:DriverIconClipArt.png|link=|alt=Driver clip art]]
  
The clip art can be added as layers to the image which makes them easier to manipulate (resize and move).</td>
+
The clip art can be added as layers to the image which makes them easier to manipulate (resize and move).<br>
</tr>
+
<table>
+
 
+
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.<br>
+
  
 +
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.</td>
 +
</tr>
 +
</table>
 +
<br>
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
Line 55: Line 79:
 
</table>
 
</table>
  
After cropping, reduce the image size to 64 pixels wide (and therefore 64 pixels high).
+
After cropping, reduce the image size to '''64''' pixels wide and '''64''' pixels high.
  
 
<table>
 
<table>
Line 61: Line 85:
 
<td>[[image:DriverIconSized64.png|link=|alt=Resizing the image]]</td>
 
<td>[[image:DriverIconSized64.png|link=|alt=Resizing the image]]</td>
 
<td>Save the final resized image with a suitable name and in a suitable file format:-
 
<td>Save the final resized image with a suitable name and in a suitable file format:-
* '''.png''' (best choice)
+
<table>
* '''.tga''' (2nd best choice but do not use compression)
+
<tr valign="top">
* '''.jpg''' (3rd best choice)
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''.png''' (best choice)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''.tga''' (2nd best choice but do not use compression)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''.jpg''' (3rd best choice)</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<table> <!-- 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 -->
 
='''Create Driver Character Asset'''=
 
='''Create Driver Character Asset'''=
  
<table cellpadding=4 bgcolor=#ffffff> <!-- BEGIN Step table -->
+
<table width=1000> <!-- BEGIN Step table -->
<tr>
+
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Steps.PNG|link=]]<br><br>
+
<td width=50><span style="font-weight: 700; font-size: 15px;">Steps:</span></td>
<span style="font-size: 17px; font-weight: 700;">Steps</span></td>
+
<td>[[image:DotPoint1.JPG|link=]]&#160;<span style="font-size: 17px; font-weight: 700;">Create the Asset:</span><br>
<td>[[file:DotPoint1.JPG|link=]]&nbsp;<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">
<td>[[file:NewAsset.PNG|link=]]<br><br>
+
<td>[[image:NewAsset.PNG|link=]]<br><br>
[[file:NewAssetCreated.PNG|link=]]</td>
+
[[image:NewAssetCreated.PNG|link=]]</td>
<td>From the '''Trainz''' Launcher
+
<td>
#select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Manage Content&nbsp;</span>
+
<table bgcolor=#000000 cellpadding=2>
#in '''Content Manager''' open the '''Developer''' menu
+
<tr valign="top">
#select '''New Content'''
+
<td>
This will create a new asset and open it for editing.
+
<table bgcolor=#ffffff cellpadding=2>
<br><br>
+
<tr valign="top">
A message window will appear that will (hopefully) report on the successful creation of a new asset.
+
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps:</span> From the '''Trainz Launcher''':-</td>
*Close the message window
+
</tr>
 +
<tr valign="top">
 +
<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;">&#160;Manage Content&#160;</span></td>
 +
</tr>
 +
<tr valign="top">
 +
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;2&#160;</span></td>
 +
<td>in '''Content Manager''' open the <span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;Developer&#160;</span> menu</td>
 +
</tr>
 +
<tr valign="top">
 +
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;3&#160;</span></td>
 +
<td>select <span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;New Content&#160;</span>
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>This will create a new asset and open it for editing.</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>A message window will appear that will (hopefully) report on the successful creation of a new asset</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
</table> <!-- END Step 1 table -->
+
<tr valign="top">
 +
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;4&#160;</span></td>
 +
<td>Close the message window</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
<tr>
+
</table>
<td colspan="2">
+
</td>
----</td>
+
 
</tr>
 
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table> <!-- END Step 1 table -->
 +
<br>
 +
<table width=1000> <!-- BEGIN Step 2 table -->
 
<tr valign="top">
 
<tr valign="top">
<td>&nbsp;</td>
+
<td width=50>&#160;</td>
<td>[[file: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> <!-- BEGIN Step 2 table -->
+
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:NewAssetSelectOpen.PNG|link=]]</td>
+
<td>[[image:NewAssetSelectOpen.PNG|link=]]</td>
 
<td>
 
<td>
*Set the CM Search Filter to '''Open for Editing'''
+
<table bgcolor=#000000 cellpadding=2>
This will display only those assets that have been opened for editing (hopefully only your new and as yet unnamed asset will be shown)
+
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffff cellpadding=2>
 +
<tr valign="top">
 +
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;5&#160;</span></td>
 +
<td>Set the '''Content Manager''' Search Filter to <span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;Open for Editing&#160;</span></td>
 +
</tr>
 +
<tr>
 +
<td colspan=2>This will display only those assets that have been opened for editing (hopefully only your new and as yet unnamed asset will be shown)</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
</table> <!-- END Step 2 table -->
+
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
<tr>
+
</table>
<td colspan="2">
+
</td>
----</td>
+
 
</tr>
 
</tr>
 +
</table> <!-- END Step 2 table -->
 +
<br>
 +
<table width=1000> <!-- BEGIN Step 3 table -->
 
<tr valign="top">
 
<tr valign="top">
<td>&nbsp;</td>
+
<td width=50>&#160;</td>
<td>[[file: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> <!-- BEGIN Step 3 table -->
+
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:NewAssetShowExplorer.PNG|link=]]</td>
+
<td>[[image:NewAssetShowExplorer.PNG|link=]]</td>
 
<td>
 
<td>
#Right mouse click on the entry '''New Asset'''
+
<table bgcolor=#000000 cellpadding=2>
#Select '''Open'''
+
<tr valign="top">
#Select '''Show in Explorer'''
+
<td>
 +
<table bgcolor=#ffffff cellpadding=2>
 +
<tr valign="top">
 +
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;6&#160;</span></td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Right Click</span> on the entry '''New Asset'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;7&#160;</span></td>
 +
<td>Select <span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">Open...</span></td>
 +
</tr>
 +
<tr valign="top">
 +
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;8&#160;</span></td>
 +
<td>Select <span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">Show in Explorer</span></td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 139: Line 231:
 
</td>
 
</td>
 
</tr>
 
</tr>
<tr>
+
</table>
<td colspan="2">
+
<br>
----</td>
+
<table width=1000> <!-- BEGIN Step 4 table -->
</tr>
+
 
<tr valign="top">
 
<tr valign="top">
<td>&nbsp;</td>
+
<td width=50>&#160;</td>
<td>[[file:DotPoint4.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Open Config.txt File in Notepad:</span><br>
+
<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">
<td>[[file:NewAssetOpenExplorer.PNG|link=]]</td>
+
<td>[[image:NewAssetOpenExplorer.PNG|link=]]</td>
<td>There will only be a single item in the asset, its config.txt file
+
<td>
*Double click on the file to open it in Notepad</td>
+
<table bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffff cellpadding=2>
 +
<tr valign="top">
 +
<td colspan=2>There will only be a single item in the asset, its config.txt file</td>
 
</tr>
 
</tr>
</table> <!-- END Step 4 table -->
+
<tr valign="top">
 +
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;9&#160;</span></td>
 +
<td>In '''Windows File Explorer''' <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Double Left Click</span> on the file to open it in '''Notepad'''</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
<tr>
+
</table>
<td colspan="2">
+
</td>
----</td>
+
 
</tr>
 
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table> <!-- END Step 4 table -->
 +
<br>
 +
<table width=1000> <!-- BEGIN Step 5 table -->
 
<tr valign="top">
 
<tr valign="top">
<td>&nbsp;</td>
+
<td width=50>&#160;</td>
<td>[[file: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">
<td>[[file:NewAssetOpenNotepad.PNG|link=]]</td>
+
<td>[[image:NewAssetOpenNotepad.PNG|link=]]</td>
<td>You will need to edit the contents of this file.  
+
<td>
*The next section, [[file:PageLink.PNG|link=]] '''[[#The Config.txt File|The Config.txt File]]''', identifies the changes you will need to make.  
+
<table bgcolor=#000000 cellpadding=2>
*The new name you give to the asset will not take effect until after it has been committed.
+
<tr valign="top">
*After editing, save the changes and exit Notepad.</td>
+
<td>
 +
<table bgcolor=#ffffff cellpadding=2>
 +
<tr valign="top">
 +
<td colspan=2>You will need to edit the contents of this file.</td>
 +
</tr>
 +
<tr valign="top">
 +
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;10&#160;</span></td>
 +
<td>The next section, [[image:PageLink.PNG|link=]] '''[[#The Config.txt File|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'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;11&#160;</span></td>
 +
<td>After editing, save the changes and exit '''Notepad'''</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table> <!-- END Step 5 table -->
 
</table> <!-- END Step 5 table -->
 
<br>
 
<br>
<table bgcolor=#ff0000> <!-- BEGIN Step 5 warning table -->
+
<table width=1000> <!-- BEGIN Step 5 Warning table -->
 
<tr valign="top">
 
<tr valign="top">
 +
<td width=50>&#160;</td>
 
<td>
 
<td>
<table bgcolor=#fcbcbc>
+
<table bgcolor=#ff0000> <!-- BEGIN Step 5 warning table -->
 
<tr valign="top">
 
<tr valign="top">
 +
<td>
 +
<table bgcolor=#fcbcbc>
 +
<tr valign="top"> <!-- warning -->
 
<td colspan=2><span style="font-size: 17px;"><b>Warning:</b></span></td>
 
<td colspan=2><span style="font-size: 17px;"><b>Warning:</b></span></td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file: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 188: Line 317:
 
</td>
 
</td>
 
</tr>
 
</tr>
</table> <!-- END Step 5 warning table -->
+
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
<tr>
+
</table> <!-- END Step 5 warning table -->
<td colspan="2">
+
<br>
----</td>
+
<table width=1000> <!-- BEGIN Step 6 table -->
</tr>
+
 
<tr valign="top">
 
<tr valign="top">
<td>&nbsp;</td>
+
<td width=50>&#160;</td>
<td>[[file: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> <!-- BEGIN Step 6 table -->
+
<table>  
 
<tr valign="top">
 
<tr valign="top">
 
<td colspan=2>
 
<td colspan=2>
You will need to add:-
+
<table bgcolor=#000000 cellpadding=2>
*a thumbnail image as described in the section [[file:PageLink.PNG|link=]] '''[[#The Thumbnail Image|The Thumbnail Image]]'''
+
<tr valign="top">
*the icon image as described in the section [[file:PageLink.PNG|link=]] '''[[#The Icon Image|The Icon Image]]'''
+
<td>
*a texture text file as described in the section [[file:PageLink.PNG|link=]] '''[[#The Texture File|The Texture File]]'''
+
<table bgcolor=#ffffff cellpadding=2>
<br>
+
<tr valign="top">
These files do not have to be added immediately but must be present before the new asset can be used. You can reopen the asset for editing later to add the files before it is committed.</td>
+
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;12&#160;</span></td>
 +
<td>You will need to add:-
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>a thumbnail image as described in the section [[image:PageLink.PNG|link=]] '''[[#The Thumbnail Image|The Thumbnail Image]]'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the icon image as described in the section [[image:PageLink.PNG|link=]] '''[[#The Icon Image|The Icon Image]]'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>texture text file as described in the section [[image:PageLink.PNG|link=]] '''[[#The Texture File|The Texture File]]'''</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2><span style="font-size: 17px;">'''THIS IS AN EXAMPLE ONLY'''</span><br></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>[[file:DriverIconFiles.png|link=]]</td>
+
<td>[[image:DriverIconFiles.png|link=]]</td>
<td><span style="font-size: 17px;">'''THIS IS AN EXAMPLE ONLY'''</span><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>
 
</tr>
 
</tr>
Line 216: Line 369:
 
</td>
 
</td>
 
</tr>
 
</tr>
<tr>
+
</table>
<td colspan="2">
+
<br>
----</td>
+
<table width=1000> <!-- BEGIN Step 7 table -->
</tr>
+
 
<tr valign="top">
 
<tr valign="top">
<td>&nbsp;</td>
+
<td width=50>&#160;</td>
<td>[[file: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> <!-- BEGIN Step 7 table -->
+
<table>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:NewAssetSubmit.PNG|link=]]</td>
 
<td>[[image:NewAssetSubmit.PNG|link=]]</td>
 
<td>
 
<td>
*Close the Asset window
+
<table bgcolor=#000000 cellpadding=2>
*Commit the asset in '''Content Manager'''
+
**Right mouse click on the asset
+
**Select '''Submit Edits'''
+
Hopefully there will be no errors.<br><br>
+
<table width=604 bgcolor=#000000> <!-- BEGIN Step 7 Notes table -->
+
 
<tr valign="top">
 
<tr valign="top">
 
<td>
 
<td>
<table width=600 bgcolor=#ffffb0> <!-- BEGIN Step 7 Notes table -->
+
<table bgcolor=#ffffff cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
+
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;13&#160;</span></td>
 +
<td>Close the Asset window</td>
 +
</tr>
 +
<tr valign="top">
 +
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;14&#160;</span></td>
 +
<td>Commit the asset in '''Content Manager'''
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Right Click</span> on the asset</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>Select <span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;Submit Edits&#160;</span>
 +
Hopefully there will be no errors.</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table bgcolor=#000000> <!-- BEGIN Step 7 Notes table -->
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffb0> <!-- BEGIN Step 7 Notes table -->
 +
<tr valign="top">
 +
<td width=25>[[image:NotePad.PNG|link=]]</td>
 
<td>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'''.
 
<td>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'''.
 
</td>
 
</td>
Line 246: Line 422:
 
</table> <!-- END Step 7 Notes table -->
 
</table> <!-- END Step 7 Notes table -->
 
<br>
 
<br>
<table cellpadding=4 bgcolor=#ff0000> <!-- BEGIN Step 7 errors table -->
+
<table cellpadding=2 bgcolor=#ff0000> <!-- BEGIN Step 7 errors table -->
 
<tr valign="top">
 
<tr valign="top">
 
<td>
 
<td>
 
<table cellpading="4" bgcolor=#ffffff> <!-- BEGIN Step 7 errors-bugs table -->
 
<table cellpading="4" bgcolor=#ffffff> <!-- BEGIN Step 7 errors-bugs table -->
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Bug.png|link=]]</td>
+
<td>[[image:Bug.png|link=]]</td>
<td>Some of the most common errors that can occur when creating and committing a new asset are:-
+
<td>Some of the most common errors that can occur when creating and '''Submitting''' a new asset are:-
*no '''''thumbnail image''''' in the asset
+
<table>
*typing errors in the config.txt file
+
<tr valign="top">
*poorly formatted tags in the config.txt file
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
*incorrect file types added to the asset folder
+
<td>no '''''thumbnail image''''' in the asset</td>
*files missing from the asset folder
+
</tr>
*incorrect '''kuid''' value (despite the warning you changed it in '''Step 5''')</td>
+
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>typing errors in the config.txt file</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>poorly formatted tags in the config.txt file</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>incorrect file types added to the asset folder</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>files missing from the asset folder</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>an incorrect '''kuid''' value (despite the warning you changed it in '''Step''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: red;">&#160;5&#160;</span>)</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table> <!-- END Step 7 errors-bugs table -->
 
</table> <!-- END Step 7 errors-bugs table -->
Line 270: Line 467:
 
</tr>
 
</tr>
 
</table> <!-- END Steps table -->
 
</table> <!-- END Steps table -->
----
 
 
<br>
 
<br>
<table> <!-- 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 284: Line 480:
 
='''The Config.txt File'''=
 
='''The Config.txt File'''=
  
This file should follow the same (or a similar) format as the example below.<br>
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
*entries in&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;red&nbsp;</span>&nbsp;must not be changed
+
<tr valign="top">
*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
+
<td width=10>[[image:BlueDot10x10.png|link=]]</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>'''All assets must have a config.txt file'''</td>
*the order of the "tags" is not important
+
</tr>
 +
</table> <!-- END Dot point table -->
 +
<br>
 +
<table width=1000 bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<td>
 +
<table width=996 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td align="center"><span style="color: blue; font-weight: 700; font-size: 17px;">&#160;Update:&#160;</span></td>
 +
</tr>
 +
<tr valign="top">
 +
<td>The latest Trainz release ('''Trainz Plus''' and '''TRS22PE SP4''' from July 2024) seems to have made a change in that a mesh is now required for a driver character. Fortunately a suitable built-in mesh is available.<br></td>
 +
</tr>
 +
<tr align="top">
 +
<td>
 +
<table bgcolor=#ffffb0 cellpadding=2>
 +
<tr valign="top">
 +
<td width=25>[[image:NotePad.PNG|link=]]</td>
 +
<td>This change only applies to Driver Characters created using the latest, '''July 2024''' and later, updates to '''Trainz Plus''' and '''TRS22PE''' (the '''SP4''' release) - those with build number 5.5 and above. Characters created for earlier builds of '''Trainz''' are unaffected and these versions will still work in the latest Trainz releases without the need for the mesh.</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr valign="top">
 +
<td><br>
 +
The following instructions have been updated to include this new requirement.</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding=2 bgcolor=#eeeeee> <!-- BEGIN Settings table -->
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Settings:'''</span>
 +
<table>
 +
<tr valign="top">
 +
<td>The Driver Character asset must have a '''config.txt''' text file that '''must''' include the following tags:-
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''kind''' set to "drivercharacter"</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''username''' set to the asset title or name</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''kuid''' a unique ID code</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''mesh''' set to a valid drivercharacter mesh asset (e.g. &lt;kuid:-25:1011&gt; DriverAlastair)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''trainz-build''' set to 4.1 or above (5.5 works in '''TRS22PE SP4''')</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''thumbnails''' set to a 240 by 180 pixel JPG image</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>While not mandatory, the following tag is useful:-
 +
<table>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''category-class''' set to "OHD"'''</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table> <!-- END Settings table -->
 +
<br>
  
  '''kuid'''                                    <span style="background-color: red; color: white; font-weight: 700;"><kuid: this is an auto-generated number ></span>
+
<table width=1000>
 +
<tr valign="top">
 +
<td colspan=2>This file should follow the same (or a similar) format as the example below.</td>
 +
</tr>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPoint.JPG|10px|link=]]</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 valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>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</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</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 valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the order of the "tags" is not important</td>
 +
</tr>
 +
</table>
 +
 
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>
 +
  '''kuid'''                                    <span style="background-color: red; color: white; font-weight: 700;">&lt;kuid: this is an auto-generated number &gt;</span>
 
  '''kind'''                                    "<span style="background-color: red; color: white; font-weight: 700;">drivercharacter</span>"
 
  '''kind'''                                    "<span style="background-color: red; color: white; font-weight: 700;">drivercharacter</span>"
 
  '''face-texture                            "DriverLillian'''<span style="background-color: red; color: white; font-weight: 700;">.texture</span>"
 
  '''face-texture                            "DriverLillian'''<span style="background-color: red; color: white; font-weight: 700;">.texture</span>"
Line 296: Line 606:
 
  '''category-class                          "'''<span style="background-color: red; color: white; font-weight: 700;">OHD</span>'''"'''
 
  '''category-class                          "'''<span style="background-color: red; color: white; font-weight: 700;">OHD</span>'''"'''
 
  '''trainz-build                            4.3'''
 
  '''trainz-build                            4.3'''
 +
'''mesh                                    <kuid:-25:1011>'''
 
   
 
   
 
  '''thumbnails'''
 
  '''thumbnails'''
Line 312: Line 623:
 
   }
 
   }
 
  }
 
  }
  '''description             "Icon for train driver Lillian"'''
+
  '''description                             "Icon for train driver Lillian"'''
 +
</td>
 +
</tr>
 +
</table>
  
<table cellpadding=4 bgcolor=#eeeeee>
+
<table width=1000 cellpadding=2 bgcolor=#eeeeee>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
Line 320: Line 634:
 
</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:'''<br>
+
'''For the above example:'''
*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
+
<table>
*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. A list of asset kinds can be found at [[file:WikiLink.PNG|link=]] '''[[KIND_TrainzBaseSpec#KIND_Hierarchy|KIND Hierarchy]]'''
+
<tr valign="top">
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> 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 '''texture''' tag so it would appear as "'''driverlillian.texture'''"
+
<td width=10>[[image:BlackDot10x10.png|link=]]</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>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>
*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 "'''OHD'''". A list of category classes can be found at [[file:WikiLink.PNG|link=]] '''[[Category-class]]'''
+
</tr>
*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]]'''
+
<tr valign="top">
*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>[[image:BlackDot10x10.png|link=]]</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&#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>
***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
+
</tr>
***The '''width''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;240&#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;180&#160;</span>
+
<td>[[image:BlackDot10x10.png|link=]]</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&#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>
***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>[[image:BlackDot10x10.png|link=]]</td>
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> description </span>&nbsp;provides more details for users than the '''username'''
+
<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 valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</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 valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</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 valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>The&#160;<span style="background-color: black; color: white; font-weight: 700;"> mesh </span>&#160;a new requirement in the latest '''Trainz''' versions. A suitable mesh, &lt;kuid:-25:1011&gt; '''DriverAlistair''', is supplied built-in to '''Trainz'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<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>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackCircle10x10.png|link=]]</td>
 +
<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>
 +
</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;240&#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;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>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>The <span style="background-color: black; color: white; font-weight: 700;">&#160;description&#160;</span> provides more details for users than the '''username'''</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 347: Line 724:
 
</table>
 
</table>
  
<table 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 356: Line 733:
 
<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 378: Line 755:
 
</table>
 
</table>
 
<br>
 
<br>
<table> <!-- 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 390: Line 767:
 
='''The Thumbnail Image'''=
 
='''The Thumbnail Image'''=
  
<table cellpadding=4 bgcolor=#c1e7e7>
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 
<td>'''A thumbnail image MUST be present in the asset'''</td>
 
<td>'''A thumbnail image MUST be present in the asset'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
<table bgcolor=#000000 width=804>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
 
<td>
 
<td>
<table bgcolor=#ffffb0 width=800>
+
<table bgcolor=#000000 width=720>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffb0 width=716>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[image:NotePad.PNG|link=]]</td>
 
<td>[[image:NotePad.PNG|link=]]</td>
Line 406: Line 786:
 
----
 
----
 
The thumbnail image:-
 
The thumbnail image:-
*must be in '''JPG''' format.
+
<table>
*must be '''240''' pixels wide by '''180''' pixels tall.
+
<tr valign="top">
*'''does not''' have to be named ''thumbnail.jpg'' as long as the name used is in the '''Thumbnails''' container in the '''config.txt''' file.
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>must be in '''JPG''' format</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>must be '''240''' pixels wide by '''180''' pixels tall</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''does not''' have to be named ''thumbnail.jpg'' as long as the name used is in the '''Thumbnails''' container in the '''config.txt''' file</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 415: Line 806:
 
</tr>
 
</tr>
 
</table>
 
</table>
 
+
</td>
 +
<td with=240>[[image:DriverThumbLillian.png|link=|alt=Thumbnail]]</td>
 +
</tr>
 +
</table>
 +
<br>
 
='''The Icon Image'''=
 
='''The Icon Image'''=
  
<table cellpadding=4 bgcolor=#c1e7e7>
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 
<td>You will need image editing software to create the icon image or to change an existing image to the required dimensions and format</td>
 
<td>You will need image editing software to create the icon image or to change an existing image to the required dimensions and format</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|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>
 
<br>
 
<br>
<table>
+
<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>
<table cellpadding=4 bgcolor=#eeeeee>
+
<table cellpadding=2 bgcolor=#eeeeee>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
Line 440: Line 835:
 
</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:-
*64 pixels wide and 64 pixels tall
+
<table>
*bit depth ''should'' be 24 (no '''alpha channel''' or transparency) or 32 (if an '''alpha channel''' is used)
+
<tr valign="top">
*image file format can be any of:-
+
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
**bmp
+
<td>64 pixels wide and 64 pixels tall</td>
**jpg (jpg '''does not''' support transparency)
+
</tr>
**png
+
<tr valign="top">
**tga (tga compression '''should not''' be used)</td>
+
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>bit depth ''should'' be 24 (no '''alpha channel''' or transparency) or 32 (if an '''alpha channel''' is used)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>image file format can be any of:-
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackCircle10x10.png|link=]]</td>
 +
<td>'''bmp'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackCircle10x10.png|link=]]</td>
 +
<td>'''jpg''' (jpg '''does not''' support transparency)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackCircle10x10.png|link=]]</td>
 +
<td>'''png'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackCircle10x10.png|link=]]</td>
 +
<td>'''tga''' (tga compression '''should not''' be used)</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
Line 459: Line 881:
 
</table>
 
</table>
 
<br>
 
<br>
<table bgcolor=#000000>
+
<table width=1000 bgcolor=#000000>
 
<tr valign="top">
 
<tr valign="top">
 
<td>
 
<td>
 
<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
*convert the background to a transparency or
+
<table>
*remove the background and add a transparent layer to the image as its background
+
<tr valign="top">
than it is to use a format that does not support an '''alpha channel''' and have to create a second image for the '''alpha channel'''. See [[file:PageLink.PNG|link=]] '''[[#The Texture File|The Texture File]]''' below.
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
</td>
+
<td>convert the background to a transparency <span style="font-weight: 700; font-size: 15px;">OR</span></td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>remove the background and add a transparent layer to the image as its background</td>
 +
</tr>
 +
</table>
 +
... 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 476: Line 905:
 
</table>
 
</table>
 
<br>
 
<br>
<table> <!-- 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 -->
 
='''The Texture File'''=
 
='''The Texture File'''=
  
<table cellpadding=4 bgcolor=#c1e7e7>
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 
<td>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.</td>
 
<td>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.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
<table cellpadding=4 bgcolor=#eeeeee>
+
<table cellpadding=2 bgcolor=#eeeeee>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
Line 500: Line 929:
 
</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>
*the '''Texture File''' is a standard '''text''' file
+
<table>
*the filename is composed of:-
+
<tr valign="top">
**a user selected '''asset_name''' followed by a period ('''.''')
+
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
**the word '''texture''' followed by a period ('''.''')
+
<td>the '''Texture File''' is a standard '''text''' file</td>
**the letters '''txt'''</td>
+
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>the filename is composed of:-
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackCircle10x10.png|link=]]</td>
 +
<td>a user selected '''asset_name''' followed by a period ('''.''')</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackCircle10x10.png|link=]]</td>
 +
<td>the word '''texture''' followed by a period ('''.''')</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackCircle10x10.png|link=]]</td>
 +
<td>the letters '''txt'''</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
Line 515: Line 965:
 
<br>
 
<br>
 
A sample '''Texture File''', "driverlillian.texture.txt", is shown below:-
 
A sample '''Texture File''', "driverlillian.texture.txt", is shown below:-
<table cellpadding=5>
+
<table width=1000 cellpadding=5>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 523: Line 973:
 
</td>
 
</td>
 
<td>
 
<td>
<table cellpadding=4 bgcolor=#eeeeee>
+
<table cellpadding=2 bgcolor=#eeeeee>
 
<tr valign="top">
 
<tr valign="top">
 
<td colspan="2">
 
<td colspan="2">
Line 529: Line 979:
 
</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>
*'''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
+
<table>
*'''alpha''' - this is the name of the icon image file that contains the '''Alpha Channel''' (transparency) image (see '''Notes:''' below)
+
<tr valign="top">
*'''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
+
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''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</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''alpha''' - this is the name of the icon image file that contains the '''Alpha Channel''' (transparency) image (see '''Notes:''' below)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>'''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</td>
 +
</tr>
 +
</table>
 
No "white spaces" between the text characters is allowed.</td>
 
No "white spaces" between the text characters is allowed.</td>
 
</tr>
 
</tr>
Line 540: Line 1,001:
 
----</td>
 
----</td>
 
</tr>
 
</tr>
</table></td>
+
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
<table cellpadding=4 bgcolor=#ffffb0>
+
 
 +
<table width=1000 cellpadding=2 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>
 
----
 
----
There are 3 general "scenarios" for the structure of the '''Texture File''' in a '''Driver Character''' asset.<br>
+
There are 3 general "scenarios" for the structure of the '''Texture File''' in a '''Texture Non Environmental''' asset.<br>
 
<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 563: Line 1,024:
 
  tile=st
 
  tile=st
 
</td>
 
</td>
<td><br>
+
<td>
*the '''primary''' and '''alpha''' images are the same file, as in the example shown left
+
<table>
*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 valign="top">
 +
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the '''primary''' and '''alpha''' images are the same file, as in the example shown left</td>
 +
</tr>
 +
<tr valign="top">
 +
<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>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 571: Line 1,044:
 
<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 584: Line 1,055:
 
</td>
 
</td>
 
<td>
 
<td>
*two different files (different file names or different image file formats) must be used as in the example shown left
+
<table>
*both images must be the same size (64 pixels x 64 pixels)
+
<tr valign="top">
*both images must have a '''depth''' of '''24 bits''' - so no '''alpha channel''' must be present in either image
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
*the '''alpha''' image file ''should'' be a greyscale image or even just black and white</td>
+
<td>two different files (different file names or different image file formats) must be used as in the example shown left</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>both images must be the same size (64 pixels x 64 pixels)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>both images must have a '''depth''' of '''24 bits''' - so no '''alpha channel''' must be present in either image</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the '''alpha''' image file should be a greyscale image or just black and white</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 593: Line 1,082:
 
<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 604: Line 1,091:
 
  tile=st
 
  tile=st
 
</td>
 
</td>
<td><br>
+
<td>
*the '''alpha=''' line in the '''.texture.txt file''' is not needed, as in the example shown left
+
<table>
*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</td>
+
<tr valign="top">
 +
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the '''alpha=''' line in the '''.texture.txt file''' is not needed, as in the example shown left</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>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</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Image file formats supported by '''Trainz''' that have an '''alpha channel''' are:-<br>
+
</td>
*bmp
+
</tr>
*png
+
</table>
*tga
+
</td>
Image file formats supported by '''Trainz''' that DO NOT have an '''alpha channel''' are:-<br>
+
</tr>
*jpg</td>
+
</table>
 +
 
 +
Image file formats supported by '''Trainz''' that have an '''alpha channel''' are:-
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''bmp'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''png'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''tga''' (do not use compression)</td>
 +
</tr>
 +
</table>
 +
Image file formats supported by '''Trainz''' that '''DO NOT''' have an '''alpha channel''' are:-
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''jpg'''</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
<table cellpadding=4 bgcolor="Aquamarine">
+
<table cellpadding=2 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>
* '''[[Texture_file|Texture File]]'''</td>
+
[[image:BlueDot10x10.png|link=]] '''[[Texture_file|Texture File]]'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
<table> <!-- 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 640: Line 1,157:
 
Once the new asset has been committed it will be available for use in a '''Driver Setup Rule'''.
 
Once the new asset has been committed it will be available for use in a '''Driver Setup Rule'''.
  
<table>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DriverIconSelect.png|link=]]</td>
+
<td width=500>[[image:DriverIconSelect.png|500px|link=]]</td>
 
<td>
 
<td>
<table cellpadding=4 bgcolor=#ffffff>
+
<table bgcolor=#000000 cellpadding=2>
<tr>
+
<tr valign="top">
<td colspan="2">
+
<td>
----</td>
+
<table bgcolor=#ffffff cellpadding=2>
 +
<tr valign="top">
 +
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps:</span> To use the Driver Character:-</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</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>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
+
Open the '''Session Editor''' (see [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''') and open it for editing.
+
#Select the '''Driver Setup Rule''' and click the '''Edit''' button
+
#Select a driver icon to change to your new wicon, or add a new driver
+
#Click on the icon for the selected (or new) driver
+
#Scroll down the list to find your newly created driver character
+
#Select the driver name and click the [[file:Tick.PNG|link=]] icon
+
#Click the [[file:Tick.PNG|link=]] on the '''Driver Setup Rule''' window to accept the selection</td>
+
 
</tr>
 
</tr>
<tr>
+
<tr valign="top">
<td colspan="2">
+
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
----</td>
+
<td>Select the '''Driver Setup Rule''' and <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> the '''Edit''' button</td>
 
</tr>
 
</tr>
</table></td>
+
<tr valign="top">
 +
<td>[[image:DotPoint2.JPG|link=]]</td>
 +
<td>Select a driver icon to change to your new icon, or add a new driver</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint3.JPG|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the icon for the selected (or new) driver</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint4.JPG|link=]]</td>
 +
<td>Scroll down the list to find your newly created driver character</td>
 +
</tr>
 +
<tr valign="top">
 +
<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 [[image:Tick.PNG|link=]] icon</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint6.JPG|link=]]</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>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 671: Line 1,206:
 
[[image:DriverIconLillian.png|link=]]
 
[[image:DriverIconLillian.png|link=]]
  
<table> <!-- 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 683: Line 1,218:
 
----
 
----
 
='''Trainz Wiki'''=
 
='''Trainz Wiki'''=
<table cellpadding=4 bgcolor=#ffffff>
+
<table cellpadding=2 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>
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
+
*'''<span class="plain;s">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
 
*'''[[Driver Commands List]]'''
 
*'''[[Driver Commands List]]'''
 
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
 
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
Line 696: Line 1,231:
 
</table>
 
</table>
 
----
 
----
This page was created by Trainz user '''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in November 2022 and was last updated as shown below.
+
This page was created by Trainz user '''<span class="plain;s">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in November 2022 and was last updated as shown below.
 
----
 
----
 
[[Category:How-to guides]]
 
[[Category:How-to guides]]

Latest revision as of 15:19, 2 September 2024

          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  In Windows File Explorer 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


 Update: 
The latest Trainz release (Trainz Plus and TRS22PE SP4 from July 2024) seems to have made a change in that a mesh is now required for a driver character. Fortunately a suitable built-in mesh is available.
NotePad.PNG This change only applies to Driver Characters created using the latest, July 2024 and later, updates to Trainz Plus and TRS22PE (the SP4 release) - those with build number 5.5 and above. Characters created for earlier builds of Trainz are unaffected and these versions will still work in the latest Trainz releases without the need for the mesh.

The following instructions have been updated to include this new requirement.



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 mesh set to a valid drivercharacter mesh asset (e.g. <kuid:-25:1011> DriverAlastair)
BlackDot10x10.png trainz-build set to 4.1 or above (5.5 works in TRS22PE SP4)
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
mesh                                    <kuid:-25:1011>

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  mesh  a new requirement in the latest Trainz versions. A suitable mesh, <kuid:-25:1011> DriverAlistair, is supplied built-in to Trainz
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 Texture Non Environmental 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