truelight@0: OpenTTD README truelight@0: Last updated: $LastChangedDate: 2004-07-25 21:22:11 +0200 (Sun, 25 Jul 2004) $ truelight@0: Release version: 0.3.3 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 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: 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: truelight@0: The OpenTTD homepage is http://www.openttd.com/. truelight@0: truelight@0: You can find a forum for OpenTTD 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, ...) truelight@0: - Attach a save 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 truelight@0: MacOS - SDL truelight@0: BeOS - SDL truelight@0: MorphOS - 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/ truelight@0: subdirectory. You need the following files from the original Windows version truelight@0: of TTD as OpenTTD makes use of the original TTD artwork. truelight@0: truelight@0: IMPORTANT! You need the files from the WINDOWS version of TTD. 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@0: If you want music you need to copy the gm/ folder from Windows TTD into your OpenTTD folder, not your data folder. truelight@0: truelight@0: You can change the data path (which contains savegames as well) in 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. truelight@0: Currently there is unfortunately no comprehensive list of features. You could truelight@0: check the features list on the web, and some optional features can be truelight@0: 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 truelight@0: * Ctrl-d toggles double mode on win32 truelight@0: truelight@0: truelight@0: 6.0) Configuration File: truelight@0: ---- ------------------- truelight@0: The configuration file for OpenTTD (openttd.cfg) is in a simple windows-like truelight@0: .INI format. It's mostly undocumented. 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 truelight@0: and it should build automatically. In case you don't build with SDL, truelight@0: you need to remove WITH_SDL from the project settings. truelight@0: (see also docs/Readme_Windows_MSVC6.0.txt) darkvater@222: truelight@0: 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: truelight@0: OpenTTD can be built either with "make" or with "jam". To build with truelight@0: "make", just type "make", or "gmake" on non-gnu systems. To build with "jam", truelight@0: first run "./configure" and then "jam". Note that you need SDL to compile truelight@0: OpenTTD. truelight@0: (see also docs/Readme_Mandrake_Linux.txt) truelight@0: truelight@0: MacOS: truelight@0: Use "make". truelight@0: truelight@0: BeOS: truelight@0: Use "jam". truelight@0: truelight@0: FreeBSD truelight@0: Use "gmake". truelight@0: truelight@0: MorphOS darkvater@222: Use "make". Note that you need the MorphOS SDK and the darkvater@222: powersdl.library SDK. truelight@0: truelight@0: 8.0) Translating: truelight@0: ---- ------------------- truelight@0: See http://www.openttd.com/translating.php for up-to-date information. 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. truelight@0: * Translators must use the charater set "Windows latin-1", also known as ISO 8859-1. truelight@0: Otherwise, some characters will not display correctly in the game. 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. truelight@0: 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: truelight@0: truelight@0: X.X) Credits: truelight@0: ---- -------- truelight@0: The OpenTTD team: truelight@0: Ludvig Strigeus (ludde) - OpenTTD author, main coder. truelight@0: Serge Paquet (vurlix) - Assistant project manager, coder and webmaster. truelight@0: Dominik Scherer (dominik81) - Coder truelight@0: Tamas Farago (Darkvater) - Coder truelight@0: Owen Rudge (orudge) - Contributor, forum host. truelight@0: Bjarni Corfitzen (Bjarni) - MacOS port truelight@0: Cian Duffy (MYOB) - BeOS port / manual writing truelight@0: Christian Rosentreter (tokaiz) - MorphOS/AmigaOS port truelight@0: Viktor Strigeus (wiggo) - Web hosting services darkvater@222: truelight@0: Thanks to: truelight@0: Josef Drexler - For his great work on TTDPatch. dominik@37: Marcin Grzegorczyk - For his TTDPatch work and documentation of TTD internals and graphics (signals and track foundations). truelight@0: Mike Ragsdale - OpenTTD installer truelight@0: pasky - Many patches, newgrf support, etc. truelight@0: truesatan - Some patches truelight@0: TrueLight - Some patches truelight@0: Michael Polnick - Some patches truelight@0: Michael Blunck - Nice graphics truelight@0: George - Canal graphics dominik@37: Bug Reporters - Thanks for all bug reports. truelight@0: Chris Sawyer - For an amazing game. darkvater@222: