Swedish Railtracks
------------------

This version: {{GRF_TITLE}}

Contents:

1 About
2 Usage
  2.1 Parameters
  2.2 Compatibility with other NewGRF
  2.3 Known bugs
3 Obtaining the source
4 License
5 Credits



-------
1 About
-------

This set provides a replacement for the rail infrastructure in Swedish style
while providing a number of graphical enhancements over the default tracks
which it will replace by default, but allows to be customized via parameters.

Swedish Rails is designed to work with OpenTTD 1.2.0 and later.

It provides completely snow - aware graphics for the rail track
infrastructure. Features include:
- snow-aware depots in an old and a modern style, different for electric
  and non-electric rails (see parameters).
- completely ground-tile independence for all graphics
- new level crossings which match every chosen road style
- optionally new tunnels portals (see parameters)
- choice of fences (see parameters)

Name of this Repo: {{GRF_TITLE}}
GRF_ID:            {{GRF_ID}}
MD5 sum:           {{GRF_MD5}}

Repository version: {{REPO_REVISION}}



-------
2 Usage
-------

You just select the NewGRF in the NewGRF config and enjoy it.



--------------
2.1 Parameters
--------------

No 1:   Introduction year for modern depots. The behaviour depends upon
        the game version used.
        Default: 1975

No 2:   Choice of rail fences
        0: (default) Use Swedish rail fences w/o company colour
		1: Use Swedish rail fences with company colour
		2: Use non company-coloured fences
		3: Use the OpenTTD default fences
		4: Use no fences

		+5: Apply this setting only for Swedish rails

        It is recommended to use in multiplayer games the company colour
        version of the fences. It allows to find the owner of a piece of
        track more easily.

No 3:   Introduction year for modern level crossings
        Default: same year as modern depots are introduced.

        From the given year on all level crossings will be converted to the
        modern version within a range of 15 years.
        Default: same year as modern depots are introduced.

No 4:   Level crossings
		0: (default) Swedish Rails level crossings
		1: Plain level crossings without bars and signs
		2: forbid building of level crossings

No. 5:  GUI replacements for rail toolbar and related cursors

		0: (default) no replacement (compatible with all base sets)
            strongly recommended for multiplayer games
		1: OpenGFX style
		2: TTD style

No. 6:  Railtype label to be replaced by the normal rail:
        Default: RAIL

        This parameter provides flexible compatibility with other railtype
        NewGRFs, namely NuTracks. It allows to choose a specific track type
        to feature the graphcis of this set

No. 7:  Railtype label to be replaced by the electrified rail:
        Default: ELRL

        This parameter provides flexible compatibility with other railtype
        NewGRFs, namely NuTracks. It allows to choose a specific track type
        to feature the graphcis of this set

No. 8:  Bridge overlay

        0: (default) Use same track sprites as on ground
        1: Use overlay track sprites only

        This parameter is provided only for support with possible future
        bridge sets which could allow the infrastructure NewGRFs to overlay
        the bridges with their own sprites and do NOT provide infrastructure
        drawn on bridges themselves (as currently ALL bridge NewGRFs as
        well as the default bridges do). It will look strange, if you use
        overlay sprites only with current (August 2012) bridges.



2.1 Compatibility with other NewGRF
-----------------------------------

- other railtypes newgrfs:
  When Swedish Rails is used concurrently with other railtypes newgrfs,
  conflicts may arise when both try to (re-)define the standard train
  tracks. The order of loading the newgrfs will matter. It should work
  nicely along with railtype NewGRFs which only define an additional track
  type or metro tracks, 3rdRail, or alike; but combine at your own risk.

  * Pikka's UK Narrow Gauge Railset is incompatible with Swedish Rails;
    they both define electrical and normal rails.

  * NuTracks (tested up to r112) works surprisingly well jointly with
    Swedish Rails. It will in the presence of NuTracks replace the old,
    slow tracks. Compatibility with future versions cannot be guaranteed.

- landscape newgrfs:
  Swedish Rails should work with any landscape newgrfs and without. It makes
  use of the tunnel overlay feature and tunnels as well as tracks should be
  drawn onto the normal ground sprites as appropriate.

- road newgrfs:

  Swedish Rails currently supports actively the default TTD and TTRS roads,
  you have to select proper support via parameter 1. When used in
  conjunction with other road sets, you'll experience glitches concerning
  level crossings as the road style might not be supported (yet). If a road
  set specifically supports Swedish Rails, you may want to load it after
  Swedish Rails.


2.2 Known Bugs
--------------
- [OTTD] Bridges show snowy or normal tracks, depending upon the height of
  the tile below it. There's currently not much we can do about it as there
  is no way to query the height of the bridge.
- [OTTD] Snowy version of the tracks is not chosen on tiles where the
  height of the lowest corner would correctly result in non-snowy versions
  (e.g. on tiles with slopes and / or foundations). This is sub-optimal
  handling of the height information within OpenTTD.



3 Obtaining the source
----------------------

The source code can be obtained from the #openttdcoop DevZone at
http://dev.openttdcoop.org/projects/swedishrails
or via mercurial checkout
hg clone http://dev.openttdcoop.org/projects/swedishrails



---------
4 License
---------

OpenGFX+ Trains trainset for OpenTTD and TTDPatch
Copyright (C) 2010-2011 by the OpenGFX+ Trains team (see below)

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 (or, at your
discretion, any later version) as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the
Free Software Foundation, Inc.
1 Franklin Street, Fifth Floor
Boston, MA 02110-1301
USA.



---------
5 Credits
---------

Coding: Ingo von Borstel (aka planetmaker)
Graphics: Irwe

Translations:
Croatian:      Voyager1
Dutch:         Yexo, ^Spike^, Transportman
English (US):  Supercheese
Finnish:       juzza1
Frensh:        arikover
German:        planetmaker
Hungarian:     zaza
Indonesian:    UseYourIllusion, Yoursnotmine
Luxembourgish: Phreeze
Norwegian:     Trond
Spanish:       Terkhen
Russian:       akasoft
Swedish:       Irwe, El'Muppo

Contact: planetmaker @ openttd.org

Special thanks to:
* Ammler who provides and works a lot on maintaining the DevZone where this
  repository is hosted and who also frequently gives much valuable input.
* Yexo, Hirundo and Alberth who stomped from ground in nearly no time the
  amazing newgrf language NML this project is written in and which is one
  of the reasons it could be created so quickly.
* DJ Nekkid for his idea of using the random bits in order to define a
  transition period for introduction of modern versions (depots and level
  crossings).
* michi_cc who made this NewGRF much simpler by introducing the tunnel
  overlay feature.
