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

Please note that SDL release 2005-03-30 does NOT work with OpenTTD,

    24

at least in my experience and the experience of a couple of other

    25

users. If you experience problems with OpenTTD, please try downgrading

    26

to SDL 2004-12-22.

    27

    28

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

    29

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

    30

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

    31

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

    32

and see if they help the problem.

    33

    34

KNOWN ISSUES

    35

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

    36

    37

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

    38

  is not always displayed.

    39

    40

A NOTE ABOUT MUSIC

    41

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

    42

    43

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

    44

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

    45

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

    46

effects. I therefore decided to DISABLE music by default.

    47

    48

To enable music, start OpenTTD with the command line:

    49

    50

   openttd -m os2

    51

    52

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

    53

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

    54

    55

A NOTE ABOUT DEDICATED MULTIPLAYER SERVERS

    56

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

    57

    58

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

    59

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

    60

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

    61

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

    62

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

    63

dedicated.cmd.

    64

    65

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

    66

BUILDING THE OS/2 VERSION

    67

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

    68

    69

Compiler

    70

--------

    71

    72

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

    73

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

    74

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

    75

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

    76

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

    77

    78

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

    79

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

    80

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

    81

have subsequently built OpenTTD successfully this way.

    82

    83

Libraries Required

    84

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

    85

    86

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

    87

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

    88

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

    89

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

    90

    91

- zlib

    92

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

    93

  of date and uses EMX, ignore this

    94

    95

- libpng

    96

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

    97

    98

- SDL for OS/2

    99

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

   100

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

   101

  out now, which is recommended for stability updates.

   102

   103

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

   104

can be downloaded from the Files section at

   105

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

   106

   107

A Note About Subversion Revision Numbers

   108

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

   109

   110

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

   111

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

   112

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

   113

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

   114

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

   115

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

   116

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

   117

play a multiplayer game with a different version.

   118

   119

Compiling

   120

---------

   121

   122

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

   123

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

   124

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

   125

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

   126

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

   127

target.

   128

   129

Contact Information

   130

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

   131

   132

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

   133

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

   134

issues, see the Contacting section of readme.txt.

   135

   136

- Owen Rudge