~ubuntu-branches/debian/squeeze/openttd/squeeze

« back to all changes in this revision

Viewing changes to readme.txt

  • Committer: Bazaar Package Importer
  • Author(s): Matthijs Kooijman, Matthijs Kooijman
  • Date: 2009-10-01 22:52:59 UTC
  • mfrom: (1.1.8 upstream) (2.1.6 squeeze)
  • Revision ID: james.westby@ubuntu.com-20091001225259-5kpkp4sthbszpyif
[ Matthijs Kooijman ]
* New upstream release
* Use printf instead of echo -en in openttd-wrapper to make it POSIX
  compatible (Closes: #547758).
* Remove three patches that are now included in upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
OpenTTD README
2
 
Last updated:    2009-06-09
3
 
Release version: 0.7.1
 
2
Last updated:    2009-10-01
 
3
Release version: 0.7.3
4
4
------------------------------------------------------------------------
5
5
 
6
6
 
17
17
5.0) OpenTTD features
18
18
6.0) Configuration File
19
19
7.0) Compiling
 
20
 * 7.1) Required/optional libraries
20
21
8.0) Translating
21
22
 * 8.1 Guidelines
22
23
 * 8.2 Translation
48
49
 
49
50
2.1) Reporting Bugs:
50
51
---- ---------------
51
 
To report a bug, please create a Flyspray account and follow the bugs
52
 
link from our homepage. Please make sure the bug is reproducible and
53
 
still occurs in the latest daily build or the current SVN version. Also
54
 
please look through the existing bug reports briefly to see whether the bug
55
 
is not already known.
56
 
 
57
 
The Flyspray project page URL is: http://bugs.openttd.org/
58
 
 
59
 
Please include the following information in your bug report:
60
 
        - OpenTTD version (PLEASE test the latest SVN/nightly build)
61
 
        - Bug details, including instructions how to reproduce it
62
 
        - Platform and compiler (Win32, Linux, FreeBSD, ...)
63
 
        - Attach a saved game *and* a screenshot if possible
64
 
        - If this bug only occurred recently please note the last
65
 
          version without the bug and the first version including
66
 
          the bug. That way we can fix it quicker by looking at the
67
 
          changes made.
68
 
        - Attach crash.dmp, crash.log and crash.sav from the data
69
 
          directory if they exist.
 
52
First of all, check whether the bug is not already known. Do this by looking
 
53
through the file called 'known-bugs.txt' which is distributed with OpenTTD
 
54
like this readme.
 
55
 
 
56
For tracking our bugs we are using a bug tracker called Flyspray. You can find
 
57
the tracker at http://bugs.openttd.org/. Before actually reporting take a look
 
58
through the already reported bugs there to see if the bug is already known.
 
59
The 'known-bugs.txt' file might be a bit outdated at the moment you are
 
60
reading it as only bugs known before the release are documented there. Also
 
61
look through the recently closed bugs.
 
62
 
 
63
When you are sure it is not already reported you should:
 
64
 * Make sure you are running a recent version, i.e. run the latest stable or
 
65
   nightly based on where you found the bug.
 
66
 * Make sure you are not running a non-official binary, like a patch pack.
 
67
   When you are playing with a patch pack you should report any bugs to the
 
68
   forum thread related to that patch pack.
 
69
 * Make it reproducable for the developers. In other words, create a savegame
 
70
   in which you can reproduce the issue once loaded. It is very useful to give
 
71
   us the crash.dmp, crash.sav and crash.log which are created on crashes.
 
72
 * Check whether the bug is already reported on our bug tracker. This includes
 
73
   searching for recently closed bug reports as the bug might already be fixed.
 
74
 
 
75
After you have done all that you can report the bug. Please include the
 
76
following information in your bug report:
 
77
 * OpenTTD version (PLEASE test the latest SVN/nightly build)
 
78
 * Bug details, including instructions how to reproduce it
 
79
 * Platform (Win32, Linux, FreeBSD, ...) and compiler (including version) if
 
