truelight@0: OpenTTD README orudge@1849: Last updated: 2005-05-21 orudge@1849: Release version: 0.4.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 truelight@0: on irc.freenode.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: ---- --------------- truelight@0: To report a bug, please create a SourceForge 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: truelight@0: The SourceForge project page URL is: http://sourceforge.net/projects/openttd/ truelight@0: Click on "Bugs" to see the bug tracker. truelight@0: truelight@0: Please include the following information in your bug report: truelight@0: - OpenTTD version (PLEASE test the latest SVN/daily 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: truelight@0: Windows - Win32 GDI (faster) or SDL truelight@0: Linux - SDL truelight@0: FreeBSD - SDL Darkvater@1734: Mac OS X - SDL truelight@0: BeOS - SDL truelight@0: MorphOS - SDL Darkvater@1734: OS/2 - 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, dominik@961: TRGC.GRF, TRGH.GRF, TRGI.GRF, TRGT.GRF. A few minor graphical glitches with dominik@961: 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: truelight@799: You can change the data path (which contains savegames as well) in Makefile.config dominik@614: 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. Darkvater@1734: Unfortunately, there is currently no comprehensive list of features, but there is Darkvater@1734: 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: truelight@0: * Use Ctrl to place presignals Darkvater@1734: * Ctrl-D toggles double mode in the Windows version darkvater@288: * Ingame console. More information at http://wiki.openttd.org/index.php/OpenTTDDevBlackBook 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 Darkvater@1703: .INI format. It's mostly undocumented. Almost all settings can be changed ingame by Darkvater@1734: using the 'Configure Patches' window. truelight@0: truelight@0: truelight@0: 7.0) Compiling: truelight@0: ---- ---------- truelight@0: Windows: truelight@0: You need Microsoft Visual Studio 6 or .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. Darkvater@1703: PNG (WITH_PNG) and ZLIB (WITH_ZLIB) support is enabled by default. For these to Darkvater@1734: work you need their development files. For best results, download the openttd-useful.zip Darkvater@1734: file from SourceForge under the Files tab. Put the header files into your compiler's Darkvater@1703: include/ directory and the library (.lib) files into the lib/ directory. For more help Darkvater@1703: with VS6 see docs/Readme_Windows_MSVC6.0.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: truelight@0: Unix: tron@1133: OpenTTD can be built with GNU "make". On non-GNU systems it's called "gmake". tron@1133: Note that you need SDL-devel 1.2.5 (or higher) to compile OpenTTD. truelight@0: (see also docs/Readme_Mandrake_Linux.txt) truelight@0: truelight@0: MacOS: truelight@0: Use "make". truelight@0: truelight@0: BeOS: tron@1133: Use "make". truelight@0: Darkvater@1734: FreeBSD: truelight@0: Use "gmake". truelight@0: Darkvater@1734: MorphOS: darkvater@222: Use "make". Note that you need the MorphOS SDK and the darkvater@222: powersdl.library SDK. 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: Darkvater@1734: The use of the online Translator service, located at http://translator.openttd.org/, is Darkvater@1734: highly encouraged. For a username/password combo you should contact the development team, Darkvater@1734: either by mail, IRC or the forums. The system is straightforward to use, and if you have any Darkvater@1734: problems, read the online help located there. darkvater@250: darkvater@250: If for some reason the website is down for a longer period of time, the information below darkvater@250: 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: truelight@0: * Please contact the development team before begining the translation process! truelight@0: This avoids double work, as someone else may have already started translating to the same language. tron@504: * Translators must use the charater set ISO 8859-15. truelight@0: Otherwise, some characters will not display correctly in the game. Darkvater@1734: * Currently it is not possible to translate into character sets other than Latin. Also, changing Darkvater@1734: the order of strings is unsupported. For instance, it is always '16 tonnes of coal' and cannot be Darkvater@1734: 'coal existing of 16 tonnes' truelight@0: truelight@0: 8.2) Translation: truelight@0: ---- ------------------- truelight@0: So, now that you've notified the development team about your intention to translate truelight@0: (You did, right? Of course you did.) you can pick up english.txt (found in the SVN repository truelight@0: 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}) truelight@0: * Lines beginning with ## (such as ##id), other than the first two lines of the file truelight@0: truelight@0: 8.3) Previewing: truelight@0: ---- ------------------- truelight@0: In order to view the translation in the game, you need to compile your language file truelight@0: 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. Darkvater@1734: Any missing strings are replaced with the English strings. Note that it looks for english.txt truelight@0: in the lang subdirectory, which is where your language file 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: Darkvater@1703: To see all startup options available to you, start OpenTTD with the "./openttd -h" Darkvater@1703: option. This might help you tweak some of the settings. Darkvater@1703: Darkvater@1734: If the game is acting strange and you feel adventorous you can try the "-d [[]=[]" Darkvater@1734: flag, where the higher levels will give you more debugging output. The "name" variable can help Darkvater@1734: you to display only some type of debugging messages. This is mostly undocumented Darkvater@1734: so best is to look in the source code file debug.c for the various debugging types. For more Darkvater@1734: information look at http://wiki.openttd.org/index.php/Command_line. Darkvater@1734: Darkvater@1734: The most frequent problem is missing data files. Don't forget to put all GRF files from TTD Darkvater@1734: into your data/ folder including sample.cat! Darkvater@1734: Darkvater@1703: Another, less frequent problem is the game refusing to run when you don't have a Darkvater@1734: sound card. To solve this, force OpenTTD to run without sound/music by running it with Darkvater@1703: the command line option: "./openttd -s null -m null". This will disable both sound Darkvater@1703: and music. Darkvater@1734: Darkvater@1734: Under Windows 98 and lower it is impossible to use a dedicated server; it will fail to Darkvater@1703: start. Perhaps this is for the better because those OS's are not known for their stability. truelight@0: truelight@0: X.X) Credits: truelight@0: ---- -------- darkvater@1124: The OpenTTD team (in alphabetical order): Darkvater@1734: Bjarni Corfitzen (Bjarni) - Mac OS X port, coder darkvater@1125: Victor Fischer (Celestar) - Programming everywhere you need him to Darkvater@2134: Tamás Faragó (Darkvater) - Lead programmer darkvater@1124: Kerekes Miham (MiHaMiX) - Maintainer of translator service, and host of nightlies Darkvater@1734: Owen Rudge (orudge) - Contributor, forum host, master server host, OS/2 port 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@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: truelight@0: Josef Drexler - For his great work on TTDPatch. truelight@799: Marcin Grzegorczyk - For his TTDPatch work and documentation of TTD internals and graphics (signals and track foundations) matthijs@1579: Matthijs Kooijman (blathijs) - For his many patches, suggestions and major work on maprewrite matthijs@1579: Petr Baudis (pasky) - Many patches, newgrf support, etc. Darkvater@1821: Simon Sasburg (HackyKid) - For the many bugfixes he has blessed us with (and future PBS) truelight@799: Stefan Meißner (sign_de) - For his work on the console darkvater@1124: Mike Ragsdale - OpenTTD installer darkvater@1124: Cian Duffy (MYOB) - BeOS port / manual writing darkvater@1124: Christian Rosentreter (tokaiz) - MorphOS / AmigaOS port darkvater@1125: Michael Blunck - For revolutionizing TTD with awesome graphics truelight@0: George - Canal graphics darkvater@250: All Translators - For their support to make OpenTTD a truly international game truelight@799: Bug Reporters - Thanks for all bug reports truelight@799: Chris Sawyer - For an amazing game!