///////////////////////// /// METRO TRACK SET /// ///////////////////////// The Metro Track Set adds third rail tracks to OpenTTD and TTDPatch and is originally designed to complement the metros of the 2cc Trainset. It will add Metro Tracks as a new railtype to OpenTTD or at your option replace monorail or maglev with Metro Tracks instead. Version: Metro Track Set 1.0.0 GRF-ID: FB FB 04 02 MD5 hash: a394409d4ff754d28a079bdbbb5ee66f metrotrk.grf 0. Contents =========== 1. License Information 2. Background Information 3. Terrain and Road Set Support 4. OpenTTD Railtypes Support 5. Parameter Options 5.1 Parameter 0 5.2 Parameter 1 6. Train Set Compatibility 7. Upgrading From Previous Version 8. Credits 9. Frequently Asked Questions A. Changelog 1. License Information ====================== The Metro Track Set is available according to the GNU General Public License version 2.0. For more information, see the file "license.txt". Metro Track Set for OpenTTD and TTDPatch Copyright (C) 2010 Purno, FooBar and others (see list of credits below) 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; version 2 of the License. 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. 2. Background Information ========================= The system used in this set is commonly known as a 'bottom contact third rail', where the third rail sits at either side of the running rails and is slightly elevated above the ground (in the order of a foot (30 cm) or something). This type of third rail has a protective cover on top of the live rail preventing direct contact and therefore limiting the risk of electrocution. This set is inspired by the Dutch metro systems of Amsterdam and Rotterdam which both use the type of third rail as described above (and where the protective cover is in fact yellow). 3. Terrain and Road Set Support =============================== The Metro Track Set has native support for the OpenGFX and TTD base graphic sets. The OpenGFX graphics style is enabled by default. The TTD graphics style can be enabled by a parameter setting, see section 5. Support for third party road sets might be added in the future. 4. OpenTTD Railtypes Support ============================ The Metro Track Set supports OpenTTD's railtypes feature. Support for this is automatically enabled in case of OpenTTD r19307 or higher (this includes OpenTTD 1.0.0). In case of railtypes, the Metro Track Set is added as an additional track type rather than replacing one of the existing track types. The rail type label used in that case is 3RDR. Whether that is usable for you depends on the vehicle set you are using. If you find your metro vehicles running on monorail or maglev track, you might want to consider setting the appropriate track type parameter (see next section). In that case, monorail or maglev tracks are replaced by the Metro Track Set (rather than adding an additional track type) and the rail type label MONO respectively MGLV is used instead. Furthermore, with railtypes, the Metro Track Set is automatically compatible with any terrain or road set. 5. Parameter Options ==================== There are two parameters which can be useful. Parameter 0 controls visual aspects of the Metro Track Set. Parameter 1 controls technical aspects of the track type. 5.1 Parameter 0 --------------- This parameter controls how the tracks look in the game. The options of this parameter are listed in the table below. --------------------------------------------------------------- |Bit|Value|Enables | --------------------------------------------------------------- | - | 0 | OpenGFX terrain, tracks and GUI support (default) | | 0 | 1 | TTD terrain, tracks and GUI support | | 1 | 2 | Extra-snowy OpenGFX style tracks (Railtypes only) | --------------------------------------------------------------- Example: If you use the TTD base graphics, set the parameter value to 1. 5.2 Parameter 1 --------------- This parameter controls how the tracks are added to the game. The behaviour of this parameter depends on the platform used (OpenTTD or TTDPatch) and platform version. Only one value from the table below can be set at any time. ----------------------------------------------------------------------------------------------- |Value|Behaviour OpenTTD >= r19307 |Behaviour TTDPatch and OpenTTD < r19307| ----------------------------------------------------------------------------------------------- | 0 | Add 3RDR railtype (default) | Replace monorail tracks (default) | | 1 | Replace MONO (monorail) railtype | [option has no effect] | | 2 | Replace MGLV (maglev) railtype | Replace maglev tracks | | 4 | Replace monorail tracks (don't use railtypes) | [option has no effect] | | 6 | Replace maglev tracks (don't use railtypes) | Replace maglev tracks | ----------------------------------------------------------------------------------------------- Example: If you don't want the options of the first parameter, but do want to replace the maglev tracks with Metro Tracks, set parameter value 0 2 (note the space). 6. Train Set Compatibility ========================== The Metro Track Set is known to work with a few train sets that supply metro vehicles. For each train set, the recommended setting for parameter 1 (see section 5.2) is listed in the table below. If your favourite train set, containing metro vehicles, is not listed below that does not mean that the Metro Track Set doesn't work with it! It just means that no recommended parameter setting is listed! --------------------------------------------------------------- |Train Set and Version |Parameter 1 | --------------------------------------------------------------- | 2cc Trainset 2.0.0-Beta3 | 1 | | UK Railway Set (UKRS2) Public Alpha 0.41 | 0 (OpenTTD only) | --------------------------------------------------------------- Note: a recommended setting of 0 is equal to not setting parameter 1. 7. Upgrading From Previous Version ================================== If you are upgrading from a previous version of the Metro Track Set, you should disable all previous versions of Metro Track Set that you have active. If you neglect to do so, the newest version of Metro Track Set will disable itself. OpenTTD users who are upgrading Metro Track Set in a running game are required to set parameter 1 (see section 5.2) in order to maintain the original behaviour of Metro Track Set. In short: set parameters to 0 1 to get OpenGFX style graphics or set parameters to 1 1 to get TTD style graphics. 8. Credits ========== The third rail graphics are drawn by Purno and the set was originally coded by XeryusTC. Development of the set was continued by DJ Nekkid but soon taken over by FooBar who recoded the set, who added OpenGFX support and enhanced a thing or two, most notably the behaviour of the third rail at junctions. The set contains (parts of) graphics by others: TTD Graphics: Simon Foster. OpenGFX Tracks: Zepyris (Richard Wheeler). OpenGFX Bridges: Zimmlock, Thgergo, Purno and Zephyris. OpenGFX GUI: Bubersson and LordAzamath and Zephyris. Makefile system: planetmaker 9. Frequently Asked Questions ============================= Q: The colours of the tracks look weird! A: That's not a question, but if the graphics have a lot of brownish/pinkish pixels in them, then you are using the DOS version of the base graphics. In OpenTTD, open the NewGRF configuration window, select the Metro Track Set and use the option to toggle the palette. This will give you the correct colours. TTDPatch users will have to decode the grf and then recode it using a palette translation using GRFCodec. Q: The Metro Tracks are not buildable, why is that? A: The Metro Tracks are only availabe if there are metro vehicles available. These metro vehicles must be provided by a third-party vehicle set and are not available by default in OpenTTD. Q: My metro vehicles are running on some other track than the Metro Tracks, can you fix that? A: You can easily fix that yourself using the parameter options as described in section 5, allowing the Metro Tracks to replace either the maglev or the monorail tracks. Q: Where can I ask a question that is not listed here? A: Feature requests and bug reports go into the Metro Track Set Development topic at TT-Forums.net: http://www.tt-forums.net/viewforum.php?f=26. Compliments and questions about getting the set to work go in the Metro Track Release topic: http://www.tt-forums.net/viewforum.php?f=67. A. Changelog ============ Please refer to changelog.txt.