80
   you compiled OpenTTD yourself.
 
81
 * Attach a saved game *and* a screenshot if possible
 
82
 * If this bug only occurred recently please note the last version without
 
83
   the bug and the first version including the bug. That way we can fix it
 
84
   quicker by looking at the changes made.
 
85
 * Attach crash.dmp, crash.log and crash.sav. These files are usually created
 
86
   next to your openttd.cfg. The crash handler will tell you the location.
70
87
 
71
88
2.2) Reporting Desyncs:
72
89
---- ------------------
191
208
the following sections) as sooner or later you will run into graphical glitches
192
209
when using other versions of the game.
193
210
 
 
211
If you want AIs use the in-game content downloader. If for some reason that is
 
212
not possible or you want to use an AI that has not been uploaded to the content
 
213
download system download the tar file and place it in the ai/ directory. If the
 
214
AI needs libraries you'll have to download those too and put them in the
 
215
ai/library/ directory. All AIs and AI Libraries that have been uploaded to
 
216
the content download system can be found at http://noai.openttd.org/downloads/
 
217
The AIs and libraries can be found their in the form of .tar.gz packages.
 
218
OpenTTD can read inside tar files but it does not extract .tar.gz files by
 
219
itself.
 
220
To figure out which libraries you need for an AI you have to start the AI and
 
221
wait for an error message to pop up. The error message will tell you
 
222
"couldn't find library 'lib-name'". Download that library and try again.
 
223
 
194
224
4.2) OpenTTD directories
195
225
---- -------------------------------
196
226
 
316
346
  You can also build it using the Makefile with MSYS/MinGW or Cygwin/MinGW.
317
347
  Please read the Makefile for more information.
318
348
 
319
 
Solaris 10:
320
 
  You need g++ (version 3 or higher), together with SDL. Installation of
321
 
  libpng and zlib is recommended. For the first build it is required
322
 
  to execute "bash configure" first. Note that ./configure does not work
323
 
  yet. It is likely that you don't have a strip binary, so use the
324
 
  --disable-strip option in that case. Fontconfig (>2.3.0) and freetype
325
 
  are optional. "make run" will then run the program.
 
349
Solaris, FreeBSD, OpenBSD:
 
350
  Use "gmake", but do a "./configure" before the first build.
326
351
 
327
 
Unix:
 
352
Linux/Unix:
328
353
  OpenTTD can be built with GNU "make". On non-GNU systems it's called "gmake".
329
354
  However, for the first build one has to do a "./configure" first.
330
 
  Note that you need SDL-devel 1.2.5 (or higher) to compile OpenTTD.
331
355
 
332
356
MacOS X:
333
357
  Use "make" or Xcode (which will then call make for you)
339
363
BeOS:
340
364
  Use "make", but do a "./configure" before the first build.
341
365
 
342
 
FreeBSD:
343
 
  You need the port devel/sdl12 for a non-dedicated build.
344
 
  graphics/png is optional for screenshots in the PNG format.
345
 
  Use "gmake", but do a "./configure" before the first build.
346
 
 
347
 
OpenBSD:
348
 
  Use "gmake", but do a "./configure" before the first build.
349
 
  Note that you need the port devel/sdl to compile OpenTTD.
350
 
 
351
366
MorphOS:
352
367
  Use "make". However, for the first build one has to do a "./configure" first.
353
368
  Note that you need the MorphOS SDK, latest libnix updates (else C++ parts of
368
383
  will be generated that does not need cwsdpmi.exe by adding the cswdstub.exe
369
384
  to the created OpenTTD binary.
370
385
 
 
386
7.1) Required/optional libraries:
 
387
---- -------------------
371
388
The following libraries are used by OpenTTD for:
372
389
  - libSDL/liballegro: hardware access (video, sound, mouse)
373
390
  - zlib: (de)compressing of savegames
376
393
  - libfontconfig: searching for fonts, resolving font names to actual fonts
