2016-10-25T22:31:43Z

Pev: ScreenShot of ConTEXT added

[[Image:context_icon.jpg]] 
* Context is a freeware programmer's editor which can be downloaded from http://www.contexteditor.org/downloads.html.
* Highlighters for script files and for config.txt files can be downloaded by [[Media:TrainzScript.chl.zip|clicking here.]] These are not essential for TRS2006 but are needed for TS2009 onwards. They show keywords, text strings and numbers in different colours and help to show where there might be missing quote marks and other problems with your code. A highlighter for config.txt files is included.
* Install the program and copy the highlighter files to ''\Program Files\Context\Highlighters.''
* To integrate the compiler select ''Option\Environment Options'' from Context's menu and then select the ''Execute Keys'' tab.
* Click on ''Add'' and enter the file extension ''gs''
* In the box at the top select one of the function keys and make these entries: 

[[Image:ContextOptions.jpg]] 

* Click OK to close the dialogue.
* Close Context.
* Create a new file called ''compile2006.bat'' in ''C:\Program Files\Auran\'' (use whatever name and location you prefer)
* Add this text to the batch file, you may need to modify paths or filenames:

@echo off
set gsc="C:\Program Files\Auran\TRS2006\Bin"
set include="C:\Program Files\Auran\TRS2006\Scripts"
%gsc%\gsc.exe %1 -i%include% -pc:\windows\temp
set gsc=
set include=
pause

* Reopen Context and load a script file.
* Press F11, your script file will be saved and then checked by the compiler, if all has gone well you will see this: 

[[Image:CompiledOK.jpg]] 

* If there are any problems with the script details will be given together with the line number of the error.
* Interpreting these can be something of a black art, don't worry it will become easier as time passes. 

==Compiling in Context with TrainzUtil.exe for TS2009, TS2010, and TS12==

'''TrainzUtil.exe''' is used to compile scripts in TS2009 onwards.

Set up a Context execute key as follows:

1. Open a trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F10)

5. Assuming you have TS2010, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"C:\Program Files\Auran\TS2010\bin\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"c:\Program Files\Auran\TS2010\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F10 the script should be compiled and error checked by TrainzUtil for TS2010.
 

==Compiling in Context with TrainzUtil.exe for Trainz A New Era==

'''TrainzUtil.exe''' can be used to syntax-check scripts in T:ANE.

Please note that the T:ANE launch window must be open for this to work, and that you must set the advanced debugging options as below.

[[Image:TANE_debug_setup_1.jpg]] 

Also please note that I have T:ANE installed on E: drive (a solid state drive), and that I have moved my user data to that drive.
The settings below should work for the default locations of the data.

Additionally note that this setup uses an undocumented feature for trainzutil.exe for T:ANE. The compile feature has been unsupported for some time now. Scripts are now checked by the validation process.

Set up a Context execute key as follows:

1. Open a T:ANE trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F11)

5. Assuming you have T:ANE, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"E:\N3V Games\Trainz A New Era\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"E:\N3V Games\Trainz A New Era\resources\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F11 the script should be syntax-checked by TrainzUtil for T:ANE.

The image below shows a T:ANE trainz script in ConTEXT. 
Note the different colours for keywords, text, numbers and comments. 
The script has a deliberate error in line 93 to illustrate how the output from the syntax-check is displayed. 
[[Image:TANE_script_in_ConTEXT.jpg]]

File:TANE script in ConTEXT.jpg

2016-10-25T22:18:30Z

Pev:

Using Context with Trainzscript

2016-10-25T21:42:29Z

Pev: ConTEXT icon added

[[Image:context_icon.jpg]] 
* Context is a freeware programmer's editor which can be downloaded from http://www.contexteditor.org/downloads.html.
* Highlighters for script files and for config.txt files can be downloaded by [[Media:TrainzScript.chl.zip|clicking here.]] These are not essential for TRS2006 but are needed for TS2009 onwards. They show keywords, text strings and numbers in different colours and help to show where there might be missing quote marks and other problems with your code. A highlighter for config.txt files is included.
* Install the program and copy the highlighter files to ''\Program Files\Context\Highlighters.''
* To integrate the compiler select ''Option\Environment Options'' from Context's menu and then select the ''Execute Keys'' tab.
* Click on ''Add'' and enter the file extension ''gs''
* In the box at the top select one of the function keys and make these entries: 

[[Image:ContextOptions.jpg]] 

* Click OK to close the dialogue.
* Close Context.
* Create a new file called ''compile2006.bat'' in ''C:\Program Files\Auran\'' (use whatever name and location you prefer)
* Add this text to the batch file, you may need to modify paths or filenames:

@echo off
set gsc="C:\Program Files\Auran\TRS2006\Bin"
set include="C:\Program Files\Auran\TRS2006\Scripts"
%gsc%\gsc.exe %1 -i%include% -pc:\windows\temp
set gsc=
set include=
pause

* Reopen Context and load a script file.
* Press F11, your script file will be saved and then checked by the compiler, if all has gone well you will see this: 

[[Image:CompiledOK.jpg]] 

* If there are any problems with the script details will be given together with the line number of the error.
* Interpreting these can be something of a black art, don't worry it will become easier as time passes. 

==Compiling in Context with TrainzUtil.exe for TS2009, TS2010, and TS12==

'''TrainzUtil.exe''' is used to compile scripts in TS2009 onwards.

Set up a Context execute key as follows:

1. Open a trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F10)

5. Assuming you have TS2010, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"C:\Program Files\Auran\TS2010\bin\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"c:\Program Files\Auran\TS2010\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F10 the script should be compiled and error checked by TrainzUtil for TS2010.
 

==Compiling in Context with TrainzUtil.exe for Trainz A New Era==

'''TrainzUtil.exe''' can be used to syntax-check scripts in T:ANE.

Please note that the T:ANE launch window must be open for this to work, and that you must set the advanced debugging options as below.

[[Image:TANE_debug_setup_1.jpg]] 

Also please note that I have T:ANE installed on E: drive (a solid state drive), and that I have moved my user data to that drive.
The settings below should work for the default locations of the data.

Additionally note that this setup uses an undocumented feature for trainzutil.exe for T:ANE. The compile feature has been unsupported for some time now. Scripts are now checked by the validation process.

Set up a Context execute key as follows:

1. Open a T:ANE trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F11)

5. Assuming you have T:ANE, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"E:\N3V Games\Trainz A New Era\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"E:\N3V Games\Trainz A New Era\resources\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F11 the script should be syntax-checked by TrainzUtil for T:ANE.

File:Context icon.jpg

2016-10-25T20:39:12Z

Pev:

File:TANE debug setup 1.jpg

2016-10-10T01:01:25Z

Pev: Pev uploaded a new version of "File:TANE debug setup 1.jpg"

Using Context with Trainzscript

2016-10-09T23:37:49Z

Pev: Introduction wording changed.

* Context is a freeware programmer's editor which can be downloaded from http://www.contexteditor.org/downloads.html.
* Highlighters for script files and for config.txt files can be downloaded by [[Media:TrainzScript.chl.zip|clicking here.]] These are not essential for TRS2006 but are needed for TS2009 onwards. They show keywords, text strings and numbers in different colours and help to show where there might be missing quote marks and other problems with your code. A highlighter for config.txt files is included.
* Install the program and copy the highlighter files to ''\Program Files\Context\Highlighters.''
* To integrate the compiler select ''Option\Environment Options'' from Context's menu and then select the ''Execute Keys'' tab.
* Click on ''Add'' and enter the file extension ''gs''
* In the box at the top select one of the function keys and make these entries: 

[[Image:ContextOptions.jpg]] 

* Click OK to close the dialogue.
* Close Context.
* Create a new file called ''compile2006.bat'' in ''C:\Program Files\Auran\'' (use whatever name and location you prefer)
* Add this text to the batch file, you may need to modify paths or filenames:

@echo off
set gsc="C:\Program Files\Auran\TRS2006\Bin"
set include="C:\Program Files\Auran\TRS2006\Scripts"
%gsc%\gsc.exe %1 -i%include% -pc:\windows\temp
set gsc=
set include=
pause

* Reopen Context and load a script file.
* Press F11, your script file will be saved and then checked by the compiler, if all has gone well you will see this: 

[[Image:CompiledOK.jpg]] 

* If there are any problems with the script details will be given together with the line number of the error.
* Interpreting these can be something of a black art, don't worry it will become easier as time passes. 

==Compiling in Context with TrainzUtil.exe for TS2009, TS2010, and TS12==

'''TrainzUtil.exe''' is used to compile scripts in TS2009 onwards.

Set up a Context execute key as follows:

1. Open a trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F10)

5. Assuming you have TS2010, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"C:\Program Files\Auran\TS2010\bin\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"c:\Program Files\Auran\TS2010\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F10 the script should be compiled and error checked by TrainzUtil for TS2010.
 

==Compiling in Context with TrainzUtil.exe for Trainz A New Era==

'''TrainzUtil.exe''' can be used to syntax-check scripts in T:ANE.

Please note that the T:ANE launch window must be open for this to work, and that you must set the advanced debugging options as below.

[[Image:TANE_debug_setup_1.jpg]] 

Also please note that I have T:ANE installed on E: drive (a solid state drive), and that I have moved my user data to that drive.
The settings below should work for the default locations of the data.

Additionally note that this setup uses an undocumented feature for trainzutil.exe for T:ANE. The compile feature has been unsupported for some time now. Scripts are now checked by the validation process.

Set up a Context execute key as follows:

1. Open a T:ANE trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F11)

5. Assuming you have T:ANE, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"E:\N3V Games\Trainz A New Era\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"E:\N3V Games\Trainz A New Era\resources\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F11 the script should be syntax-checked by TrainzUtil for T:ANE.

Using Context with Trainzscript

2016-10-09T22:54:50Z

Pev: Note for undocumented feature added.

* Context is a freeware programmer's editor which can be downloaded from http://www.contexteditor.org/downloads.html.
* Highlighters for script files and for config.txt files can be downloaded by [[Media:TrainzScript.chl.zip|clicking here.]] These are not essential but they do show keywords, text strings and numbers in different colours and help to show where there might be missing quote marks and other problems with your code. A highlighter for config.txt files is included.
* Install the program and copy the highlighter files to ''\Program Files\Context\Highlighters.''
* To integrate the compiler select ''Option\Environment Options'' from Context's menu and then select the ''Execute Keys'' tab.
* Click on ''Add'' and enter the file extension ''gs''
* In the box at the top select one of the function keys and make these entries: 

[[Image:ContextOptions.jpg]] 

* Click OK to close the dialogue.
* Close Context.
* Create a new file called ''compile2006.bat'' in ''C:\Program Files\Auran\'' (use whatever name and location you prefer)
* Add this text to the batch file, you may need to modify paths or filenames:

@echo off
set gsc="C:\Program Files\Auran\TRS2006\Bin"
set include="C:\Program Files\Auran\TRS2006\Scripts"
%gsc%\gsc.exe %1 -i%include% -pc:\windows\temp
set gsc=
set include=
pause

* Reopen Context and load a script file.
* Press F11, your script file will be saved and then checked by the compiler, if all has gone well you will see this: 

[[Image:CompiledOK.jpg]] 

* If there are any problems with the script details will be given together with the line number of the error.
* Interpreting these can be something of a black art, don't worry it will become easier as time passes. 

==Compiling in Context with TrainzUtil.exe for TS2009, TS2010, and TS12==

'''TrainzUtil.exe''' is used to compile scripts in TS2009 onwards.

Set up a Context execute key as follows:

1. Open a trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F10)

5. Assuming you have TS2010, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"C:\Program Files\Auran\TS2010\bin\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"c:\Program Files\Auran\TS2010\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F10 the script should be compiled and error checked by TrainzUtil for TS2010.
 

==Compiling in Context with TrainzUtil.exe for Trainz A New Era==

'''TrainzUtil.exe''' can be used to syntax-check scripts in T:ANE.

Please note that the T:ANE launch window must be open for this to work, and that you must set the advanced debugging options as below.

[[Image:TANE_debug_setup_1.jpg]] 

