docs/Readme_OS2.txt

   1 OpenTTD: OS/2 version
   2 =====================
   3
   4 OpenTTD has been ported to work on OS/2 4.x or later (including
   5 eComStation). The game should work as well as it does on Windows
   6 or other platforms: the main issues you may encounter are graphics
   7 card problems, but that is really the fault of SDL.
   8
   9 =========================
  10 USING OPENTTD FOR OS/2
  11 =========================
  12
  13 LIBRARIES REQUIRED FOR END USERS
  14 --------------------------------
  15
  16 SDL.DLL (SDL 1.2.7) and FSLib.dll are required to use this program:
  17 these can be downloaded from the Files section at
  18 http://sourceforge.net/projects/openttd/ - see "os2-useful-v1.1.zip".
  19 Version 20051222 of SDL or later is required. This can be found at
  20 http://sdl.netlabs.org/.
  21
  22 Please note that earlier SDL releases will probably NOT work with
  23 OpenTTD. If you experience problems with OpenTTD, please check
  24 your SDL and FSLib.dll versions (both must match).
  25
  26 Note that to actually play the game, I have found in my own
  27 experience that a version of the Scitech Display Drivers or its later
  28 incarnation (see www.scitech.com) are necessary for it to work. If
  29 you have trouble with your native drivers, try the Scitech drivers
  30 and see if they help the problem.
  31
  32 KNOWN ISSUES
  33 ------------
  34
  35 - If an error occurs during loading, the OS/2 error message window
  36   is not always displayed.
  37
  38 A NOTE ABOUT MUSIC
  39 ------------------
  40
  41 OpenTTD includes a music driver which uses the MCI MIDI system. Unfortunately,
  42 due to the lack of proper MIDI hardware myself, I have been unable to test it,
  43 but during testing, I found that when MIDI was enabled, I got no sound
  44 effects. I therefore decided to DISABLE music by default.
  45
  46 To enable music, start OpenTTD with the command line:
  47
  48    openttd -m os2
  49
  50 If I hear enough responses that both music and sound work together (it might
  51 just be my system), I'll have the defaults changed.
  52
  53 Please note also that the GCC version does not currently support the MCI MIDI
  54 system.
  55
  56
  57 A NOTE ABOUT DEDICATED MULTIPLAYER SERVERS
  58 ------------------------------------------
  59
  60 To start a dedicated multiplayer server, you should run the dedicated.cmd
  61 file. This enables OpenTTD to open up a VIO console window to display
  62 its output and gather any necessary input. Running "openttd -D"
  63 directly will result in the console not being displayed. You may
  64 still pass any other parameters ('-D' is already passed) to
  65 dedicated.cmd.
  66
  67 You can find the dedicated.cmd file in the os/os2 directory.
  68
  69 =========================
  70 BUILDING THE OS/2 VERSION
  71 =========================
  72
  73 Compiler
  74 --------
  75
  76 Innotek GCC, an OS/2 port of the popular GCC compiler, was used to build OpenTTD.
  77 See www.innotek.de for more information. You WILL need a reasonably UNIX-like
  78 build environment in order to build OpenTTD successfully - the following link
  79 may help to set one up (although some of the links from that page are broken):
  80
  81    http://www.mozilla.org/ports/os2/gccsetup.html
  82
  83 Alternatively, Paul Smedley's ready-to-go GCC build environment has been known to
  84 successfully build the game:
  85
  86    http://www.smedley.info/os2ports/index.php?page=build-environment
  87
  88 To build, you should, if your environment is set up well enough, be able to just
  89 type `./configure' (or `sh configure' if you're using the OS/2 shell) and `make'.
  90
  91 You may have to manually specify `--os OS2' on the configure command line, as
  92 configure cannot always detect OS/2 correctly.
  93
  94 A note on Open Watcom
  95 ---------------------
  96
  97 Open Watcom C/C++ was previously used to build OpenTTD (version 0.4.x and earlier).
  98 However, due to advanced C++ features used in the YAPF portion of OpenTTD 0.5
  99 in particular, the compiler is no longer able to build the game at the moment.
 100 Hopefully one day Open Watcom will be able to catch up and we will be able to build
 101 the game once again (it's easier than getting an OS/2 UNIX-like environment set up
 102 in my opinion!), but until then, OpenTTD 0.5 and later can only be built with GCC.
 103
 104 Libraries Required
 105 ------------------
 106
 107 The following libraries are required. To build zlib and libpng, I
 108 simply added the required files (watch out for sample programs, etc)
 109 to an IDE project file and built a library. Do not use the makefiles
 110 provided, they are not designed for Watcom (apart from SDL):
 111
 112 - zlib
 113   http://www.zlib.org/
 114
 115 - libpng
 116   http://www.libpng.org/
 117
 118 - SDL for OS/2
 119   ftp://ftp.netlabs.org/pub/sdl/sdl-1.2.7-src-20051222.zip used for
 120   0.4.7
 121
 122 - Freetype
 123   http://freetype.sourceforge.net/
 124
 125 Currently, there are no pre-built libraries available for GCC. If you manage to get
 126 OpenTTD working on Watcom though (do let us know if this is the case!), pre-built
 127 versions can be downloaded from the Files section at
 128 http://sourceforge.net/projects/openttd/ - see "os2-useful-v1.1.zip".
 129
 130 Contact Information
 131 -------------------
 132
 133 If you have any questions regarding OS/2 issues, please contact me
 134 (owen@owenrudge.net) and I'll try to help you out. For general OpenTTD
 135 issues, see the Contacting section of readme.txt.
 136
 137 Thanks to Paul Smedley for his help with getting OpenTTD to compile under GCC on OS/2.
 138
 139 - Owen Rudge, 24th June 2007