docs/Readme_OS2.txt
changeset 810 7c51ba5a4368
parent 782 3c1414ad5fbc
child 818 906f21e653b2
equal deleted inserted replaced
809:86cc46f97149 810:7c51ba5a4368
     1 OpenTTD: OS/2 version  ** CURRENTLY INCOMPLETE **
     1 OpenTTD: OS/2 version
     2 =====================
     2 =====================
     3 
     3 
     4 OpenTTD has been ported to work on OS/2 4.x or later (including eComStation). At the moment, it does not work properly, but it
     4 OpenTTD has been ported to work on OS/2 4.x or later (including
     5 can compile and work to an extent.
     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.zip".
       
    19 
       
    20 Note that to actually play the game, I have found in my own
       
    21 experience that a version of the Scitech Display Drivers or its later
       
    22 incarnation (see www.scitech.com) are necessary for it to work. If
       
    23 you have trouble with your native drivers, try the Scitech drivers
       
    24 and see if they help the problem.
       
    25 
       
    26 KNOWN ISSUES
       
    27 ------------
       
    28 
       
    29 - If an error occurs during loading, the OS/2 error message window
       
    30   is not always displayed.
       
    31 
       
    32 A NOTE ABOUT MUSIC
       
    33 ------------------
       
    34 
       
    35 OpenTTD includes a music driver which uses the MCI MIDI system. Unfortunately,
       
    36 due to the lack of proper MIDI hardware myself, I have been unable to test it,
       
    37 but during testing, I found that when MIDI was enabled, I got no sound
       
    38 effects. I therefore decided to DISABLE music by default.
       
    39 
       
    40 To enable music, start OpenTTD with the command line:
       
    41 
       
    42    openttd -m os2
       
    43 
       
    44 If I hear enough responses that both music and sound work together (it might
       
    45 just be my system), I'll have the defaults changed.
       
    46 
       
    47 A NOTE ABOUT DEDICATED MULTIPLAYER SERVERS
       
    48 ------------------------------------------
       
    49 
       
    50 To start a dedicated multiplayer server, you should run the dedicated.cmd
       
    51 file. This enables OpenTTD to open up a VIO console window to display
       
    52 its output and gather any necessary input. Running "openttd -D"
       
    53 directly will result in the console not being displayed. You may
       
    54 still pass any other parameters ('-D' is already passed) to
       
    55 dedicated.cmd.
       
    56 
       
    57 =========================
       
    58 BUILDING THE OS/2 VERSION
       
    59 =========================
     6 
    60 
     7 Compiler
    61 Compiler
     8 --------
    62 --------
     9 
    63 
    10 Open Watcom 1.3 was used to build OpenTTD (earlier versions will NOT work). See http://www.openwatcom.org/ to download it.
    64 Open Watcom 1.3 was used to build OpenTTD (earlier versions will
    11 It may also be possible to build OpenTTD under OS/2: I attempted this before using Open Watcom, but found the tools available
    65 NOT work). See http://www.openwatcom.org/ to download it. It may
    12 for OS/2 at the time to be a bit more tricky to get working.
    66 also be possible to build OpenTTD under OS/2: I attempted this
       
    67 before using Open Watcom, but found the tools available for OS/2
       
    68 at the time to be a bit more tricky to get working.
    13 
    69 
    14 Due to complexities in my set-up, I actually used the Win32 version of Open Watcom to initially compile OpenTTD for OS/2. There
    70 Due to complexities in my set-up, I actually used the Win32 version
    15 should be no reason of course why the OS/2 version cannot be used.
    71 of Open Watcom to initially compile OpenTTD for OS/2. There should
       
    72 be no reason of course why the OS/2 version cannot be used.
    16 
    73 
    17 Libraries Required
    74 Libraries Required
    18 ------------------
    75 ------------------
    19 
    76 
    20 The following libraries are required. To build zlib and libpng, I simply added the required files (watch out for sample
    77 The following libraries are required. To build zlib and libpng, I
    21 programs, etc) to an IDE project file and built a library:
    78 simply added the required files (watch out for sample programs, etc)
       
    79 to an IDE project file and built a library. Do not use the makefiles
       
    80 provided, they are not designed for Watcom (apart from SDL):
    22 
    81 
    23 - zlib
    82 - zlib
    24   http://www.zlib.org/ - contains a makefile for OS/2, but is out of date and uses EMX
    83   http://www.zlib.org/ - contains a makefile for OS/2, but is out
       
    84   of date and uses EMX
    25 
    85 
    26 - libpng
    86 - libpng
    27   http://www.libpng.org/ - contains an EMX/gcc makefile
    87   http://www.libpng.org/ - contains an EMX/gcc makefile
    28 
    88 
    29 - SDL for OS/2
    89 - SDL for OS/2
    30   I used ftp://ftp.netlabs.org/pub/sdl/SDL-1.2.7-src-20040908a.zip - take SDL.dll and SDL.lib from the src/ directory.
    90   I used ftp://ftp.netlabs.org/pub/sdl/SDL-1.2.7-src-20040908a.zip -
       
    91   take SDL.dll and SDL.lib from the src/ directory.
    31 
    92 
    32 Note that to use the compiled program, you also need FSLib.dll (from src/ in the SDL zip) and a version of the Scitech
    93 If you do not wish to build the libraries yourself, pre-built versions
    33 Display Drivers or its later incarnation (see www.scitech.com).
    94 can be downloaded from the Files section at
       
    95 http://sourceforge.net/projects/openttd/ - see "os2-useful.zip".
    34 
    96 
    35 Compiling
    97 Compiling
    36 ---------
    98 ---------
    37 
    99 
    38 To compile, open the os/os2/openttd.wpj file in the IDE and build the openttd.exe target.
   100 To compile, open the os/os2/openttd.wpj file in the IDE and first build
       
   101 the strgen.exe target. This will build the .lng file generator, and will
       
   102 also attempt to build all the language files (plus the table\strings.h
       
   103 file which is required for openttd.exe to be built). Once strgen.exe and
       
   104 the language files are built successfully, you can build the openttd.exe
       
   105 target.
    39 
   106 
    40 TODO: compilation of language files properly
   107 Contact Information
       
   108 -------------------
    41 
   109 
       
   110 If you have any questions regarding OS/2 issues, please contact me
       
   111 (owen@owenrudge.net) and I'll try to help you out. For general OpenTTD
       
   112 issues, see the Contacting section of readme.txt.
    42 
   113 
    43 ** THESE DOCS ARE INCOMPLETE FOR THE MOMENT, WILL BE COMPLETED SOON **
   114 - Owen Rudge, 26th December 2004
    44 
       
    45 If you have any questions, please contact me (owen@owenrudge.net) and I'll try to help you out
       
    46 
       
    47 - Owen Rudge, 18th December 2004
       
    48