[edit] HTML Assets

[edit] How to Create a New HTML Asset

[edit] The Config.txt File

kuid                                    <kuid: this is an auto-generated number >
username                                "HTML assets for Steamville Session 1"
trainz-build                            4.5
kind                                    "html-asset"
description                             "All the images, web pages and sounds for the Steamville 1st Session"
category-class                          "YH"
thumbnails
{
  Default
  {
    image                               "SteamV1HTML.jpg"
    width                               240
    height                              180
  }
}

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  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  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  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 HTML assets, the category class is  html-asset . A list of asset kinds can be found at KIND Hierarchy
	The  description  provides more details for users than the username
	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  YH . A list of category classes can be found at Category-class
	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). Information on thumbnails can be found at Thumbnails The  Default  is the container ID or placeholder for the thumbnail (some types of assets can have several thumbnails) and its exact label (or number - eg. "Default", "00", "01", etc) is not important but each thumbnail if there are more than one must have a different label. 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

username                    "HTML assets for Steam Ride session"
username-c2                 "Steam会话的HTML资产"
username-de                 "HTML-Assets für die Steam-Ride-Sitzung"
username-es                 "Recursos HTML para la sesión de Steam Ride"
username-fr                 "Éléments HTML pour la session Steam Ride"
username-nl                 "HTML-middelen voor stoomrit sessie"
username-ru                 "HTML-ресурсы для сессии Steam Ride"

string-table
   {
      warning_message_stop                          "You have passed a stop signal. Apply your brakes immediately"
      warning_message_speed                         "You are speeding. Slow down"
   }

string-table
   {
      warning_message_stop                          "You have passed a stop signal. Apply your brakes immediately"
      warning_message_speed                         "You are speeding. Slow down"
   }
string-table-fr
   {
      warning_message_stop                          "Vous avez passé un signal d'arrêt. Appliquez vos freins immédiatement"
      warning_message_speed                         "Vous accélérez. Ralentir"
   }
string-table-nl
   {
      warning_message_stop                          "Je hebt een stop-signaal geslaagd. Breng je remmen onmiddellijk aan"
      warning_message_speed                         "Je versnelt. Vertragen"
   }

<font locale=generic>warning_message_stop</font>

If the users language has been set to French then the message "Vous avez passé un signal d'arrêt. Appliquez vos freins immédiatement" will appear in their browser window.
If the users language has been set to Dutch then the message "Je hebt een stop-signaal geslaagd. Breng je remmen onmiddellijk aan" will appear in their browser window.
If the users language has been set to English, or to a language that is not included in the string-table, then the message "You have passed a stop signal. Apply your brakes immediately" will appear in their browser window.

[edit] Graphic Files

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

• Texture File

[edit] HTML Files

Some suggestions for Wiki pages:-

	tasks to be completed in each session
	a driving tutorial of your route
	loco rosters and train schedules
	list of industries and their commodities
Some actual examples from the Trainz Wiki that are accessed from Popup Message Pages in Sessions include:-
	TRS19_TheInnterKohnNecktionRailroadSessions
	SAR_Peterborough_Base_Session

The Anchor Tag begins with ...

<a href="add link address here...">

... and ends with ...

</a>

In between the starting and ending parts of the tag you place the image or text that will become the link as shown in the text example below.

This will display the link in the MiniBrowser as

Left Click on the link to open the web page in your default web browser program.

The Trainz Wiki has a page giving more information about the MiniBrowser at MiniBrowser. You may be interested in the image tag (<img src="name of image file">) for using images instead of text for the links, and adding tool tips (the tooltip="place tool tip text here") parameter in the Anchor tag as shown in the example below.

Some suggestions:-   Simple text editors, such as MS Notepad supplied with MS Windows or TextEdit on MacOS, will work well but will require you to do a lot of typing and they will not perform any error checking More advanced text editors are available that are "HTML aware" and will recognise HTML "tags" making it easier to enter the tags and to check for their completeness

Shown on the left is the Notepad++ text editor which recognises HTML coding and provides some tools to assist in entering and correcting HTML code. The software has coloured the text segments that it has identifed as HTML tags or parts of tags.

Suitable freeware HTML editing software would include:-

	Notepad++ (Windows only)
	Atom (MacOSX and Windows)

[edit] Audio Files

Audio files must be recorded using, or converted to:-

	8 or 16 bit sample sizes
	22kHz (22,050Hz) or 44kHz (44,100Hz) sample rate
	Mono, stereo or surround format ("surround" is not fully tested)
...and saved using
	Uncompressed WAV format PCM (Pulse Coded Modulation)

A suitable freeware audio editing software would be:-

Audacity for both MacOSX and Windows

[edit] Adding a Message Popup to a Session

 from a simple text message typed into the rule with an optional graphic. If needed a sound can be added from an existing HTML asset.

 from a HTML page stored as a file in a HTML asset. This HTML page can have many graphic images, each stored in the HTML asset, and many lines of text. If needed a sound can be added from the same or another HTML asset.

 from a "string-table" in the config.txt file of a HTML asset. If needed a sound can be added from the same or another HTML asset.

To find information on how to create your own Message Popup Icons, see the Trainz Wiki Page:-

The minimum number of files needed in a HTML asset is 2 - the config.txt file and a thumbnail image (a .jpg file).

string-table
   {
      html_warning_late                             "You are running behind schedule."
      html_warning_early                            "You are running ahead of schedule."
      html_finished_title                           "Session completed!"
   }

The label html_warning_late is a "string-table token" that identifies the message "You are running behind schedule". The Message Popup rule uses this token to identify the message.

	Settings: A pre-defined string-table entry from a HTML asset (advanced) In This Example: Pause game while message is displayed - game play will not be paused Close previous message popup windows - this is usually a good idea unless you want multiple message windows open Message location: Top left of the screen has been chosen as the location for the message window. Other positions are Top right, Bottom left and Bottom right HTML Asset: General Purpose Session HTML one of the HTML assets installed with Trainz String Table Token: html_warning_late the string table token in the config.txt file of the General Purpose Session HTML asset contains the message to be displayed HTML Wave: General Purpose Session HTML HTML asset contains the optional sound file to be played Wav Name: all-aboard.wav is the optional sound file to be played Autoplay Wav - the sound will be played when the page is displayed

The string-table also has foreign language options as shown in the section The Config.txt File: String Table Option above.

warning_message_stop                "You have passed a stop signal.<br><br><font color=#ffff00><b>Apply your brakes immediately</b></font>"

More Tutorials and Guides to Using Trainz

• How to Guides
• Driver Commands List
• Session Rules List (Alphabetical) with Parameters
• Session Rules List (Categories) With Parameters