Swedish Railtracks ------------------ This version: Swedish Rails 0.7.3 Contents: 1 About 2 Usage 2.1 Parameters 2.2 Compatibility with other NewGRF 2.3 Known bugs 3 Building from source 3.1 Requirements 3.2 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 heavily via parameters. Swedish Rails is designed to work for both, TTDPatch and OpenTTD. It will be most enjoyable with OpenTTD 1.0.0 or later as only railtypes allow to enjoy the true beauty this set can provide. 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: Swedish Rails 0.7.3 GRF_ID: "SER0" MD5 sum: 7147d9fecd846c0dcb8e57eaa2cfec1b swedishrails.grf Repository version: 230 ------- 2 Usage ------- You just select the NewGRF in the NewGRF config and enjoy it. -------------- 2.1 Parameters -------------- No 1: Compatibility 0: (default) Use normal tunnel portals, compatible with all base sets. This is strongly recommended for multiplayer games 1: Use OpenGFX - compatible tunnel sprites 2: Use TTD - compatible tunnel sprites. 3: TTDPatch - compatibility with OpenGFX ground sprites 4: TTDPatch - compatibility with TTD ground sprites 5: TTDPatch - compatibility with TTD ground sprites and TTRS level crossings Tunnel portal sprites are a bit difficult: they need to match the ground tiles - which depend upon the base set being used by the player. In multiplayer games different players use different base sets. Thus by choosing any tunnel portal by default, this set would glitch for at least one third or two thirds of the players (depending upon which option one choses). If you play in single player only, you know your base set, then feel free to choose the new tunnel portals; they are after all nicer than either original :-) When playing OpenTTD, do not use a parameter value larger than 2 as it will interfere with the railtypes feature and produce glitches. No 2: Introduction year for modern depots. The behaviour depends upon the game version used. Default: 1975 OpenTTD 1.1.0 or nightlies since r20003: The parameter indicates the introduction year for the modern version of the depots. From that year onward all depots newly built will be of the new design while old ones retain their old style. Default introduction year for modern depots: 1975 OpenTTD 1.0.x and nightlies older than r20003: Introduction year when all graphics start to show the new depot version. These versions of OpenTTD don't support a build date of depots, as such ALL depot graphics will change their style from old to modern over a time span of 15 years starting with this year. Default introduction year for modern depots: never TTDPatch or parameter 1 set to 3 or higher: From the given year on all depots will be converted to the modern version within a range of 15 years. No 3: 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 4: Introduction year for modern level crossings Default: same year as modern depots are introduced. OpenTTD: 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. TTDPatch compatibility: On the given year on all level crossings will be converted to the modern version instantly. Default: same year as modern depots are introduced. No 5: Level crossings OpenTTD 1.1.0 or nightlies since r20049: 0: (default) Swedish Rails level crossings 1: Plain level crossings without bars and signs 2: forbid building of level crossings OpenTTD earlier than r20049 or TTDPatch compatibility: Not applicable, no effect. No. 6: GUI replacements for rail toolbar and related cursors OpenTTD: 0: (default) no replacement (compatible with all base sets) strongly recommended for multiplayer games 1: OpenGFX style 2: TTD style TTDPatch compatibility: not applicable / no effect No. 7: Railtype label to be replaced by the normal rail (OpenTTD only): 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. 8: Railtype label to be replaced by the electrified rail (OpenTTD only): 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. 9: Bridge overlay (OpenTTD only): 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 (November 2011) bridges. 2.1 Compatibility with other NewGRF ----------------------------------- - other railtypes newgrfs (OpenTTD only): 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. - OpenGFX+ Landscape: All climates fully supported. Swedish tunnel portals use the OpenGFX grass style. Put SwedishRails in the NewGRF list below this NewGRF. - Alpine Climate, No Grid Land and Japanese Landscape: Fully supported, Matching tunnel entrances are supplied. Swedish tunnel portals use the TTD grass style. Put SwedishRails in the NewGRF below this NewGRF. - Toyland to Mars conversion: Supported. No Swedish tunnel portals are available. - road sets (TTDPatch only): Make sure that Swedish Rails is loaded AFTER the road set, or it won't be able to supply proper level crossing sprites and you may experience glitches. 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. - [TTDP] Level crossing replacement in the TTDPatch only work for the default TTD tiles and for the total town replacement set (TTRS). The choice of the correct sprites has to be made via parameter 1, the presence of other newgrfs is not yet tested for. - [TTDP] The Swedish style level crossings are known to glitch a bit due to missing bounding boxes for the level crossing tiles. ---------------------- 3 Building from source ---------------------- Requirements for running this Makefile successfully: NML gcc md5sum (or md5 on Mac) make mercurial (recommended) python (recommended) If you want to bundle the grf, you'll need additionally tar zip bzip2 unix2dos (optional) Windows only: On Windows systems this means that you'll need to install MinGW and MSys in order to obtain a posix compatible environment. Then the makefile can be called the very same way as it is on linux and mac systems. MinGW/MSys contain the above mentioned programmes (except renum and grfcodec of course) and can be obtained from http://www.mingw.org/ That site also features an excellent walk-through o how to install it. If you use for OpenTTD data folder a non-default path or Windows with a non-English localization make sure to copy Makefile.local.sample to Makefile.local and edit the line with INSTALLDIR = accordingly so that it shows the full path to your OpenTTD / TTDP data directory. If the Makefile is too slow, you may try different dependency checks or skip those completely. Available options for dependency generation are: mdep: uses a python script. Default when used in a hg repository normal: uses gcc and bash to scan for dependencies none: disable the dependency generation (mostly) Makefile.local allows to choose the method via the declaration of DEP_CHECK_TYPE. The Makefile offers different targets. A brief overview is given here: all: This is the default target, if also no parameter is given to make. It will simply build the grf file, if it needs building depend: Re-run the dependency check. Usually not manually needed. docs: Build the documentation files bundle: This target will create a directory called "-nightly" and copy the grf file there and the documentation files, readme.txt, changelog.txt and license.txt bundle_zip This will zip the bundle directory into one zip for distribution bundle_tar This will tar the bundle directory into a tar archive for distribution or upload to bananas bundle_src Creates a source bundle install: This will create a tar archive (like bundle_tar) and copy it into the INSTALLDIR as specified in Makefile.local (or the default dir, if that isn't defined). Don't rely on a good detection of the default installation directory. It's especially bound to fail on windows machines. distclean: This phony target cleans everything from a source bundle which wasn't shipped. clean: This phony target will delete all files which this Makefile will create mrproper: This phony target will delete also all directories created by different Makefile targets remake: It's a shortcut for first cleaning the dir and then making the grf anew. addcheck: Check whether there are some files required but not part of the repository. check: Check the md5sum of the built newgrf against the supplied md5sum (Intended to be used when building from tar balls) 3.1 Requirements ---------------- In order to build this newgrf from source you need: - python 2.5+ with yacc, pil modules installed - NML r1323 or newer - make 3.80+ - gcc as pre-processor - some small shell tools: cat, sed and optionally: - unix2dos possibly for conversion of the documentation files - tar for creating bundles - zip for creating bundles 3.2 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: Dutch: Yexo German: planetmaker Spanish: Terkhen Russian: akasoft Swedish: Irwe, El'Muppo Contact: ottd @ planetmaker.de 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).