Release Notes for v0.03 Build 243 Final of MidDoom
--------------------------------------------------
****** THIS IS THE LAST RELEASE OF MIDDOOM *******

-This particular version was written by Ryan Nunn (triforce@merlin.net.au)
 based upon DosDoom a port of LinuxDoom by Chi Hoang (cyhoang@acs.ucalgary.ca)
-DOOM is copyright ID software (www.idsoftware.com)
-This port is not endorsed by id software, so don't bug them about it
-I am not responsible for any damage that may be done by this program

Whats New since v0.02
---------------------
-Lots of Bug Fixes
-Player Stats HUD
-Player Names in Networking
-Menu System for choosing multiple IWADS

Whats Implemented
-----------------
-Mouse
-Keyboard
-Graphics
-Sound Effects
-Music - including: MIDI Music, Software Wavetable Synthesiser, CD Audio Music
-Networking
-Player Names in Network modes
-2 Toggleable Statistics Heads Up Displays
-Support for more than one IWAD in the directory

Commandline paramters accepted by MidDoom 
-----------------------------------------
-remap (file) - Specifies a CD Remap File where (file) is the filename of
                the CD Remap File

-heapsize (size) - Specifies the amount of Memory (in mb) for MidDoom to use (Defaults to 6)

-width (width) - Specifies the width of the resolution to be used
-height (height) - Specifies the height of the resolution to be used
 eg To play in 640x480 use -width 640 -height 480

-hicolor - Run MidDoom in 16Bit hi-color

-Plus any Commands that Work With Normal Doom

The Statistics Head Up Displays
-------------------------------
Level Stats HUD:

The Level Stats HUD is toggled by pressing the S key. When in AUTOMAP
mode it is always on.

The Level Stats HUD is two lines high and looks like one of the following
(note statistics are not real):
-Single Player or COOP
 Level 1: Entryway    Kills: 4 / 18
 Items: 3 / 5    Secrets: 4 / 6    Time: 0:54

-Deathmatch No Timer
 Green: 42   Indigo: 23   Time: 42:53
 Brown: -10   Red: 0

-Deathmatch With Timer
 Green: 42   Indigo: 23   Time Limit Enabled
 Brown: -10   Red: 0   Time Remaining: 5:53
 
The Level Stats HUD appears directly above the Status Bar or At the bottom of
the screen in Full Screen Mode.


The Player Stats HUD:

The Player Stats HUD is toggled with the H Key. The HUD has three modes. Off, Left and
Right.

Notes on Networking
-------------------
To do networking rename your doom.exe/doom2.exe to something else, copy
MidDoom.exe to Doom.exe/Doom2.exe and setup a network game like normal. After
your finished the network game copy the original exe files back if you want
to.

MidDoom's Metworking is compatable normal Doom Version 1.9 and only 1.9.

To change you name in networking go into the chat mode ('T') and type:
/name (your name)

Now in the Level stats hud your colour will be replaced with you name on all computers.

Multiple IWADs
--------------
If you have more than one IWAD (doom.wad, doomu.wad, doom2.wad, tnt.wad, etc) in your
MidDoom directory when you start up a selection list will appear. It might look like the
following

4 Valid IWADs found
Choose game mode! Press
2 for Doom 2: Hell on Earth
S for Doom Shareware

Press the corresponding key to play that doom! If you make press an invalid key MidDoom will
tell you.

Notes on the Sound Subsystem
----------------------------
Now included with MidDoom is ASETUP.EXE.

ASETUP is a modified version of a small setup program that comes with the
Allegro Source.

ASETUP changes all the settings for the Sound Subsystem. It allows Manual
Selection of sound card settings and settings for CD Audio.

The Maximum Amount of MIDI Channels (if shown) is 32. -1 is max.
The Maximum Amount of Digital Channels is 100. If more is set only 100 will
be used. If -1 is set 8 will be used.

For Software Wavetable Synthesis Notes see "Notes on the Software Wavetable
Synthesiser"
For CD Audio Notes see "Notes on CD Audio"

Notes on CD Audio
-----------------
In ASETUP in the CD Audio Dialog there are two options. CD Enabled and CD
Audio Only.

CD Enabled is just that. If it is checked CD Audio will be used. If not it
wont.

CD Audio Only specifies whether CD Audio is used for every level even if the
level doesn't have it's music on the Doom Music CD. If it is not checked the
levels without tracks will still use MIDI Music. If checked all levels will
have CD Music. The Levels without specified Music will play a predetermined
track. 

NOTE: Some things will always use MIDI. These are the title screens, the bunny
ending, the wolfenstein levels.

Remapping CD Tracks is done by the commandline parameter -remap (file).
The cd remap file has a very simple structure. 20 Numbers which are the
cd tracks. See the file remap.cd for an example of the format. Remap.cd
will reverse the track order.

A list of the Track Definitions is in tracks.def. NOTE this file does NOT
affect MidDoom's The Actual Definitions are in MidDoom.EXE

The Definitions of what tracks for what levels are in SOUNDS.C. Only
programming types should have to worry about that. Track 0 means no track.

Notes on the Software Wavetable Synthesiser
-------------------------------------------
To use the Software Wavetable Synthesiser you must have the GUS .PATs.
These can be obtained from
ftp://ftp.cdrom.com/pub/gus/sound/patches/files/gus-patches.zip . Decompress
them into a directory. Do not decompress them into your Doom/Doom 2 directory
as you default.cfg will be overwritten.

***NOTE The default.cfg file is not in the zip above. It is avaliable on my homepage in the
downloads section. http://arthur.merlin.net.au/~triforce/

Once you have these you use the Software Wavetable Synthesiser by going
into ASETUP and choosing Digital Midi as the Midi Device. Click on the Patches
check box and goto the directory where you decompressed the .PATs to and choose
DEFAULT.CFG. Channels should be set to no more than 32.

Known Bugs
----------
-MidDoom reports the wrong version of MSCDEX
-The Level Stats HUD get covered in small screen sizes
-Can't load save games for normal dos version of doom

Programming Notes
-----------------
This was compiled with DJGPP - http://www.delorie.com/djgpp/
I use the Allegro Library - http://www.talula.demon.co.uk/allegro/index.html
The CD Audio uses the BCD Library - http://brennan.home.ml.org/programming

Future Releases
---------------
It is unlikely to be any future releases of MidDoom.  

Aknowledgments
--------------
-id Software for Doom, Doom 2, ....
 Homepage: http://www.idsoftware.com

-Chi Hoang for the DosDoom Port
 DosDoom Homepage: http://www.acs.ucalgary.ca/~cyhoang/dosdoom/
 Email: cyhoang@acs.ucalgary.ca

-Andy Bay for the Win32 Doom Port

How to Contact Me
-----------------
Email: triforce@merlin.net.au
Homepage: http://arthur.merlin.net.au/~triforce