Also please note that I have T:ANE installed on E: drive (a solid state drive), and that I have moved my user data to that drive.
The settings below should work for the default locations of the data.

Additionally note that this setup uses an undocumented feature for trainzutil.exe for T:ANE. The compile feature has been unsupported for some time now. Scripts are now checked by the validation process.

Set up a Context execute key as follows:

1. Open a trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F11)

5. Assuming you have T:ANE, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"E:\N3V Games\Trainz A New Era\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"E:\N3V Games\Trainz A New Era\resources\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F11 the script should be syntax-checked by TrainzUtil for T:ANE.

Using Context with Trainzscript

2016-10-09T22:43:52Z

Pev:

* Context is a freeware programmer's editor which can be downloaded from http://www.contexteditor.org/downloads.html.
* Highlighters for script files and for config.txt files can be downloaded by [[Media:TrainzScript.chl.zip|clicking here.]] These are not essential but they do show keywords, text strings and numbers in different colours and help to show where there might be missing quote marks and other problems with your code. A highlighter for config.txt files is included.
* Install the program and copy the highlighter files to ''\Program Files\Context\Highlighters.''
* To integrate the compiler select ''Option\Environment Options'' from Context's menu and then select the ''Execute Keys'' tab.
* Click on ''Add'' and enter the file extension ''gs''
* In the box at the top select one of the function keys and make these entries: 

[[Image:ContextOptions.jpg]] 

* Click OK to close the dialogue.
* Close Context.
* Create a new file called ''compile2006.bat'' in ''C:\Program Files\Auran\'' (use whatever name and location you prefer)
* Add this text to the batch file, you may need to modify paths or filenames:

@echo off
set gsc="C:\Program Files\Auran\TRS2006\Bin"
set include="C:\Program Files\Auran\TRS2006\Scripts"
%gsc%\gsc.exe %1 -i%include% -pc:\windows\temp
set gsc=
set include=
pause

* Reopen Context and load a script file.
* Press F11, your script file will be saved and then checked by the compiler, if all has gone well you will see this: 

[[Image:CompiledOK.jpg]] 

* If there are any problems with the script details will be given together with the line number of the error.
* Interpreting these can be something of a black art, don't worry it will become easier as time passes. 

==Compiling in Context with TrainzUtil.exe for TS2009, TS2010, and TS12==

'''TrainzUtil.exe''' is used to compile scripts in TS2009 onwards.

Set up a Context execute key as follows:

1. Open a trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F10)

5. Assuming you have TS2010, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"C:\Program Files\Auran\TS2010\bin\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"c:\Program Files\Auran\TS2010\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F10 the script should be compiled and error checked by TrainzUtil for TS2010.
 

==Compiling in Context with TrainzUtil.exe for Trainz A New Era==

'''TrainzUtil.exe''' can be used to syntax-check scripts in T:ANE.

Please note that the T:ANE launch window must be open for this to work, and that you must set the advanced debugging options as below.

[[Image:TANE_debug_setup_1.jpg]] 

Also please note that I have T:ANE installed on E: drive (a solid state drive), and that I have moved my user data to that drive.
The settings below should work for the default locations of the data.

Set up a Context execute key as follows:

1. Open a trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F11)

5. Assuming you have T:ANE, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"E:\N3V Games\Trainz A New Era\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"E:\N3V Games\Trainz A New Era\resources\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F11 the script should be syntax-checked by TrainzUtil for T:ANE.

Using Context with Trainzscript

2016-10-09T22:42:55Z

Pev: Set up for TANE added

* Context is a freeware programmer's editor which can be downloaded from http://www.contexteditor.org/downloads.html.
* Highlighters for script files and for config.txt files can be downloaded by [[Media:TrainzScript.chl.zip|clicking here.]] These are not essential but they do show keywords, text strings and numbers in different colours and help to show where there might be missing quote marks and other problems with your code. A highlighter for config.txt files is included.
* Install the program and copy the highlighter files to ''\Program Files\Context\Highlighters.''
* To integrate the compiler select ''Option\Environment Options'' from Context's menu and then select the ''Execute Keys'' tab.
* Click on ''Add'' and enter the file extension ''gs''
* In the box at the top select one of the function keys and make these entries: 

[[Image:ContextOptions.jpg]] 

* Click OK to close the dialogue.
* Close Context.
* Create a new file called ''compile2006.bat'' in ''C:\Program Files\Auran\'' (use whatever name and location you prefer)
* Add this text to the batch file, you may need to modify paths or filenames:

@echo off
set gsc="C:\Program Files\Auran\TRS2006\Bin"
set include="C:\Program Files\Auran\TRS2006\Scripts"
%gsc%\gsc.exe %1 -i%include% -pc:\windows\temp
set gsc=
set include=
pause

* Reopen Context and load a script file.
* Press F11, your script file will be saved and then checked by the compiler, if all has gone well you will see this: 

[[Image:CompiledOK.jpg]] 

* If there are any problems with the script details will be given together with the line number of the error.
* Interpreting these can be something of a black art, don't worry it will become easier as time passes. 

==Compiling in Context with TrainzUtil.exe for TS2009, TS2010, and TS12==

'''TrainzUtil.exe''' is used to compile scripts in TS2009 onwards.

Set up a Context execute key as follows:

1. Open a trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F10)

