How to Create a Driver Character
(Updated due to a change in requirements for driver character assets) |
m (→The Config.txt File) |
||
(4 intermediate revisions by one user not shown) | |||
Line 250: | Line 250: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;"> 9 </span></td> | <td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;"> 9 </span></td> | ||
− | <td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Double Left Click</span> on the file to open it in '''Notepad'''</td> | + | <td>In '''Windows File Explorer''' <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> | </tr> | ||
</table> | </table> | ||
Line 487: | Line 487: | ||
</table> <!-- END Dot point table --> | </table> <!-- END Dot point table --> | ||
<br> | <br> | ||
− | <table bgcolor=#000000 | + | <table width=1000 bgcolor=#000000 cellpadding=2> |
<tr valign="top"> | <tr valign="top"> | ||
<td> | <td> | ||
− | <table | + | <table width=996 bgcolor="lightcyan" cellpadding=2> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td | + | <td align="center"><span style="color: blue; font-weight: 700; font-size: 17px;"> Update: </span></td> |
− | <span style="color: blue; font-weight: 700; font-size: | + | </tr> |
− | The latest Trainz release ('''TRS22PE | + | <tr valign="top"> |
− | + | <td>The latest Trainz release ('''Trainz Plus''' and '''TRS22PE SP4''' from July 2024) seems to have made a change in that a mesh is now required for a driver character. Fortunately a suitable built-in mesh is available.<br></td> | |
</tr> | </tr> | ||
<tr align="top"> | <tr align="top"> | ||
<td> | <td> | ||
+ | <table bgcolor=#ffffb0 cellpadding=2> | ||
+ | <tr valign="top"> | ||
+ | <td width=25>[[image:NotePad.PNG|link=]]</td> | ||
+ | <td>This change only applies to Driver Characters created using the latest, '''July 2024''' and later, updates to '''Trainz Plus''' and '''TRS22PE''' (the '''SP4''' release) - those with build number 5.5 and above. Characters created for earlier builds of '''Trainz''' are unaffected and these versions will still work in the latest Trainz releases without the need for the mesh.</td> | ||
+ | </tr> | ||
+ | </table> | ||
</td> | </td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td><br> | ||
+ | The following instructions have been updated to include this new requirement.</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
Line 505: | Line 515: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | + | <br> | |
<table cellpadding=2 bgcolor=#eeeeee> <!-- BEGIN Settings table --> | <table cellpadding=2 bgcolor=#eeeeee> <!-- BEGIN Settings table --> | ||
<tr> | <tr> | ||
Line 536: | Line 546: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:BlackDot10x10.png|link=]]</td> | <td>[[image:BlackDot10x10.png|link=]]</td> | ||
− | <td>'''trainz-build''' set to 4.1 or above (5.5 works in '''TRS22PE | + | <td>'''trainz-build''' set to 4.1 or above (5.5 works in '''TRS22PE SP4''')</td> |
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 654: | Line 664: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:BlackDot10x10.png|link=]]</td> | <td>[[image:BlackDot10x10.png|link=]]</td> | ||
− | <td>The <span style="background-color: black; color: white; font-weight: 700;"> mesh </span> a new requirement in the latest '''Trainz''' versions. A suitable mesh, '''DriverAlistair''', is supplied built-in to '''Trainz'''</td> | + | <td>The <span style="background-color: black; color: white; font-weight: 700;"> mesh </span> a new requirement in the latest '''Trainz''' versions. A suitable mesh, <kuid:-25:1011> '''DriverAlistair''', is supplied built-in to '''Trainz'''</td> |
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> |
Latest revision as of 15:19, 2 September 2024
The information in this Wiki Page applies to TANE, TRS19, Trainz Plus and TRS22.
Driver Characters are avatars that can be assigned to locomotives in sessions. They play the role of train drivers and can be moved between locomotives | |
Driver Character Icons are small graphic icons or images that can be selected to represent locomotive drivers in the Driver Setup Rule |
|
Workflow Diagram |
[edit] Create the Driver Image
The final image must be reduced to 64 pixels by 64 pixels in size |
The image can be easily created and resized using your favourite image editor. It can start with a photograph, as shown in the example below, a piece of clip art or a drawing. Make sure that there will be no copyright issues so something of your own creation, such as a photograph, would be ideal. |
If possible use a photograph with a simple background behind the subject, as shown in the image on the left. This keeps the icon simple and can avoid unnecessary "clutter". Most image editors will have tools for removing unwanted backgrounds but this can be time consuming. You may choose to add some clipart - in this case a train drivers cap and a "traditional" red scarf. Copyright free clipart is strongly recommended.
The clip art can be added as layers to the image which makes them easier to manipulate (resize and move). |
After cropping, reduce the image size to 64 pixels wide and 64 pixels high.
Save the final resized image with a suitable name and in a suitable file format:-
|
[edit] Create Driver Character Asset
Steps: | Create the Asset:
|
Find the New Asset:
|
Open the Asset in Windows File Explorer:
|
Open Config.txt File in Notepad:
|
Edit the Config.txt File:
|
|
Add Any Extras:
|
Finish Up:
|
[edit] The Config.txt File
All assets must have a config.txt file |
|
|
|||||||||||||||||
Settings:
|
|||||||||||||||||
|
This file should follow the same (or a similar) format as the example below. | |
entries in red must not be changed | |
the indenting of the lines and the spacing ("tabbing") between the "tags" on the left and their contents on the right are purely to make it easier for humans to read | |
the use of the { } braces is to group tags into common "containers". These containers must not be broken up and the number of { characters must match the number of } characters | |
the order of the "tags" is not important |
kuid <kuid: this is an auto-generated number > kind "drivercharacter" face-texture "DriverLillian.texture" username "Driver Lillian" category-class "OHD" trainz-build 4.3 mesh <kuid:-25:1011> thumbnails { Default { width 240 height 180 image "thumbnail.jpg" } 01 { width 64 height 64 image "driverlillian.texture" } } description "Icon for train driver Lillian" |
|
|||||||||||||||||||||||||||||||||||
Settings: For the above example:
|
|||||||||||||||||||||||||||||||||||
|
Language Options: |
|
All Trainz assets have a language facility built into their config.txt files that allows other language translations to be added for certain tags, such as the username and description tags. A full description of the process can be found on the Trainz Wiki at Localize an Asset and a list of all the supported languages with their two character codes at Localization (country) Codes. At the very basic level any creator can easily provide other language translations for the username and description tags in the assets they create. Examples are shown below for this sample asset. |
|
username "Driver Lillian" username-c2 "司机莉莲" username-es "Conductor Liliana" username-de "Fahrer Lilian" username-fr "Chauffeur Lilianen" username-nl "Chauffeur Lillian" username-ru "Драйвер Лилиан" |
|
Translations to Chinese (simplified), Spanish, French, German, Dutch and Russian, perfect or not, were provided by Google Translate. |
[edit] The Thumbnail Image
A thumbnail image MUST be present in the asset |
|
[edit] The Icon Image
You will need image editing software to create the icon image or to change an existing image to the required dimensions and format | |
See the Create the Driver Image section at the top of this page for an example |
(not to scale) |
|
|
[edit] The Texture File
The .texture.txt file controls how an image icon is displayed, particularly its Alpha Channel (or transparency) data. The file must be present even if no transparency is used in the icon. |
|
|||||||||||
Settings:
|
|||||||||||
|
A sample Texture File, "driverlillian.texture.txt", is shown below:-
primary=Lillian64.png alpha=Lillian64.png tile=st |
|
Notes: There are 3 general "scenarios" for the structure of the Texture File in a Texture Non Environmental asset.
Image file formats supported by Trainz that have an alpha channel are:-
Image file formats supported by Trainz that DO NOT have an alpha channel are:-
|
A detailed description of the .texture file format can be found on the Trainz Wiki Page at:- Texture File |
[edit] Using the Asset
Once the new asset has been committed it will be available for use in a Driver Setup Rule.
|
The finished product as a Driver.
[edit] Trainz Wiki
More Tutorials and Guides to Using Trainz |
This page was created by Trainz user pware in November 2022 and was last updated as shown below.