
HOW TO USE
----------

To enable the mouse, make sure that the "Use Mouse" toggle in the
"Doom Setup" popup is enabled.  If the mouse is enabled, the pointer
will be grabbed automatically when it first enters the DOOM window.
The "Scroll Lock" key is used to toggle the pointer grab.


USEFUL FEATURES
---------------

* Disabling Vertical Mouse Motion

Included in this patch is the ability to disable vertical mouse
movement.  Using the mouse is annoying when walking along narrow
ledges.  The slight vertical movement that inadvertently occurs while
making a turn often causes the DOOM marine to fall into the muck.

To get around this problem, I've added a way to temporarily disable
vertical mouse motion.  You can toggle vertical mouse motion on and
off by double-clicking the mouse strafe button.  The strafe button is
button 2 by default.

I tend to leave the vertical motion enabled until I come to a narrow
ledge.  Then I double-click to disable vertical mouse motion, start
walking across the ledge (or running like mad if playing deathmatch),
and double-click again when I'm back on solid ground to enable the
vertical mouse motion.


* Pausing single player or network game

The mouse patch includes a pause feature where the "Pause" key can be
used to pause the game.  Pressing any subsequent key will resume the
game.  If the mouse is grabbed, it will be released for the duration
of the pause and will be automatically re-grabbed when the game is
resumed.  A watch cursor will appear while the pause is in effect.
When the game is paused, DOOM's CPU usage will drop to zero.  This is
better than just hitting Esc because Esc does not free up the CPU.
The pause feature is disabled for networked games.


* Speed toggle

Normally, to run fast you need to hold down the shift key.  With the
mouse patch, you can use either CapsLock or NumLock to turn speed on
and off.  Much easier on the pinkie finger!


* Audio keys

When you are playing doom, the Sun audio keys can be used to control
the global audio levels.  Mute, raise volume, and lower volume are all
enabled.  Mute is really useful if someone important who doesn't like
DOOM walks in your office.


Comments are welcome, but I do not promise any support whatsoever
(see copyright notice in mouse.c).

Author:  Douglas R. Stein
         dstein@sun.com
