Home | History | Annotate | Download | only in docs
      1 README for Linux Quake
      2 ----------------------
      3 
      4 This README convers all versions of Quake for Linux:
      5 	- SVGALib Quake (squake)
      6 	- GLQuake (glquake, glquake.glx and glquake.3dfxgl)
      7 	- X11 Quake (quake.x11)
      8 
      9 Requirements for SVGALib Quake:
     10 
     11 - SVGALib 1.20 or later (/lib/libvga.so.1.2.10)
     12 - libc 5.2.18 or later (5.0.9 will not work, /lib/libc.so.5.2.18)
     13   or glibc (libc6) for the glibc version
     14 - CD-ROM for CDAudio
     15 - Soundcard capable of mmap'd buffers.  USSLite 3.5.4 was used to build squake
     16   with.  Works fine on SoundBlaster 16 and Gravis Ultrasound MAX.
     17 - SVGALib supported mouse (usually if it works with X, it'll work with
     18   squake).
     19 - Kernel 2.0.24 or later
     20   - untested with 2.1 kernels, your mileage may vary
     21 
     22 Requirements for GLQuake:
     23 
     24 - 3DFX based card for the GLQuake version, VooDoo, VooDoo Rush or VooDoo2
     25 at this writing.  In order to use 3DFX hardware, you must have 3DFX's
     26 GLIDE drivers installed.  RPMs for these drivers are available at:
     27 http://glide.xxedgexx.com/3DfxRPMS.html
     28 - For the glX version, an OpenGL implementation that includes hardware
     29 glX support.
     30 - CD-ROM for CDAudio
     31 - Soundcard capable of mmap'd buffers.  USSLite 3.5.4 was used to build squake
     32   with.  Works fine on SoundBlaster 16 and Gravis Ultrasound MAX.
     33 - SVGALib compatible mouse for glquake or X11 for glquake.glx
     34 - Kernel 2.0.24 or later
     35   - untested with 2.1 kernels, your mileage may vary
     36 
     37 Requirements for X11 Quake:
     38 
     39 - X11R5 later, only tested with XFree86, should work with most X Servers
     40 - libc 5.2.18 or later (5.0.9 will not work, /lib/libc.so.5.2.18)
     41   or glibc (libc6) for the glibc version
     42 - CD-ROM for CDAudio
     43 - Soundcard capable of mmap'd buffers.  USSLite 3.5.4 was used to build squake
     44   with.  Works fine on SoundBlaster 16 and Gravis Ultrasound MAX.
     45 - SVGALib supported mouse (usually if it works with X, it'll work with
     46   squake).
     47 - Kernel 2.0.24 or later
     48   - untested with 2.1 kernels, your mileage may vary
     49 
     50 Additional notes for SVGALib Quake
     51 ----------------------------------
     52 
     53 SVGALib may not detect a 3-button mouse properly (it
     54 will only use two buttons).  Check your /etc/vga/libvga.config
     55 and set it up for your mouse type.
     56 
     57 Additional notes for GLQuake
     58 ----------------------------
     59 
     60 There are three different ways to execute GLQuake:
     61 
     62 1. The binary "glquake" requires Mesa 3-D 2.5 or later installed and compiled
     63 with 3DFX support (fxMesa..() function interface).  It also requires
     64 svgalib 1.3.0 or later for keyboard/mouse input.  This binary is a console
     65 application.  Mesa 3-D requires GLIDE to be installed.
     66 
     67 2. The shell script "glquake.3dfxgl" runs the "glquake" binary after
     68 preloading the lib3dfxgl.so library.  This is a port of 3DFX's Win32
     69 OpenGL MCD (Mini Client Driver) to Linux.  It is faster than Mesa 3-D
     70 since it was written specifically with supporting GLQuake in mind.
     71 lib3dfxgl.so requires that GLIDE be installed.
     72 
     73 3. The binary "glquake.glx" is linked against standard OpenGL libraries.
     74 It should run on many different hardward OpenGL implementations under
     75 Linux and X11.  This binary is an X11 application and must be run under
     76 X11.  It will work with Mesa 3-D as a standard glX based OpenGL 
     77 applications.  If the Mesa 3-D library is compiled with 3DFX support,
     78 you can have Mesa 3-D support 3DFX hardware under X11 by setting the
     79 enviroment variable "MESA_GLX_FX" to "fullscreen" for fullscreen mode
     80 and "window" for windowed mode, eg. "export MESA_GLX_FX=fullscreen" for sh 
     81 or "setenv MESA_GLX_FX fullscreen" for csh.
     82 
     83 For glquake, you must also have SVGALib or later installed (1.3.0 or later
     84 prefered).  GLQuake uses SVGALib for mouse and keyboard handling.
     85 
     86 If you have gpm and/or selection running, you will have to terminate them
     87 before running GLQuake since they will not give up the mouse when GLQuake
     88 attempts to run.  You can kill gpm by typing 'killall gpm' as root.
     89 
     90 You must run GLQuake as root or setuid root since it needs to access things 
     91 such as sound, keyboard, mouse and the 3DFX video.  Future versions may not 
     92 require root permissions.
     93 
     94 Additional notes for X11 Quake
     95 ------------------------------
     96 
     97 This is a windowed version that is generic for X11.  It runs in a window
     98 and can be resized.  You can specify a starting window size with:
     99 	-width <width>
    100 	-height <height>
    101 	-winsize <width> <height>
    102 Default is 320x200. It works in 16bit modes, but it's slower (twice as many
    103 bytes to copy).
    104 
    105 No other video modes are supported (just runs windowed).  Mouse is read, but
    106 not "grabbed" by default.  Go to the Options menu and turn on Use Mouse to grab
    107 the mouse and use it in the game (or type "_windowed_mouse 1" at the console).
    108 
    109 Command Line Options for Linux Quake
    110 ------------------------------------
    111 
    112 -mem <mb>
    113 Specify memory in megabytes to allocate (default is 8MB, which should be fine
    114 for most needs).
    115 
    116 -nostdout
    117 Don't do any output to stdout
    118 
    119 -mdev <device> (SVGALib based versions only)
    120 Mouse device, default is /dev/mouse
    121 
    122 -mrate <speed> (SVGALib based versions only)
    123 Mouse baud rate, default is 1200
    124 
    125 -cddev <device>
    126 CD device, default is /dev/cdrom
    127 
    128 -mode <modenum>
    129 Use indicated video mode
    130 
    131 -nokdb
    132 Don't initialize keyboard
    133 
    134 -sndbits <8 or 16>
    135 Set sound bit sample size.  Default is 16 if supported.
    136 
    137 -sndspeed <speed>
    138 Set sound speed.  Usual values are 8000, 11025, 22051 and 44100.
    139 Default is 11025.
    140 
    141 -sndmono
    142 Set mono sound
    143 
    144 -sndstereo
    145 Set stereo sound (default if supported)
    146 
    147 End Notes
    148 ---------
    149 
    150 Linux Quake is *NOT* an officially supported product.  Mail about it
    151 will be deleted.  Do not email id about this product.  If you are having
    152 technical difficultly, you can email me, but make sure you have the correct
    153 kernel, libc, svgalib and other software versions before you email me.
    154 
    155 Dave 'Zoid' Kirsch
    156 zoid (a] idsoftware.com
    157 Official Quake Unix Port Administrator
    158