////////////////////////////// /// TRANSRAPID TRACK SET /// ////////////////////////////// The TransRapid Track Set is a maglev track replacement set featuring optically elevated tracks. The track style is based on the tracks at the Transrapid test facility in Lathen, Emsland, Germany. Version: TransRapid Track Set 0.9.0-beta GRF-ID: FB FB 02 02 MD5 hash: d8395aab346181680157e7792d5cd875 traratrk.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 and Station Set Compatibility 7. Upgrading From Previous Version 8. Credits 9. Frequently Asked Questions A. Obtaining the Source B. Changelog 1. License Information ====================== The TransRapid Track Set is available according to the GNU General Public License version 2.0. For more information, see the file "license.txt". TransRapid 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 Transrapid system is a German high-speed monorail train system using magnetic levitation. The tracks in this set are based upon their real life equivalents at the test facility for the system in Emsland, Germany. Transrapid is a trademark of ThyssenKrupp Transrapid GmbH. 3. Terrain and Road Set Support =============================== The TransRapid 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 TransRapid Track Set supports OpenTTD's railtypes feature. Support for this is automatically enabled in case of OpenTTD r20242 or higher (this includes OpenTTD 1.0.3). In case of railtypes, the TransRapid Track Set replaces the tracks with rail type label MGLV. Whether that is usable for you depends on the vehicle set you are using. If you find your TransRapid vehicles running on monorail, you might want to consider setting the appropriate track type parameter (see next section). In that case, monorail tracks are replaced by the TransRapid Track Set (rather than adding an additional track type) and the rail type label MONO is used instead. Furthermore, with railtypes, the TransRapid Track Set is automatically compatible with any terrain or road set. Due to the nature of railtypes, the optical illusion of the TransRapid Tracks might be broken at stations and especially bridges. This will be improved in a future version of the set, provided it is possible to improve this. 5. Parameter Options ==================== There are two parameters which can be useful. Parameter 0 controls visual aspects of the TransRapid 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. To enable multiple options at the same time, simply add the values of those options and set this sum as parameter value. --------------------------------------------------------------- |Bit|Value|Enables | --------------------------------------------------------------- | - | 0 | OpenGFX terrain, tracks and GUI support (default) | | 0 | 1 | TTD terrain, tracks and GUI support | | 1 | 2 | [not yet available] | | 2 | 4 | Enable fences | --------------------------------------------------------------- Note: Not all features from the table can be enabled at the same time and/or are compatible with all settings of parameter 1. Example: If you use the TTD base graphics with fences, set the parameter value to 5 (i.e. 1 + 4). 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 >= r20242 (or >= 1.0.3) |Behaviour TTDPatch and OpenTTD < r20242| ----------------------------------------------------------------------------------------------- | 0 | Replace MGLV (maglev) railtype (default) | Replace maglev tracks (default) | | 1 | Replace MONO (monorail) railtype | Replace monorail tracks | | 2 | Replace/add custom railtype [0] | [option has no effect] | | 4 | Replace maglev tracks (don't use railtypes) | [option has no effect] | | 6 | Replace monorail tracks (don't use railtypes) | Replace monorail tracks | ----------------------------------------------------------------------------------------------- Note: [0] This feature is not yet available. Setting this option will currently add TransRapid Tracks as an additional railtype with label TRPD, resulting in the tracks being disabled. Example: If you don't want the options of the first parameter, but do want to replace the monorail tracks with TransRapid Tracks, set parameter value 0 1 (note the space). 6. Train and Station Set Compatibility ====================================== The TransRapid Track Set works with any trainset including maglev trains. This includes the default vehicles. The TransRapid Tracks are not compatible with station sets. You can use station sets, but the optical illusion will be broken. 7. Upgrading From Previous Version ================================== If you are upgrading from a previous version of the TransRapid Track Set, you should disable all previous versions of TransRapid Track Set that you have active. If you neglect to do so, the newest version of TransRapid Track Set will disable itself. 8. Credits ========== Track graphics drawn by: FooBar Code written by: FooBar 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. The repository contains code by others: Makefile system: planetmaker Transrapid is a trademark of ThyssenKrupp Transrapid GmbH 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 TransRapid 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 TransRapid Tracks are not buildable, why is that? A: The TransRapid Tracks are only availabe if there are TransRapid vehicles available. Q: My TransRapid vehicles are running on some other track than the TransRapid Tracks, can you fix that? A: You can easily fix that yourself using the parameter options as described in section 5, allowing the TransRapid Tracks to replace the monorail tracks. Q: Where can I ask a question that is not listed here? A: Feature requests and bug reports go into the TransRapid Track Set Development topic at TT-Forums.net: http://www.tt-forums.net/viewtopic.php?t=34753. Compliments and questions about getting the set to work go in the TransRapid Track Release topic: http://www.tt-forums.net/viewtopic.php?t=45437. A. Obtaining the Source ======================= The source code of the TransRapid Track Set is freely available at the OpenTTDCoop DevZone and is available in the form of a Mercurial repository: http://dev.openttdcoop.org/projects/transrapidtrackset/repository B. Changelog ============ Please refer to changelog.txt.