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