Troubleshooting guide (bug reports)
=====================


The Logfile
-----------

First and foremost, if IRE crashes when the game is running, please, please
please send me the BOOTLOG.TXT file.

This will be found in the installation directory in Windows, DOS and BeOS.

Under Linux (and any other Unices), it will be found in the .ire directory
in your home area.

If you run the game or the editor after the crash, it will be copied to
BOOTLOG.PRV.  If the game or editor is run a third time, it will be erased.
Hence, you should copy the file somewhere safe after a crash has happened.



Repeatable Crashes
------------------

If IRE crashes, first copy the bootlog file somewhere safe so it doesn't
get overwritten.  Then, please try to figure out what you were doing at
the time.

If you can manage, a set of steps that cause the crash to happen will be
invaluable for debugging.


Useful information can also be gained by running the game with the
-debugvrm switch.  This will slow the game down slightly and produce a
larger log file.

The most verbose logfile can be obtained with -debugvm but this will slow
the game down IMMENSELY and is not recommended unless you are trying to
debug scripts (and the script parser!).

It is possible to turn this feature on and off in-game by pressing shift-F3.
If you can do this just before the crash happens, the output will be helpful.


Reporting bugs
--------------

There is now a general-purpose mailing list at the following address:
ire-users@lists.sourceforge.net

The archives can be browsed from the IRE project page on Sourceforge,
if you don't feel like subscribing.

To browse (or subscribe), visit the following pages:
http://sourceforge.net/mail/?group_id=17640
