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

<table cellpadding="4" bgcolor=#c1e7e7>

<td>[[file:DotPoint.JPG|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>[[file:DotPoint.JPG|link=]]</td>

<td>'''Message Popup Icons''' are classified as '''Non-Environmental Textures'''<td>

</table><br>

<table cellpadding="4" bgcolor="Aquamarine">

<td>

Information on creating and using '''Message Popups''' can be found on the '''Trainz Wiki pages''' at:-<br>

* '''[[How to Use Message Popup Rule|Using the Message Popup Rule]]'''

* '''[[How to Use Message Popup Rule (Applications)|Using the Message Popup Rule (Applications)]]'''

* '''[[How to Create a HTML Asset|How to Create a HTML Asset]]'''

* '''[[Session Rule List with Parameters#Message Popup Rule|Message Popup Rule (description)]]'''

 

<table width="100%">

<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>

</table>

 

<table cellpadding="4" bgcolor=#ffffff> <!-- BEGIN Step table -->

</tr>

<td>[[file:Steps.PNG|link=]]<br><br>

<span style="font-size: 17px; font-weight: 700;">Steps</span></td>

<td>[[file:DotPoint1.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Create the Asset:</span><br>

<td>[[file:NewAsset.PNG|link=]]<br><br>

[[file:NewAssetCreated.PNG|link=]]</td>

<td>From the '''Trainz''' Launcher

#select '''Manage Content'''

#in '''Content Manager''' open the '''Developer''' menu

#select '''New Content'''

This will create a new asset and open it for editing.

<br><br>

A message window will appear that will (hopefully) report on the successful creation of a new asset.

</table> <!-- END Step 1 table -->

<tr>

----</td>

<td>&nbsp;</td>

<td>[[file:DotPoint2.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Find the New Asset:</span><br>

<table> <!-- BEGIN Step 2 table -->

<td>[[file:NewAssetSelectOpen.PNG|link=]]</td>

*Set the CM 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)

</table> <!-- END Step 2 table -->

<tr>

----</td>

<td>&nbsp;</td>

<td>[[file:DotPoint3.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Open the Asset in Windows File Explorer:</span><br>

<table> <!-- BEGIN Step 3 table -->

<td>[[file:NewAssetShowExplorer.PNG|link=]]</td>

#Right mouse click on the entry '''New Asset'''

#Select '''Open'''

#Select '''Show in Explorer'''

<tr>

<td colspan="2">

----</td>

</tr>

<td>&nbsp;</td>

<td>[[file:DotPoint4.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Open Config.txt File in Notepad:</span><br>

<td>[[file:NewAssetOpenExplorer.PNG|link=]]</td>

<td>There will only be a single item in the asset, its config.txt file

*Double click on the file to open it in Notepad</td>

</table> <!-- END Step 4 table -->

<tr>

----</td>

<td>&nbsp;</td>

<td>[[file:DotPoint5.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Edit the Config.txt File:</span><br>

<td>[[file:NewAssetOpenNotepad.PNG|link=]]</td>

<td>You will need to edit the contents of this file.  

*The next section, [[file: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 committed.

*After editing, save the changes and exit Notepad.</td>

<table cellpadding="4" bgcolor=#fcbcbc> <!-- BEGIN Step 5 warning table -->

<td>[[file:Stop.PNG|link=]]</td>

'''*''' but even if you do, think <span style="font-weight: 700; text-decoration: underline">twice</span> before you change it !</td>

</table> <!-- END Step 5 warning table -->

<tr>

----</td>

<td>&nbsp;</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 -->

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>

<td><span style="font-size: 17px;">'''THIS IS AN EXAMPLE ONLY'''</span><br><br>

This is the '''minimum''' number of files needed in a '''Texture asset'''</td>

<tr>

<td colspan="2">

----</td>

<td>&nbsp;</td>

<td>[[file:DotPoint7.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Finish Up:</span>

<table> <!-- BEGIN Step 7 table -->

<table cellpadding="4" bgcolor=#ffffb0> <!-- BEGIN Step 7 Notes table -->

<td>[[file:NotePad.PNG|link=]]</td>

<td><span style="font-size: 17px;">'''Notes:'''</span><br>

Because you still have the Filter '''Open for Editing''' in operation, the now closed and committed asset will vanish from the window display. To check that your asset has been correctly created and renamed, set the CM Search Filter to "Today".</td>

</table> <!-- END Step 7 Notes table -->

<table cellpadding="4" bgcolor=#ff0000> <!-- BEGIN Step 7 errors table -->

<td>[[file:Bug.png|link=]]</td>

<td>Some of the most common errors that can occur when creating and committing a new asset are:-

*no '''''thumbnail image''''' in the asset

*typing errors in the config.txt file

*poorly formatted tags in the config.txt file

*incorrect file types added to the asset folder

*files missing from the asset folder

*incorrect '''kuid''' value (despite the warning you changed it in '''Step 5''')</td>

 

<table width="100%"> <!-- BEGIN Back-to-top table -->

<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>

</table> <!-- END Back-to-top table -->

='''The Config.txt File'''=

 

This file should follow the same (or a similar) format as the example below.<br>

*entries in&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;red&nbsp;</span>&nbsp;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'''                                    <span style="background-color: red; color: white; font-weight: 700;"><kuid: this is an auto-generated number </span>

  '''kind''''                                    "<span style="background-color: red; color: white; font-weight: 700;">texture</span>"

<table cellpadding="4" bgcolor=#eeeeee>

'''For the above example:'''<br>

*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

*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]]'''

*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'''"

*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.

*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]]'''

*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]]'''

*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]]'''

**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 '''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;">240</span>

***The '''height''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">180</span>

**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

***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;">64</span>

***The '''height''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">64</span>

*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> description </span>&nbsp;provides more details for users than the '''username'''

<table cellpadding="4" bgcolor=#ffffb0>

<td><span style="font-weight: 700; font-size: 17px;">Language Options:</span></td>

 

<table width="100%">

<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>

</table>

<table cellpadding="4" bgcolor=#c1e7e7>

<td>[[file:DotPoint.JPG|link=]]</td>

<table cellpadding="4" bgcolor=#ffffb0>

<td>[[file:NotePad.PNG|link=]]</td>

*must be in '''JPG''' format.

*must be 240 pixels wide by 180 pixels tall.

*'''does not''' have to be named ''thumbnail.jpg'' as long as the name used is in the '''Thumbnails''' container in the '''config.txt''' file.

 

<table cellpadding="4" bgcolor=#c1e7e7>

<td>[[file:DotPoint.JPG|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>

<table>

<table cellpadding="4" bgcolor=#eeeeee>

*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)</td>

<table cellpadding="4" bgcolor=#ffffb0>

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 align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>

 

<table cellpadding="4" bgcolor=#c1e7e7>

<td>[[file:DotPoint.JPG|link=]]</td>

<table cellpadding="4" bgcolor=#eeeeee>

<td><span style="font-size: 17px;">'''Settings:'''</span><br>

*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'''</td>

<table cellpadding=5>

<table cellpadding="4" bgcolor=#eeeeee>

<td><span style="font-size: 17px;">'''Settings:'''</span><br>

*'''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 icon in a message popup window but must be included for validation purposes

</table></td>

<table cellpadding="4" bgcolor=#ffffb0>

<td>[[file:NotePad.PNG|link=]]</td>

<td>[[file:DotPoint1Blue.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>

</table>

  primary=ashpit.tga

  alpha=ashpit.tga

<td><br>

*the '''primary''' and '''alpha''' images are the same file, as in the example shown left

*the image must contain '''<span style="text-decoration: underline;">both</span>''' the '''RGB''' colour data and the '''Alpha Channel''' (transparency) data (it must have a '''depth''' of '''32 bits''')</td>

<td>[[file:DotPoint2Blue.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>

</table>

  primary=ashpit.jpg

  alpha=ashpit_alpha.jpg

*two different files (different file names or different image file formats) must be used as in the example shown left

*both images must be the same size (64 pixels x 64 pixels)

*both images must have a '''depth''' of '''24 bits''' - so no '''alpha channel''' must be present in either image

*the '''alpha''' image file ''should'' be a greyscale image or even just black and white</td>

<td>[[file:DotPoint3Blue.png|link=]]</td>

<td>If the icon image does not have a transparency and no '''alpha channel''' is needed</td>

</table>

  primary=ashpit.tga

<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 that data it will be ignored so the icon will be shown without any transparency</td>

Image file formats supported by '''Trainz''' that have an '''alpha channel''' are:-<br>

*bmp

*png

*tga

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

*jpg</td>

<table cellpadding="4" bgcolor="Aquamarine">

* '''[[Texture_file|Texture File]]'''</td>

<table width="100%">

<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>

 

 

 

<table>

<table cellpadding="4" bgcolor=#ffffff>

<tr>

<td colspan="2">

----</td>

<td>[[file:Steps.PNG|link=]]</td>

<td><span style="font-size: 17px;">'''Steps:'''</span><br>

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.

#Click the [[file:Tick.PNG|link=]] icon to accept the selection</td>

<tr>

<td colspan="2">

----</td>

</table></td>

<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>