How to Create a Message Popup Icon

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (→‎The Config.txt File)
m (→‎The Config.txt File)
Line 233: Line 233:
 
*The '''<kuid>''' is unique to every asset so it is not advisable to select your own. This will be automatically generated by the '''Content Manager''' program when a new asset is created
 
*The '''<kuid>''' is unique to every asset so it is not advisable to select 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 TANE will expect to find in the asset. It also tells TANE how to render and error check the asset. A list of asset kinds can be found at [[file:WikiLink.PNG]] '''[[KIND_TrainzBaseSpec#KIND_Hierarchy|KIND Hierarchy]]'''
 
*The '''kind''' identifies the ''type'' of asset and the types of files that TANE will expect to find in the asset. It also tells TANE how to render and error check the asset. A list of asset kinds can be found at [[file:WikiLink.PNG]] '''[[KIND_TrainzBaseSpec#KIND_Hierarchy|KIND Hierarchy]]'''
−
*The '''texture''' is the name of the assets '''texture''' file. This will be a simple text file and will have the name '''<font color=#0000ff>asset_name</font>.texture''' where '''<font color=#0000ff>asset_name</font> will be a name you have selected for this asset. The actual texture file itself will be named '''<font color=#0000ff>asset_name</font>.texture.txt''' but ending ".txt" is not added to the '''texture''' tag
+
*The '''texture''' is the name of the assets '''texture''' file. This will be a simple text file and will have the name '''<font color=#0000ff>asset_name</font>.texture''' where '''<font color=#0000ff>asset_name</font>''' will be a name you have selected for this asset - e.g. "ashpit.texture". The actual texture file itself will be named '''<font color=#0000ff>asset_name</font>.texture.txt''' but ending ".txt" is not added to the '''texture''' tag
 
*The '''username''' is your name for the asset and the name that other users will see. It is a good idea to make it compact and meaningful.
 
*The '''username''' is your name for the asset and the name that other users will see. It is a good idea to make it compact and meaningful.
 
*The '''category-class''' identifies the ''intent'' of the asset and is important in classifying it for filtering and searching. A list of category classes can be found at [[file:WikiLink.PNG]] '''[[Category-class]]'''
 
*The '''category-class''' identifies the ''intent'' of the asset and is important in classifying it for filtering and searching. A list of category classes can be found at [[file:WikiLink.PNG]] '''[[Category-class]]'''

Revision as of 09:52, 5 August 2018

Contents

Message Popup Icons

DotPoint.JPG The icons used in Custom Message Popups belong to the class of Textures - Not Environmental

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

How to Create a New Non-Environmental Texture Asset

Steps.PNG Step 1: Create the Asset
NewAsset.PNG

NewAssetCreated.PNG		 From the TANE Launcher
  1. select Manage Content
  2. in Content Manager open the Developer menu
  3. select New Content

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

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

  • Close the message window


Steps.PNG Step 2: Find the New Asset
NewAssetSelectOpen.PNG
  • 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)


Steps.PNG Step 3: Open the Asset in Windows Explorer
NewAssetShowExplorer.PNG
  1. Right mouse click on the entry New Asset
  2. Select Open
  3. Select Show in Explorer


Steps.PNG Step 4: Open File in Notepad
NewAssetOpenExplorer.PNG There will only be a single item in the asset, its config.txt file
  • Double click on the file to open it in Notepad


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

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


Steps.PNG Step 6: Add Any "Extras"

You will need to add three additional files (possibly more depending on how the icon is created) to the asset folder:-


TexturePopupFiles.PNG THIS IS AN EXAMPLE ONLY

This is the minimum number of files needed in a Texture asset
Steps.PNG Step 7: Finish Up
NewAssetSubmit.PNG
  • Close the Asset window
  • Commit the asset in Content manager
    • Right mouse click on the asset
    • Select Submit Edits

Hopefully there will be no errors.

