How to Create a Message Popup Icon: Difference between revisions

From TrainzOnline
Jump to navigationJump to search
Pware (talk | contribs)
Pware (talk | contribs)
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
The information in this Wiki Page applies to '''TANE''', '''TRS19''' and '''Trainz Plus'''.
<table width=1000 bgcolor=#000000 cellpadding=2>
<tr valign="top">
<td>
<table width=996 bgcolor=#ffffff cellpadding=2>
<tr valign="middle">
<td width=35>[[image:Information.png|35px|link=]]</td>
<td><span style="font-size: 15px;">The information in this Wiki Page describes how to create a graphic '''Icon''' asset to be used in the '''Message Popup Rule''' for '''TANE''', '''TRS19''', '''TRS22''' and '''Trainz Plus'''.</span></td>
</tr>
</table>
</td>
</tr>
</table>
<br>
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
<tr valign="top">
<td width=629>&#160;</td>
<td width=50>&#160;</td> <!-- Skip Down -->
<td width=50>&#160;</td> <!-- Skip Up -->
<td width=46>&#160;</td>
<td width=75>&#160;</td>
<td width=75>[[image:NextDown.png|link=#stepMessage|alt=Next Down|Next Down]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</table> <!-- END Nav Buttons Table -->


<table>
<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:PopupIconWorkflow.png|link=|alt=Workflow diagram]]</td>
</tr>
</table>
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
<tr valign="top">
<td width=629><span id="stepMessage"></span>
='''Message Popup Icons'''=
='''Message Popup Icons'''=
</td>
<td width=50>&#160;</td> <!-- Skip Down -->
<td width=50>&#160;</td> <!-- Skip Up -->
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75></td>
<td width=75>[[image:NextDown.png|link=#stepCreate|alt=Next Down|Next Down]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</table> <!-- END Nav Buttons Table -->


<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>'''Message Popup Icons''' are small graphic icons that can be placed in browser message windows in Driver mode. The browser windows are created by the '''Message Popup Rule'''<td>
<td>'''Message Popup Icons''' are small graphic icons that can be placed in browser message windows in Driver mode. The browser windows are created by the '''Message Popup Rule'''</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
<td>[[image:BlueDot10x10.png|link=]]</td>
<td>'''Message Popup Icons''' are classified as '''Non-Environmental Textures'''<td>
<td>'''Message Popup Icons''' are classified as '''Non-Environmental Textures'''</td>
</tr>
</tr>
</table><br>
</table>
<table cellpadding="4" bgcolor="Aquamarine">
<br>
<table cellpadding=4 bgcolor="Aquamarine">
<tr valign="top">
<tr valign="top">
<td>[[file:LinkWiki.PNG|link=]]</td>
<td>[[file:LinkWiki.PNG|link=]]</td>
<td>
<td>Information on creating and using '''Message Popups''' can be found on the '''Trainz Wiki pages''' at:-
Information on creating and using '''Message Popups''' can be found on the '''Trainz Wiki pages''' at:-<br>
<table>
* '''[[How to Use Message Popup Rule|Using the Message Popup Rule]]'''
<tr valign="top">
* '''[[How to Use Message Popup Rule (Applications)|Using the Message Popup Rule (Applications)]]'''
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
* '''[[How to Create a HTML Asset|How to Create a HTML Asset]]'''
<td>'''[[How to Use Message Popup Rule|Using the Message Popup Rule]]'''</td>
* '''[[Session Rule List with Parameters#Message Popup Rule|Message Popup Rule (description)]]'''
</tr>
<tr valign="top">
<td>[[image:BlueDot10x10.png|link=]]</td>
<td>'''[[How to Use Message Popup Rule (Applications)|Using the Message Popup Rule (Applications)]]'''</td>
</tr>
<tr valign="top">
<td>[[image:BlueDot10x10.png|link=]]</td>
<td>'''[[How to Create a HTML Asset|How to Create a HTML Asset]]'''</td>
</tr>
<tr valign="top">
<td>[[image:BlueDot10x10.png|link=]]</td>
<td>'''[[Session Rule List with Parameters#Message Popup Rule|Message Popup Rule (description)]]'''</td>
</tr>
</table>
</td>
</td>
</tr>
</tr>
</table>
</table>
 
<br>
<table> <!-- BEGIN Nav Buttons Table -->
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepCreate"></span>&nbsp;</td>
<td width=629><span id="stepCreate"></span>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
='''Create a Non-Environmental Texture Asset'''=
<td width=75>&nbsp;</td>
</td>
<td width=75>[[file:NextDown.png|link=#stepConfig|alt=Next Down|Next Down]]</td>
<td width=50>&#160;</td> <!-- Skip Down -->
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
<td width=50>&#160;</td> <!-- Skip Up -->
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[image:NextUp.png|link=#stepMessage|alt=Next Up|Next Up]]</td>
<td width=75>[[image:NextDown.png|link=#stepConfig|alt=Next Down|Next Down]]</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 -->
='''How to Create a New Non-Environmental Texture 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=]]&nbsp;<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: From the Trainz Launcher:-</span></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;">&nbsp;Manage Content&nbsp;</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>
</tr>
<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>
</table> <!-- END Step 1 table -->
</table>
</td>
</td>
</tr>
</tr>
<tr>
</table>
<td colspan="2">
</td>
----</td>
</tr>
</tr>
</table> <!-- END Step 1 table -->
<br>
<table width=1000> <!-- BEGIN Step 2 table -->
<tr valign="top">
<td width=50>&#160;</td>
<td>[[image:DotPoint2.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Find the New Asset:</span><br>
<table>
<tr valign="top">
<tr valign="top">
<td>&nbsp;</td>
<td>[[image:NewAssetSelectOpen.PNG|link=]]</td>
<td>[[file:DotPoint2.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Find the New Asset:</span><br>
<td>
<table> <!-- BEGIN Step 2 table -->
<table bgcolor=#000000 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[file:NewAssetSelectOpen.PNG|link=]]</td>
<td>
<td>
*Set the CM Search Filter to '''Open for Editing'''
<table bgcolor=#ffffff 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><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">
<td width=50>&#160;</td>
<td>[[image:DotPoint3.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Open the Asset in Windows File Explorer:</span><br>
<table>
<tr valign="top">
<tr valign="top">
<td>&nbsp;</td>
<td>[[image:NewAssetShowExplorer.PNG|link=]]</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>
<table> <!-- BEGIN Step 3 table -->
<table bgcolor=#000000 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[file:NewAssetShowExplorer.PNG|link=]]</td>
<td>
<td>
#Right mouse click on the entry '''New Asset'''
<table bgcolor=#ffffff cellpadding=2>
#Select '''Open'''
<tr valign="top">
#Select '''Show in Explorer'''
<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 98: Line 216:
</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=]]&nbsp;<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 valign="top">
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;9&#160;</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>
</tr>
</tr>
</table> <!-- END Step 4 table -->
</table>
</td>
</td>
</tr>
</tr>
<tr>
</table>
<td colspan="2">
</td>
----</td>
</tr>
</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=]]&nbsp;<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">
<td width=50>&#160;</td>
<td>
<table bgcolor=#ff0000> <!-- BEGIN Step 5 warning table -->
<tr valign="top">
<tr valign="top">
<td>
<td>
<table bgcolor=#fcbcbc>
<table bgcolor=#fcbcbc>
<tr valign="top">
<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'''*''',&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>
'''*''' 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>
</tr>
</table>
</td>
</td>
</tr>
</tr>
Line 148: Line 306:
</tr>
</tr>
</table> <!-- END Step 5 warning table -->
</table> <!-- END Step 5 warning table -->
<br>
<table width=1000> <!-- BEGIN Step 6 table -->
<tr valign="top">
<td width=50>&#160;</td>
<td>[[image:DotPoint6.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Add Any Extras:</span><br>
<table>
<tr valign="top">
<td colspan=2>
<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;">&#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 [[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>
</td>
</tr>
</tr>
<tr>
</table>
<td colspan="2">
</td>
----</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>&nbsp;</td>
<td colspan=2><span style="font-size: 17px;">'''THIS IS AN EXAMPLE ONLY'''</span><br></td>
<td>[[file:DotPoint6.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Add Any Extras:</span><br>
<table> <!-- BEGIN Step 6 table -->
<tr valign="top">
<td colspan=2>
You will need to add:-
*a thumbnail image as described in the section [[file:PageLink.PNG|link=]] '''[[#The Thumbnail Image|The Thumbnail Image]]'''
*the icon image as described in the section [[file:PageLink.PNG|link=]] '''[[#The Icon Image|The Icon Image]]'''
*a texture text file as described in the section [[file:PageLink.PNG|link=]] '''[[#The Texture File|The Texture File]]'''
<br>
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>
</tr>
</tr>
<tr>
<tr>
<td>[[file:TexturePopupFiles.PNG|link=]]</td>
<td>[[file:TexturePopupFiles.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 in a '''Texture asset'''</td>
This is the '''minimum''' number of files needed for a '''Driver Character'''</td>
</tr>
</tr>
</table> <!-- END Step 6 table -->
</table> <!-- END Step 6 table -->
</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=]]&nbsp;<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">
<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">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<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 205: Line 407:
</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=4 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 229: Line 452:
</tr>
</tr>
</table> <!-- END Steps table -->
</table> <!-- END Steps table -->
----
<br>
<table> <!-- BEGIN Nav Buttons Table -->
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepConfig"></span>&nbsp;</td>
<td width=629><span id="stepConfig"></span>
 
='''The Config.txt File'''=
</td>
<td width=50>&#160;</td> <!-- Skip Down -->
<td width=50>&#160;</td> <!-- Skip Up -->
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepCreate|alt=Next Up|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepCreate|alt=Next Up|Top]]</td>
Line 240: Line 468:
</table> <!-- END Nav Buttons Table -->
</table> <!-- END Nav Buttons Table -->


='''The Config.txt File'''=
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<tr valign="top">
This file should follow the same (or a similar) format as the example below.<br>
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
*entries in&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;red&nbsp;</span>&nbsp;must not be changed
<td>'''All assets must have a config.txt file'''</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
</tr>
*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
</table> <!-- END Dot point table -->
*the order of the "tags" is not important
<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>The Texture 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 '''"texture"'''</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>'''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 '''"JI"'''</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&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;red&nbsp;</span>&nbsp;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>


  '''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;">&lt;kuid: this is an auto-generated number &gt;</span>
  '''kind'''                                    "<span style="background-color: red; color: white; font-weight: 700;">texture</span>"
  '''kind'''                                    "<span style="background-color: red; color: white; font-weight: 700;">texture</span>"
  '''texture                                "icon_gradeXing'''<span style="background-color: red; color: white; font-weight: 700;">.texture</span>"
  '''texture                                "icon_gradeXing'''<span style="background-color: red; color: white; font-weight: 700;">.texture</span>"
Line 272: Line 571:
  '''description            "Icon representing an approaching grade crossing. Designed for message popups."'''
  '''description            "Icon representing an approaching grade crossing. Designed for message popups."'''


<table cellpadding="4" bgcolor=#eeeeee>
<table width=1000 cellpadding=4 bgcolor=#eeeeee>
<tr>
<tr>
<td colspan="2">
<td colspan="2">
Line 280: Line 579:
<td>[[file:Gears.PNG|link=]]</td>
<td>[[file: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. "'''icon_gradeXing'''". The actual texture file itself will be named '''<span style="color: black;">asset_name</span>.texture.txt''' (e.g. "'''icon_gradeXing.texture.txt'''") but the filename ending "'''.txt'''" is not added to the name in the '''texture''' tag so it would appear as "'''icon_gradeXing.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 a good idea to make it short and meaningful.
<td>The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> kuid </span>&nbsp;is unique to every asset so it is&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;not a good idea to choose your own&nbsp;</span>. This will be automatically generated by the '''Content Manager''' program when a new asset is created</td>
*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 '''texture icon''' assets, the category class is "'''JI'''". 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&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> kind </span>&nbsp;identifies the ''type'' of asset and the types of files that '''Trainz''' will expect to find in the asset. It also tells '''Trainz''' how to render and error check the asset. For '''Texture''' assets, the category class is <span style="font-weight: 700; color: white; background-color: red;">&#160;texture&#160;</span>. A list of asset kinds can be found at [[file: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;">240</span>
<tr valign="top">
***The '''height''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">180</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 '''Message Popup Rule''' for this asset. Its ''exact label'' does not matter but it must be different from the first thumbnail image placeholder label
<td>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. "'''icon_gradeXing.texture'''". The actual texture file itself will be named '''<span style="color: black;">asset_name</span>.texture.txt''' (e.g. "'''icon_gradeXing.texture.txt'''") but the filename ending "'''.txt'''" is not added to the name in the '''texture''' tag so it would appear as "'''icon_gradeXing.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;">64</span>
<tr valign="top">
***The '''height''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">64</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&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>
</tr>
<tr valign="top">
<td>[[image:BlackDot10x10.png|link=]]</td>
<td>The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> category-class </span>&nbsp;identifies the ''intent'' of the asset and is important in classifying it for filtering and searching. For '''driver character''' assets, the category class is <span style="font-weight: 700; color: white; background-color: red;">&#160;JI&#160;</span>. A list of category classes can be found at [[file:WikiLink.PNG|link=]] '''[[Category-class]]'''</td>
</tr>
<tr valign="top">
<td>[[image:BlackDot10x10.png|link=]]</td>
<td>The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> trainz-build </span>&nbsp;identifies the ''minimum'' Trainz version needed for this asset. A list of asset trainz-build numbers and their corresponding Trainz versions can be found at [[file:WikiLink.PNG|link=]] '''[["Trainz-build"_number]]'''</td>
</tr>
<tr valign="top">
<td>[[image:BlackDot10x10.png|link=]]</td>
<td>The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> thumbnails </span>&nbsp;container holds the ''preview'' images of the asset shown by the '''Content Manager''' program, the Web version of the ''DLS'' and, for '''some assets''', the Surveyor main menu image(s) and, in this case, the asset texture itself. Information on thumbnails can be found at [[file:WikiLink.PNG|link=]] '''[[Thumbnails]]'''
<table>
<tr valign="top">
<td width=10>[[image:BlackCircle10x10.png|link=]]</td>
<td>The first thumbnail&nbsp;<span style="background-color: black; color: white; font-weight: 700;">&nbsp;Default&nbsp;</span>&nbsp;is the '''container ID''' or '''placeholder''' for the thumbnail used by CM and the Web based DLS. While its ''exact label'' (or number - eg. "Default", "00", "01", etc) is not important, it must be different from any other labels. '''Default''' and '''0''' are commonly used placeholder labels for the 240 x 180 thumbnail image
*The '''image''' is the name of the thumbnail image. It does not have to be called '''thumbnail.jpg''' but it '''must''' be a JPG format image
*The '''width''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;240&#160;</span>
*The '''height''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;180&#160;</span></td>
</tr>
<tr valign="top">
<td>[[image:BlackCircle10x10.png|link=]]</td>
<td>The second thumbnail&nbsp;<span style="background-color: black; color: white; font-weight: 700;">'''&nbsp;01&nbsp;'''</span>&nbsp;is the placeholder label for the 64 x 64 icon image used by the '''Driver Character''' for this asset. Its ''exact label'' does not matter but it must be different from the first thumbnail image placeholder label
*The '''image''' is the assets '''<span style="color: black;">asset_name</span>.texture.txt''' file (but without the ".txt" at the end)
*The '''width''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;64&#160;</span>
*The '''height''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">&#160;64&#160;</span></td>
</tr>
</table>
</td>
</tr>
<tr 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 305: Line 639:
</table>
</table>


<table cellpadding="4" bgcolor=#ffffb0>
<table width=1000 bgcolor=#ffffe0>
<tr valign="top">
<tr valign="top">
<td>[[file:PencilTips.PNG|link=]]</td>
<td>[[file:PencilTips.PNG|link=]]</td>
Line 322: Line 656:
  username                    "icon grade crossing ahead"
  username                    "icon grade crossing ahead"
  username-c2                "图标前方的路口"
  username-c2                "图标前方的路口"
username-de                "Symbol Bahnübergang voraus"
  username-es                "icono de cruce de grados por delante"
  username-es                "icono de cruce de grados por delante"
  username-fr                "icône passage à niveau avant"
  username-fr                "icône passage à niveau avant"
username-gr                "Symbol Bahnübergang voraus"
  username-nl                "pictogram cijferovergang vooruit"
  username-nl                "pictogram cijferovergang vooruit"
  username-ru                "значок пересекает"
  username-ru                "значок пересекает"
Line 335: Line 669:
</tr>
</tr>
</table>
</table>
<br>
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
<tr valign="top">
<td width=629><span id="stepThumbIcon"></span>


<table> <!-- BEGIN Nav Buttons Table -->
='''The Thumbnail Image'''=
<tr valign="top">
</td>
<td width=729><span id="stepThumbIcon"></span>&nbsp;</td>
<td width=50>&#160;</td> <!-- Skip Down -->
<td width=50>&#160;</td> <!-- Skip Up -->
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepConfig|alt=Next Up|Top]]</td>
<td width=75>[[file: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>[[file:NextDown.png|link=#stepIcon|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</tr>
</table> <!-- END Nav Buttons Table -->
</table> <!-- END Nav Buttons Table -->
 
<br>
='''The Thumbnail Image'''=
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<table cellpadding="4" bgcolor=#c1e7e7>
<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.''' You can create a HTML asset without any other images but there must be a thumbnail image.</td>
<td>'''A thumbnail image MUST be present in the asset'''</td>
</tr>
</tr>
</table>
</table>
<br>
<br>
<table bgcolor="black" width=804>
<table width=1000>
<tr valign="top">
<td>
<table bgcolor=#000000 width=720>
<tr valign="top">
<tr valign="top">
<td>
<td>
<table bgcolor=#ffffb0 width=800>
<table bgcolor=#ffffb0 width=716>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td>[[image:NotePad.PNG|link=]]</td>
Line 364: Line 704:
----
----
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 373: Line 724:
</tr>
</tr>
</table>
</table>
 
</td>
<td with=240>[[image:IconDecoupleThumbnail.png|link=|alt=Thumbnail]]</td>
</tr>
</table>
<br>
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
<tr valign="top">
<td width=629><span id="stepIcon"></span>
='''The Icon Image'''=
='''The Icon Image'''=
</td>
<td width=50>&#160;</td> <!-- Skip Down -->
<td width=50>&#160;</td> <!-- Skip Up -->
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[image:NextUp.png|link=#stepThumbIcon|alt=Next Up|Next Up]]</td>
<td width=75>[[image:NextDown.png|link=#stepTexture|alt=Next Down|Next Down]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</table> <!-- END Nav Buttons Table -->


<table cellpadding="4" bgcolor=#c1e7e7>
<table width=1000 bgcolor="lightcyan" cellpadding=2>
<tr valign="top">
<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>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
<td>[[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>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>
</tr>
</tr>
</table>
</table>
<br>
<br>
<table>
<table width=1000>
<tr valign="top">
<tr valign="top">
<td>[[file:Texture64Pixels.PNG|link=]]<br>
<td>[[file:Texture64Pixels.PNG|link=]]<br>
(not to scale)</td>
(not to scale)</td>
<td>
<td>
<table cellpadding="4" bgcolor=#eeeeee>
<table cellpadding=4 bgcolor=#eeeeee>
<tr>
<tr>
<td colspan="2">
<td colspan="2">
Line 397: Line 768:
<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 413: Line 811:
</table>
</table>
<br>
<br>
<table cellpadding="4" bgcolor=#ffffb0>
<table width=1000 bgcolor=#000000>
<tr valign="top">
<td>
<table bgcolor=#ffffe0>
<tr valign="top">
<tr valign="top">
<td>[[file:PencilTips.PNG|link=]]</td>
<td>[[file: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>
<td width=10>[[image:DotPoint.JPG|10px|link=]]</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 [[file:PageLink.PNG|link=]] '''[[#The Texture File|The Texture File]]''' below for more details.</td>
</tr>
</table>
</td>
</tr>
</tr>
</table>
</table>
 
<br>
<table> <!-- BEGIN Nav Buttons Table -->
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepTexture"></span>&nbsp;</td>
<td width=629><span id="stepTexture"></span>
='''The Texture File'''=
</td>
<td width=50>&#160;</td> <!-- Skip Down -->
<td width=50>&#160;</td> <!-- Skip Up -->
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepThumbIcon|alt=Next Up|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepIcon|alt=Next Up|Top]]</td>
<td width=75>[[file:NextDown.png|link=#stepUsing|alt=Next Down|Next Down]]</td>
<td width=75>[[file: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>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</tr>
</table> <!-- END Nav Buttons Table -->
</table> <!-- END Nav Buttons Table -->
='''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=4 bgcolor=#eeeeee>
<tr>
<tr>
<td colspan="2">
<td colspan="2">
Line 448: Line 863:
<tr valign="top">
<tr valign="top">
<td>[[file:Gears.PNG|link=]]</td>
<td>[[file: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 462: Line 898:
<br>
<br>
A sample '''Texture File''', "ashpit.texture.txt", is shown below:-
A sample '''Texture File''', "ashpit.texture.txt", is shown below:-
<table cellpadding=5>
<table width=1000 cellpadding=5>
<tr>
<tr>
<td>
<td>
Line 470: Line 906:
</td>
</td>
<td>
<td>
<table cellpadding="4" bgcolor=#eeeeee>
<table cellpadding=4 bgcolor=#eeeeee>
<tr valign="top">
<tr valign="top">
<td colspan="2">
<td colspan="2">
Line 477: Line 913:
<tr valign="top">
<tr valign="top">
<td>[[file:Gears.PNG|link=]]</td>
<td>[[file: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 icon in a message popup window 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 487: Line 934:
----</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>
----
----
Line 498: Line 947:
<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>
Then:-
<table>
<tr valign="top">
<td>
primary=Lillian64.png
alpha=Lillian64.png
tile=st
</td>
<td>
<table>
<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>
</tr>
</table>
</table>
</td>
</tr>
</table>
<table>
<tr valign="top">
<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<br>
Then:-
Then:-
<table>
<table>
<tr valign="top">
<tr valign="top">
<td>
<td>
  primary=ashpit.tga
  primary=Lillian64.jpg
  alpha=ashpit.tga
  alpha=Lillian64_alpha.jpg
  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>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 518: Line 1,015:
<table>
<table>
<tr valign="top">
<tr valign="top">
<td>[[file:DotPoint2Blue.png|link=]]</td>
<td>[[image:Cblue.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 image does not have a transparency and no '''alpha channel''' is needed<br>
</tr>
</table>
Then:-
Then:-
<table>
<table>
<tr valign="top">
<tr valign="top">
<td>
<td>
  primary=ashpit.jpg
  primary=Lillian64.jpg
alpha=ashpit_alpha.jpg
  tile=st
  tile=st
</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>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>
</table>
</td>
</tr>
</table>
</td>
</tr>
</tr>
</table>
</table>


Image file formats supported by '''Trainz''' that have an '''alpha channel''' are:-
<table>
<table>
<tr valign="top">
<tr valign="top">
<td>[[file:DotPoint3Blue.png|link=]]</td>
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>If the icon image does not have a transparency and no '''alpha channel''' is needed</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>
</tr>
</table>
</table>
Then:-
Image file formats supported by '''Trainz''' that '''DO NOT''' have an '''alpha channel''' are:-
<table>
<table>
<tr valign="top">
<tr valign="top">
<td>
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
primary=ashpit.tga
<td>'''jpg'''</td>
tile=st
</td>
<td><br>
*the '''alpha=''' line in the '''.texture.txt file''' is not needed, as in the example shown left
*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
*png
*tga
Image file formats supported by '''Trainz''' that DO NOT have an '''alpha channel''' are:-<br>
*jpg</td>
</tr>
</tr>
</table>
</table>
<br>
<br>
<table cellpadding="4" bgcolor="Aquamarine">
<table cellpadding=4 bgcolor="Aquamarine">
<tr valign="top">
<tr valign="top">
<td>[[file:LinkWiki.PNG|link=]]</td>
<td>[[file: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>
<table> <!-- BEGIN Nav Buttons Table -->
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepUsing"></span>&nbsp;</td>
<td width=629><span id="stepUsing"></span>
='''Using the Asset'''=
</td>
<td width=50>&#160;</td> <!-- Skip Down -->
<td width=50>&#160;</td> <!-- Skip Up -->
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepTexture|alt=Next Up|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepTexture|alt=Next Up|Top]]</td>
Line 583: Line 1,090:
</table> <!-- END Nav Buttons Table -->
</table> <!-- END Nav Buttons Table -->


='''Using the Asset'''=
<table width=1000>
 
<tr valign="top">
Once the new asset has been committed it will be available for use in a '''Message Popup Rule'''. It will appear as a '''Texture Asset''' in the rule icon list.
<td>Once the new asset has been committed it will be available for use in a '''Message Popup Rule'''. It will appear as a '''Texture Asset''' in the rule icon list.</td>
 
</tr>
<table>
</table>
<br>
<table width=1000>
<tr valign="top">
<tr valign="top">
<td>[[file:TextureAssetList.PNG|link=]]</td>
<td>[[file:TextureAssetList.PNG|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: To Use the Texture Asset:-</span></td>
</tr>
<tr valign="top">
<td colspan=2>In the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' add a [[file:WikiLink.PNG|link=]] '''[[How to Use Message Popup Rule|Message Popup Rule]]''' and open it for editing.</td>
</tr>
<tr valign="top">
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
<td>Select [[file:PortalOptionButtonFilled.PNG|link=]] '''Custom Text'''</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint2.JPG|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> the link '''<span style="text-decoration: underline;">Click here to set</span>'''</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint3.JPG|link=]]</td>
<td>Scroll through the list of Texture Icons</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint4.JPG|link=]]</td>
<td>Select the required icon</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td>[[image:DotPoint5.JPG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> the [[file:Tick.PNG|link=]] icon to accept the selection</td>
In the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' add a [[file:WikiLink.PNG|link=]] '''[[How to Use Message Popup Rule|Message Popup Rule]]''' and open it for editing.
#Select [[file:PortalOptionButtonFilled.PNG|link=]] '''Custom Text'''
#Click the icon link '''<span style="text-decoration: underline;">Click here to set</span>'''
#Scroll through the list of Texture Icons
#Select the required icon
#Click the [[file:Tick.PNG|link=]] icon to accept the selection</td>
</tr>
</tr>
<tr>
</table>
<td colspan="2">
</td>
----</td>
</tr>
</tr>
</table></td>
</table>
</td>
</tr>
</tr>
</table>
</table>
 
<br>
<table> <!-- BEGIN Nav Buttons Table -->
<table> <!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<tr valign="top">
Line 625: Line 1,149:
----
----
----
----
='''Trainz Wiki'''=
='''Trainz Wiki'''=
<table cellpadding="4" bgcolor=#ffffff>
<table width=1000>
<tr valign="top">
<td>
<table width=500 cellpadding=2 bgcolor=#ffffff>
<tr valign="top">
<tr valign="top">
<td>[[file:TrainzWiki.png|link=]]</td>
<td width=80>[[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>
Line 635: Line 1,163:
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
</td>
</tr>
</table>
</td>
<td>
<table width=500 cellpadding=4 bgcolor="aquamarine">
<tr valign="top">
<td width=50>[[image:LinkWiki.PNG|link=]]</td>
<td>
<span style="font-size: 17px;">'''Related Links'''</span><br>
* '''[[How to Use Message Popup Rule|How to Use the Message Popup Rule]]'''
</td>
</tr>
</table>
</td>
</td>
</tr>
</tr>

Latest revision as of 11:16, 30 August 2026

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The information in this Wiki Page describes how to create a graphic Icon asset to be used in the Message Popup Rule for TANE, TRS19, TRS22 and Trainz Plus.


          Next Down Bottom
 Workflow Diagram 
Workflow diagram

Message Popup Icons

    Top Next Down Bottom
Message Popup Icons are small graphic icons that can be placed in browser message windows in Driver mode. The browser windows are created by the Message Popup Rule
Message Popup Icons are classified as Non-Environmental Textures


Information on creating and using Message Popups can be found on the Trainz Wiki pages at:-
Using the Message Popup Rule
Using the Message Popup Rule (Applications)
How to Create a HTML Asset
Message Popup Rule (description)


Create a Non-Environmental Texture Asset

    Top Next Up Next Down Bottom
Steps:  Create the Asset:


Steps: From the Trainz Launcher:-
 1  select  Manage Content 
 2  in Content Manager open the  Developer  menu
 3  select  New Content 
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 This will create a new asset and open it for editing.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 A message window will appear that will (hopefully) report on the successful creation of a new asset
 4  Close the message window


   Find the New Asset:
 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)


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


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


   Edit the Config.txt File:
You will need to edit the contents of this file.
 10  The next section, 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:
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 !


   Add Any Extras:
 12  You will need to add:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 a thumbnail image as described in the section The Thumbnail Image
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 the icon image as described in the section The Icon Image
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 texture text file as described in the section The Texture File
THIS IS AN EXAMPLE ONLY


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


   Finish Up:
 13  Close the Asset window
 14  Commit the asset in Content Manager
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Right Click on the asset
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Select  Submit Edits  Hopefully there will be no errors.


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.


Some of the most common errors that can occur when creating and Submitting a new asset are:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 no thumbnail image in the asset
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 typing errors in the config.txt file
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 poorly formatted tags in the config.txt file
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 incorrect file types added to the asset folder
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 files missing from the asset folder
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 an incorrect kuid value (despite the warning you changed it in Step  5 )


The Config.txt File

    Top Next Up Next Down Bottom
All assets must have a config.txt file



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


This file should follow the same (or a similar) format as the example below.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 entries in  red  must not be changed
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 the order of the "tags" is not important
kuid                                    <kuid: this is an auto-generated number >
kind                                    "texture"
texture                                 "icon_gradeXing.texture"
username                                "icon grade crossing ahead"
category-class                          "JI"
trainz-build                            4.3

thumbnails
{
  Default
  {
    width                               240
    height                              180
    image                               "icon_gradeXing.jpg"
  }
  01
  {
    width                               64
    height                              64
    image                               "icon_gradeXing.texture"
  }
}
description             "Icon representing an approaching grade crossing. Designed for message popups."

Settings:

For the above example:

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
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 Texture assets, the category class is  texture . A list of asset kinds can be found at KIND Hierarchy
The  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. "icon_gradeXing.texture". The actual texture file itself will be named asset_name.texture.txt (e.g. "icon_gradeXing.texture.txt") but the filename ending ".txt" is not added to the name in the texture tag so it would appear as "icon_gradeXing.texture"
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
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  JI . A list of category classes can be found at Category-class
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 "Trainz-build"_number
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 Thumbnails
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
  • The image is the name of the thumbnail image. It does not have to be called thumbnail.jpg but it must be a JPG format image
  • The width of the image in pixels must be  240 
  • The height of the image in pixels must be  180 
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
  • The image is the assets asset_name.texture.txt file (but without the ".txt" at the end)
  • The width of the image in pixels must be  64 
  • The height of the image in pixels must be  64 
The  description  provides more details for users than the username

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                    "icon grade crossing ahead"
username-c2                 "图标前方的路口"
username-de                 "Symbol Bahnübergang voraus"
username-es                 "icono de cruce de grados por delante"
username-fr                 "icône passage à niveau avant"
username-nl                 "pictogram cijferovergang vooruit"
username-ru                 "значок пересекает"
Translations to Chinese (simplified), Spanish, French, German, Dutch and Russian, perfect or not, were provided by Google Translate.


The Thumbnail Image

    Top Next Up Next Down Bottom


A thumbnail image MUST be present in the asset


Notes:

The thumbnail image:-

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 must be in JPG format
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 must be 240 pixels wide by 180 pixels tall
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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


The Icon Image

    Top Next Up Next Down Bottom
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)

Settings:

The image must meet the following specifications:-

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


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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 convert the background to a transparency OR
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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 The Texture File below for more details.


The Texture File

    Top Next Up Next Down Bottom
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:
the Texture File is a standard text file
the filename is composed of:-
a user selected asset_name followed by a period (.)
the word texture followed by a period (.)
the letters txt


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

primary=ashpit.jpg
alpha=ashpit.bmp
tile=st

Settings:
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
alpha - this is the name of the icon image file that contains the Alpha Channel (transparency) image (see Notes: below)
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.

Notes:

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

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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 the primary and alpha images are the same file, as in the example shown left
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 the image must contain both the RGB colour data and the Alpha Channel (transparency) data (it must have a depth of 32 bits)
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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 two different files (different file names or different image file formats) must be used as in the example shown left
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 both images must be the same size (64 pixels x 64 pixels)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 both images must have a depth of 24 bits - so no alpha channel must be present in either image
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 the alpha image file should be a greyscale image or just black and white
If the icon image does not have a transparency and no alpha channel is needed

Then:-

primary=Lillian64.jpg
tile=st
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 the alpha= line in the .texture.txt file is not needed, as in the example shown left
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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:-

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 bmp
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 png
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 tga (do not use compression)

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

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 jpg


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


Using the Asset

    Top Next Up   Bottom
Once the new asset has been committed it will be available for use in a Message Popup Rule. It will appear as a Texture Asset in the rule icon list.


Steps: To Use the Texture Asset:-
In the Session Editor add a Message Popup Rule and open it for editing.
Select Custom Text
Left Click the link Click here to set
Scroll through the list of Texture Icons
Select the required icon
Left Click the icon to accept the selection


  Top Next Up    


Trainz Wiki

More Tutorials and Guides to Using Trainz

Related Links


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