NuTracks Readme =========================================================================== Current Version: NuTracks 1.0.0 =========================================================================== Contents 1 About NuTracks 2 Installing or Updating NuTracks using the Online Content service 3 Installing NuTracks Manually 4 Reporting bugs 5 Contributing to and building of NuTracks 6 License 6.1 Obtaining the source 7 Parameters 8 Compatible trainsets 9 Credits =========================================================================== 1 About NuTracks =========================================================================== NuTracks is an open source supplement for the game OpenTTD. The main goal of NuTracks is to add more then the four standard rails in OpenTTD, with different max running speeds, max costs etc, all to make the game more fun and add more 'realism'* to the game. Its goal is also to make the game abit more challangeing, as the higher speed rail cost skyrocket. * Not neccesary real life realism, but the game itselfs realism =========================================================================== 4 Installing or Updating NuTracks using the Online Content service =========================================================================== This method uses the Online content service (BaNaNaS) to download NuTracks. In order to use this, you need a working OpenTTD and again at least OpenTTD version 1.1.0 or a recent nightly. 1. Start OpenTTD and on the main menu click the Check online content button. A new window will pop up. If OpenTTD doesn't start, follow the manual installation procedure. 2. Find the NuTracks entry from the list at the left. You can use the search box in the upper right corner of the window. 3. Click the little square in front of the NuTracks entry in order to mark it for download. 4. Click the Download button in the bottom right corner. After download, close the open windows. 5. In the main menu of the game, click the Game Options button. The Game Options dialog will appear. 6. Select NuTracks from the drop-down list below Base graphics set if that's not selected already (bottom left of window). Close the window using the × in the upper left corner. =========================================================================== 3 Installing NuTracks Manually =========================================================================== 1. First, make sure that you downloaded and installed at least OpenTTD version 1.1.0 (or nightly r21866) or later. 2. Next, download the latest NuTracks package. There are a few sources: - the development homepage: http://bundles.openttdcoop.org/NuTracks/ - Under 'releases' are the most recent 'official' release - Under 'nightlies' are the most recent non-official build. This build contain either new features, bugfixes not yet in the 'official' releases or a combination of the both. 3. Unpack the zip file into the OpenTTD /data directory (see section 4.2 of the OpenTTD readme for a detailed treatise on all data dirs OpenTTD recognizes). There's no need to unpack the tar, so just leave it as it is. - An OpenTTD folder in your user account's home directory: Windows: C:\My Documents (95, 98, ME) C:\Documents and Settings\\My Documents\OpenTTD (2000, XP) C:\Users\\Documents\OpenTTD (Vista, 7) Mac OSX: ~/Documents/OpenTTD Linux: ~/.openttd - The OpenTTD installation directory. 4. In the main menu of the game, click the NewGRF dialogue button. 5. Select NuTracks from the list of available NewGRFS. Close the window using the × in the upper left corner.and then start a new game Now that wasn't so hard, was it? Anyways, if you're having trouble getting NuTracks to work, please file a detailed report on what you did, what error messages you got and where you got stuck in the NuTracks release topic at TT-forums: http://www.tt-forums.net/viewtopic.php?f=36&t=40162 or (preferrably) at our bug tracker at http://dev.openttdcoop.org/projects/nutracks =========================================================================== 4 Reporting bugs =========================================================================== If you do spot any grapical bugs or glitches in the available graphics, please let us know via the NuTracks release topic at TT-forums.net: http://www.tt-forums.net/viewtopic.php?f=26&t=47347 or preferrably our bug tracker http://dev.openttdcoop.org/projects/nutracks/issues . Please make sure that you're using the latest available version before reporting a bug. You can check the Issue Tracker to see if the bug you've found is already reported (or fixed!). =========================================================================== 5 Contributing to and building of NuTracks =========================================================================== The NuTracks source is available in a Mercurial repository or as gzip'ed tarball. You can do an anonymous checkout from http://mz.openttdcoop.org/hg/nutracks , e.g. using hg clone http://mz.openttdcoop.org/hg/nutracks or obtain the tarball from http://bundles.openttdcoop.org/nutracks/releases. Prerequisites to building NuTracks: - mercurial (only when not building from a tarball, available from http://mercurial.selenic.com/wiki/Download?action=show&redirect=BinaryPackages) - gcc (the pre-processor is needed) - md5sum (linux, mingw) or md5 (mac) - grfcodec r821 or better (available from http://bundles.openttdcoop.org/grfcodec) - some gnu utils: make, cat, sed and you might additionally want a text editor of your choice and a graphics programme suitable to handle palettes. On Windows: we advise to get a mingw development environment, download grfcodec, nforenum and mercurial from the sources mentioned above) For more detailed instructions see our guide at http://dev.openttdcoop.org/projects/home/wiki and the very extensive and detailed installation instructions on the mingw wiki at http://www.mingw.org/wiki/Getting_Started On Linux: your system should already have most tools, you'll probably only need nforenum, grfcodec and mercurial available from the source mentioned above. For installation instructions concerning mercurial refer to the manual of your distribution. On Mac: Install the developers tools and get grfcodec and nforenum from the source mentioned above. Mercurial is easiest insalled via macports: sudo port install mercurial The use of mercurial is strongly encouraged as only that allows to keep track of changes. Once all tools are installed, get a checkout of the repository and you can build NuTracks using make. The following targets are available: - all: builds all grfs and the obg file - install: build and then copy NuTracks in your OpenTTD data directory. Use Makefile.local to specify a different path - clean: cleans all generated files - mrproper: also cleans generated directories - bundle_src: create a source tarball - bundle_zip: create a zip archive of NuTracks - bundle_bz2: create a bzip2 archive of NuTracks - bundle_tar: create a tar archive of NuTracks Given the usual case that you modify something within NuTracks and want to test that, a simple 'make install' should suffice and you can immediately test the changes ingame, if you selected the nightly version of NuTracks. Given default paths, a 'make install' will overwrite a previous nightly version of NuTracks. Mind to re-start OpenTTD as it needs to re-read the grf files. =========================================================================== 6 Configureing NuTracks - Parameters =========================================================================== In the summer of 2010 did the OpenTTD devs introduce an ingame GUI to configure NewGRF's in a more graphical manner, and makeing it MUCH easier for the 'dumb user'[*] to set parameters. As of NuTracks r171/1.1.0 Beta5 do NuTracks contain the following parameters: - 1st Trackset: Autodetect (see 'compatible trainsets) - Default - Metro rails - 3rd rails - 2nd Track price: 1/4th (a quarter) - 1/2 (half) - default - 2x (double) - 4x (quadruple) - Speedsettings for the 4 'main' tracktypes: - Very low speed tracks: 1-500kmh, with 80 beeing default - Low speed tracks: 1-500kmh, with 125 beeing default - Medium speed tracks: 1-500kmh, with 180 beeing default - High speed tracks: 1-500kmh, with 230 beeing default [*] You :P =========================================================================== 7 Compatible Trainsets =========================================================================== As the railtype feature are a very new feature (as of january2011) and most trainsets are made before this date, not all trainsets are 100% compatible as is. However, all (not tested, but there is no reason why not) minor and major trainsets should be compatible due to the introduction dates of the different tracks. There are however a few trainsets that have 'built in' support, so a train with a certain speed is called e.g. a "medium speed engine". This also ensure that the proper tracks are released when a useable engine is available. Currently theese trainsets have some kind of support: - The 2cc Trainset 2.0.0-Beta5, Nightly r727 - Full support. It also activate the 'metro' trackset if the 1st parameter is set to 'autodetect' - UKRS2 - Semi-supported - The 3rd rail engines/mus in this set should drive on the 3rd rails in NuTracks. It also activate the '3rd rail' trackset if the 1st parameter is set to 'autodetect'. It will not however introduce new railtypes by itself, you have to rely on the introdates. - BROS (not yet released) will have full support, and will activate the '3rd rail' trackset if the 1st parameter is set to 'autodetect' More trainsets to come =========================================================================== 8 License =========================================================================== NuTracks for OpenTTD Copyright (C) 2009-2011 NuTracks authors (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 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. =========================================================================== 9 Credits =========================================================================== NuTracks is created by the following people (in random order): Coders: - DJ Nekkid (Thomas Mjelva) (Main NFO coder) - planetmaker (Main man of the makefile system, also some NFO) Gfx: - Zephyris (Richard Wheeler) (Most of the gfx) - Purno (Mark) (Metro tracks) - FooBar () (Updated the Metro tracks to opengfx, and some other twinks) - Irwe ()(the 80kmh rails) - oberhümer (230kmh/High Speed Rails) Thanks to: - First and formost to Ammler (Marcel GmŸr) for hosting the repository and providing his services - Peter_1138 for creating the RailTypes - Rubidum and Yexo for misc updates to the Railtypes - The other OpenTTD devs for other possible updates to Railtypes, and the game in general And a special thanks go out to the guys at #openttdcoop for inspiration, testing, bugreporting, etc etc. I could not have done this without you.