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.zip".

    19

(Note that a newer version of SDL is now available at

    20

ftp://ftp.netlabs.org/pub/sdl/sdl-dev-os2-2004-12-22.zip which may

    21

help solve some problems).

    22

    23

Note that to actually play the game, I have found in my own

    24

experience that a version of the Scitech Display Drivers or its later

    25

incarnation (see www.scitech.com) are necessary for it to work. If

    26

you have trouble with your native drivers, try the Scitech drivers

    27

and see if they help the problem.

    28

    29

KNOWN ISSUES

    30

------------

    31

    32

- If an error occurs during loading, the OS/2 error message window

    33

  is not always displayed.

    34

    35

A NOTE ABOUT MUSIC

    36

------------------

    37

    38

OpenTTD includes a music driver which uses the MCI MIDI system. Unfortunately,

    39

due to the lack of proper MIDI hardware myself, I have been unable to test it,

    40

but during testing, I found that when MIDI was enabled, I got no sound

    41

effects. I therefore decided to DISABLE music by default.

    42

    43

To enable music, start OpenTTD with the command line:

    44

    45

   openttd -m os2

    46

    47

If I hear enough responses that both music and sound work together (it might

    48

just be my system), I'll have the defaults changed.

    49

    50

A NOTE ABOUT DEDICATED MULTIPLAYER SERVERS

    51

------------------------------------------

    52

    53

To start a dedicated multiplayer server, you should run the dedicated.cmd

    54

file. This enables OpenTTD to open up a VIO console window to display

    55

its output and gather any necessary input. Running "openttd -D"

    56

directly will result in the console not being displayed. You may

    57

still pass any other parameters ('-D' is already passed) to

    58

dedicated.cmd.

    59

    60

=========================

    61

BUILDING THE OS/2 VERSION

    62

=========================

    63

    64

Compiler

    65

--------

    66

    67

Open Watcom 1.3 was used to build OpenTTD (earlier versions will

    68

NOT work). See http://www.openwatcom.org/ to download it. It may

    69

also be possible to build OpenTTD with GCC: I attempted this

    70

before using Open Watcom, but found the tools available for OS/2

    71

at the time to be a bit more tricky to get working.

    72

    73

Due to complexities in my set-up, I actually used the Win32 version

    74

of Open Watcom to initially compile OpenTTD for OS/2. There should

    75

be no reason of course why the OS/2 version cannot be used, and I

    76

have subsequently built OpenTTD successfully this way.

    77

    78

Libraries Required

    79

------------------

    80

    81

The following libraries are required. To build zlib and libpng, I

    82

simply added the required files (watch out for sample programs, etc)

    83

to an IDE project file and built a library. Do not use the makefiles

    84

provided, they are not designed for Watcom (apart from SDL):

    85

    86

- zlib

    87

  http://www.zlib.org/ - contains a makefile for OS/2, but is out

    88

  of date and uses EMX, ignore this

    89

    90

- libpng

    91

  http://www.libpng.org/ - contains an EMX/gcc makefile, ignore this

    92

    93

- SDL for OS/2

    94

  For 0.3.5, I used ftp://ftp.netlabs.org/pub/sdl/SDL-1.2.7-src-20040908a.zip -

    95

  take SDL.dll and SDL.lib from the src/ directory. Note that 20041222 is

    96

  out now, which is recommended for stability updates.

    97

    98

If you do not wish to build the libraries yourself, pre-built versions

    99

can be downloaded from the Files section at

   100

http://sourceforge.net/projects/openttd/ - see "os2-useful.zip".

   101

   102

A Note About Subversion Revision Numbers

   103

----------------------------------------

   104

   105

The project file uses a bit of a hack to find out the SVN revision number and

   106

create an appropriate rev.c file. You'll need the SVN tools in your path

   107

(specifically, "svnversion"). If "svnversion" can't be found, a generic rev.c

   108

with the revision set to "norev000" will be created. To specifically force a

   109

version number, set the environment variable "RELEASE" to the number (eg, "0.3.6")

   110

-before- starting the Open Watcom IDE (which must be launched from the same shell

   111

session). Also, beware, as you WILL cause incompatibilities if you try to

   112

play a multiplayer game with a different version.

   113

   114

Compiling

   115

---------

   116

   117

To compile, open the os/os2/openttd.wpj file in the IDE and first build

   118

the strgen.exe target. This will build the .lng file generator, and will

   119

also attempt to build all the language files (plus the table\strings.h

   120

file which is required for openttd.exe to be built). Once strgen.exe and

   121

the language files are built successfully, you can build the openttd.exe

   122

target.

   123

   124

Contact Information

   125

-------------------

   126

   127

If you have any questions regarding OS/2 issues, please contact me

   128

(owen@owenrudge.net) and I'll try to help you out. For general OpenTTD

   129

issues, see the Contacting section of readme.txt.

   130

   131

- Owen Rudge