========================================================================
{{GRF_TITLE}}
========================================================================

1 About
  1.1 Version Requirements
2 Parameters
3 Detailed Description
  3.1 Animated Stations
  3.2 Station Layout
  3.3 Cargo Display on Station Tiles
  3.4 Buffers
4 Bug Reports
5 Translations
6 Known Issues
7 License
8 Credits



1 About
=======

The Ore Unloading Station for OpenTTD.

Features include animation of the cranes, ore trolleys etc. Most
animations are triggered by activity at the station, such as trains
arriving/leaving and cargo being delivered. Non-track tiles are included
that display cargo waiting at the station.


1.1 Version Requirements
------------------------

OpenTTD 1.2.0 or newer.

TTDPatch is not supported.



2 Parameters
============

1) Rail style
    0: TTD style rail overlay graphics (default)
    1: OpenGFX style rail overlay graphics

Set this parameter to suit the base set graphics used.



3 Detailed Description
======================

3.1 Animated Stations
---------------------

Animations that span multiple tiles (the cranes and the ore trolleys)
require some special considerations when modifying the station. If
over-building or removing tiles from an animation, it is advisable to
remove or overbuild all the tiles of the animation (i.e. the whole
platform). Graphical errors may occur otherwise.



3.2 Station Layout
----------------------

It is intended that the non-track ore bins are built 2 tiles shorter
than the ore hoist platforms. 

i.e.

 -----------------
 |H|H|H|H|H|H|H|H|
 -----------------
   |B|B|B|B|B|B|
 -----------------
 |H|H|H|H|H|H|H|H|
 -----------------

There is nothing to stop other arrangements being built but the platform 
buildings need to align with the ore-bin building, for them to connect
together as designed.



3.3 Cargo Display on Station Tiles
----------------------------------

When used as an unloading station, the amount of cargo displayed in the
ore storage bins, depends on when cargo was last delivered to the
station. When used as a loading station, the amount of cargo displayed,
depends on the amount of cargo waiting at the station.



3.4 Buffers
-----------

The north/south orientation of the buffers is automatically controlled
by the direction of connected rails or platforms. If there is a track
that the buffer can connect to, it will orientate itself in the
direction of the track. If there is track both sides of the buffer, a
back-to-back double buffer will be used.



4 Bug Reports
=============

Please report any bugs found to the Transport Tycoon forum in the
Ore Unloading Station topic
(http://www.tt-forums.net/viewtopic.php?f=26&t=71446) or at the DevZone
issue tracker (https://dev.openttdcoop.org/projects/iorestat/issues)



5 Translations
==============

Translations are always welcome. Please request a list of strings for
translation in the TT Forum Ore Unloading Station topic
(http://www.tt-forums.net/viewtopic.php?f=26&t=71446)



6 Known Issues
==============

Some railtypes GRFs have features that lie outside of the normal track
width, e.g. the third rail of the Metro Track from the Metro Track Set
(metrotrackset.grf). Due to the way that the ore unloading station uses
track overlays with some transparency, these features will be only
partially visible.

Some versions of OpenTTD (including 1.2.3) have an issue (FS#5335) that
prevents stations from using snow and desert ground tiles. This was
fixed at r24715 and works correctly in OpenTTD 1.3.0.

Animation triggers for double track cranes only work for one platform.

There is only limited support for monorail and maglev.



7 Licensing
===========

The Ore Unloading Station is licensed under the GNU General Public
License version 2.

Ore Unloading Station for OpenTTD.

Copyright © 2014-2015 mart3p and Oz (see credits for full details).

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

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.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.



8 Credits
=========

Graphics by:
    Oz

Coded by:
    mart3p

