IRE Source Code
===============

LINEFEEDS
---------

Some of the source files may be in MSDOS format, which will upset Linux and
BeOS.

If you have a string of errors like 'Stray \ in source file' or
'Unknown character 0x??', then this is almost certainly the case.

It fix it, you will need to download DOS2UNIX or a similar tool, which will
strip off the linefeeds from the source files.


Libraries needed to compile
===========================

You will need to have the following libraries to recompile the game.
I try to provide precompiled libraries whenever possible, so you shouldn't
NEED to recompile these unless you're targeting a new platform.
Please let me know if you're trying this.


Allegro
-------

Allegro is now a fundamental part of the game.  It can be replaced with
another library if absolutely necessary, but it will be a hell of a job,
one that I don't really want to do AGAIN (I had to remove the ITG dependencies
to put Allegro in!).  If your platform isn't properly supported by Allegro
it is probably best to help the Allegro project add support for it rather
than start from scratch with a different library.

Allegro lives at alleg.sourceforge.net

You will need to get a WORK-IN-PROGRESS version: as of this writing the
current version is 3.9.35.  The old v3.12 will NOT work.
It should work with v4.0 when it is eventually released.

Allegro is cross-platform between DOS, BeOS, Linux, Windows, Solaris and
most other UNIX-based operating systems.  In theory Alpha-NT support should
be easy since there are already GDI drivers for Windows.

For Windows users, it is probably best to get the pre-compiled library from
the main Allegro site.  If you wish to recompile you MAY need to install the
DJGPP DOS compiler as part of the initial build process (why?!?)

If you have difficulties with Allegro under Linux (e.g. IRE crashes on
startup and so do some of the examples) try configuring Allegro to disable
the assembler code.  This was a problem in 3.9.34 and '35.


AUDlib
------

Audlib is a library to play ADPCM-compressed streamed music.
Quality and compression aren't brilliant but it's faster than MP3 and if it
is patented, the holders don't seem to mind it's use.  Unlike MP3.

I have included a copy of the library in the AUDLIB directory.  For GCC-based
systems (DOS, Linux, Beos) you should just be able to unzip it and compile.
It won't compile for MSVC out-of-the-box.

To compile for MSVC:

1. Create a project to compile the library.  It is just one module, audlib.c

2. MSVC doesn't support inline functions.  Remove the 'inline' keywords.

3. Compile and hope.


BGUI
----

BGUI is a library to make the Allegro dialogs look like Windows 95.
Unfortunately it won't work under Windows itself (for some mental reason I
haven't tracked down yet), so MSVC users, you DON'T need to compile it.

(This gives the ironic situation that all the platforms look like Win95
 except for Windows 95 itself which now looks like Gem Desktop)

I have included a radically-modified version of this unmaintained library
in the BGUI directory.


SEER
----

You will need the modified SEER library in order to compile.
You must use SEER 0.94 (for binary compatability.. If you use a different
version, you will need to recompile all the VRMS and even then the game may
need to be adapted to suit it).  Currently this is the latest version.

Unfortunately it is bug-ridden so I have provided a fixed version of the
source code to compile from, and a list of changes in patch.094 directory.

SEER's homepage is http://home.elka.pw.edu.pl/~ppodsiad

When you have compiled it, copy the library files into the appropriate
LIBS\<system> directory.

Examples:

Dos:     libseer.a -> libs/dos
Linux:   libseer.a -> libs/linux
BeOS:    libseer.a -> libs/beos
MSVC:	 seer.lib  -> libs/win
	 (keep SEER.DLL in the current directory)

IRE should then link correctly, unless you are using MSVC, in which case, pray.


LIBJPEG
-------

You will also need the Independent JPEG group's libjpeg library to compile
the game.

This can be found on simtel and other places, use a search engine, or see the
accompanying readme.jpg file.

Once you've got the thing to compile (and this isn't always easy) you should
again copy it into the appropriate libs directory, as described in the section
above.

It is STRONGLY SUGGESTED that you remove or replace the bundled #include
files provided in the 'jpeg' directory, to prevent version conflicts.
