Swedish Rails NewGRF ----------------------------------- This version: Swedish Rails 0.4.0 Contents: 1 About 2 Quickstart 3 Usage and parameters 4 Building from source 4.1 Requirements 5 License 6 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. Swedish Rails is designed to work for both, TTDPatch (any version) and OpenTTD (version 1.0.0 or newer). It provides completely snow - aware graphics for the rail infrastructure (except stations). Features include: - snow-aware depots in old and modern style, different for electric and non- electric rails (see parameters; OpenTTD only). - completely ground-tile independence for all graphics (OpenTTD only) - new level crossings which match every chosen road style (OpenTTD only) - optionally new tunnels portals (see parameters) - new fences (see parameters) Name of this Repo: Swedish Rails 0.4.0 GRF_ID: "SER" 00 MD5 sum: 2dc2d1e61d811edc5d011fab1207c401 swedishrails.grf Repository version: 89 -------------- 2 Installation -------------- Download the set from bananas or put the unziped archive into your OpenTTD or TTDPatch data folder. ---------------------- 3 Usage and parameters ---------------------- Just activate it in the NewGRF settings and enjoy. Parameters: No 1: Tunnels sprites to use 0 = Use default tunnels (compatible with all base sets, default) strongly recommended for multiplayer games 1 = Use OpenGFX - compatible tunnel sprites 2 = Use TTD - compatible tunnel sprites. 3 = Disable the use of rail types (only sprite replacements, only for debugging) 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 chose the new tunnel portals; they are after all nicer than either original :-) No 2: Introduction year for modern depots. The behaviour depends upon the game version used. OpenTTD > 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 < 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 on the given date. default introduction year for modern depots: never TTDPatch or parameter 1 set to 3: no effect, always uses old depots. No 3: Choice of rail fences 0 = Use swedish rail fences whereever possible (default) 1 = Use fences only with SwedishRails rails (OpenTTD only) 2 = Don't change the fences, use the default ones 3 = Use no fences at all 4 = Use no fences for Swedish Rails only (OpenTTD only) 5 = Use non-CC fences wherever possible 6 = Use non-CC fences only with SwedishRails (OpenTTD only) 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: Choice of level crossings 0 = Use Swedish level crossings 1 = Use plain level crossings (no lights, no bars) 3.1 Known Bugs -------------- - In TTDPatch the level crossings will not look right. Those sprites are still missing. - Bridges don't yet support SwedishRails (it needs support from the bridge set's side!) ---------------------- 4 Building from source ---------------------- Before this build system can be applied to a newgrf, you have to adopt a few lines in Makefile.config, mainly you'll have to replace "mynewgrf" by the actual name of your newgrf. Also make sure to change that in the .hgignore file. 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 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. 4.1 Requirements ---------------- In order to build this newgrf from source you need: - python 2.5+ with yacc, pil modules installed - NML r500 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 --------- 5 License --------- This generic NewGRF is drawn by Irwe and was written by Ingo von Borstel (aka planetmaker). It is free to use for anyone under the terms of the GNU Pulic License v2 or higher. See license.txt. 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 --------- 6 Credits --------- Coding: Ingo von Borstel (aka planetmaker) Graphics: Irwe Special thanks to Ammler who provides and works a lot on maintaining the Development Zone where this repository is hosted and who also frequently gives much valuable input. Special thanks also to 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.