============================
Quake 1.01 for IBM OS/2 v4.x
Released by: A friend
Documentation by: CandyMan, and others
============================


What is it?  Why is it?
-----------------------
Id didn't write Quake for OS/2.  They wrote it for Dos/W95 and Unix. This
port allows someone with a previously installed copy of DOS/W95 Quake to run
a FULL-SCREEN OS/2 version.  The main reason for this port is to allow
the OS/2 version to use the OS/2 TCPIP stack so we can go whoop those Win95
players <BG>.  Since this is version 1.01 (and DOS Quake is at version
1.06), there are a few bugs inherent in the Id code.  Sorry.


Requirements
------------
    - OS/2 v4.x (Merlin)
    - 16 megs of RAM minimum
    - A previously installed version of DOS Quake
    - Sound card
    - Mouse
    - Network card
      (network play; internet play if connected to outside world)
    - 28.8 connect minimum
      (modem play; internet play thru your Internet Provider)
    - Pentium 166 or better for 640x480 and higher resolution modes
      (for smooth play; a slower machine WILL work if you don't mind
       choppy framerates)


Limitations
-----------
    - No CD music
    - No joystick support
    - 640x480 and higher video modes not supported on Matrox OS/2 drivers, or
      any other video card that does not use svga.exe/svgadata.pmi interface.

Installation
------------
    - Copy QUAKEFS.EXE to your Quake directory and run it in an OS/2
      full screen session.
   

Command Line Options (OS/2 only)
--------------------------------
  -nobg          -- Do not run in background (use this if you're NOT playing
                    a network game)
  -sharesound    -- Open soundcard in shareable mode (other well-behaved
                    programs will be able to play sounds also.)
  -bnice         -- Do not render faster than sys_ticrate even in
                    non-dedicated server mode. Use this to free some CPU
                    cycles for other programs.  See FAQ further down.
  -myip <ip>     -- Use this if your IP address appears wrong in the join
                    new game screen.

  Example:   C:\QUAKE\QUAKEFS.EXE -bnice -sharesound
                

Network Play
------------
   99.9% of Quake servers run registered version of Quake which means you
   require a registered version of DOS Quake to connect. If you connect to
   a Quake server running the registered version, this version of Quake 
   will exit with an error message stating it cannot find certain files.
   

Known video bugs
----------------
    If you change from the basic 320x200 video mode to a higher resolution
    (ie. 640x480), and then switch back, your display may become corrupted.
    A switch to the desktop should reset the display.
    
    If you change video modes too fast (ie. before the previous mode is
    complete), Quake may crash.
    

Performance
-----------
    Pentium Pro 200 or better allows good framerates at 1024x768.
    A Pentium Pro 200 allows 15-17 fps (frames per second) at 640x480.

    A slower machine should use lower video modes.  Experiment and see
    what works best for you!  

    Tip: The 360x480 video mode is almost as good as the 640x480
    but is noticeably faster.



FAQ (Frequently Asked Questions)
--------------------------------
   Q: Error Message "I_Error: UDP Unable to create control socket"
   A: Quake is unable to initialize TCP/IP.  Start it with the
      -nolan parameter.

   Q: When trying to connect to a Quake server, I receive the error
      message "I_Error: unable to open maps/e2m3.map"
   A: You have the shareware version of Quake, and the server which you
      are trying to connect to is running a registered level.

   Q: When trying to connect to a Quake server, I receive the error
      message "missing ??.wav files" or a similar message.
   A: Quake server is running modified .PAK files with additional weapons,
      monsters, levels, etc., and you do not have these installed.

   Q: Sound doesn't work.
   A: You are probably running Warp 3.0. Sorry, you need to upgrade <G>.
      -OR-
   A: Make sure your sound works in other applications.

   Q: I can't get Quake running in a window.
   A: This is FULL SCREEN Quake.  Don't run it in a window.

   Q: I have the Matrox video card and want the Hi-Res video modes.  Help!!!
   A: Trade that Matrox for an S3-based card with some of your Win95
      friends.

   Q: I see this "disconnected phone" symbol in the upper-left corner every
      4 to 5 seconds while playing thru the Internet.
   A: This is the bane of Internet play.  Let's see some of the possible
      causes (and hopefully solutions):

      - Your connection is too slow.
        A: If you connected less than 24.4bps, redial!

      - Your ISP stinks or is overloaded.
        A: Well, you'll have to figure that one out.
        
      - The Quake server you connected to is:
        ->too far away!
          A: In an OS2 window, do a "PING ipaddress/name" (without quotes)
             and see what response rate you are getting from the server.
             Ie., PING 1.1.1.1 
        ->Overloaded
          A: There are too many people on that server or the server just 
             doesn't have the power.  Look for a server with less people.
        ->located in Greenland <G>.
          A: Move there if you have to use that server 

      - PPP.EXE or Injoy (an OS/2 dialer) is running on regular priority.
        A: Try to add "priority 31" to your PPP.EXE command line.  For
           InJoy, set the priority to a very high value. 

       - System ticrate from the Quake server is not syncing correctly.
        A: Add -bnice parameter,
           This parameter will make Quake slow its rendering to the
           sys_ticrate value.  The default is 0.05 which is 20fps.
           If you have a slower machine, leave it at 0.05.  If you have
           a fast machine, you can either leave it or try 0.1.  Do NOT
           set the rate over 1.
       
           Note 1: To set the rate, press ~ to enter console mode,  Type
            "sys_ticrate 0.1" (no quotes) or another number.  Refer to the
            techinfo.txt file in the Quake directory for more information
            about the console.
           Note 2: Without the -bnice parameter, sys_ticrate is only used
            in dedicated server mode.  Standalone and network play are
            always run as fast as possible.
       
   Q: I want joystick support, and throw in CD ROM music support also.
   A: Go ask your parents to buy you a Nintendo-64.
      
   Q: Where do I find servers?
   A: See section "World Wide Web."


World Wide Web
--------------
Good places to look for Quake related files are:
http://www.planetquake.com
http://www.stomped.com

You should be able to find server lists from here also.


Final Word
----------\
Send a message to Id stating you are running the OS/2 version,
and also that you bought the registered version because you
have an EXE to run it under OS/2.