377
394
  - libicu: handling of right-to-left scripts (e.g. Arabic and Persian)
378
395
 
 
396
OpenTTD does not require any of the libraries to be present, but without
 
397
zlib you cannot open most savegames or use the content downloading system.
 
398
Without libSDL/liballegro on non-Windows and non-MacOS X machines you have
 
399
no graphical user interface; you would be building a dedicated server.
 
400
 
379
401
8.0) Translating:
380
402
---- -------------------
381
403
See http://www.openttd.org/development for up-to-date information.
382
404
 
383
405
The use of the online Translator service, located at
384
 
http://translator2.openttd.org/, is highly encouraged. For a username/password
385
 
combo you should contact the development team, either by mail, IRC or the
386
 
forums. The system is straightforward to use, and if you have any problems,
387
 
read the online help located there.
 
406
http://translator.openttd.org/, is highly encouraged. For getting an account
 
407
simply follow the guidelines in the FAQ of the translator website.
388
408
 
389
409
If for some reason the website is down for a longer period of time, the
390
410
information below might be of help.
479
499
  Owen Rudge (orudge)            - Forum host, OS/2 port
480
500
  Peter Nelson (peter1138)       - Spiritual descendant from newGRF gods
481
501
  Remko Bijker (Rubidium)        - Lead coder and way more
482
 
  Zdenek Sojka (SmatZ)           - Bug finder and fixer
 
502
  Zdeněk Sojka (SmatZ)           - Bug finder and fixer
483
503
  Thijs Marinussen (Yexo)        - AI Framework
484
504
 
485
505
Inactive Developers:
486
506
  Tamás Faragó (Darkvater)       - Ex-Lead coder
487
507
  Jaroslav Mazanec (KUDr)        - YAPG (Yet Another Pathfinder God) ;)
488
508
  Jonathan Coome (Maedhros)      - High priest of the NewGRF Temple
489
 
  Attila Bán (MiHaMiX)           - WebTranslator, Nightlies, Wiki and bugtracker host
 
509
  Attila Bán (MiHaMiX)           - WebTranslator 1 and 2
490
510
  Christoph Mallon (Tron)        - Programmer, code correctness police
491
511
 
492
512
Retired Developers:
494
514
  Serge Paquet (vurlix)          - Assistant project manager, coder (0.1 - 0.3.3)
495
515
  Dominik Scherer (dominik81)    - Lead programmer, GUI expert (0.3.0 - 0.3.6)
496
516
  Benedikt Brüggemeier (skidd13) - Bug fixer and code reworker
497
 
  Patric Stout (TrueLight)       - Programmer, webhoster (0.3 - pre0.7)
 
517
  Patric Stout (TrueLight)       - Programmer (0.3 - pre0.7), sys op (active)
498
518
 
499
519
Thanks to:
500
520
  Josef Drexler                  - For his great work on TTDPatch.
501
521
  Marcin Grzegorczyk             - For his TTDPatch work and documentation of TTD internals and graphics (signals and track foundations)
502
 
  Petr Baudis (pasky)            - Many patches, newgrf support, etc.
 
522
  Petr Baudiš (pasky)            - Many patches, newgrf support, etc.
503
523
  Simon Sasburg (HackyKid)       - For the many bugfixes he has blessed us with
504
524
  Stefan Meißner (sign_de)       - For his work on the console
505
525
  Mike Ragsdale                  - OpenTTD installer
507
527
  Christian Rosentreter (tokai)  - MorphOS / AmigaOS port
508
528
  Richard Kempton (RichK67)      - Additional airports, initial TGP implementation
509
529
  Alberto Demichelis             - Squirrel scripting language
 
530
  Markus F.X.J. Oberhumer        - MiniLZO for loading old savegames
 
531
  L. Peter Deutsch               - MD5 implementation
510
532
  Michael Blunck                 - For revolutionizing TTD with awesome graphics
511
533
  George                         - Canal graphics
512
534
  David Dallaston (Pikka)        - Tram tracks