FooBar's Tram Tracks 1.0.1 ----------------------------------- Contents: 1 About 2 Requirements 3 Installation 3.1 Parameter settings 4 Frequently Asked Questions 5 Credits 6 License 7 Building from source 7.1 Obtaining the source 7.2 Dependencies 7.3 Makefile targets 7.4 Speed issues ------- 1 About ------- FooBar's Tram Tracks is a tramway replacement set featuring single-sided supports for overhead wires, slightly wider tracks and off-road tracks embedded in the grass (or in brown or gray ballast if you prefer). FooBar's Tram Tracks 1.0.1 Filename: {{FILE_NAME}} MD5Hash: 157e5141bdad888311c0f41683322906 foobarstramtracks.grf Version: 26 GRF ID: FB FB 03 01 FooBar's Tram Tracks supports the Temperate, Sub-Arctic and Tropical climates of both the original TTD graphics and OpenGFX, as well as the New Terrain, the Japanese Landscape Set and OpenGFX+ Landscape. Additionally, the player can choose between two types of wire supports: the set's default single-sided wire supports with support poles as wide as streetlights or an alternative with slightly slimmer poles. To OpenGFX users these tram tracks may look familiar: the OpenGFX tram tracks are based on this very set. Now why would you use this if you use OpenGFX? Maybe because you want something else instead of the brown ballast. Or maybe because you want the slimmer poles. Your choice. FooBar's Tram Tracks were previously know as "New Tram Tracks" and before that as "Grass Tram Tracks". The latest change was made for the fact that the tracks are all but new. Also, the tracks are not new to OpenGFX users, as the first impression is that it's the same thing (although it really isn't!). -------------- 2 Requirements -------------- Game version requirements for this new grapics set: OpenTTD: 1.2.0 (r23166) or higher. TTDPatch: not compatible. If you build this yourself from source, using NML 0.2.x, you should be able to get a version that works in OpenTTD 1.0.0 or higher and TTDPatch 2.6 alpha 0 r1651 or higher. -------------- 3 Installation -------------- The installation procedure is the same as with any other NewGRF. Read the manual the game if you don't know how: OpenTTD: http://wiki.openttd.org/NewGRF 3.1 Parameter Settings ---------------------- There are 3 parameter settings available. Users of a recent version of OpenTTD will be presented with a comfortable GUI to make the parameter settings and as such the information below does not apply. TTDPatch users as well as users of an old OpenTTD version (please upgrade!) will have to type in the parameter values manually. For this, the following information will be useful. 1st parameter: Base set support. 0: OpenGFX base graphics (default) 1: TTD base graphics 2nd parameter: Off-road track ballast 0: Auto-detect* (default) 1: Brown ballast 2. Grey ballast 3: Temperate grass 4: Arctic grass 5: Sub-tropical sand 6: Toyland terrain 4: New Terrain by Kolijn Wolfaardt 5: Japanese Landscape terrain 3rd parameter: Support pole width 0: Normal; 2 px wide (default) 1: Narrow; 1 px wide Example: If you want the narrow supports with the TTD base graphics, set parameter value "1 0 1" (note the spaces, without quotes). Footnote: * The auto-dectect feature is able to detect New Terrain [GRF-ID 75 87 01 02], Japanese Landscape [GRF-ID 45 52 0B 00] and OpenGFX+ Landscape [GRF-ID 4F 47 2B 34]. If one of these NewGRFs is detected, terrain matching this NewGRF is used as ballast automagically. In case none of these sets is detected, you'll be given climate-dependent terrain as ballast. If more than one of these three is detected at the same time, auto-detect will bail out and just give you temperate grass as track ballast, also in other climates (set what you want manually in this case). ---------------------------- 4 Frequently Asked Questions ---------------------------- This section covers some questions you may have when using this set. Q: Why can't I build tram tracks? A: You can only build tram tracks when there are tram vehicles available. You most likely haven't added a tram vehicle set to your game or you game year is too low such that tram vehicles aren't introduced yet. Q: Why doesn't it detect that I'm using the TTD base graphics? A: It is impossible for NewGRFs to detect what base graphics set is being used. If you want the off-road tracks to match TTD terrain, you need to make a parameter setting, see section 3.1. Q: Why can't NewGRFs detect the base graphics set? A: The NewGRF format has no means to do so. This limitation exists so that NewGRF developers can't produce bad code. For example, a NewGRF that would make completely different choices with base set B than with base set A would easily desync in multiplayer if players with different base graphics sets partake in the same multiplayer game. Q: Why aren't there more questions in this FAQ? A: There aren't more answers, that's why. Now go outside and play. --------- 5 Credits --------- Author: ------- Jasper Vries (FooBar) Graphical credits: ------------------ Based on the original TTDPatch Tram Tracks by PikkaBird. Contains parts of New Terrain by Kolijn Wolfaardt. Contains parts of Japanese Landscape Set by Jezulkim and others. Contains parts of the original TTD graphics by Simon Foster. Makefile system: ---------------- Ingo von Borstel (planetmaker) Translations: ------------- Dutch: Jasper Vries (FooBar) German: Ingo von Borstel (planetmaker) Special thanks: --------------- NML developers #openttdcoop DevZone --------- 6 License --------- FooBar's Tram Tracks for OpenTTD and TTDPatch Copyright (C) 2007, 2011-2012 Jasper Vries (FooBar) 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. ---------------------- 7 Building from source ---------------------- Usually there's not much which needs to be changed when you obtain the source. Your friends will usually be make make install Both will build the grf from source, the latter will also try to copy the grf into your grf folder so that it is available for testing and use straight away. 7.1 Obtaining the source ------------------------ The source code can be obtained from the #openttdcoop DevZone at http://dev.openttdcoop.org/projects/foobarstramtracks or via mercurial checkout hg clone http://hg.openttdcoop.org/foobarstramtracks 7.2 Dependencies ---------------- Requirements for running the 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 NML of course) and can be obtained from http://www.mingw.org/ That site also features an excellent walk-through on how to install it.0 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 data directory. 7.3 Makefile targets -------------------- A brief overview over all Makefile targets 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) 7.4 Speed issues ---------------- A note concerning the speed of the makefile: It seems that the required tools using MinGW and / or msys are thoroughly slow on Windows. A few example run times for OpenGFX, same processor type (both core 2 duo, 2.26GHz for the windows machine, 2.0 GHz for the OSX machine). Note that the values given are the 'real' time. Even though this varies more and is dependent on the processor load, that's what you have to wait for; the 'user' times are quite low on the Windows machine (~16s), but that by no means reflects the build time. Times are from OpenGFX r539 with makefile r199. DEP_CHECK_TYPE Windows bash native native in VM (OSX) none 1m23.360s - 0m32.781s mdep 1m54.484s 0m30.164s 0m33.807s normal 2m37.857s - 0m36.528s