From fafafcc3f8bd2071bc7ced0fbd8e02f35bf2bdc3 Mon Sep 17 00:00:00 2001 From: rubidium Date: Thu, 28 Dec 2006 18:01:22 +0000 Subject: [PATCH] (svn r7600) -Remove: out-dated documentation about console and Mandrake Readme. -Change: make readme.txt UTF-8 instead of ISO 8859-15. -Change: some indenting, aligning and other small textual changes. -Add: some comments about port forwarding and NewGRF over the net.. --- docs/Howto_compile_lng_files_from_CLI.txt | 14 ----- docs/Manual.txt | 2 - docs/Readme_Mandrake_Linux.txt | 62 ----------------------- docs/console.txt | 58 --------------------- docs/multiplayer.txt | 15 ++++-- readme.txt | 61 +++++++++++----------- 6 files changed, 42 insertions(+), 170 deletions(-) delete mode 100644 docs/Readme_Mandrake_Linux.txt delete mode 100644 docs/console.txt diff --git a/docs/Howto_compile_lng_files_from_CLI.txt b/docs/Howto_compile_lng_files_from_CLI.txt index 6fe70b0df1..afeee7d29c 100644 --- a/docs/Howto_compile_lng_files_from_CLI.txt +++ b/docs/Howto_compile_lng_files_from_CLI.txt @@ -32,17 +32,3 @@ this will need english.txt to be present -w strgen will print any missing strings to standard error output(stderr) this will need english.txt to be present - -here are a very useful tool for translators: -http://openttd.rulez.org/ - - -HOWTO compile strgen: -(this should be useless as you can just type make) -Goto the main dir -Compile by typing -gcc strgen/strgen.c -o strgen/strgen -DUNIX -or if you want it to tell the revision too -gcc strgen/strgen.c rev.o -o strgen/strgen -DUNIX -DWITH_REV (this is the one the makefile uses) - -you now have a program called strgen in the strgen directory diff --git a/docs/Manual.txt b/docs/Manual.txt index 3a4cfa6655..7880d5f6a3 100644 --- a/docs/Manual.txt +++ b/docs/Manual.txt @@ -18,7 +18,6 @@ Use make or gmake to compile OpenTTD. You can adjust Makefile.config to compile BeOS: On BeOS, run ./configure and then use jam. There are a variaty of options you can pass to your build tool, these are reported by ./configure. - 1.2 Installing OpenTTD. On Windows, insert your "Transport Tycoon Deluxe for Windows 95" disk. You can use a DOS version, but your graphics will be purple. NB: Even if your version of Transport Tycoon Deluxe ran on Windows 95, it may still be the DOS version. Then run the OpenTTD installer. @@ -58,7 +57,6 @@ However, there is an even more noticable difference in rail station construction 2.3 Checkpoint Stations - Checkpoint stations (the small blue item in the rail construction window) are small 1x1 stations. They must be built on top of pre-existing track. They do not accept or produce carge of any kind. They exist solely for use as route points. They become useful when dealing with large networks where trains may attempt to route themselves along undesirable or impossible routes. As an alternative to checkpoint stations, you can also direct trains to visit depots along the way. This has the advantage of also servicing the train and hence the train will rarely to never need to depart from its route to be serviced. 2.4 Freeform Rail Laying. diff --git a/docs/Readme_Mandrake_Linux.txt b/docs/Readme_Mandrake_Linux.txt deleted file mode 100644 index bbdea4acae..0000000000 --- a/docs/Readme_Mandrake_Linux.txt +++ /dev/null @@ -1,62 +0,0 @@ -Compiling and developing OpenTTD on MandrakeLinux 10.0 Official - -A quick guide to get started with OpenTTD development on Linux. ---------------------------------------------------------------- - -1.) RPMs: - -Most packages that are required for development (like gcc) should already be installed on your box. You will require those RPMs additionally: -- libsdl1.2-devel-1.2.7-2mdk -- subversion-1.0.1-1mdk (+ dependencies) -- libsvn_ra_svn1_0-1.0.1-1mdk - - -2.) Subversion: - -To obtain the source code from the subversion server type - $ svn co svn://svn.openttd.com/openttd/trunk openttd -from command line to dump the code into the directory 'openttd'. - -To update your working copy to the latest revision use - $ svn update -Don't worry, your version will be merged with the latest version. - -The command - $ svn diff > mypatch.diff -creates a patch file (aka diff file) which you can submit to the developers to share your improvements. - -You can undo changes to a file with - $svn revert filename - - -3.) Required data files: - -Copy the following files from Transport Tycoon Deluxe to openttd/data/ - sample.cat - trg1r.grf - trgcr.grf - trghr.grf - trgir.grf - trgtr.grf - -(Alternatively you can use the TTD GRF files from the DOS version: TRG1.GRF, TRGC.GRF, TRGH.GRF, TRGI.GRF, TRGT.GRF. A few minor graphical glitches with the DOS graphics remain. E.g. the autorail button in the rail toolbar doesn't look as nice as with the Windows graphics.) - - -4.) Compiling and running: - -Compile OpenTTD with - $ make -and run it with - $ ./ttd - - -5.) Playing the soundtrack: - -If you want the original TTD music you need to copy the whole /gm/ directory from Windows. Additionally the TiMidity driver is required: - TiMidity++-2.12.0-0.pre1.4mdk (+ dependencies) -To run OpenTTD with music support type - $ ./ttd -m extmidi - - -X.) Last Update: $Date: 2004-06-01 19:08:09 +0200 (Tue, 01 Jun 2004) $ - Written for revision $Rev: 710 $ diff --git a/docs/console.txt b/docs/console.txt deleted file mode 100644 index 6606e8e5ba..0000000000 --- a/docs/console.txt +++ /dev/null @@ -1,58 +0,0 @@ -OPENTTD INGAME CONSOLE DOCUMENTATION -==================================== -http://wiki.openttd.org/index.php/OpenTTDDevBlackBook -for detailed information - -*** WARNING ** - This document is out of date -*** WARNING ** - -HOTKEY: BACKQUOTE (aka tilde, the key left to "1") - -COMMANDS: ---------- - -echo [string] -echoc [color-code] [string] -exit -debug_level [0-9] -dump_vars [filter] -help -list_cmds [filter] -list_vars [filter] -printf [formatstring] [var] [var] [var].... -printfc [color-code] [formatstring] [var] [var] [var].... -quit -random -screenshot ["big"/"no_con"] - -VARIABLES: ----------- -*con_developer --> true = console debugging info --> false = no output - -*developer --> 0 = no output --> 1 = console error output [like command not found] --> 2 = console error and debug output - -*cursor_rate --> 1-12 = defines the cursor blink interval - - -VARIABLE HANDLING: ------------------- - -developer = 0 -developer ++ - -temp_string = test -temp_string = "my little" - -printf "%s world" temp_string - - ---------------------------------------------------- -feel free to add more commands and use this in-game -console for your debugging / enhancements diff --git a/docs/multiplayer.txt b/docs/multiplayer.txt index 77a6d7ad84..ffe7ab9fb3 100644 --- a/docs/multiplayer.txt +++ b/docs/multiplayer.txt @@ -9,7 +9,7 @@ Multiplayer Manual for OpenTTD (0.3.5) - Type in a game name - Select the type of game ('LAN/Internet' or 'Internet (advertise)'. With the last one other people are able to see you online. Else they need your IP and port to join) - - Click "start game" ,"load game" or "load scenario" + - Click "start game", "load game" or "load scenario" - Start playing @@ -46,7 +46,7 @@ Multiplayer Manual for OpenTTD (0.3.5) - Open the console and type in the following command: - ]connect :# + connect :# 4. Playing Internet-Games @@ -54,7 +54,9 @@ Multiplayer Manual for OpenTTD (0.3.5) - Since OpenTTD 0.3.5 the network protocol has been rewritten and is very stable, even over slow connections. - - Server with a red dot behind it have a different version then you have. You will not be able to join those servers. + - Servers with a red dot behind it have a different version then you have. You will not be able to join those servers. + + - Servers with a yellow dot behind it have NewGRFs that you do not have. You will not be able to join those servers. - It can happen that a connection is that slow, or you have that many clients connected to your server, that your clients start to loose their connection. Some things you can do about it: @@ -110,3 +112,10 @@ Multiplayer Manual for OpenTTD (0.3.5) - From 0.3.5, desyncs should not happen anymore - From 0.3.5, patch-settings are also synced. You can now play without deleting openttd.cfg, and with, for example, extra large trains enabled. + +7. Troubleshooting +------------------ + + - My advertised server does not show up in the 'advertised server list' (servers.openttd.org) + Run openttd with the '-d net=2' parameter, as this will show whether it receives replies from the master server. + If it does not receive replies it is most likely that you need to configure your router to forward the OpenTTD ports 3979 (both TCP and UDP) to the computer that is hosting the game. diff --git a/readme.txt b/readme.txt index 7a7fb5ecce..184b5a0a02 100644 --- a/readme.txt +++ b/readme.txt @@ -35,7 +35,7 @@ more information, see the file 'COPYING'. ---- ---------- The easiest way to contact the OpenTTD team is by submitting bug reports or posting comments in our forums. You can also chat with us on IRC (#openttd -on irc.freenode.net). +on irc.oftc.net). The OpenTTD homepage is http://www.openttd.org/. @@ -54,7 +54,7 @@ is not already known. The Flyspray project page URL is: http://bugs.openttd.org/ Please include the following information in your bug report: - - OpenTTD version (PLEASE test the latest SVN/daily build) + - OpenTTD version (PLEASE test the latest SVN/nightly build) - Bug details, including instructions how to reproduce it - Platform and compiler (Win32, Linux, FreeBSD, ...) - Attach a saved game or a screenshot if possible @@ -70,13 +70,13 @@ OpenTTD has been ported to several platforms and operating systems. It shouldn't be very difficult to port it to a new platform. The currently working platforms are: - BeOS - SDL - FreeBSD - SDL - Linux - SDL - MacOS X (universal) - Cocoa video and sound drivers (SDL works too, but not 100% and not as a universal binary) - MorphOS - SDL - OS/2 - SDL - Windows - Win32 GDI (faster) or SDL + BeOS - SDL + FreeBSD - SDL + Linux - SDL + MacOS X (universal) - Cocoa video and sound drivers (SDL works too, but not 100% and not as a universal binary) + MorphOS - SDL + OS/2 - SDL + Windows - Win32 GDI (faster) or SDL 4.0) Running OpenTTD: @@ -120,7 +120,7 @@ Several important non-standard controls: * Use Ctrl to place semaphore signals * Ctrl-D toggles double mode in the Windows version * Ingame console. More information at - http://wiki.openttd.org/index.php/OpenTTDDevBlackBook + http://wiki.openttd.org/index.php/Console 6.0) Configuration File: @@ -149,12 +149,11 @@ Windows: Unix: OpenTTD can be built with GNU "make". On non-GNU systems it's called "gmake". Note that you need SDL-devel 1.2.5 (or higher) to compile OpenTTD. - (see also docs/Readme_Mandrake_Linux.txt) MacOS X: Use "make" or Xcode (which will then call make for you) - This will give you a binary for your CPU type (PPC/Intel) - To make a universal binary type "make UNIVERSAL_BINARY:=1" + This will give you a binary for your CPU type (PPC/Intel) + To make a universal binary type "make UNIVERSAL_BINARY:=1" BeOS: Use "make". @@ -272,13 +271,13 @@ The OpenTTD team (in alphabetical order): Bjarni Corfitzen (Bjarni) - Mac OS X port, coder Matthijs Kooijman (blathijs) - Pathfinder-guru Victor Fischer (Celestar) - Programming everywhere you need him to - Tamás Faragó (Darkvater) - Lead programmer - Loïc Guilloux (glx) - In training, not yet specialized + Tamás Faragó (Darkvater) - Lead programmer + Loïc Guilloux (glx) - In training, not yet specialized Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;) Kerekes Miham (MiHaMiX) - Maintainer of translator service, and host of nightlies Peter Nelson (peter1138) - Spiritual descendant from newgrf gods - Remko Bijker (Rubidium) - Belugas code scrutinizer", + Remko Bijker (Rubidium) - Programmer Christoph Mallon (Tron) - Programmer, code correctness police Patric Stout (TrueLight) - Programmer, network guru, SVN-repository and website host @@ -289,18 +288,18 @@ Retired Developers: Serge Paquet (vurlix) - Assistant project manager, coder (0.1 - 0.3.3) Thanks to: - Josef Drexler - For his great work on TTDPatch. - Marcin Grzegorczyk - For his TTDPatch work and documentation of TTD internals and graphics (signals and track foundations) - Matthijs Kooijman (blathijs) - For his many patches, suggestions and major work on maprewrite - Petr Baudis (pasky) - Many patches, newgrf support, etc. - Simon Sasburg (HackyKid) - For the many bugfixes he has blessed us with (and future PBS) - Stefan Meißner (sign_de) - For his work on the console - Mike Ragsdale - OpenTTD installer - Cian Duffy (MYOB) - BeOS port / manual writing - Christian Rosentreter (tokai) - MorphOS / AmigaOS port - Richard Kempton (richK) - additional airports, initial TGP implementation - Michael Blunck - For revolutionizing TTD with awesome graphics - George - Canal graphics - All Translators - For their support to make OpenTTD a truly international game - Bug Reporters - Thanks for all bug reports - Chris Sawyer - For an amazing game! + Josef Drexler - For his great work on TTDPatch. + Marcin Grzegorczyk - For his TTDPatch work and documentation of TTD internals and graphics (signals and track foundations) + Matthijs Kooijman (blathijs) - For his many patches, suggestions and major work on maprewrite + Petr Baudis (pasky) - Many patches, newgrf support, etc. + Simon Sasburg (HackyKid) - For the many bugfixes he has blessed us with (and future PBS) + Stefan Meißner (sign_de) - For his work on the console + Mike Ragsdale - OpenTTD installer + Cian Duffy (MYOB) - BeOS port / manual writing + Christian Rosentreter (tokai) - MorphOS / AmigaOS port + Richard Kempton (RichK67) - Additional airports, initial TGP implementation + Michael Blunck - For revolutionizing TTD with awesome graphics + George - Canal graphics + All Translators - For their support to make OpenTTD a truly international game + Bug Reporters - Thanks for all bug reports + Chris Sawyer - For an amazing game!