5. Assuming you have TS2010, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"C:\Program Files\Auran\TS2010\bin\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"c:\Program Files\Auran\TS2010\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''"n(%l)"'''

10. Click on the 'Apply' button to save.

Now when you press F10 the script should be compiled and error checked by TrainzUtil for TS2010.
 

==Compiling in Context with TrainzUtil.exe for Trainz A New Era==

'''TrainzUtil.exe''' can be used to syntax-check scripts in T:ANE.

Please note that the T:ANE launch window must be open for this to work, and that you must set the advanced debugging options as below.

[[Image:TANE_debug_setup_1.jpg]] 

Also please note that I have T:ANE installed on E: drive (a solid state drive), and that I have moved my user data to that drive.
The settings below should work for the default locations of the data.

Set up a Context execute key as follows:

1. Open a trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F11)

5. Assuming you have T:ANE, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"E:\N3V Games\Trainz A New Era\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"E:\N3V Games\Trainz A New Era\resources\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F11 the script should be syntax-checked by TrainzUtil for T:ANE.

File:TANE debug setup 1.jpg

2016-10-09T22:02:01Z

Pev:

Trainz Tools by PEV

2016-10-02T22:37:17Z

Pev: Updated by PEV

==Attachment Maker==

A program to add attachment points to existing assets by creating an invisible mesh with those points. Very simple and quick to use; add attachments in minutes.

Download AttachmentMaker [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools here]

==Images2TGA==

A program to view all image types used in Trainz. The program can also convert any image to another format, as well as add and manipulate alpha images. You can attach your favourite image editor to allow opening of images for edit from within Images2TGA. The program handles the DXT compressed textures and allows conversion of these images to other formats. The trawl feature can be used to convert textures to TGAs. Additionally it can make grey scale images and normal maps. It has recently been updated to view the two versions of textures from Trainz A New Era.

This program supercedes Texture Viewer 2 and Texture2TGA.

Download Images2TGA [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools here]

==PM2IM==

A tool program to convert Auran progressive meshes (PM) to indexed meshes (IM). An option is provided to alter specular values that can cause unwanted shine on object surfaces.

This program can also be used to remove unsupported texture types from IM meshes.

Download PM2IM [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools here]

==Trainz Mesh Viewer 2==

Trainz Mesh Viewer 2 is a program to render textured meshes for Trainz. Also can now render complete train cars on short length of track. The views can be zoomed and rotated to view the object from any angle. If textures are not present the object is rendered in the diffuse colour with shadows. The program includes a facility to make 240x 180 thumbnail images of the object and can display normal mapped objects with a separate display for the bumps. A mesh data display has been added showing poly count and mesh size. Recent additions allow viewing of complete traincars as well as attachments and individual textures. A further addition creates 128x64 consist icons from the train car view.

Download Trainz Mesh Viewer 2 [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools here]

==QuickShadows==

This PEVSoft tool is provided to the Trainz community for the generation of shadow meshes without having to use 3DMax, Gmax or Blender. Many rolling stock items
downloaded into Content Manager show errors caused by missing shadow meshes. Where the shadow mesh is missing a simple rectangular box mesh should be sufficient
to give the shadow effect and to satisfy the requirements of the Content Manager program for an error-free asset. QuickShadows can create the shadow mesh in the shape of a rectangular box, or a simplified billboard version of the original mesh, or a pologon reduced version of the original mesh, or a black only copy of the original mesh.

Download QuickShadows [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools here]

==PEVs Download Page==

As you can see if you download any of the above you are directed to Shane Turner's web site. Shane has kindly hosted PEV's downloads as his original site no longer supports them. Check out the other tools on offer.

==Tutorials for PEV's Tools==

John King's Trainz Resources NewsLetter published a series of tutorials on PEV's Trainz Tools.

They covered:-

'''Images2TGA''' ''for manipulating all image types used in Trainz''

'''PM2IM''' ''for conversions of Progressive Meshes to Indexed Meshes''

'''QuickShadows''' ''for creating simple shadows where needed''

'''AttachmentMaker''' ''add attachments to assets in minutes''

PDFs of these are available from Shane's [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools download page].

==Disclaimer==

PEV accepts no liability for damage or lost data arising from the use or misuse of the above software.

The programs are provided free of charge and in good faith to assist Trainz authors and users.

Some meshes don't render correctly in AssetX or Trainz Mesh Viewer. All of PEV's mesh tools (and AssetX) have a bug in INFL chunk based animations as produced by 3DSMax. These are rare as GMax does not support this type of animation. Unfortunately there is no documentation on how this works, and PEV has been unable to get it right by experimentation.

==About PEV==

I am a retired electrical engineer who worked for a major Australian building materials manufacturer for many years. I have two recreational passions, making classical guitars, and Trainz.. I made many software tools when working and now write them when ever I think a problem can be solved with a bit of software.

I hope you find my efforts helpful.

==Exit==

[[Tools|Return to Tools]]

Tutorials for AssetX and PEV Tools

2016-08-07T13:17:05Z

Pev: spelling error fixed

== AssetX Tutorials ==

[[AssetX/Tutorial Define Tools|Defining Tools in AssetX]] - a tutorial on connecting external programs as tools.

== PEV's Tools Tutorials ==
PEV wrote a series of tutorials for John King's Trainz Resources NewsLetter.

They covered:-

'''Images2TGA''' ''for manipulating all image types used in Trainz''

'''PM2IM''' ''for conversions of Progressive Meshes to Indexed Meshes''

'''QuickShadows''' ''for creating simple shadows where needed''

'''AttachmentMaker''' ''add attachments to assets in minutes''

Reprints of these are available from Shane Turner's web site on the PEV Tools [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools download page].

Back to [[AssetX Wiki]] page.

AssetX Scripts

2016-08-07T12:23:50Z

Pev: download links changed

=AssetX Script Libraries=

As well as being a Help Page, this page is intended to be a source for scripts written for AssetX.

'''Please Note: Any installers on this page must be executed separately, and AssetX opened immediately afterwards.'''

==Ian Woodmore's TARDIS 2.0 Scripts==

During the development of AssetX, Ian Woodmore wrote an extensive set of scripts to test the scripting language.

These TARDIS scripts, in conjunction with Asset X, can perform automated repair. upgrade and up-version of legacy assets to any asset trainz-build TB 2.7 or greater.

The scripts cover a wide range of common config.txt tags and containers. They work fine for the bulk of early version assets. Any remaining errors must be fixed manually using the Content Manager (CM) as a guide.

TARDIS is a Work in Progress and will evolve as new versions of Trainz and TANE are released.

The script installer is available from [https://www.dropbox.com/s/1bt0ax6g0t710uy/Tardis_3_7_Scripts.exe?dl=0 HERE] and will automatically load the scripts into your AssetX installation.

==PEV's Version Upgrade Scripts==
Also during the development of AssetX, PEV wrote a simple set of version upgrade scripts to test the scripting language.

These are a set of four AssetX scripts that, together, can perform asset version upgrades to TC1/2 (trainzbuild 2.7) or TS2009 (trainzbuild 2.9).

These simple scripts do no error checking, and only cover the common config.txt tags. They work fine for the bulk of early version assets. Those errors that remain must be fixed manually using CM2 or CM3 as a guide.

The script installer is available from [https://www.dropbox.com/s/hv94iu1lon6k2nx/PEVs_Updating_Scripts.exe?dl=0 HERE]
and will automatically load the scripts into your AssetX installation.

==Add TrainzUtil to your AssetX Menu==

AssetX can use TrainzUtil to verify assets and commit or revert them into the Trainz database.

Please be aware that this process can be slow, and it requires the Trainz Version setting in Options/Paths be set for the target Trainz version (if you have more than one Trainz installation).

The menu installer is available from [https://www.dropbox.com/s/s47adwyw1f5tjxx/TrainzUtil_Menu_Script.exe?dl=0 HERE]
and will automatically load into your AssetX installation. This installer loads a "RunOnce" script that will execute automatically when you open AssetX and then the RunOnce will delete itself when finished. You need to close and re-open AssetX to see the new TrainzUtil menu.

Note that this TrainzUtil menu is designed to run with Version 2.2 of AssetX and may cause earlier versions to stall on a pointer over-run.

If you wish to '''remove''' the TrainzUtil Menu use this [https://www.dropbox.com/s/km4msz29z3st8nm/TrainzUtil_Menu_Delete.exe?dl=0 LINK]

''This is an example of an AssetX '''Custom Menu'''. Three of these are provided, Custom A, Custom B and Custom C. In this case we have used Custom A. You can check out how it works by clicking on Options/Configure Tools on the AssetX Main Menu. Select Custom A in the drop-down box labelled Menu. The program help gives a detailed description of this process.''

=Script Code for Sharing=
If you have written an AssetX script that you think may be useful for the community you can copy and paste it into this section.
To get the text to appear in a code box, all of the lines must start with a space character. Here is a simple example:-

FileName "Username.axm"

-If|config.txt\name!""
-Save|0|config.txt\name
-Update|config.txt\username|"*** NEW TAG ***"
-Restore|0|config.txt\username
-delete|config.txt\name
-EndIf

=Corrected Version of Install Superscript.axm=
This corrects some typos in the file provided with the AssetX installation. Copy and paste the following and save in the scripts folder as 'Install Superscript.axm'

;install library and asset stub script
-If|kind!traincar
-Info|Script can only be used with kind traincar assets
-Exit
-EndIf

-IfAsset|<kuid2:122285:508:14>
-Else
-Info|Script requires that Superscript Library <kuid2:122285:508:14> or later must be open in AssetX.
-Exit
-EndIf

-If|engine=
-Info|Asset has no engine tag, please correct and re-run script
-Exit
-EndIf

-Update|script-include-table\superscript|<kuid2:122285:508:14>
-Update|kuid-table\codelib|<kuid2:122285:508:14>
-If|engine=1
-IfAsset|<kuid2:122285:508:14>
-CopyFromAsset|lstub.gs
-EndIf
-Update|script|LStub
-Update|class|LStub
-Else
-IfAsset|<kuid2:122285:508:14>
-CopyFromAsset|vstub.gs
-EndIf
-Update|script|VStub
-Update|class|VStub
-EndIf

;extensions container options
-IfQuery||Run in Debug Mode?
-Update|extensions\debug-122285|1
-EndIf
-IfQuery||Change Train Heading via View-Details in Driver?
-Update|extensions\heading-122285|1
-EndIf

;front mesh
-IfQuery||Add Front of Car Marker (used when debugging attachments)?
-Update|mesh-table\front\mesh-asset|<kuid:122285:508>
-Update|mesh-table\front\mesh|front.im
-Update|mesh-table\front\att|a.limfront
-Update|mesh-table\front\att-parent|default
-Update|mesh-table\front\auto-create|0
-EndIf

;mesh-table front headlight
-IfQuery||Add Headlight at Front of Car?
-Update|mesh-table\default\effects\headlight-0\kind|corona
-Update|mesh-table\default\effects\headlight-0\att|a.headlight-0
-Update|mesh-table\default\effects\headlight-0\texture-kuid|<kuid:104722:100>
-Update|mesh-table\default\effects\headlight-0\object-size|0.12
-EndIf

;mesh-table rear headlight
-IfQuery||Add Headlight at Rear of Car?
-Update|mesh-table\default\effects\headlight-1\kind|corona
-Update|mesh-table\default\effects\headlight-1\att|a.headlight-1
-Update|mesh-table\default\effects\headlight-1\texture-kuid|<kuid:104722:100>
-Update|mesh-table\default\effects\headlight-1\object-size|0.12
-EndIf

;mesh-table front taillamp
-IfQuery||Add Tail Light at Front of Car?
-Update|mesh-table\default\effects\taillight-0\kind|corona
-Update|mesh-table\default\effects\taillight-0\att|a.taillight-0
-Update|mesh-table\default\effects\taillight-0\texture-kuid|<kuid:104722:200>
-Update|mesh-table\default\effects\taillight-0\object-size|0.12
-EndIf

;mesh-table rear taillamp
-IfQuery||Add Tail Light at Rear of Car?
-Update|mesh-table\default\effects\taillight-1\kind|corona
-Update|mesh-table\default\effects\taillight-1\att|a.taillight-1
-Update|mesh-table\default\effects\taillight-1\texture-kuid|<kuid:104722:200>
-Update|mesh-table\default\effects\taillight-1\object-size|0.12
-EndIf

;lamp bodies
-IfQuery||Add Lamp Bodies?
-If|mesh-table\default\effects\headlight-0\kind$
-Update|mesh-table\headlight-0-body\mesh-asset|<kuid:122285:508>
-Update|mesh-table\headlight-0-body\mesh|lamp.im
-Update|mesh-table\headlight-0-body\att|a.headlight-0
-Update|mesh-table\headlight-0-body\att-parent|default
-EndIf
-If|mesh-table\default\effects\headlight-1\kind$
-Update|mesh-table\headlight-1-body\mesh-asset|<kuid:122285:508>
-Update|mesh-table\headlight-1-body\mesh|lamp.im
-Update|mesh-table\headlight-1-body\att|a.headlight-1
-Update|mesh-table\headlight-1-body\att-parent|default
-EndIf
-If|mesh-table\default\effects\taillight-0\kind$
-Update|mesh-table\taillight-0-body\mesh-asset|<kuid:122285:508>
-Update|mesh-table\taillight-0-body\mesh|lamp.im
-Update|mesh-table\taillight-0-body\att|a.taillight-0
-Update|mesh-table\taillight-0-body\att-parent|default
-EndIf
-If|mesh-table\default\effects\taillight-1\kind$
-Update|mesh-table\taillight-1-body\mesh-asset|<kuid:122285:508>
-Update|mesh-table\taillight-1-body\mesh|lamp.im
-Update|mesh-table\taillight-1-body\att|a.taillight-1
-Update|mesh-table\taillight-1-body\att-parent|default
-EndIf
-EndIf

;corridors
-IfQuery||Add Corridor at Front of Car?
-Update|extensions\corridor-0-122285|1
-Update|mesh-table\corridor-0\mesh-asset|<kuid:122285:508>
-Update|mesh-table\corridor-0\mesh|corridor.im
-Update|mesh-table\corridor-0\anim|corridor.kin
-Update|mesh-table\corridor-0\auto-create|1
-Update|mesh-table\corridor-0\att|a.couple0
-Update|mesh-table\corridor-0\att-parent|default
-EndIf

-IfQuery||Add Corridor at Rear of Car?
-Update|extensions\corridor-1-122285|1
-Update|mesh-table\corridor-1\mesh-asset|<kuid:122285:508>
-Update|mesh-table\corridor-1\mesh|corridor.im
-Update|mesh-table\corridor-1\anim|corridor.kin
-Update|mesh-table\corridor-1\auto-create|1
-Update|mesh-table\corridor-1\att|a.couple1
-Update|mesh-table\corridor-1\att-parent|default
-EndIf

;front driver
-IfQuery||Add Driver Mesh at Front of Car?
-Update|mesh-table\driver-0\mesh-asset|<kuid:122285:508>
-Update|mesh-table\driver-0\mesh|driver.im
-Update|mesh-table\driver-0\att|a.driver-0
-Update|mesh-table\driver-0\att-parent|default
-Update|mesh-table\driver-0\auto-create|1
-EndIf

;rear driver
-IfQuery||Add Driver Mesh at Rear of Car?
-Update|mesh-table\driver-1\mesh-asset|<kuid:122285:508>
-Update|mesh-table\driver-1\mesh|driver.im
-Update|mesh-table\driver-1\att|a.driver-1
-Update|mesh-table\driver-1\att-parent|default
-Update|mesh-table\driver-1\auto-create|1
-EndIf

-IfQuery||Save Changes to config.txt?
-Sort
-SaveConfig
-MessageBox|Config.txt entries have been made for the options selected. You can amend attachment point names, corona kuid references etc to suit your model. Please ensure that the attachment points specified are present within your traincar mesh.
-EndIf

Resources: Plans

2014-06-26T00:06:06Z

Pev: GW drawings added

This page related to resources for finding plans and blueprints useful in creating models for Trainz is a stub.

A selection of UK Great Western Drawings from Swindon.. [http://www.greatwestern.org.uk/loco_draw.htm HERE.]

HowTo/Upload a new asset to the DownloadStation

2014-06-19T02:02:07Z

Pev: /* Verify Content is Error Free */ AssetX reference added

The [[Download Station]] and [[Content Manager]] are designed to make it easy to share assets and maps for Trainz.

[[Content Manager]] and [[Content Creator Plus]] aim to allow content creators to create and upload error free assets for Trainz. In previous builds errors in assets on the download station have created frustration for users. With [[Content Creator Plus]] we now have a utility to eliminate as many errors and problems as possible, and therefore we ask that the following procedures be used.

== The Trainz Download Station ==

The uploading and downloading processes are fully encapsulated within [[Content Manager]]. Assets no longer need to be manually packaged in order to be uploaded, making the process much simpler. To upload your content, you must have a valid [[Planet Auran account]], with a registered version of Trainz.

== Steps to Upload ==

You have completed your masterpiece and would like to share it with the Trainz community. Let's put it on the [[Download Station]].

===Verify Content is Error Free===

Before uploading your new asset it must be verified and proved error-free; a process which is rigorously enforced by [[Content Manager]]. This verification occurs automatically when committing assets in Trainz and is repeated on the [[Download Station]] server after upload.

Faulty assets are displayed with a [[Image:Faulty001.jpg]] icon in [[Content Manager]].

If an asset is faulty it must be fixed before it is able to be uploaded, this can be done using [[Content Creator Plus]] or by manually editing the asset.

Fixing faulty content can be quite complex. Use the error messages in [[Content Manager]] and [[Content Creator Plus]] to correct any errors one by one. If you are having trouble search the [http://forums.auran.com/trainz/index.php Trainz forum] for help in repairing faults. Keep in mind that, if you have correctly exported the mesh(s) from 3dsMax or Blender, and you have the texture.txt and image files correctly located, [[Content Creator Plus]] should make a config.txt file clear of errors.

AssetX is a useful third party tool for asset repair. See [[AssetX_Wiki]].

===Select Content to be Uploaded===

Once you have created your error free assets you can select them to be uploaded.

To add your assets to the upload queue, first select them in the main list. You can use 'Shift' or 'Ctrl' click to select multiple assets. Right click on the selected assets and choose the "Upload" option. This will expand the upload helper and add the items to the list.

[[Content Manager]] may prompt you to automatically add asset dependencies. This is a good idea as missing dependencies can cause much frustration for other Trainz users who download your creations.

===Begin Uploading===

Once you've added all the assets you wish to share you are ready to begin the upload. Click the "Upload" button on the upload helper side panel in [[Content Manager]].

You must agree to the Planet Auran License Agreement before you can upload your assets, this is displayed automatically. Accepting the agreement will upload your content to the Download Station. On completion of the upload the Planet Auran "Your Content" page will open in your default web browser. This page is part of your personal Planet Auran profile and allows you to manage your online content at any time. You can access this page at any time by visiting the [https://www.auran.com/planetauran/default.htm Auran] website and following the links.

The "Your Content" section is divided into the following areas:

[[Image:my_content001.jpg]]

'''Upload Content:''' You needn't utilize this section as [[Content Manager]] now handles the entire upload process. It is recommended that you only use [[Content Manager]] to upload TS2009, TS2010 and TS12 assets.

'''Unprocessed:''' The "Unprocessed" section shows the files you have uploaded which have not yet been approved by N3V.

After uploading an asset you will find it in this section. Any files uploaded using [[Content Manager]] will be packed into a file named "upload.cdp". If you upload multiple files in one instance they will be compiled into a single file before they are processed online.

If you have uploaded a file and decide you no longer want it to be processed you can mark it as "do not process", but do not delay as uploads are processed quickly and may not remain in this section long.

'''Preview Area:''' The preview area acts as a temporary 'holding bay' for previewing and testing your content before it is made available for download. The main features of the Preview Area are as follows:

''a.'' You can review and approve your own content before the final approval process.

''b.'' You can send the private link to your content to others for testing purposes.

''c.'' You can re-check all the Download Station pack information before final approval, i.e. pack contents, category, obsoletes, descriptions etc.

''d.'' You may delete the content if you change your mind.

''Important note: Preview Area content is only be held for 4 weeks since it was uploaded. All testing/revision must be done within this time. If you have (say) 4 assets for upload - A locomotive, an engine file, a bogey and a pantograph, and you only update ONE of these assets, the other 3 are still on the original 4 week period.''

'''Waiting Area:''' The waiting area contains assets which have successfully passed through the automated checks made by the Download Station and are awaiting visual confirmation from internal N3V Games staff. This is done for a number of reasons, including:

- Verifying that the name and description are valid and appropriate

- Verifying that the correct category is selected

- Verifying that the thumbnail image is visually acceptable.

You will receive a Planet Auran mailbox message to indicate if your content has been approved or declined. By default, Planet Auran mailbox messages are also forwarded to your email address. If approved, the content should be available for download in [[Content Manager]] within 48 hours.

'''Your Content:''' The "Your Content" section shows every asset you have previously uploaded to the Download Station.

== Return to How To Index ==

[[HowToGuides]]

[[Category:How-to guides]]

Trainz Tools by PEV

2014-06-17T00:00:05Z

Pev: QuickShadows added

==Attachment Maker==

A program to add attachment points to existing assets by creating an invisible mesh with those points. Very simple and quick to use; add attachments in minutes.

Download AttachmentMaker [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools here]

==Images2TGA==

A program to view all image types used in Trainz. The program can also convert any image to another format, as well as add and manipulate alpha images. You can attach your favourite image editor to allow opening of images for edit from within Images2TGA. The program handles the DXT compressed textures and allows conversion of these images to other formats. The trawl feature can be used to convert textures to TGAs. Additionally it can make grey scale images and normal maps.

This program supercedes Texture Viewer 2 and Texture2TGA.

Download Images2TGA [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools here]

==PM2IM==

A tool program to convert Auran progressive meshes (PM) to indexed meshes (IM). An option is provided to alter specular values that can cause unwanted shine on object surfaces.

This program can also be used to remove unsupported texture types from IM meshes.

Download PM2IM [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools here]

==Trainz Mesh Viewer 2==

Trainz Mesh Viewer 2 is a simple program to render textured meshes for Trainz. Also can now render complete train cars on short length of track. The views can be zoomed and rotated to view the object from any angle. If textures are not present the object is rendered in the diffuse colour with shadows. The program includes a facility to make 240x 180 thumbnail images of the object and can display normal mapped objects with a separate display for the bumps. A mesh data display has been added showing poly count and mesh size. Recent additions allow viewing of complete traincars as well as attachments and individual textures.

Download Trainz Mesh Viewer 2 [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools here]

==QuickShadows==

This PEVSoft tool is provided to the Trainz community for the generation of shadow meshes without having to use 3DMax, Gmax or Blender. Many rolling stock items
downloaded into Content Manager show errors caused by missing shadow meshes. Where the shadow mesh is missing a simple rectangular box mesh should be sufficient
to give the shadow effect and to satisfy the requirements of the Content Manager program for an error-free asset. QuickShadows can create the shadow mesh in the shape of a rectangular box, or a simplified billboard version of the original mesh, or a pologon reduced version of the original mesh, or a black only copy of the original mesh.

Download QuickShadows [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools here]

==PEVs Download Page==

As you can see if you download any of the above you are directed to Shane Turner's web site. Shane has kindly hosted PEV's downloads as his original site no longer supports them. Check out the other tools on offer.

==Tutorials for PEV's Tools==

John King's Trainz Resources NewsLetter published a series of tutorials on PEV's Trainz Tools.

They covered:-

'''Images2TGA''' ''for manipulating all image types used in Trainz''

'''PM2IM''' ''for conversions of Progressive Meshes to Indexed Meshes''

'''QuickShadows''' ''for creating simple shadows where needed''

'''AttachmentMaker''' ''add attachments to assets in minutes''

Reprints of these are available from Shane's [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools download page].

==Disclaimer==

PEV accepts no liability for damage or lost data arising from the use or misuse of the above software.

The programs are provided free of charge and in good faith to assist Trainz authors and users.

Some meshes don't render correctly in AssetX or Trainz Mesh Viewer. All of PEV's mesh tools (and AssetX) have a bug in INFL chunk based animations as produced by 3DSMax. These are rare as GMax does not support this type of animation. Unfortunately there is no documentation on how this works, and PEV has been unable to get it right by experimentation.

==About PEV==

I am a retired electrical engineer who worked for a major Australian building materials manufacturer for many years. I have two recreational passions, making classical guitars, and Trainz.. I made many software tools when working and now write them when ever I think a problem can be solved with a bit of software.

I hope you find my efforts helpful.

==Exit==

[[Tools|Return to Tools]]

AssetX Wiki

2014-05-01T23:28:32Z

Pev: Reference to Shane's site added

Welcome to the AssetX WIKI page.
Latest news will usually be found in the [http://forums.auran.com/trainz/showthread.php?t=63264 AssetX FAQ]

AssetX is now up to Version 3.0. Get it from [http://www.ajsmith.org.uk/trs/assetx HERE]

AssetX uses PEV's Images2TGA, PM2IM and QuickShadows as part of its toolbox. Download these from Shane Turner's web site on the PEV Tools [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools download page].

Links to pages providing support and access to additional materials:

==[[AssetX Scripts]]==

==[[Tutorials for AssetX and PEV Tools]]==

==[[Articles]]==

Tutorials for AssetX and PEV Tools

2014-05-01T23:25:24Z

Pev: /* PEV's Tools Tutorials */ Reference to Shane's site added

== AssetX Tutorials ==

[[AssetX/Tutorial Define Tools|Defining Tools in AssetX]] - a tutorial on connecting external programs as tools.

== PEV's Tools Tutorials ==
PEV wrote a series of tutorials for John King's Trainz Resources NewsLetter.

They covered:-

'''Images2TGA''' ''for manipulating all image types used in Trainz''

'''PM2IM''' ''for conversions of Progressive Meshes to Indexed Meshes''

'''QuickShadows''' ''for creating simple shadows were needed''

'''AttachmentMaker''' ''add attachments to assets in minutes''

Reprints of these are available from Shane Turner's web site on the PEV Tools [http://trainz.shaneturner.co.uk/tutorials/index.php/en/home/utilities/3rd-party-trainz-utilities/pevsoft-trainz-tools download page].

Back to [[AssetX Wiki]] page.

HowTo/Implement a Destination Sign System

2014-03-23T08:36:24Z

Pev: /* Introduction */ grammar error

== Introduction ==

This document was inspired by the release from NormP of Surfside Trams 2 for TS12. This is a fictional route with tramways on the Gold Coast in Australia. The Gold Coast is near Brisbane where trams were used up to 1972.

The Brisbane trams modelled by motorman1066 seemed appropriate to use on the route, so were added. To my surprise the destination boards for Brisbane appeared for use in the session. Consequently, a set of destination boards was made for the Surfside Trams route, and this document details the steps required to get them to work.

== The Destination Boards ==

These work by script controlled texture replacement so the format and config.txt are important.

Motorman1066's trams all share the same destination boards for Brisbane, kuid2:108959:99901:2, and these are read into the tram script and provide an option selection from the properties button in surveyor. (more on this later)

To use this process on another route, eg Surfside Trams, a different set of destination signs is needed.

An asset with set of textures for the Gold Coast was built by cloning and editing motorman1066's Brisbane ones. In his case each texture has a destination name and route number. The two bits of data are separated by texture mapping and displayed on the destination sign and the route number sign as below.

[[File:Dest_Phoenix_PEV.jpg]]

Each texture looks as below.

[[File:Dest_sign_sample_PEV.jpg]]

In this case the boards are backlit at night with a white night mesh so the white text is transparent.

The Surfside destination boards are a small set with only 10 destinations. Here is the complete config.txt.

kuid <kuid:XXXXXX:YYYYYY>
username "SurfSideDestsignTextures"
kind "texture-group"
trainz-build 2.9

extensions
{
destnames-000000
{
0 "BLANK"
1 "SEA WORLD DEPOT"
2 "SEA WORLD"
3 "CAVILL AVE"
4 "SURFERS PARADISE"
5 "PRIMARY SCHOOL"
6 "BUNDALL"
7 "SOUTHPORT POOL"
8 "PACIFIC FAIR"
9 "PACIFIC FAIR DEPOT"
}
}

textures
{
0 "Blank.texture" [[File:Dest_texture0_PEV.jpg]]

1 "dest0.texture" [[File:Dest_texture1_PEV.jpg]]

2 "dest1.texture" [[File:Dest_texture2_PEV.jpg]]

3 "dest2.texture" [[File:Dest_texture3_PEV.jpg]]

4 "dest3.texture" [[File:Dest_texture4_PEV.jpg]]

5 "dest4.texture" [[File:Dest_texture5_PEV.jpg]]

6 "dest5.texture" [[File:Dest_texture6_PEV.jpg]]

7 "dest6.texture" [[File:Dest_texture7_PEV.jpg]]

8 "dest7.texture" [[File:Dest_texture8_PEV.jpg]]

9 "dest8.texture" [[File:Dest_texture9_PEV.jpg]]
}
category-class "JO"
category-era "1940s;1950s;1960s"
category-region "AU"
description "Destination signs for Normp's Surf-Side Trams.
Derived from destination boards for Motorman1066 Brisbane trams.
Developed from an original concept created by Peter Denhert."
author "motorman1066 amended by PEV"
license "etc"
organisation "Selz Tramz Workshopz 2006"

thumbnails
{
0
{
image "destination sign 240.jpg"
width 240
height 180
}
}

Note the kind must be "texture-group" and category class must be "JO" (Other Textures).
Also note the sub-container name in the "extensions" container. It must start with lower case "destnames-" as shown above. Put your own user ID number after it.

The tram script generates a selection table which shows the items listed in the "extensions" container as destination board options.

Selecting from the list chooses the texture of the same number. So, from the above config.txt, texture 1 (dest0.texture) is SEA WORLD DEPOT and so on.

== Tram Car (or loco) Requirements ==

In this case the trams were cloned from motorman1066's assets and the names changed to represent use by me on Surfside Trams route. The kuid-table is changed so that the asset for new destinations is included. See below:

The tram cars must be built to support texture replacement on the destination sign. The config.txt must have effects container named "destsign" in the mesh table as below.

mesh-table
{
default
{
mesh "554 body/554 body.lm"
auto-create 1

effects
{
destsign
{
kind "texture-replacement"
texture "texture dest.texture"
}
}
}
etc

kuid-table
{
bogey <kuid2:108959:50554:1>
enginesound <kuid2:108959:53554:1>
enginespec <kuid2:108959:51554:1>
hornsound <kuid2:108959:54554:1>
interior <kuid2:108959:55554:1>
product <kuid:-3:10060>
destsigntextures <kuid:329364:100013> ...... ''the new destination sign asset''
}

Additionally the kuid-table of the tram config.txt can have the entry "destsigntextures", as above though not essential, which calls the kuid of the destination sign asset above.

The "texture dest.texture" is a blank sign the same as the blank in the destination sign asset. It is located in the same folder as the parent mesh (in this case the 554 body folder.)

The tram assets in this case have a script (tram.gs) of class called "Tram". The script from Peter Dehnert provides the interface to select destinations in Surveyor and to communicate with the "Change Destination Sign To" rule [[File:Dest_change_sign_PEV.jpg]] allowing destinations to be changed by the driver AI.

== Using the Destination Sign System ==

Firstly we add the "DestsignTable" Rule to the Session (or route, depending on layer setting). We can choose to be in the session layer to make the sessions more flexible.

Press the Edit Session Rules Button [[File:Dest_Session_Edit_Button_PEV.jpg]] at the top left of the surveyor screen.

The Edit Session window will appear.

[[File:Dest_step01_PEV.jpg]]

Press the Add button to add a rule to the session.

The selection box for Rules will appear.

[[File:Dest_step02_PEV.jpg]]

Scroll down to find and select the "DestSignTable" rule.

The rule is added to the session as shown. This rule searches the session and route assets for kind "texture-group" assets and builds a table of such assets. It also adds the "Change Destination to" [[File:Dest_change_sign_PEV.jpg]] to the driver command menu.

[[File:Dest_step01a_PEV.jpg]]

Select the "DestSignTable" rule from the Edit Session box and Press the Edit Button (circled in the image above). The Rule properties box is displayed.

[[File:Dest_step07_PEV.jpg]]

Ensure that ''Enable industries/station as destination'' and ''Enable trackmarks as destinations'' are '''not''' checked (ticked) and that ''Enable table of destinations'' is checked (ticked) as shown.

Click on '''Import destinations from texture-group'''. The "Select texture-group" box will be displayed.

[[File:Dest_step08_PEV.jpg]]

Select the appropriate texture group.. in this case "SurfSideDestTextures".

A list of destinations will be added as below.

[[File:Dest_step09_PEV.jpg]]

Accept the edits by clicking on the check (tick) button on the above windows.

This completes the set up of the "DestSignTable" rule; we can now add trams to our session.

== We Have Added a Tram ==

When we have placed the tram car on a track in Trainz Surveyor, press the properties button in the rolling stock tab,

[[File:Dest_Properties_button_PEV.jpg]]

and left click on the tram itself. The tram properties window appears where we can add a running number and enable our destination list.

[[File:Dest_step03_PEV.jpg]]

The circled text is the name of the texture-group for our destination sign.

If the texture group is incorrect, left click on the text and "Select texture-group" box will appear allowing us to change the texture group to "SurfSideDestsignTextures" as previously.

[[File:Dest_step08_PEV.jpg]]

We can also select a destination sign immediately if desired by left clicking Destination text as shown.

[[File:Dest_step05_PEV.jpg]]

The Destination selection box is displayed allowing us to choose an appropriate destination.

[[File:Dest_step11_PEV.jpg]]

The Driver AI can be used to change destination signs at any time. Click on the green arrow to insert a driver command. From the menu choose "Change Destination To" and select a destination from the drop down menu.

[[File:Dest_step12_PEV.jpg]]

The destinations can change automatically at the appropriate location with this driver command. When in ''Driver'' mouse over the icon to find the new destination.

== Return to How To Index ==

[[HowToGuides]]

[[Category:How-to guides]]

HowTo/Implement a Destination Sign System

2013-11-11T23:15:51Z

Pev: /* Tram Car (or loco) Requirements */

== Introduction ==

This document was inspired by the release from NormP of Surfside Trams 2 for TS12. This is a fictional route with tramways on the Gold Coast in Australia. The Gold Coast is near Brisbane where trams were used up to 1972.

The Brisbane trams modelled by motorman1066 seemed appropriate to use on the route, so were added. To my surprise the destination boards for Brisbane appeared for use the session. Consequently, a set of destination boards was made for the Surfside Trams route, and this document details the steps required to get them to work.

== The Destination Boards ==

These work by script controlled texture replacement so the format and config.txt are important.

Motorman1066's trams all share the same destination boards for Brisbane, kuid2:108959:99901:2, and these are read into the tram script and provide an option selection from the properties button in surveyor. (more on this later)

To use this process on another route, eg Surfside Trams, a different set of destination signs is needed.

An asset with set of textures for the Gold Coast was built by cloning and editing motorman1066's Brisbane ones. In his case each texture has a destination name and route number. The two bits of data are separated by texture mapping and displayed on the destination sign and the route number sign as below.

[[File:Dest_Phoenix_PEV.jpg]]

Each texture looks as below.

[[File:Dest_sign_sample_PEV.jpg]]

In this case the boards are backlit at night with a white night mesh so the white text is transparent.

The Surfside destination boards are a small set with only 10 destinations. Here is the complete config.txt.

kuid <kuid:XXXXXX:YYYYYY>
username "SurfSideDestsignTextures"
kind "texture-group"
trainz-build 2.9

extensions
{
destnames-000000
{
0 "BLANK"
1 "SEA WORLD DEPOT"
2 "SEA WORLD"
3 "CAVILL AVE"
4 "SURFERS PARADISE"
5 "PRIMARY SCHOOL"
6 "BUNDALL"
7 "SOUTHPORT POOL"
8 "PACIFIC FAIR"
9 "PACIFIC FAIR DEPOT"
}
}

textures
{
0 "Blank.texture" [[File:Dest_texture0_PEV.jpg]]

1 "dest0.texture" [[File:Dest_texture1_PEV.jpg]]

2 "dest1.texture" [[File:Dest_texture2_PEV.jpg]]

3 "dest2.texture" [[File:Dest_texture3_PEV.jpg]]

4 "dest3.texture" [[File:Dest_texture4_PEV.jpg]]

5 "dest4.texture" [[File:Dest_texture5_PEV.jpg]]

6 "dest5.texture" [[File:Dest_texture6_PEV.jpg]]

7 "dest6.texture" [[File:Dest_texture7_PEV.jpg]]

8 "dest7.texture" [[File:Dest_texture8_PEV.jpg]]

9 "dest8.texture" [[File:Dest_texture9_PEV.jpg]]
}
category-class "JO"
category-era "1940s;1950s;1960s"
category-region "AU"
description "Destination signs for Normp's Surf-Side Trams.
Derived from destination boards for Motorman1066 Brisbane trams.
Developed from an original concept created by Peter Denhert."
author "motorman1066 amended by PEV"
license "etc"
organisation "Selz Tramz Workshopz 2006"

thumbnails
{
0
{
image "destination sign 240.jpg"
width 240
height 180
}
}

Note the kind must be "texture-group" and category class must be "JO" (Other Textures).
Also note the sub-container name in the "extensions" container. It must start with lower case "destnames-" as shown above. Put your own user ID number after it.

The tram script generates a selection table which shows the items listed in the "extensions" container as destination board options.

Selecting from the list chooses the texture of the same number. So, from the above config.txt, texture 1 (dest0.texture) is SEA WORLD DEPOT and so on.

== Tram Car (or loco) Requirements ==

In this case the trams were cloned from motorman1066's assets and the names changed to represent use by me on Surfside Trams route. The kuid-table is changed so that the asset for new destinations is included. See below:

The tram cars must be built to support texture replacement on the destination sign. The config.txt must have effects container named "destsign" in the mesh table as below.

mesh-table
{
default
{
mesh "554 body/554 body.lm"
auto-create 1

effects
{
destsign
{
kind "texture-replacement"
texture "texture dest.texture"
}
}
}
etc

kuid-table
{
bogey <kuid2:108959:50554:1>
enginesound <kuid2:108959:53554:1>
enginespec <kuid2:108959:51554:1>
hornsound <kuid2:108959:54554:1>
interior <kuid2:108959:55554:1>
product <kuid:-3:10060>
destsigntextures <kuid:329364:100013> ...... ''the new destination sign asset''
}

Additionally the kuid-table of the tram config.txt can have the entry "destsigntextures", as above though not essential, which calls the kuid of the destination sign asset above.

The "texture dest.texture" is a blank sign the same as the blank in the destination sign asset. It is located in the same folder as the parent mesh (in this case the 554 body folder.)

The tram assets in this case have a script (tram.gs) of class called "Tram". The script from Peter Dehnert provides the interface to select destinations in Surveyor and to communicate with the "Change Destination Sign To" rule [[File:Dest_change_sign_PEV.jpg]] allowing destinations to be changed by the driver AI.

== Using the Destination Sign System ==

Firstly we add the "DestsignTable" Rule to the Session (or route, depending on layer setting). We can choose to be in the session layer to make the sessions more flexible.

Press the Edit Session Rules Button [[File:Dest_Session_Edit_Button_PEV.jpg]] at the top left of the surveyor screen.

The Edit Session window will appear.

[[File:Dest_step01_PEV.jpg]]

Press the Add button to add a rule to the session.

The selection box for Rules will appear.

[[File:Dest_step02_PEV.jpg]]

Scroll down to find and select the "DestSignTable" rule.

The rule is added to the session as shown. This rule searches the session and route assets for kind "texture-group" assets and builds a table of such assets. It also adds the "Change Destination to" [[File:Dest_change_sign_PEV.jpg]] to the driver command menu.

[[File:Dest_step01a_PEV.jpg]]

Select the "DestSignTable" rule from the Edit Session box and Press the Edit Button (circled in the image above). The Rule properties box is displayed.

[[File:Dest_step07_PEV.jpg]]

Ensure that ''Enable industries/station as destination'' and ''Enable trackmarks as destinations'' are '''not''' checked (ticked) and that ''Enable table of destinations'' is checked (ticked) as shown.

Click on '''Import destinations from texture-group'''. The "Select texture-group" box will be displayed.

[[File:Dest_step08_PEV.jpg]]

Select the appropriate texture group.. in this case "SurfSideDestTextures".

A list of destinations will be added as below.

[[File:Dest_step09_PEV.jpg]]

Accept the edits by clicking on the check (tick) button on the above windows.

This completes the set up of the "DestSignTable" rule; we can now add trams to our session.

== We Have Added a Tram ==

When we have placed the tram car on a track in Trainz Surveyor, press the properties button in the rolling stock tab,

[[File:Dest_Properties_button_PEV.jpg]]

and left click on the tram itself. The tram properties window appears where we can add a running number and enable our destination list.

[[File:Dest_step03_PEV.jpg]]

The circled text is the name of the texture-group for our destination sign.

If the texture group is incorrect, left click on the text and "Select texture-group" box will appear allowing us to change the texture group to "SurfSideDestsignTextures" as previously.

[[File:Dest_step08_PEV.jpg]]

We can also select a destination sign immediately if desired by left clicking Destination text as shown.

[[File:Dest_step05_PEV.jpg]]

The Destination selection box is displayed allowing us to choose an appropriate destination.

[[File:Dest_step11_PEV.jpg]]

The Driver AI can be used to change destination signs at any time. Click on the green arrow to insert a driver command. From the menu choose "Change Destination To" and select a destination from the drop down menu.

[[File:Dest_step12_PEV.jpg]]

The destinations can change automatically at the appropriate location with this driver command. When in ''Driver'' mouse over the icon to find the new destination.

== Return to How To Index ==

[[HowToGuides]]

[[Category:How-to guides]]

KIND Texture-group

2013-11-11T00:50:42Z

Pev: /* Example Config.txt */ Link to Destination Sign added

[[KIND Texture-group]] defines a group of textures as an asset that can be referenced from another asset or via scripting.

[[Image:Example.jpg]]

==KIND Hierarchy==
===Parent Classes===
* [[KIND TrainzBaseSpec]]
===Child Classes===
* ''none.''

==Supported Tags==
''TBD''

==Example Config.txt==

kuid <kuid:171456:100034>
trainz-build 2.5
category-class "JO"
category-region "AU"
category-era "1810s"
username "testTextureGroup"
kind "texture-group"
description "Test texture group."
textures
{
0 "1.bmp"
1 "2.bmp"
2 "3.bmp"
}
thumbnails
{
0
{
image "thumb.jpg"
width 240
height 180
}
}
An example for the use of "texture-group" is a destination board system. See [[HowTo/Implement_a_Destination_Sign_System|How to Implement a Destination Sign System]].

==Categories==
[[Category:Asset KIND]]
[[Category:TBD]]

HowTo/Add Carz Traffic to a Route

2013-11-11T00:20:17Z

Pev: /* Adding Carz to a Route Using a Region */ TS12 reference added

==Adding Car Traffic to a Route==

There are two ways to add carz to routes to enable them for traffic. Both involve adding lists of kuids for carz to config.txt files.

Trainz reads the car0, car1, car2 etc tags in the route config.txt and the region config.txt specified for that route, to build a list of carz to randomly spawn onto the roads that are traffic enabled.

==Adding Carz to a Route Using a Region==

If you have a route that has no region specified you can add a car enabled region by just adding/editing the region tag in the config.txt. Before adding the region, open it in Content Manager and inspect the config.txt. It should have a list of car entries starting a car0 and be an unbroken incremented list car0, car1, car2, etc. If there is a gap in the car numbering the car number before the gap will be the last car added. Those following the gap will be ignored.

An example of the config.txt of kind "region":-

username "Queensland Region"
kuid <kuid:XXXXXX:YYYY>
category-region "AU"
category-era "1970s;1980s;1990s;2000s;2010s"
kind "region"
watercolor 154,104,53
defaultjunction 100633
ontheright 0
longitude 153,2,1
latitude 27,28,-1
altitude 0
car0 <kuid:329364:1514> .............''kuid of car best obtained by using CCP''
car1 <kuid:60238:29>
car2 <kuid:60238:33>
''without any gaps in the car# list up to''
car13 <kuid:-1:100527>
car14 <kuid2:329364:1189:2>
car15 <kuid:-1:36>
category-class "YX"
trainz-build 2.9
thumbnails
{
0
{
image "qld_region.jpg"
width 240
height 180
}
}
kuid-table
{
''all the kuid's above except for the kuid of this asset''
}

The carz to be added need to be the latest type with a trackside tag to work in TS2010 or TS12, refer to [[HowTo/Build a Car for Traffic (stand-alone version)]]

If your region has a car list then it can be used to add those carz to a route by adding the region tag to the route's config.txt as follows:-

region <kuid:XXXXXX:YYYY> ..............''the kuid of your region''
carrate 4 ..............''an integer 3 to 50 in value to control''
''the delay between cars being spawned''
''(smaller value means more carz)''
ontheright 1 ..............''for countries where we drive on the''
''right hand side of the road''

==Adding Carz to a Route Directly==

You can add a car list to a route to either enable cars or add more cars than specified in the region. Again the list must be an unbroken list starting at car0.

Here is the config.txt of a test route used to test the carz in the list.

region <kuid:-1:7801>
category-era "1800s"
category-class "ZX"
category-region "00"
car0 <kuid:329364:1574>
car1 <kuid:329364:1575>
car2 <kuid:329364:1576>
car3 <kuid:329364:1577>
car4 <kuid:329364:1578>
car5 <kuid:329364:1579>
car6 <kuid:329364:1565>
car7 <kuid:329364:1569>
car8 <kuid:329364:1558>
kuid <kuid:329364:100020>
kind "map"
username "Test"
workingscale 0
workingunits 0
water <kuid:-1:6342>
description
trainz-build 3.3
world-origin
{
latitude 27,28,-1
longitude 153,2,1
altitude 0
}
string-table
{
}
kuid-table
{
}

[[Content Creator Plus]] (CCP) is the easy way to add carz to the route.
Note that the carz must be category-class "VL" (land vehicles) for this to work.

From [[Content Manager]] select '''Edit in Content Creator Plus''' and CCP will open.

[[Image:AddingCarz001.jpg]]

Right Click on '''Map''' in the top left corner of the program window to open a pop-up menu.

[[Image:AddingCarz002.jpg]]

From the menu select '''car0'''. An empty car0 entry will appear in the RHS pane of the CCP window.

[[Image:AddingCarz003.jpg]]

Left Click on the Browse button (3 dots on the button). The '''KUID Browser''' will open displaying a list of "scenery" items. Unfortunately there is a bug in CCP so only built-in items are listed. Click on the arrow next to "scenery" and select "(automatic)" from the drop down list. (It's at the top of the list) The list will now contain all appropriate assets installed in the asset database.

[[Image:AddingCarz004.jpg]]

Select a car from the KUID Browser list. It will appear as car0 in the RHS pane of CCP.

'''Note''' that when we right click on the Map entry there is NO car selection on the pop-up menu. A little creative thinking is needed here.

Save and close the route from CCP.

Then from Content Manager, select the route and from the right click menu select '''Edit in Explorer''' and open the config.txt in NotePad. Find the car0 entry and add empty car entries as follows:-

car0 <kuid:XXXXX:YYYY>
car1
car2
car3
car3
car4
''etc for the number of carz you desire.''

Save and Close from NotePad.

In Content Manager select '''Edit in Content Creator Plus''' and CCP will open again.

This time we will have empty car# entries that can be populated with the '''KUID Browser''' as above.

[[Image:AddingCarz005.jpg]]

When done save and close from CCP.

The route will now be ready to use with traffic.

'''Note''' that the same CCP procedure can be used to add the car list to a region.

If you do not add a "carrate" entry to the route config.txt, the game will use the default value of 5.

If you do not add a "ontheright" entry to the route config.txt, the game will use the default value of 0 (boolean false); meaning the carz will drive on the LHS of the roads as in UK, Australia, Japan etc.

== Return to How To Index ==

[[HowToGuides]]

[[Category:How-to guides]]

HowTo/Implement a Destination Sign System

2013-08-28T05:06:19Z

Pev:

== Introduction ==

This document was inspired by the release from NormP of Surfside Trams 2 for TS12. This is a fictional route with tramways on the Gold Coast in Australia. The Gold Coast is near Brisbane where trams were used up to 1972.

The Brisbane trams modelled by motorman1066 seemed appropriate to use on the route, so were added. To my surprise the destination boards for Brisbane appeared for use the session. Consequently, a set of destination boards was made for the Surfside Trams route, and this document details the steps required to get them to work.

== The Destination Boards ==

These work by script controlled texture replacement so the format and config.txt are important.

Motorman1066's trams all share the same destination boards for Brisbane, kuid2:108959:99901:2, and these are read into the tram script and provide an option selection from the properties button in surveyor. (more on this later)

To use this process on another route, eg Surfside Trams, a different set of destination signs is needed.

An asset with set of textures for the Gold Coast was built by cloning and editing motorman1066's Brisbane ones. In his case each texture has a destination name and route number. The two bits of data are separated by texture mapping and displayed on the destination sign and the route number sign as below.

[[File:Dest_Phoenix_PEV.jpg]]

Each texture looks as below.

[[File:Dest_sign_sample_PEV.jpg]]

In this case the boards are backlit at night with a white night mesh so the white text is transparent.

The Surfside destination boards are a small set with only 10 destinations. Here is the complete config.txt.

kuid <kuid:XXXXXX:YYYYYY>
username "SurfSideDestsignTextures"
kind "texture-group"
trainz-build 2.9

extensions
{
destnames-000000
{
0 "BLANK"
1 "SEA WORLD DEPOT"
2 "SEA WORLD"
3 "CAVILL AVE"
4 "SURFERS PARADISE"
5 "PRIMARY SCHOOL"
6 "BUNDALL"
7 "SOUTHPORT POOL"
8 "PACIFIC FAIR"
9 "PACIFIC FAIR DEPOT"
}
}

textures
{
0 "Blank.texture" [[File:Dest_texture0_PEV.jpg]]

1 "dest0.texture" [[File:Dest_texture1_PEV.jpg]]

2 "dest1.texture" [[File:Dest_texture2_PEV.jpg]]

3 "dest2.texture" [[File:Dest_texture3_PEV.jpg]]

4 "dest3.texture" [[File:Dest_texture4_PEV.jpg]]

5 "dest4.texture" [[File:Dest_texture5_PEV.jpg]]

6 "dest5.texture" [[File:Dest_texture6_PEV.jpg]]

7 "dest6.texture" [[File:Dest_texture7_PEV.jpg]]

8 "dest7.texture" [[File:Dest_texture8_PEV.jpg]]

9 "dest8.texture" [[File:Dest_texture9_PEV.jpg]]
}
category-class "JO"
category-era "1940s;1950s;1960s"
category-region "AU"
description "Destination signs for Normp's Surf-Side Trams.
Derived from destination boards for Motorman1066 Brisbane trams.
Developed from an original concept created by Peter Denhert."
author "motorman1066 amended by PEV"
license "etc"
organisation "Selz Tramz Workshopz 2006"

thumbnails
{
0
{
image "destination sign 240.jpg"
width 240
height 180
}
}

Note the kind must be "texture-group" and category class must be "JO" (Other Textures).
Also note the sub-container name in the "extensions" container. It must start with lower case "destnames-" as shown above. Put your own user ID number after it.

The tram script generates a selection table which shows the items listed in the "extensions" container as destination board options.

Selecting from the list chooses the texture of the same number. So, from the above config.txt, texture 1 (dest0.texture) is SEA WORLD DEPOT and so on.

== Tram Car (or loco) Requirements ==

In this case the trams were cloned from motorman1066's assets and the names changed to represent use by me on Surfside Trams route. The kuid-table is changed so that the asset for new destinations is included. See below:

The tram cars must be built to support texture replacement on the destination sign. The config.txt must have effects container named "destsign" in the mesh table as below.

mesh-table
{
default
{
mesh "554 body/554 body.lm"
auto-create 1

effects
{
destsign
{
kind "texture-replacement"
texture "texture dest.texture"
}
}
}
etc

kuid-table
{
bogey <kuid2:108959:50554:1>
enginesound <kuid2:108959:53554:1>
enginespec <kuid2:108959:51554:1>
hornsound <kuid2:108959:54554:1>
interior <kuid2:108959:55554:1>
product <kuid:-3:10060>
destsigntextures <kuid:329364:100013> ...... ''the new destination sign asset''
}

Additionally the kuid-table of the tram config.txt must have the entry "destsigntextures", as above, which calls the kuid of the destination sign asset above.

The "texture dest.texture" is a blank sign the same as the blank in the destination sign asset. It is located in the same folder as the parent mesh (in this case the 554 body folder.)

The tram assets in this case have a script (tram.gs) of class called "Tram". The script from Peter Dehnert provides the interface to select destinations in Surveyor and to communicate with the "Change Destination Sign To" rule [[File:Dest_change_sign_PEV.jpg]] allowing destinations to be changed by the driver AI.

== Using the Destination Sign System ==

Firstly we add the "DestsignTable" Rule to the Session (or route, depending on layer setting). We can choose to be in the session layer to make the sessions more flexible.

Press the Edit Session Rules Button [[File:Dest_Session_Edit_Button_PEV.jpg]] at the top left of the surveyor screen.

The Edit Session window will appear.

[[File:Dest_step01_PEV.jpg]]

Press the Add button to add a rule to the session.

The selection box for Rules will appear.

[[File:Dest_step02_PEV.jpg]]

Scroll down to find and select the "DestSignTable" rule.

The rule is added to the session as shown. This rule searches the session and route assets for kind "texture-group" assets and builds a table of such assets. It also adds the "Change Destination to" [[File:Dest_change_sign_PEV.jpg]] to the driver command menu.

[[File:Dest_step01a_PEV.jpg]]

Select the "DestSignTable" rule from the Edit Session box and Press the Edit Button (circled in the image above). The Rule properties box is displayed.

[[File:Dest_step07_PEV.jpg]]

Ensure that ''Enable industries/station as destination'' and ''Enable trackmarks as destinations'' are '''not''' checked (ticked) and that ''Enable table of destinations'' is checked (ticked) as shown.

Click on '''Import destinations from texture-group'''. The "Select texture-group" box will be displayed.

[[File:Dest_step08_PEV.jpg]]

Select the appropriate texture group.. in this case "SurfSideDestTextures".

A list of destinations will be added as below.

[[File:Dest_step09_PEV.jpg]]

Accept the edits by clicking on the check (tick) button on the above windows.

This completes the set up of the "DestSignTable" rule; we can now add trams to our session.

== We Have Added a Tram ==

When we have placed the tram car on a track in Trainz Surveyor, press the properties button in the rolling stock tab,

[[File:Dest_Properties_button_PEV.jpg]]

and left click on the tram itself. The tram properties window appears where we can add a running number and enable our destination list.

[[File:Dest_step03_PEV.jpg]]

The circled text is the name of the texture-group for our destination sign.

If the texture group is incorrect, left click on the text and "Select texture-group" box will appear allowing us to change the texture group to "SurfSideDestsignTextures" as previously.

[[File:Dest_step08_PEV.jpg]]

We can also select a destination sign immediately if desired by left clicking Destination text as shown.

[[File:Dest_step05_PEV.jpg]]

The Destination selection box is displayed allowing us to choose an appropriate destination.

[[File:Dest_step11_PEV.jpg]]

The Driver AI can be used to change destination signs at any time. Click on the green arrow to insert a driver command. From the menu choose "Change Destination To" and select a destination from the drop down menu.

[[File:Dest_step12_PEV.jpg]]

The destinations can change automatically at the appropriate location with this driver command. When in ''Driver'' mouse over the icon to find the new destination.

== Return to How To Index ==

[[HowToGuides]]

[[Category:How-to guides]]

HowTo/Implement a Destination Sign System

2013-08-28T05:05:38Z

Pev:

== Introduction ==

This document was inspired by the release from NormP of Surfside Trams 2 for TS12. This is a fictional route with tramways on the Gold Coast in Australia. The Gold Coast is near Brisbane where trams were used up to 1972.

The Brisbane trams modelled by motorman1066 seemed appropriate to use on the route, so were added. To my surprise the destination boards for Brisbane appeared for use the session. Consequently, a set of destination boards was made for the Surfside Trams route, and this document details the steps required to get them to work.

== The Destination Boards ==

These work by script controlled texture replacement so the format and config.txt are important.

Motorman1066's trams all share the same destination boards for Brisbane, kuid2:108959:99901:2, and these are read into the tram script and provide an option selection from the properties button in surveyor. (more on this later)

To use this process on another route, eg Surfside Trams, a different set of destination signs is needed.

An asset with set of textures for the Gold Coast was built by cloning and editing motorman1066's Brisbane ones. In his case each texture has a destination name and route number. The two bits of data are separated by texture mapping and displayed on the destination sign and the route number sign as below.

[[File:Dest_Phoenix_PEV.jpg]]

Each texture looks as below.

[[File:Dest_sign_sample_PEV.jpg]]

In this case the boards are backlit at night with a white night mesh so the white text is transparent.

The Surfside destination boards are a small set with only 10 destinations. Here is the complete config.txt.

kuid <kuid:XXXXXX:YYYYYY>
username "SurfSideDestsignTextures"
kind "texture-group"
trainz-build 2.9

extensions
{
destnames-000000
{
0 "BLANK"
1 "SEA WORLD DEPOT"
2 "SEA WORLD"
3 "CAVILL AVE"
4 "SURFERS PARADISE"
5 "PRIMARY SCHOOL"
6 "BUNDALL"
7 "SOUTHPORT POOL"
8 "PACIFIC FAIR"
9 "PACIFIC FAIR DEPOT"
}
}

textures
{
0 "Blank.texture" [[File:Dest_texture0_PEV.jpg]]

1 "dest0.texture" [[File:Dest_texture1_PEV.jpg]]

2 "dest1.texture" [[File:Dest_texture2_PEV.jpg]]

3 "dest2.texture" [[File:Dest_texture3_PEV.jpg]]

4 "dest3.texture" [[File:Dest_texture4_PEV.jpg]]

5 "dest4.texture" [[File:Dest_texture5_PEV.jpg]]

6 "dest5.texture" [[File:Dest_texture6_PEV.jpg]]

7 "dest6.texture" [[File:Dest_texture7_PEV.jpg]]

8 "dest7.texture" [[File:Dest_texture8_PEV.jpg]]

9 "dest8.texture" [[File:Dest_texture9_PEV.jpg]]
}
category-class "JO"
category-era "1940s;1950s;1960s"
category-region "AU"
description "Destination signs for Normp's Surf-Side Trams.
Derived from destination boards for Motorman1066 Brisbane trams.
Developed from an original concept created by Peter Denhert."
author "motorman1066 amended by PEV"
license "etc"
organisation "Selz Tramz Workshopz 2006"

thumbnails
{
0
{
image "destination sign 240.jpg"
width 240
height 180
}
}

Note the kind must be "texture-group" and category class must be "JO" (Other Textures).
Also note the sub-container name in the "extensions" container. It must start with lower case "destnames-" as shown above. Put your own user ID number after it.

The tram script generates a selection table which shows the items listed in the "extensions" container as destination board options.

Selecting from the list chooses the texture of the same number. So, from the above config.txt, texture 1 (dest0.texture) is SEA WORLD DEPOT and so on.

== Tram Car (or loco) Requirements ==

In this case the trams were cloned from motorman1066's assets and the names changed to represent use by me on Surfside Trams route. The kuid-table is changed so that the asset for new destinations is included. See below:

The tram cars must be built to support texture replacement on the destination sign. The config.txt must have effects container named "destsign" in the mesh table as below.

mesh-table
{
default
{
mesh "554 body/554 body.lm"
auto-create 1

effects
{
destsign
{
kind "texture-replacement"
texture "texture dest.texture"
}
}
}
etc

kuid-table
{
bogey <kuid2:108959:50554:1>
enginesound <kuid2:108959:53554:1>
enginespec <kuid2:108959:51554:1>
hornsound <kuid2:108959:54554:1>
interior <kuid2:108959:55554:1>
product <kuid:-3:10060>
destsigntextures <kuid:329364:100013> ...... ''the new destination sign asset''
}

Additionally the kuid-table of the tram config.txt must have the entry "destsigntextures", as above, which calls the kuid of the destination sign asset above.

The "texture dest.texture" is a blank sign the same as the blank in the destination sign asset. It is located in the same folder as the parent mesh (in this case the 554 body folder.)

The tram assets in this case have a script (tram.gs) of class called "Tram". The script from Peter Dehnert provides the interface to select destinations in Surveyor and to communicate with the "Change Destination Sign To" rule [[File:Dest_change_sign_PEV.jpg]] allowing destinations to be changed by the driver AI.

== Using the Destination Sign System ==

Firstly we add the "DestsignTable" Rule to the Session (or route, depending on layer setting). We can choose to be in the session layer to make the sessions more flexible.

Press the Edit Session Rules Button [[File:Dest_Session_Edit_Button_PEV.jpg]] at the top left of the surveyor screen.

The Edit Session window will appear.

[[File:Dest_step01_PEV.jpg]]

Press the Add button to add a rule to the session.

The selection box for Rules will appear.

[[File:Dest_step02_PEV.jpg]]

Scroll down to find and select the "DestSignTable" rule.

The rule is added to the session as shown. This rule searches the session and route assets for kind "texture-group" assets and builds a table of such assets. It also adds the "Change Destination to" [[File:Dest_change_sign_PEV.jpg]] to the driver command menu.

[[File:Dest_step01a_PEV.jpg]]

Select the "DestSignTable" rule from the Edit Session box and Press the Edit Button (circled in the image above). The Rule properties box is displayed.

[[File:Dest_step07_PEV.jpg]]

Ensure that ''Enable industries/station as destination'' and ''Enable trackmarks as destinations'' are '''not''' checked (ticked) and that ''Enable table of destinations'' is checked (ticked) as shown.

Click on '''Import destinations from texture-group'''. The "Select texture-group" box will be displayed.

[[File:Dest_step08_PEV.jpg]]

Select the appropriate texture group.. in this case "SurfSideDestTextures".

A list of destinations will be added as below.

[[File:Dest_step09_PEV.jpg]]

Accept the edits by clicking on the check (tick) button on the above windows.

This completes the set up of the "DestSignTable" rule; we can now add trams to our session.

== We Have Added a Tram ==

When we have placed the tram car on a track in Trainz Surveyor, press the properties button in the rolling stock tab,

[[File:Dest_Properties_button_PEV.jpg]]

and left click on the tram itself. The tram properties window appears where we can add a running number and enable our destination list.

[[File:Dest_step03_PEV.jpg]]

The circled text is the name of the texture-group for our destination sign.

If the texture group is incorrect, left click on the text and "Select texture-group" box will appear allowing us to change the texture group to "SurfSideDestsignTextures" as previously.

[[File:Dest_step08_PEV.jpg]]

We can also select a destination sign immediately if desired by left clicking Destination text as shown.

[[File:Dest_step05_PEV.jpg]]

The Destination selection box is displayed allowing us to choose an appropriate destination.

[[File:Dest_step11_PEV.jpg]]

The Driver AI can be used to change destination signs at any time. Click on the green arrow to insert a driver command. From the menu choose "Change Destination To" and select a destination from the drop down menu.

[[File:Dest_step12_PEV.jpg]]

The destinations can change automatically at the appropriate location with this driver command. When in ''Driver'' mouse over the icon to find the new destination.

== Return to How To Index ==

[[HowToGuides]]

[[Category:How-to guides]]

HowTo/Implement a Destination Sign System

2013-08-28T04:57:24Z

Pev: spacing adjusted

== Introduction ==

This document was inspired by the release from NormP of Surfside Trams 2 for TS12. This is a fictional route with tramways on the Gold Coast in Australia. The Gold Coast is near Brisbane where trams were used up to 1972.

The Brisbane trams modelled by motorman1066 seemed appropriate to use on the route, so were added. To my surprise the destination boards for Brisbane appeared for use the session. Consequently, a set of destination boards was made for the Surfside Trams route, and this document details the steps required to get them to work.

== The Destination Boards ==

These work by script controlled texture replacement so the format and config.txt are important.

Motorman1066's trams all share the same destination boards for Brisbane, kuid2:108959:99901:2, and these are read into the tram script and provide an option selection from the properties button in surveyor. (more on this later)

To use this process on another route, eg Surfside Trams, a different set of destination signs is needed.

An asset with set of textures for the Gold Coast was built by cloning and editing motorman1066's Brisbane ones. In his case each texture has a destination name and route number. The two bits of data are separated by texture mapping and displayed on the destination sign and the route number sign as below.

[[File:Dest_Phoenix_PEV.jpg]]

Each texture looks as below.

[[File:Dest_sign_sample_PEV.jpg]]

In this case the boards are backlit at night with a white night mesh so the white text is transparent.

The Surfside destination boards are a small set with only 10 destinations. Here is the complete config.txt.

kuid <kuid:XXXXXX:YYYYYY>
username "SurfSideDestsignTextures"
kind "texture-group"
trainz-build 2.9

extensions
{
destnames-000000
{
0 "BLANK"
1 "SEA WORLD DEPOT"
2 "SEA WORLD"
3 "CAVILL AVE"
4 "SURFERS PARADISE"
5 "PRIMARY SCHOOL"
6 "BUNDALL"
7 "SOUTHPORT POOL"
8 "PACIFIC FAIR"
9 "PACIFIC FAIR DEPOT"
}
}

textures
{
0 "Blank.texture" [[File:Dest_texture0_PEV.jpg]]

1 "dest0.texture" [[File:Dest_texture1_PEV.jpg]]

2 "dest1.texture" [[File:Dest_texture2_PEV.jpg]]

3 "dest2.texture" [[File:Dest_texture3_PEV.jpg]]

4 "dest3.texture" [[File:Dest_texture4_PEV.jpg]]

5 "dest4.texture" [[File:Dest_texture5_PEV.jpg]]

6 "dest5.texture" [[File:Dest_texture6_PEV.jpg]]

7 "dest6.texture" [[File:Dest_texture7_PEV.jpg]]

8 "dest7.texture" [[File:Dest_texture8_PEV.jpg]]

9 "dest8.texture" [[File:Dest_texture9_PEV.jpg]]
}
category-class "JO"
category-era "1940s;1950s;1960s"
category-region "AU"
description "Destination signs for Normp's Surf-Side Trams.
Derived from destination boards for Motorman1066 Brisbane trams.
Developed from an original concept created by Peter Denhert."
author "motorman1066 amended by PEV"
license "etc"
organisation "Selz Tramz Workshopz 2006"

thumbnails
{
0
{
image "destination sign 240.jpg"
width 240
height 180
}
}

Note the kind must be "texture-group" and category class must be "JO" (Other Textures).
Also note the sub-container name in the "extensions" container. It must start with lower case "destnames-" as shown above. Put your own user ID number after it.

The tram script generates a selection table which shows the items listed in the "extensions" container as destination board options.

Selecting from the list chooses the texture of the same number. So, from the above config.txt, texture 1 (dest0.texture) is SEA WORLD DEPOT and so on.

== Tram Car (or loco) Requirements ==

In this case the trams were cloned from motorman1066's assets and the names changed to represent use by me on Surfside Trams route. The kuid-table is changed so that the asset for new destinations is included. See below:

The tram cars must be built to support texture replacement on the destination sign. The config.txt must have effects container named "destsign" in the mesh table as below.

mesh-table
{
default
{
mesh "554 body/554 body.lm"
auto-create 1

effects
{
destsign
{
kind "texture-replacement"
texture "texture dest.texture"
}
}
}
etc

The "texture dest.texture" is a blank sign the same as the blank in the destination sign asset. It is located in the same folder as the parent mesh (in this case the 554 body folder.)

Additionally the kuid-table of the tram config.txt must have an entry "destsigntextures" which calls the kuid of the destination sign asset above.

The tram assets in this case have a script (tram.gs) of class called "Tram". The script from Peter Dehnert provides the interface to select destinations in Surveyor and to communicate with the "Change Destination Sign To" rule [[File:Dest_change_sign_PEV.jpg]] allowing destinations to be changed by the driver AI.

== Using the Destination Sign System ==

Firstly we add the "DestsignTable" Rule to the Session (or route, depending on layer setting). We can choose to be in the session layer to make the sessions more flexible.

Press the Edit Session Rules Button [[File:Dest_Session_Edit_Button_PEV.jpg]] at the top left of the surveyor screen.

The Edit Session window will appear.

[[File:Dest_step01_PEV.jpg]]

Press the Add button to add a rule to the session.

The selection box for Rules will appear.

[[File:Dest_step02_PEV.jpg]]

Scroll down to find and select the "DestSignTable" rule.

The rule is added to the session as shown. This rule searches the session and route assets for kind "texture-group" assets and builds a table of such assets. It also adds the "Change Destination to" [[File:Dest_change_sign_PEV.jpg]] to the driver command menu.

[[File:Dest_step01a_PEV.jpg]]

Select the "DestSignTable" rule from the Edit Session box and Press the Edit Button (circled in the image above). The Rule properties box is displayed.

[[File:Dest_step07_PEV.jpg]]

Ensure that ''Enable industries/station as destination'' and ''Enable trackmarks as destinations'' are '''not''' checked (ticked) and that ''Enable table of destinations'' is checked (ticked) as shown.

Click on '''Import destinations from texture-group'''. The "Select texture-group" box will be displayed.

[[File:Dest_step08_PEV.jpg]]

Select the appropriate texture group.. in this case "SurfSideDestTextures".

A list of destinations will be added as below.

[[File:Dest_step09_PEV.jpg]]

Accept the edits by clicking on the check (tick) button on the above windows.

This completes the set up of the "DestSignTable" rule; we can now add trams to our session.

== We Have Added a Tram ==

When we have placed the tram car on a track in Trainz Surveyor, press the properties button in the rolling stock tab,

[[File:Dest_Properties_button_PEV.jpg]]

and left click on the tram itself. The tram properties window appears where we can add a running number and enable our destination list.

[[File:Dest_step03_PEV.jpg]]

The circled text is the name of the texture-group for our destination sign.

If the texture group is incorrect, left click on the text and "Select texture-group" box will appear allowing us to change the texture group to "SurfSideDestsignTextures" as previously.

[[File:Dest_step08_PEV.jpg]]

We can also select a destination sign immediately if desired by left clicking Destination text as shown.

[[File:Dest_step05_PEV.jpg]]

The Destination selection box is displayed allowing us to choose an appropriate destination.

[[File:Dest_step11_PEV.jpg]]

The Driver AI can be used to change destination signs at any time. Click on the green arrow to insert a driver command. From the menu choose "Change Destination To" and select a destination from the drop down menu.

[[File:Dest_step12_PEV.jpg]]

The destinations can change automatically at the appropriate location with this driver command. When in ''Driver'' mouse over the icon to find the new destination.

== Return to How To Index ==

[[HowToGuides]]

[[Category:How-to guides]]

HowTo/Implement a Destination Sign System

2013-08-28T04:56:28Z

Pev: /* Tram Car (or loco) Requirements */ spelling fixed

== Introduction ==

This document was inspired by the release from NormP of Surfside Trams 2 for TS12. This is a fictional route with tramways on the Gold Coast in Australia. The Gold Coast is near Brisbane where trams were used up to 1972.

The Brisbane trams modelled by motorman1066 seemed appropriate to use on the route, so were added. To my surprise the destination boards for Brisbane appeared for use the session. Consequently, a set of destination boards was made for the Surfside Trams route, and this document details the steps required to get them to work.

== The Destination Boards ==

These work by script controlled texture replacement so the format and config.txt are important.

Motorman1066's trams all share the same destination boards for Brisbane, kuid2:108959:99901:2, and these are read into the tram script and provide an option selection from the properties button in surveyor. (more on this later)

To use this process on another route, eg Surfside Trams, a different set of destination signs is needed.

An asset with set of textures for the Gold Coast was built by cloning and editing motorman1066's Brisbane ones. In his case each texture has a destination name and route number. The two bits of data are separated by texture mapping and displayed on the destination sign and the route number sign as below.

[[File:Dest_Phoenix_PEV.jpg]]

Each texture looks as below.

[[File:Dest_sign_sample_PEV.jpg]]

In this case the boards are backlit at night with a white night mesh so the white text is transparent.

The Surfside destination boards are a small set with only 10 destinations. Here is the complete config.txt.

kuid <kuid:XXXXXX:YYYYYY>
username "SurfSideDestsignTextures"
kind "texture-group"
trainz-build 2.9

extensions
{
destnames-000000
{
0 "BLANK"
1 "SEA WORLD DEPOT"
2 "SEA WORLD"
3 "CAVILL AVE"
4 "SURFERS PARADISE"
5 "PRIMARY SCHOOL"
6 "BUNDALL"
7 "SOUTHPORT POOL"
8 "PACIFIC FAIR"
9 "PACIFIC FAIR DEPOT"
}
}

textures
{
0 "Blank.texture" [[File:Dest_texture0_PEV.jpg]]

1 "dest0.texture" [[File:Dest_texture1_PEV.jpg]]

2 "dest1.texture" [[File:Dest_texture2_PEV.jpg]]

3 "dest2.texture" [[File:Dest_texture3_PEV.jpg]]

4 "dest3.texture" [[File:Dest_texture4_PEV.jpg]]

5 "dest4.texture" [[File:Dest_texture5_PEV.jpg]]

6 "dest5.texture" [[File:Dest_texture6_PEV.jpg]]

7 "dest6.texture" [[File:Dest_texture7_PEV.jpg]]

8 "dest7.texture" [[File:Dest_texture8_PEV.jpg]]

9 "dest8.texture" [[File:Dest_texture9_PEV.jpg]]
}
category-class "JO"
category-era "1940s;1950s;1960s"
category-region "AU"
description "Destination signs for Normp's Surf-Side Trams.
Derived from destination boards for Motorman1066 Brisbane trams.
Developed from an original concept created by Peter Denhert."
author "motorman1066 amended by PEV"
license "etc"
organisation "Selz Tramz Workshopz 2006"

thumbnails
{
0
{
image "destination sign 240.jpg"
width 240
height 180
}
}

Note the kind must be "texture-group" and category class must be "JO" (Other Textures).
Also note the sub-container name in the "extensions" container. It must start with lower case "destnames-" as shown above. Put your own user ID number after it.

The tram script generates a selection table which shows the items listed in the "extensions" container as destination board options.

Selecting from the list chooses the texture of the same number. So, from the above config.txt, texture 1 (dest0.texture) is SEA WORLD DEPOT and so on.

== Tram Car (or loco) Requirements ==

In this case the trams were cloned from motorman1066's assets and the names changed to represent use by me on Surfside Trams route. The kuid-table is changed so that the asset for new destinations is included. See below:

The tram cars must be built to support texture replacement on the destination sign. The config.txt must have effects container named "destsign" in the mesh table as below.

mesh-table
{
default
{
mesh "554 body/554 body.lm"
auto-create 1

effects
{
destsign
{
kind "texture-replacement"
texture "texture dest.texture"
}
}
}
etc

The "texture dest.texture" is a blank sign the same as the blank in the destination sign asset. It is located in the same folder as the parent mesh (in this case the 554 body folder.)

Additionally the kuid-table of the tram config.txt must have an entry "destsigntextures" which calls the kuid of the destination sign asset above.

The tram assets in this case have a script (tram.gs) of class called "Tram". The script from Peter Dehnert provides the interface to select destinations in Surveyor and to communicate with the "Change Destination Sign To" rule [[File:Dest_change_sign_PEV.jpg]] allowing destinations to be changed by the driver AI.

== Using the Destination Sign System ==

Firstly we add the "DestsignTable" Rule to the Session (or route, depending on layer setting). We can choose to be in the session layer to make the sessions more flexible.

Press the Edit Session Rules Button [[File:Dest_Session_Edit_Button_PEV.jpg]] at the top left of the surveyor screen.

The Edit Session window will appear.

[[File:Dest_step01_PEV.jpg]]

Press the Add button to add a rule to the session.

The selection box for Rules will appear.

[[File:Dest_step02_PEV.jpg]]

Scroll down to find and select the "DestSignTable" rule.

The rule is added to the session as shown. This rule searches the session and route assets for kind "texture-group" assets and builds a table of such assets. It also adds the "Change Destination to" [[File:Dest_change_sign_PEV.jpg]] to the driver command menu.

[[File:Dest_step01a_PEV.jpg]]

Select the "DestSignTable" rule from the Edit Session box and Press the Edit Button (circled in the image above). The Rule properties box is displayed.

[[File:Dest_step07_PEV.jpg]]

Ensure that ''Enable industries/station as destination'' and ''Enable trackmarks as destinations'' are '''not''' checked (ticked) and that ''Enable table of destinations'' is checked (ticked) as shown.

Click on '''Import destinations from texture-group'''. The "Select texture-group" box will be displayed.

[[File:Dest_step08_PEV.jpg]]

Select the appropriate texture group.. in this case "SurfSideDestTextures".

A list of destinations will be added as below.

[[File:Dest_step09_PEV.jpg]]

Accept the edits by clicking on the check (tick) button on the above windows.

This completes the set up of the "DestSignTable" rule; we can now add trams to our session.

== We Have Added a Tram ==

When we have placed the tram car on a track in Trainz Surveyor, press the properties button in the rolling stock tab,

[[File:Dest_Properties_button_PEV.jpg]]

and left click on the tram itself. The tram properties window appears where we can add a running number and enable our destination list.

[[File:Dest_step03_PEV.jpg]]

The circled text is the name of the texture-group for our destination sign.

If the texture group is incorrect, left click on the text and "Select texture-group" box will appear allowing us to change the texture group to "SurfSideDestsignTextures" as previously.

[[File:Dest_step08_PEV.jpg]]

We can also select a destination sign immediately if desired by left clicking Destination text as shown.

[[File:Dest_step05_PEV.jpg]]

The Destination selection box is displayed allowing us to choose an appropriate destination.

[[File:Dest_step11_PEV.jpg]]

The Driver AI can be used to change destination signs at any time. Click on the green arrow to insert a driver command. From the menu choose "Change Destination To" and select a destination from the drop down menu.

[[File:Dest_step12_PEV.jpg]]

The destinations can change automatically at the appropriate location with this driver command. When in ''Driver'' mouse over the icon to find the new destination.

== Return to How To Index ==

[[HowToGuides]]

[[Category:How-to guides]]