How to Create a Driver Character
m |
m |
||
Line 38: | Line 38: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | |||
− | |||
+ | <table> | ||
+ | <tr valign="top"> | ||
+ | <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> | <table> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 50: | Line 54: | ||
[[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> |
+ | |||
+ | 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> | </tr> | ||
</table> | </table> | ||
− | + | <br> | |
− | + | ||
− | + | ||
<table> | <table> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 69: | Line 73: | ||
<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:- | ||
− | + | <table> | |
− | + | <tr valign="top"> | |
− | + | <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> | ||
Line 87: | Line 102: | ||
='''Create Driver Character Asset'''= | ='''Create Driver Character Asset'''= | ||
− | <table | + | <table width=1000> <!-- BEGIN Step table --> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td | + | <td width=50><span style="font-weight: 700; font-size: 15px;">Steps:</span></td> |
− | <span style="font- | + | <td>[[image:DotPoint1.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Create the Asset:</span><br> |
− | <td>[[ | + | |
<table> <!-- BEGIN Step 1 table --> | <table> <!-- BEGIN Step 1 table --> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[ | + | <td>[[image:NewAsset.PNG|link=]]<br><br> |
− | [[ | + | [[image:NewAssetCreated.PNG|link=]]</td> |
− | <td>From the '''Trainz''' | + | <td> |
− | #select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Manage Content </span> | + | <table bgcolor=#000000 cellpadding=2> |
− | #in '''Content Manager''' open the | + | <tr valign="top"> |
− | #select | + | <td> |
− | This will create a new asset and open it for editing. | + | <table bgcolor=#ffffff cellpadding=2> |
− | < | + | <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> |
− | + | </tr> | |
+ | <tr valign="top"> | ||
+ | <td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;"> 1 </span></td> | ||
+ | <td>select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Manage Content </span></td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;"> 2 </span></td> | ||
+ | <td>in '''Content Manager''' open the <span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;"> Developer </span> menu</td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;"> 3 </span></td> | ||
+ | <td>select <span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;"> New Content </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> | ||
− | < | + | <tr valign="top"> |
+ | <td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;"> 4 </span></td> | ||
+ | <td>Close the message window</td> | ||
+ | </tr> | ||
+ | </table> | ||
</td> | </td> | ||
</tr> | </tr> | ||
− | < | + | </table> |
− | + | </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>& | + | <td width=50> </td> |
− | <td>[[ | + | <td>[[image:DotPoint2.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Find the New Asset:</span><br> |
− | <table | + | <table> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[ | + | <td>[[image:NewAssetSelectOpen.PNG|link=]]</td> |
<td> | <td> | ||
− | + | <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;"> 5 </span></td> | ||
+ | <td>Set the '''Content Manager''' Search Filter to <span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;"> Open for Editing </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 | + | </table> |
</td> | </td> | ||
</tr> | </tr> | ||
− | < | + | </table> |
− | + | </td> | |
− | + | ||
</tr> | </tr> | ||
+ | </table> <!-- END Step 2 table --> | ||
+ | <br> | ||
+ | <table width=1000> <!-- BEGIN Step 3 table --> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>& | + | <td width=50> </td> |
− | <td>[[ | + | <td>[[image:DotPoint3.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Open the Asset in Windows File Explorer:</span><br> |
− | <table | + | <table> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[ | + | <td>[[image:NewAssetShowExplorer.PNG|link=]]</td> |
<td> | <td> | ||
− | #<span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Right Click</span> on the entry '''New Asset''' | + | <table bgcolor=#000000 cellpadding=2> |
− | #Select | + | <tr valign="top"> |
− | #Select | + | <td> |
+ | <table bgcolor=#ffffff cellpadding=2> | ||
+ | <tr valign="top"> | ||
+ | <td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;"> 6 </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;"> 7 </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;"> 8 </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 146: | Line 219: | ||
</td> | </td> | ||
</tr> | </tr> | ||
− | < | + | </table> |
− | < | + | <br> |
− | ---- | + | <table width=1000> <!-- BEGIN Step 4 table --> |
− | + | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>& | + | <td width=50> </td> |
− | <td>[[ | + | <td>[[image:DotPoint4.JPG|link=]] <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>[[ | + | <td>[[image:NewAssetOpenExplorer.PNG|link=]]</td> |
− | <td>There will only be a single item in the asset, its config.txt file | + | <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> | ||
− | < | + | <tr valign="top"> |
+ | <td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;"> 9 </span></td> | ||
+ | <td><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> | ||
− | < | + | </table> |
− | + | </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>& | + | <td width=50> </td> |
− | <td>[[ | + | <td>[[image:DotPoint5.JPG|link=]] <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>[[ | + | <td>[[image:NewAssetOpenNotepad.PNG|link=]]</td> |
− | <td>You will need to edit the contents of this file. | + | <td> |
− | + | <table bgcolor=#000000 cellpadding=2> | |
− | + | <tr valign="top"> | |
− | + | <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;"> 10 </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;"> 11 </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 | + | <table width=1000> <!-- BEGIN Step 5 Warning table --> |
<tr valign="top"> | <tr valign="top"> | ||
+ | <td width=50> </td> | ||
<td> | <td> | ||
− | <table bgcolor=# | + | <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>[[ | + | <td>[[image:Stop.PNG|link=]]</td> |
<td>Unless you know '''exactly''' what you are doing'''*''', <span style="color: white; background-color: red; font-weight: 700; font-size: 17px;"> DO NOT ALTER THE KUID NUMBER </span> that has been added to the file<br> | <td>Unless you know '''exactly''' what you are doing'''*''', <span style="color: white; background-color: red; font-weight: 700; font-size: 17px;"> DO NOT ALTER THE KUID NUMBER </span> 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 ! | ||
Line 195: | Line 305: | ||
</td> | </td> | ||
</tr> | </tr> | ||
− | </table | + | </table> |
</td> | </td> | ||
</tr> | </tr> | ||
− | < | + | </table> <!-- END Step 5 warning table --> |
− | < | + | <br> |
− | ----< | + | <table width=1000> <!-- BEGIN Step 6 table --> |
− | < | + | |
<tr valign="top"> | <tr valign="top"> | ||
− | <td>& | + | <td width=50> </td> |
− | <td>[[ | + | <td>[[image:DotPoint6.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Add Any Extras:</span><br> |
− | <table | + | <table> |
<tr valign="top"> | <tr valign="top"> | ||
<td colspan=2> | <td colspan=2> | ||
− | You will need to add:- | + | <table bgcolor=#000000 cellpadding=2> |
− | + | <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;"> 12 </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 [[file: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 [[file: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 [[file: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>[[file:DriverIconFiles.png|link=]]</td> | ||
− | <td | + | <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 223: | Line 357: | ||
</td> | </td> | ||
</tr> | </tr> | ||
− | < | + | </table> |
− | < | + | <br> |
− | ---- | + | <table width=1000> <!-- BEGIN Step 7 table --> |
− | + | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>& | + | <td width=50> </td> |
− | <td>[[ | + | <td>[[image:DotPoint7.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Finish Up:</span> |
− | <table | + | <table> |
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:NewAssetSubmit.PNG|link=]]</td> | <td>[[image:NewAssetSubmit.PNG|link=]]</td> | ||
<td> | <td> | ||
− | + | <table bgcolor=#000000 cellpadding=2> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | <table | + | |
<tr valign="top"> | <tr valign="top"> | ||
<td> | <td> | ||
− | <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;"> 13 </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;"> 14 </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;"> Submit Edits </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 258: | Line 415: | ||
<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>[[ | + | <td>[[image:Bug.png|link=]]</td> |
− | <td>Some of the most common errors that can occur when creating and | + | <td>Some of the most common errors that can occur when creating and '''Submitting''' a new asset are:- |
− | + | <table> | |
− | + | <tr valign="top"> | |
− | + | <td width=10>[[image:DotPoint.JPG|10px|link=]]</td> | |
− | + | <td>no '''''thumbnail image''''' in the asset</td> | |
− | + | </tr> | |
− | + | <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 5''')</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </td> | ||
</tr> | </tr> | ||
</table> <!-- END Step 7 errors-bugs table --> | </table> <!-- END Step 7 errors-bugs table --> | ||
Line 277: | Line 455: | ||
</tr> | </tr> | ||
</table> <!-- END Steps table --> | </table> <!-- END Steps table --> | ||
− | |||
<br> | <br> | ||
<table> <!-- BEGIN Nav Buttons Table --> | <table> <!-- BEGIN Nav Buttons Table --> | ||
Line 291: | Line 468: | ||
='''The Config.txt File'''= | ='''The Config.txt File'''= | ||
− | This file should follow the same (or a similar) format as the example below.< | + | <table width=1000 bgcolor="lightcyan" cellpadding=2> |
− | + | <tr valign="top"> | |
− | + | <td width=10>[[image:BlueDot10x10.png|link=]]</td> | |
− | + | <td>'''All assets must have a config.txt file'''</td> | |
− | + | </tr> | |
+ | </table> <!-- END Dot point table --> | ||
+ | <br> | ||
+ | <table cellpadding=4 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 width=10>[[image:DotPoint.JPG|10px|link=]]</td> | ||
+ | <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:BlueDot10x10.png|link=]]</td> | ||
+ | <td>'''kind''' set to "drivercharacter"</td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:BlueDot10x10.png|link=]]</td> | ||
+ | <td>'''username''' set to the asset title or name</td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:BlueDot10x10.png|link=]]</td> | ||
+ | <td>'''kuid''' a unique ID code</td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:BlueDot10x10.png|link=]]</td> | ||
+ | <td>'''thumbnails''' set to a 240 by 180 pixel JPG image</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td width=10>[[image:DotPoint.JPG|10px|link=]]</td> | ||
+ | <td>While not mandatory, the following tag is useful:- | ||
+ | <table> | ||
+ | <tr valign="top"> | ||
+ | <td width=10>[[image:BlueDot10x10.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> | ||
+ | |||
+ | <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 <span style="background-color: red; color: white; font-weight: 700;"> red </span> 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 '''{}''' 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> | ||
'''kuid''' <span style="background-color: red; color: white; font-weight: 700;"><kuid: this is an auto-generated number ></span> | '''kuid''' <span style="background-color: red; color: white; font-weight: 700;"><kuid: this is an auto-generated number ></span> |
Revision as of 20:23, 24 August 2023
The information in this Wiki Page applies to TANE, TRS19, Trainz Plus and TRS22.
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 | |
Driver Character Icons are small graphic icons or images that can be selected to represent locomotive drivers in the Driver Setup Rule |
|
Workflow Diagram |
Create the Driver Image
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. |
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.
The clip art can be added as layers to the image which makes them easier to manipulate (resize and move). |
After cropping, reduce the image size to 64 pixels wide (and therefore 64 pixels high).
Save the final resized image with a suitable name and in a suitable file format:-
|
Create Driver Character Asset
Steps: | Create the Asset:
|
Find the New Asset:
|
Open the Asset in Windows File Explorer:
|
Open Config.txt File in Notepad:
|
Edit the Config.txt File:
|
|
Add Any Extras:
|
Finish Up:
|
The Config.txt File
All assets must have a config.txt file |
|
|||||||||||||||
Settings:
|
|||||||||||||||
|
This file should follow the same (or a similar) format as the example below. | |
entries in red must not be changed | |
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 | |
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 | |
the order of the "tags" is not important |
kuid <kuid: this is an auto-generated number > kind "drivercharacter" face-texture "DriverLillian.texture" username "Driver Lillian" category-class "OHD" trainz-build 4.3 thumbnails { Default { width 240 height 180 image "thumbnail.jpg" } 01 { width 64 height 64 image "driverlillian.texture" } } description "Icon for train driver Lillian"
|
|
Settings: For the above example:
|
|
|
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 Localize an Asset and a list of all the supported languages with their two character codes at 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. |
The Thumbnail Image
A thumbnail image MUST be present in the asset |
|
The Icon Image
You will need image editing software to create the icon image or to change an existing image to the required dimensions and format | |
See the Create the Driver Image section at the top of this page for an example |
(not to scale) |
|
|
The Texture File
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. |
|
|
Settings:
|
|
|
A sample Texture File, "driverlillian.texture.txt", is shown below:-
primary=Lillian64.png alpha=Lillian64.png tile=st |
|
Notes: There are 3 general "scenarios" for the structure of the Texture File in a Driver Character asset.
Then:-
Then:-
Then:-
Image file formats supported by Trainz that have an alpha channel are:-
Image file formats supported by Trainz that DO NOT have an alpha channel are:-
|
A detailed description of the .texture file format can be found on the Trainz Wiki Page at:- |
Using the Asset
Once the new asset has been committed it will be available for use in a Driver Setup Rule.
|
The finished product as a Driver.
Trainz Wiki
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.