truelight@0: OpenTTD README KUDr@6308: Last updated: 2007-04-20 KUDr@6308: Release version: 0.5.1 truelight@0: ------------------------------------------------------------------------ truelight@0: truelight@0: truelight@0: Table of Contents: truelight@0: ------------------ truelight@0: 1.0) About truelight@0: 2.0) Contacting truelight@0: * 2.1 Reporting Bugs truelight@0: 3.0) Supported Platforms truelight@0: 4.0) Running OpenTTD truelight@0: 5.0) OpenTTD features truelight@0: 6.0) Configuration File truelight@0: 7.0) Compiling truelight@0: 8.0) Translating truelight@0: * 8.1 Guidelines truelight@0: * 8.2 Translation truelight@0: * 8.3 Previewing Darkvater@1703: 9.0) Troubleshooting truelight@0: X.X) Credits truelight@0: truelight@0: truelight@0: 1.0) About: truelight@0: ---- ------ truelight@0: OpenTTD is a clone of Transport Tycoon Deluxe, a popular game originally truelight@0: written by Chris Sawyer. It attempts to mimic the original game as closely truelight@0: as possible while extending it with new features. truelight@0: Darkvater@1734: OpenTTD is licensed under the GNU General Public License version 2.0. For Darkvater@1734: more information, see the file 'COPYING'. truelight@0: truelight@0: 2.0) Contacting: truelight@0: ---- ---------- truelight@0: The easiest way to contact the OpenTTD team is by submitting bug reports or truelight@0: posting comments in our forums. You can also chat with us on IRC (#openttd rubidium@5655: on irc.oftc.net). truelight@0: darkvater@250: The OpenTTD homepage is http://www.openttd.org/. truelight@0: Darkvater@1734: You can also find the OpenTTD forums at truelight@0: http://www.tt-forums.net/index.php?c=20 truelight@0: truelight@0: truelight@0: 2.1) Reporting Bugs: truelight@0: ---- --------------- Darkvater@5355: To report a bug, please create a Flyspray account and follow the bugs truelight@0: link from our homepage. Please make sure the bug is reproducible and truelight@0: still occurs in the latest daily build or the current SVN version. Also truelight@0: please look through the existing bug reports briefly to see whether the bug truelight@0: is not already known. truelight@0: Darkvater@5355: The Flyspray project page URL is: http://bugs.openttd.org/ truelight@0: truelight@0: Please include the following information in your bug report: rubidium@5655: - OpenTTD version (PLEASE test the latest SVN/nightly build) truelight@0: - Bug details, including instructions how to reproduce it truelight@0: - Platform and compiler (Win32, Linux, FreeBSD, ...) Darkvater@1734: - Attach a saved game or a screenshot if possible truelight@0: - If this bug only occurred recently please note the last truelight@0: version without the bug and the first version including truelight@0: the bug. That way we can fix it quicker by looking at the truelight@0: changes made. truelight@0: truelight@0: truelight@0: 3.0) Supported Platforms: truelight@0: ---- -------------------- truelight@0: OpenTTD has been ported to several platforms and operating systems. It shouldn't truelight@0: be very difficult to port it to a new platform. The currently working platforms truelight@0: are: truelight@0: rubidium@5655: BeOS - SDL rubidium@5655: FreeBSD - SDL rubidium@5655: Linux - SDL rubidium@5655: MacOS X (universal) - Cocoa video and sound drivers (SDL works too, but not 100% and not as a universal binary) rubidium@5655: MorphOS - SDL rubidium@5655: OS/2 - SDL rubidium@5655: Windows - Win32 GDI (faster) or SDL truelight@0: truelight@0: truelight@0: 4.0) Running OpenTTD: truelight@0: ---- ---------------- truelight@0: truelight@0: Before you run OpenTTD, you need to put the game's datafiles into the data/ dominik@614: subdirectory. You need the following files from the original version truelight@0: of TTD as OpenTTD makes use of the original TTD artwork. truelight@0: truelight@0: List of the required files: truelight@0: sample.cat truelight@0: trg1r.grf truelight@0: trgcr.grf truelight@0: trghr.grf truelight@0: trgir.grf truelight@0: trgtr.grf truelight@0: truelight@799: (Alternatively you can use the TTD GRF files from the DOS version: TRG1.GRF, Darkvater@2748: TRGC.GRF, TRGH.GRF, TRGI.GRF, TRGT.GRF. A few minor graphical glitches with Darkvater@2748: the DOS graphics remain. E.g. the autorail button in the rail toolbar doesn't dominik@961: look as nice as with the Windows graphics.) truelight@0: truelight@799: If you want music you need to copy the gm/ folder from Windows TTD into your dominik@614: OpenTTD folder, not your data folder. dominik@614: tron@2401: You can change the data path (which contains savegames as well) in tron@2401: Makefile.config by setting DATA_DIR_PREFIX and USE_HOMEDIR. truelight@0: truelight@0: truelight@0: 5.0) OpenTTD features: truelight@0: ---- ----------------- truelight@0: truelight@0: OpenTTD has a lot of features going beyond the original TTD emulation. tron@2401: Unfortunately, there is currently no comprehensive list of features, but there tron@2401: is a basic features list on the web, and some optional features can be Darkvater@1734: controlled through the Configure Patches dialog. We also implement some truelight@0: features known from TTDPatch (http://www.ttdpatch.net/). truelight@0: truelight@0: Several important non-standard controls: truelight@0: tron@2401: * Use Ctrl to place semaphore signals Darkvater@1734: * Ctrl-D toggles double mode in the Windows version tron@2401: * Ingame console. More information at rubidium@5655: http://wiki.openttd.org/index.php/Console truelight@0: truelight@0: truelight@0: 6.0) Configuration File: truelight@0: ---- ------------------- Darkvater@1734: The configuration file for OpenTTD (openttd.cfg) is in a simple Windows-like tron@2401: .INI format. It's mostly undocumented. Almost all settings can be changed tron@2401: ingame by using the 'Configure Patches' window. truelight@0: truelight@0: truelight@0: 7.0) Compiling: truelight@0: ---- ---------- truelight@0: Windows: Darkvater@5355: You need Microsoft Visual Studio .NET. Open the project file Darkvater@1703: and it should build automatically. In case you want to build with SDL support Darkvater@1703: you need to add WITH_SDL to the project settings. tron@2401: PNG (WITH_PNG) and ZLIB (WITH_ZLIB) support is enabled by default. For these tron@2401: to work you need their development files. For best results, download the tron@2401: openttd-useful.zip file from SourceForge under the Files tab. Put the header tron@2401: files into your compiler's include/ directory and the library (.lib) files tron@2401: into the lib/ directory. Darkvater@5355: For more help with VS see docs/Readme_Windows_MSVC.txt. darkvater@222: Darkvater@1734: You can also build it using the Makefile with MSYS/MinGW or Cygwin/MinGW. truelight@0: Please read the Makefile for more information. truelight@0: bjarni@6298: Solaris 10: bjarni@6298: You need g++ (version 3 or higher), together with SDL. Installation of bjarni@6298: libpng and zlib is recommended. For the first build it is required bjarni@6298: to execute "bash configure" first. Note that ./configure does not work bjarni@6298: yet. It is likely that you don't have a strip binary, so use the bjarni@6298: --disable-strip option in that case. Fontconfig (>2.3.0) and freetype bjarni@6298: are optional. "make run" will then run the program. bjarni@6298: truelight@0: Unix: tron@1133: OpenTTD can be built with GNU "make". On non-GNU systems it's called "gmake". rubidium@5726: However, for the first build one has to do a "./configure" first. tron@1133: Note that you need SDL-devel 1.2.5 (or higher) to compile OpenTTD. truelight@0: bjarni@2937: MacOS X: bjarni@2937: Use "make" or Xcode (which will then call make for you) rubidium@5655: This will give you a binary for your CPU type (PPC/Intel) rubidium@5726: However, for the first build one has to do a "./configure" first. rubidium@5726: To make a universal binary type "./configure --enabled-universal" rubidium@5726: instead of "./configure". truelight@0: truelight@0: BeOS: rubidium@5726: Use "make", but do a "./configure" before the first build. truelight@0: Darkvater@1734: FreeBSD: tron@2401: You need the port devel/sdl12 for a non-dedicated build. tron@2401: graphics/png is optional for screenshots in the PNG format. rubidium@5726: Use "gmake", but do a "./configure" before the first build. truelight@0: Darkvater@1734: MorphOS: rubidium@5726: Use "make". However, for the first build one has to do a "./configure" first. rubidium@5726: Note that you need the MorphOS SDK, latest libnix updates (else C++ parts of rubidium@5726: OpenTTD will not build) and the powersdl.library SDK. Optionally libz, rubidium@5726: libpng and freetype2 developer files. truelight@0: Darkvater@1734: OS/2: Darkvater@1734: Open Watcom C/C++ 1.3 or later is required to build the OS/2 version. See the Darkvater@1734: docs/Readme_OS2.txt file for more information. Darkvater@1734: Darkvater@1734: truelight@0: 8.0) Translating: truelight@0: ---- ------------------- darkvater@250: See http://www.openttd.org/translating.php for up-to-date information. darkvater@250: tron@2401: The use of the online Translator service, located at Darkvater@4785: http://translator2.openttd.org/, is highly encouraged. For a username/password tron@2401: combo you should contact the development team, either by mail, IRC or the tron@2401: forums. The system is straightforward to use, and if you have any problems, tron@2401: read the online help located there. darkvater@250: tron@2401: If for some reason the website is down for a longer period of time, the tron@2401: information below might be of help. truelight@0: truelight@0: 8.1) Guidelines: truelight@0: ---- ------------------- truelight@0: Here are some translation guidelines which you should follow closely. truelight@0: Darkvater@3122: * Please contact the development team before beginning the translation tron@2401: process! This avoids double work, as someone else may have already tron@2401: started translating to the same language. Darkvater@3122: * Translators must use the character set ISO 8859-15. truelight@0: Otherwise, some characters will not display correctly in the game. tron@2401: * Currently it is not possible to translate into character sets other than tron@2401: Latin. truelight@0: truelight@0: 8.2) Translation: truelight@0: ---- ------------------- tron@2401: So, now that you've notified the development team about your intention to tron@2401: translate (You did, right? Of course you did.) you can pick up english.txt tron@2401: (found in the SVN repository under /lang) and translate. truelight@0: truelight@0: You must change the first two lines of the file appropriately: truelight@0: truelight@0: ##name English-Name-Of-Language truelight@0: ##ownname Native-Name-Of-Language truelight@0: truelight@0: Note: Do not alter the following parts of the file: truelight@0: truelight@0: * String identifiers (the first word on each line) truelight@0: * Parts of the strings which are in curly braces (such as {STRING}) tron@2401: * Lines beginning with ## (such as ##id), other than the first two lines of tron@2401: the file truelight@0: truelight@0: 8.3) Previewing: truelight@0: ---- ------------------- tron@2401: In order to view the translation in the game, you need to compile your language tron@2401: file with the strgen utility, which is now bundled with the game. truelight@0: truelight@0: strgen is a command-line utility. It takes the language filename as parameter. truelight@0: Example: truelight@0: truelight@0: strgen lang/german.txt truelight@0: truelight@0: This results in compiling german.txt and produces another file named german.lng. tron@2401: Any missing strings are replaced with the English strings. Note that it looks tron@2401: for english.txt in the lang subdirectory, which is where your language file tron@2401: should also be. truelight@0: truelight@0: That's all! You should now be able to select the language in the game options. truelight@0: Darkvater@1703: 9.0) Troubleshooting Darkvater@1734: ---- --------------- Darkvater@1734: tron@2401: To see all startup options available to you, start OpenTTD with the tron@2401: "./openttd -h" option. This might help you tweak some of the settings. Darkvater@1734: Darkvater@3122: If the game is acting strange and you feel adventurous you can try the tron@2401: "-d [[]=[]" flag, where the higher levels will give you more tron@2401: debugging output. The "name" variable can help you to display only some type of tron@2401: debugging messages. This is mostly undocumented so best is to look in the tron@2401: source code file debug.c for the various debugging types. For more information tron@2401: look at http://wiki.openttd.org/index.php/Command_line. Darkvater@1734: tron@2401: The most frequent problem is missing data files. Don't forget to put all GRF tron@2401: files from TTD into your data/ folder including sample.cat! Darkvater@1734: tron@2401: Under Windows 98 and lower it is impossible to use a dedicated server; it will tron@2401: fail to start. Perhaps this is for the better because those OS's are not known tron@2401: for their stability. truelight@0: Darkvater@5355: With the added support for font-based text selecting a non-latin language will Darkvater@5355: result in garbage (lots of '?') shown on screen. Please open your configuration Darkvater@5355: file and add a desired font for small/medium/-and large_font. This can be a font Darkvater@5355: name like "Tahoma" or a path to a font. Darkvater@5355: Darkvater@5355: Any NewGRF file used in a game is stored inside the savegame and will refuse Darkvater@5355: to load if you don't have that grf file available. A list of missing files Darkvater@5355: will be output to the console at the moment, so use the '-d' flag (on windows) Darkvater@5355: to see this list. You just have to find the files (http://grfcrawler.tt-forums.net/) Darkvater@5355: put them in the data/ folder and you're set to go. Darkvater@5355: truelight@0: X.X) Credits: truelight@0: ---- -------- darkvater@1124: The OpenTTD team (in alphabetical order): Darkvater@5355: Jean-Francois Claeys (Belugas) - In training, not yet specialized Darkvater@1734: Bjarni Corfitzen (Bjarni) - Mac OS X port, coder Darkvater@5355: Matthijs Kooijman (blathijs) - Pathfinder-guru darkvater@1125: Victor Fischer (Celestar) - Programming everywhere you need him to rubidium@5655: Tamás Faragó (Darkvater) - Lead programmer rubidium@5655: Loïc Guilloux (glx) - In training, not yet specialized Darkvater@5355: Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;) darkvater@1124: Kerekes Miham (MiHaMiX) - Maintainer of translator service, and host of nightlies Darkvater@5355: Darkvater@5355: Peter Nelson (peter1138) - Spiritual descendant from newgrf gods Darkvater@5977: Remko Bijker (Rubidium) - THE desync hunter darkvater@1125: Christoph Mallon (Tron) - Programmer, code correctness police darkvater@1125: Patric Stout (TrueLight) - Programmer, network guru, SVN-repository and website host darkvater@1125: darkvater@1125: Retired Developers: Darkvater@1703: Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3.0 - 0.3.6) Darkvater@5355: Owen Rudge (orudge) - Contributor, forum host, master server host, OS/2 port (0.1 - 0.4.8) darkvater@1125: Ludvig Strigeus (ludde) - OpenTTD author, main coder (0.1 - 0.3.3) truelight@799: Serge Paquet (vurlix) - Assistant project manager, coder (0.1 - 0.3.3) truelight@799: truelight@0: Thanks to: rubidium@5655: Josef Drexler - For his great work on TTDPatch. rubidium@5655: Marcin Grzegorczyk - For his TTDPatch work and documentation of TTD internals and graphics (signals and track foundations) rubidium@5655: Matthijs Kooijman (blathijs) - For his many patches, suggestions and major work on maprewrite rubidium@5655: Petr Baudis (pasky) - Many patches, newgrf support, etc. rubidium@5655: Simon Sasburg (HackyKid) - For the many bugfixes he has blessed us with (and future PBS) rubidium@5655: Stefan Meißner (sign_de) - For his work on the console rubidium@5655: Mike Ragsdale - OpenTTD installer rubidium@5655: Cian Duffy (MYOB) - BeOS port / manual writing rubidium@5655: Christian Rosentreter (tokai) - MorphOS / AmigaOS port rubidium@5655: Richard Kempton (RichK67) - Additional airports, initial TGP implementation rubidium@5655: Michael Blunck - For revolutionizing TTD with awesome graphics rubidium@5655: George - Canal graphics rubidium@5655: All Translators - For their support to make OpenTTD a truly international game rubidium@5655: Bug Reporters - Thanks for all bug reports rubidium@5655: Chris Sawyer - For an amazing game!