NotePad.PNG Notes:
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".
Bug.png 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 or .texture.txt files
  • poorly formatted tags in the config.txt file
  • incorrect file types added to the asset folder
  • files missing from the asset folder


The Config.txt File

This file should follow the same (or a similar) format as the example below. Entries in blue will be different for each asset. The order of the "tags" is not important:- 

kuid                                    <kuid:this is an auto-generated number>
kind                                    "texture"
texture                                 "asset_name.texture"
username                                "place your selected asset name here"
category-class                          "JI"
trainz-build                            4.3

thumbnails
{
  0
  {
    width                               240
    height                              180
    image                               "name_of_thumbnail.jpg"
  }
  
  {
    width                               64
    height                              64
    image                               "asset_name.texture"
  }
}
description                             "Place your description of the icon here"
Gears.PNG Settings:

For the above example:

  • The <kuid> is unique to every asset so it is not advisable to select 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 TANE will expect to find in the asset. It also tells TANE how to render and error check the asset. A list of asset kinds can be found at WikiLink.PNG 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. "ashpit.texture". The actual texture file itself will be named asset_name.texture.txt but ending ".txt" is not added to the texture tag
  • The username is your name for the asset and the name that other users will see. It is a good idea to make it compact and meaningful.
  • The category-class identifies the intent of the asset and is important in classifying it for filtering and searching. A list of category classes can be found at WikiLink.PNG Category-class
  • The trainz-build identifies the minimum Trainz version for this asset. A list of asset trainz-build numbers and their corresponding Trainz versions can be found at WikiLink.PNG "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 the Message Popup Rule. Information on thumbnails can be found at WikiLink.PNG Thumbnails
    • The first thumbnail (size 240 x 180) is the thumbnail image used by CM and the Web DLS Page for this asset
      • The image is the name of the thumbnail image - it must be a JPG format image
      • The width of the image must be 240 pixels
      • The height of the image must be 180 pixels
    • The second thumbnail (size 64 x 64) is the thumbnail image used by the Message Popup Rule for this asset
      • The image is the assets asset_name.texture.txt file (but without the ".txt" at the end)
      • The width of the image must be 64 pixels
      • The height of the image must be 64 pixels
  • The description provides more details for users than the username


The Icon Image

DotPoint.JPG You will need image editing software to create the icon image or to change an existing image to the required dimensions and format.


Texture64Pixels.PNG
(not to scale)
Gears.PNG Settings:

The image must meet the following specifications:-

  • 64 pixels wide and 64 pixels tall
  • bit depth should be 24 bits
  • image file format can be any of:-
    • bmp
    • jpg
    • png
    • tga (tga compression should not be used)

The Texture File

DotPoint.JPG The .texture.txt file mainly contains the transparency (or Alpha Channel) data.


Gears.PNG 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.txt file is shown below:- 

primary=ashpit.tga
alpha=ashpit.tga
tile=st
Gears.PNG Settings:
  • primary - this is the name of the icon image file that contains the RGB colour image
  • alpha - this is the name of the icon image file that contains the Alpha Channel (transparency) image
  • tile=st - instructs TANE 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
No "white spaces" between the text characters is allowed.
NotePad.PNG Notes:

In the example shown above, both the primary and alpha images are the same. In this case the image must contain both the RGB colour data and the Alpha Channel (transparency) data.

Where the two files are not the same then both files must be the same size (64 x 64) and the alpha image file should be a greyscale image.


A more detailed description of the Texture File can be found on the Trainz Wiki at WikiLink.PNG Texture File

Using the Asset

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.

TextureAssetList.PNG
Steps.PNG Steps:

In the Session Editor add a Message Popup Rule and open it for editing.

  1. Select PortalOptionButtonFilled.PNG Custom Text
  2. Click the icon link Click here to select
  3. Scroll through the list of Texture Icons
  4. Select the required icon and click the Tick.PNG icon to accept the selection


Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz
Retrieved from "https://online.ts2009.com/mediaWiki/index.php?title=How_to_Create_a_Message_Popup_Icon&oldid=16041"
Personal tools