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

A NOTE ABOUT DEDICATED MULTIPLAYER SERVERS

    54

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

    55

    56

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

    57

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

    58

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

    59

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

    60

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

    61

dedicated.cmd.

    62

    63

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

    64

BUILDING THE OS/2 VERSION

    65

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

    66

    67

Compiler

    68

--------

    69

    70

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

    71

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

    72

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

    73

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

    74

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

    75

    76

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

    77

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

    78

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

    79

have subsequently built OpenTTD successfully this way.

    80

    81

Libraries Required

    82

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

    83

    84

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

    85

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

    86

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

    87

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

    88

    89

- zlib

    90

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

    91

  of date and uses EMX, ignore this

    92

    93

- libpng

    94

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

    95

    96

- SDL for OS/2

    97

  ftp://ftp.netlabs.org/pub/sdl/sdl-1.2.7-src-20051222.zip used for

    98

  0.4.7

    99

   100

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

   101

can be downloaded from the Files section at

   102

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

   103

   104

A Note About Subversion Revision Numbers

   105

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

   106

   107

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

   108

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

   109

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

   110

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

   111

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

   112

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

   113

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

   114

play a multiplayer game with a different version.

   115

   116

Compiling

   117

---------

   118

   119

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

   120

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

   121

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

   122

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

   123

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

   124

target.

   125

   126

Contact Information

   127

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

   128

   129

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

   130

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

   131

issues, see the Contacting section of readme.txt.

   132

   133

- Owen Rudge