Industrial Stations Renewal v0.8.1

1 About
  1.1 Version Requirements
2 Parameter
3 Detailed description
  3.1 Animated Stations
  3.2 PBS Controlled Doors.
  3.3 Buffers
  3.4 Truck parking
  3.5 Cargo Display on Station Tiles
4 Bug reports
5 License
6 Credits


1 About
=======
Industrial Stations Renewal is a set of stations for TTDPatch and OpenTTD. It
includes stations and facilities suitable for freight cargo. It includes
support for the standard TTD industries plus many of the additional industry
GRFs.

Features include animation of the various cranes and warehouse doors etc.
Most animations are triggered by activity at the station, such as trains
arriving/leaving and cargo being delivered. Platforms and non-track tiles are
included that display the amount of cargo waiting at the station.



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

OpenTTD 0.6.1 or nightly build from r12674 onwards

Animated stations are only supported by OpenTTD since nightly build r12798. In
earlier versions, including 0.6.3, the stations can still be used but they
won't be animated.

TTDPatch 2.6 alpha r1683 or newer

Required patch settings:
* newstations on

Recommended patch settings:
* irregularstations on
* largestations on


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

1) Docks
    0: enable new dock (default)
    1: disable new dock

2) Ship depot
    0: enable new ship depot
    1: disable new dock (default)

3) Track overlay for stations (mineral unloader and road crossings)
	The third parameter controls track overlays used by the mineral unloader
	station and the road crossing. Different overlays are used depending on
	the	track type (normal rail, monorail or maglev). When a GRF that replaces
	monorail or maglev is being used, the normal rail overlay is usually
	required. In the case of narrow gauge rails (ngrails[w].grf), the Canadian
	Trainset (canset[w].grf) and metro rails (metro.grf) the GRF is detected
	and the	correct overlay is used. For compatibility with other track
	replacement GRFs, the parameter allows the overlays for the monorail and/or
	maglev track slots to be set to suit. The settings are:

    0: use monorail and maglev overlays (default)
    1: use normal rail overlays for the monorail slot.
    2: use normal rail overlays for the maglev slot.
    3: use normal rail overlays for both the monorail and maglev slots.

With no parameters set they default to '0 1 0' i.e. new docks enabled, ship
depot disabled, standard track overlays used.


3 Detailed description
======================

3.1 Animated Stations
---------------------
Animations that span multiple tiles (overhead crane, gantry cranes etc.)
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.

Note: station animation requires OpenTTD r12798 or greater. It is not
supported by 0.6.3.

Stations and station tiles that are animated:
Goods station A
Steel mill station
Tower crane
Crane on rails
Overhead crane
Gantry crane (modern)
Gantry crane (classic)
Conveyor belt (minerals)
Main office
Shipping office
Large warehouse
Small warehouse
Modern warehouse
Brick warehouse
Front loader (minerals)
Forklift (crates)
Forklift (containers)



3.2 PBS Controlled Doors.
-------------------------

Some buildings such as the engine sheds and valuables sheds, have doors
controlled by PBS (Path Based Signalling). The doors will also remain closed
if no rails are connected.

In cases where PBS is disabled, the doors open when a rail, a station platform
or a buffer is connected to the shed door.

If PBS is enabled, in addition to requiring a connecting rail, the doors only
open when the track is reserved. For this to work, always build a PBS signal
on the track leading to the building, otherwise the track will not be reserved
and the door will remain closed.



3.3 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.

3.4 Truck Parking.
------------------

The truck parking tiles display trucks depending on the amount of cargo
waiting at the station. Truck parking tiles will only work if built with
normal or electrified rail types selected. In TTDPatch the truck parking will
not appear in the purchase list if monorail or maglev are selected.

OpenTTD does not currently support querying of the rail tool type,
consequently truck parking tiles are not disabled for monorail or maglev, but
they will not display any trucks. It is therefore recommended to always change
to normal or electrified rail before building truck parking tiles.



3.5 Cargo Display on Station Tiles
----------------------------------

This list shows the types of cargo that must be present at a station, in order
for that station to display cargo on its platforms. Note, no attempt has been
made to restrict which types of cargo a station will accept. All industrial
stations behave as normal stations as far as the game is concerned.

Cargos included in this list are those (or their packaging - containers etc.)
that are displayed graphically. Cargos not on this list are those that would
be stored in silos, tanks etc.

Mineral silo/Mineral piles/Mineral platforms (show cargo type dependant
graphics)
* coal
* iron ore
* copper ore
* clay
* gravel
* limestone
* sand

Livestock station/Pig yard/Cattle docks/Cattle sheds
* livestock

Wood loading station/Wood platforms/Wood piles
* wood
* tropic wood

Oil Storage Tanks (level indication only)
* oil
* petrol
* refined products

Steel mill station
* steel

Goods stations (before 1960)/General cargo platforms/General cargo tiles
* mail
* goods
* paper
* food
* fruit
* fish
* wool
* glass
* ceramics

Goods stations/Container loading platforms/Container tiles (post 1960)
* mail
* goods
* paper
* food
* fruit
* fish
* wool
* glass
* ceramics
* bricks
vehicles

Steel platforms/Steel tiles
* steel

Copper platforms/Copper tiles
* copper
* goods (if copper is not available as a specific cargo)

Barrel platforms/Barrel tiles
* oil
* goods
* water
* rubber
* petrol
* fertiliser
* dyes
* refined products
* plastic

Plank platforms/Plank tiles
* wood products
* lumber
* goods (if neither wood products nor lumber is available as a specific cargo)

Car tiles
* vehicles
* goods (if vehicles are not available as a specific cargo)



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

Please report any bugs found to the Transport Tycoon forum in the Industrial
Stations Renewal topic.



5 Licensing
===========

Industrial Stations Renewal is licensed under the GNU General Public License
version 2.

Industrial Stations Renewal for TTDPatch and OpenTTD.

Copyright © 2006-2008 the ISR contributors (see credits).

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.



Some graphics used for Industrial Stations Renewal are based on graphics
originating from the Industrial Stations Set v0.98 (jcindsta[w].grf):

The Industrial Stations Set is licensed under the GNU General Public License
version 2.

The Industrial Stations Set for OpenTTD and TTDPatch
Copyright © 2005 by certain members of the Transport Tycoon Forums
(norfolksouthern37, Arte Pro 34, Oz and Oracle)


6 Credits
=========

Graphics by:

    Sanchimaru
    Oz
    norfolksouthern37
    Zimmlock
    Ben_K
    Born Acorn
    mph
    Arte Pro 34
    andythenorth

Coded by:

    Maedhros
    mart3p
    planetmaker (action14)

Translations by:

    Spanish - Sanchimaru, maquinista
    German - Aylo, zypa
    Finnish - Vemarkis
    French - cmoiromain, Wallyweb
    Estonian - Alselius
    Dutch - Foobar

