Narrow Gauge rails readme

 - Replacement track graphics for TTD Patch and OpenTTD
 - Public release; version 0.93a

*******************************************************

What are the narrow gauge rails for?
------------------------------------

This grf is intended to provide a set of narrow gauge track to replace the original tracks in Transport Tycoon Deluxe (with Patch) or OpenTTD.

They can replace any of the three track types (rail, monorail, maglev) in three of the game's environments (temperate, arctic and tropic). Therefore one set of NG tracks can be used for any of the narrow gauge train sets released or in development. The grf will be deactivated in the toyland environment.

The narrow gauge rails grf also provides a new train depot to distinguish it further from the other rail types.

What narrow gauge train sets are there?
---------------------------------------

Current (known) narrow gauge train sets include:

 - UK Narrow Gauge set (http://users.tt-forums.net/narrowgauge/)
 - Narrow Gauge component of Canadian set (http://users2.tt-forums.net/danmack/CansetMain.html)
 - Narrow Gauge component of Serbian set (http://www.tt-forums.net/viewtopic.php?p=225245#225245)

Who drew the narrow gauge rails?
--------------------------------

The narrow gauge rails were drawn by Cornelius, but are based on the original TTD rails and no ownership of or copyright on the amended sprites is claimed.


How to install the narrow gauge rails
-------------------------------------

TTD Patch
=========

 - Configuring newgrf[w].cfg
 
The narrow gauge rails are available in Windows (ngrailsw.grf) and DOS (ngrails.grf) versions. Simply copy the grf file into the "newgrf" directory under your TTD main directory and add the entry "newgrf/ngrails[w].grf" to your "newgrf[w].cfg" file. 

You will need TTD Patch version 2.0.1 alpha 51 (or higher) to run this grf because it uses new features only available since this version. You can get the latest alpha version from http://www.ttdpatch.net/src/ if you don't have it already.

When active the narrow gauge rails will appear in all compatible climates. Simply turn them off in the new graphics menu to disable them in a particular game if not required.

The TTD Patch switch `tracktypecostdiff' should be set to 'on'. This allows ngrails[w].grf to adjust the track costs of narrow gauge rails, making them cheaper than normal rails. Note, if the Canadian set (cansetw.grf) is loaded, rail costs are not adjusted. The Canadian set uses its own rail cost adjustment scheme.

 - Supplying parameters to the narrow gauge rails grf
 
1st Parameter: Rail Type - To replace the desired rail type with narrow gauge rails you must add a parameter to the line in your newgrf[w].cfg file. These are as follows:

 ** ngrails[w].grf 1 ** Replace normal rails
 ** ngrails[w].grf 2 ** Replace monorail
 ** ngrails[w].grf 4 ** Replace maglev
 
If you do not supply a parameter the default behaviour is to replace normal rails.

The narrow gauge rails grf works co-operatively with the electrifiedrailway and unifiedmaglev patch switches, and the electrified railway graphics. If you set ngrails to parameter 1 with electrifiedrailway turned on, you will get standard and electrified narrow gauge. If you are also playing with unifiedmaglev set to 1 or 2, the narrow gauge rails used with parameter 2 *or* 4 will then occupy the third track slot.

Please refer to the TTDPatch manual (http://wiki.ttdpatch.net/tiki-index.php?page=Manual) for full documentation on how to use the electrifiedrailway and unifiedmaglev patch switches.

2nd Parameter: Long Depots - Enables depots to be placed inline without gaps in-between.

 ** ngrails[w].grf 4 0 ** Replace maglev tracks, use standard depots
 ** ngrails[w].grf 4 1 ** Replace maglev tracks, use long depots

If you do not supply a parameter the default is the original narrow gauge depot.

 - Parameters and train sets
 
Please refer to the documentation for any individual train set for advice on how to set the ngrails.grf parameter to work with that set.


OpenTTD
=======

Although ngrails[w].grf will work with OpenTTD version 0.5.0 and greater, it is recommended that version 0.6.0 is used to take advantage of the improved grf support.

 - Configuring newgrf[w].cfg
 
The narrow gauge rails are available in Windows (ngrailsw.grf) and DOS (ngrails.grf) versions. Simply copy the grf file into the "data" directory under your OpenTTD directory and select "Narrow gauge rails v0.93a" from the "NewGRF settings" window from the start screen. Set the required grf parameters (see below) using the "Set parameters" button, then press the "Apply changes" button.

When active the narrow gauge rails will appear in all compatible climates.

 - Supplying parameters to the narrow gauge rails grf
 
1st Parameter: Rail Type - To replace the desired rail type with narrow gauge rails you must add a parameter. Add the parameter from "Set parameters" in the "NewGRF settings" window

 ** 1 ** Replace normal rails and electrified rails
 ** 2 ** Replace monorail
 ** 4 ** Replace maglev
 
If you do not supply a parameter the default behaviour is to replace normal rails and electrified rails.

2nd Parameter: Long Depots - Enables depots to be placed inline without gaps in-between.

 ** 0 ** Use standard depots
 ** 1 ** Use long depots

If you do not supply a parameter the default is the original narrow gauge depot.

So, for example, to replace maglev track with narrow gauge and to use long depots, enter '4 1' in the "Set parameters" window (without the quote marks and note the space).

 - Parameters and train sets
 
Please refer to the documentation for any individual train set for advice on how to set the ngrails.grf parameter to work with that set.


Compatibility
-------------

 - Viaduct bridge
   --------------

The narrow gauge rails grf has support for PikkaBird’s viaduct bridge.

Note, pb_viaduct.grf must precede ngrails[w].grf in the config.

Thanks to PikkaBird for permission to use narrow gauge viaduct bridge sprites, based on his original viaduct sprites. 

 - Total Town Replacement Set Version 3
   ------------------------------------

The narrow gauge rails grf has support for the Total Town Replacement Set Version 3 (TTRS3), with narrow gauge level crossings for all TTRS3 road types.

Note, ttrs3w.grf must precede ngrails[w].grf in the config.

Thanks to Zimmlock for the narrow gauge level crossing sprites.


Known limitations of the narrow gauge rails grf
-----------------------------------------------

The following features are currently considered out of scope for the narrow gauge rails grf

 - Compatibility with non-standard road sets (except where stated above)
 - Guaranteed compatibility with new bridge sets or tunnel mouths
 - Use with the Toyland environment
 - Incorrect base tiles if used with Alpine Climate
 
If you wish to supply your own graphics to remedy any of these restrictions please comment in the release thread on www.tt-forums.net (www.tt-forums.net/viewtopic.php?t=19888). Other suggestions may also be made in the forums.

OpenTTD does not support changing of generic texts [as of version 0.6.0] so narrow gauge rail windows still show the text "maglev" or "monorail" when these rail types are replaced by narrow gauge.

History
-------

0.93a
 - Bugfix: 3rd parameter of TTRS3 was ignored causing TTRS3 road crossings to appear even when TTRS3 roads were disabled.
 - Bugfix: incorrect operation when parameter = 1.

0.93

 - Support for TTRS3 added. Narrow gauge level crossings for all TTRS3 road types.
 - German translations added.
 - French translations added.
 - Bug fixed where snow-in-temperate had snowy tiles with the wrong track type.
 - Sprite offset problem with some bridge ramps fixed.
 - Sprite offset problem with NW facing long depot fixed.
 - Narrow gauge button and cursor sprites for OpenTTD are now working again. Note, requires version 0.6.0 r11433 or greater.
 - Adjusted rail costs now working for OpenTTD. Note, requires version 0.6.0 r11265 or greater.

0.92

 - OpenTTD compatibility - maglev track is correctly replaced when parameter = 4
 - Narrow gauge button and cursor sprites for OpenTTD’s Autorail and Rail Replace tools.
 - Narrow gauge depot button and cursor sprites (works in OpenTTD only)
 - Support for PikkaBird’s viaduct bridge. 
 - Replacement of  station sprites  (monorail or maglev) for narrow gauge in OpenTTD (not active for TTDPatch as standard station is used for all rail types).
 - Adjusted rail costs for narrow gauge rails.
 - Narrow gauge rails are deactivated for the Toyland climate.
 - Optional long depots, enables depots to be placed inline without gaps in-between. 
 - Bug fixed where centre section of a 5 tile long suspension bridge, showed the wrong track type.

0.91
 
 - Arctic snow rails corrected

0.9

 - Public beta version

Credits
-------

Cornelius - Narrow gauge rails artwork, coding to v0.91
mart3p - OpenTTD support and other updates, coding from v0.92
PikkaBird - Viaduct bridge original artwork
Zimmlock - TTRS3 level crossing artwork
Carlo Ghega - German translation
wallyweb - French translation

Also, thanks to:
Wile E. Coyote - Testing
wallyweb - Testing and suggestions

Notes
-----

This readme document was based on that used for the US Transition Set, but created independently.

The GRF ID for ngrails[w].grf is 73 66 02 01