NuTracks Readme ========= Current Version: NuTracks 1.0.0-Beta1 ========= 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 Credits 1 About NuTracks ========= NuTracks is an open source replacement for the original Transport Tycoon Deluxe (TTD) graphics used by OpenTTD. The main goal of NuTracks therefore is to provide a set of free graphics which make it possible to provide more playing options for OenTTD. 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.0.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.0.0 (or nightly r19056) or later. 2. Next, download the latest NuTracks package. There are a few sources: - the development homepage http://bundles.openttdcoop.org/NuTracks - Look for "NuTracks" on one of the OpenTTD binaries servers, it is found in the "bananas" section: http://binaries.openttd.org/bananas/NuTracks-0.2.1.tar.gz (or possibly with a newer version). 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=36&t=40162 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) - nforenum r2281 or better (available from http://www.openttd.org/download-nforenum) - grfcodec r2245 or better (available from http://www.openttd.org/download-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 License ========= NuTracks Graphics Replacement Set for OpenTTD Copyright (C) 2009-2010 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. 7 Credits ========= NuTracks is created by the following people (in random order): - Zephyris (Richard Wheeler) - FooBar (Jasper Vries) - DJ Nekkid (Thomas Mjelva) - Ammler (Marcel GmŸr) - planetmaker Thanks go out to the guys at #openttdcoop for providing the source repository and bug tracking services.