minchinweb / openttd-progressive-rail Goto Github PK

Progressive Rail Set README
===============================================================================
v.2, 2013-01-12  
Copyright © 2012-13 by W. Minchin. For more info, please visit
	<http://minchin.ca/openttd-progressive-rail/>
	
About Progressive Rail Set
-------------------------------------------------------------------------------	
The **Progressive Rail Set** is a NewGRF that serves to make upgrading of
    larger, advanced rail systems easier. Assuming a progression of *Normal
    Rail* -> *Electric Rail* -> *Monorail* -> *Maglev* -> *Vacuum Tube*, an 
    engine can now run (unpowered) on the generation of rail before it and run 
    powered on its "normal rail" and the next generation of rail.

Requirements
-------------------------------------------------------------------------------
The **Progressive Rail Set** requires OpenTTD, which is a free download from
    <http://www.openttd.org/>. The Set has been tested on OpenTTD 1.2.3, but 
    will likely work on earlier versions.

If you want to use Vacuum Tube tracks, you'll use a separate NewGRF to provide
    them.

Installation
-------------------------------------------------------------------------------
The easiest (and recommended) way to install the Set is use OpenTTD's `Check
    Online Content` interface. Search for `Progressive Rail Set`. This also 
    makes it very easy for me to provide updates.

Manual installation can be accomplished by putting the `progressive_rail_x.grf`
    file you downloaded in the  `..\OpenTTD\newgrf`  folder.

Once installed, the Set can be selected through `NewGRF Settings` on OpenTTD's
    main interface.

Settings
-------------------------------------------------------------------------------
There are no settings for the Set.

Version History
-------------------------------------------------------------------------------
Version 2 [2013-01-12]
 : Different colours for different railtypes on the minimap
Version 1 [2012-11-03]
 : Initial implementation
 : Supports normal rails, electrified rails, monorail, maglev and vacuum tube

See the attached CHANGELOG.txt for full version history.

Roadmap
-------------------------------------------------------------------------------
At this time, I think the Set is feature complete, so I am not adding any
    additional features.

Known Issues
-------------------------------------------------------------------------------
 * Vacuum Tube tracks have to be supplied by a separate NewGRF

Compile It Yourself
-------------------------------------------------------------------------------
To compile it yourself, you'll need
[NML](http://bundles.openttdcoop.org/nml/nightlies/LATEST/). Then run from the
command line (after fixing the paths as needed):
`nmlc progressive_rails.nml --grf=progressive_rails.grf`

Help! It broke! (Bug Report)
-------------------------------------------------------------------------------
If the Set brakes or doesn't work the way you'd expect, please report the bug
to:
............... <https://github.com/MinchinWeb/openttd-progressive-rail/issues>

Helpful Links
-------------------------------------------------------------------------------
Get OpenTTD! ......................................... <http://www.openttd.org>  
TT-Forums - all things Transport Tycoon related .... <http://www.tt-forums.net>  
The Set's thread on TT-Forums: release announcements, bug reports, suggestions,
and general commentary  
......................... <http://www.tt-forums.net/viewtopic.php?f=65&t=63182>  
The Set on GitHub: source code  
..................... <https://github.com/MinchinWeb/openttd-progressive-rail/>  
To report issues:  
............... <https://github.com/MinchinWeb/openttd-progressive-rail/issues>  

My other projects (for OpenTTD):  
WmDOT ................... <http://www.tt-forums.net/viewtopic.php?f=65&t=53698>  
MinchinWeb's MetaLibrary (for AIs)  
......................... <http://www.tt-forums.net/viewtopic.php?f=65&t=57903>  
Alberta Town Names ...... <http://www.tt-forums.net/viewtopic.php?f=67&t=53313>  
MinchinWeb's Random Town Name Generator  
......................... <http://www.tt-forums.net/viewtopic.php?f=67&t=53579>  

Licence
-------------------------------------------------------------------------------
The Progressive Rail Set is licensed under a Creative Commons-Attribution 3.0
    licence.

<!-- This file looks best when rendered as Markdown -->