Home | History | Annotate | Download | only in docs
      1 
      2 README for Linux SVGALib Quake
      3 ------------------------------
      4 
      5 Requirements:
      6 
      7 - SVGALib 1.20 or later (/lib/libvga.so.1.2.10)
      8 - libc 5.2.18 or later (5.0.9 will not work, /lib/libc.so.5.2.18)
      9 - CD-ROM for CDAudio
     10 - Soundcard capable of mmap'd buffers.  USSLite 3.5.4 was used to build squake
     11   with.  Works fine on SoundBlaster 16 and Gravis Ultrasound MAX.
     12 - SVGALib supported mouse (usually if it works with X, it'll work with
     13   squake).
     14 - Kernel 2.0.24 or later
     15   - untested with 2.1 kernels, your mileage may vary
     16 
     17 Here's the release you've been waiting for.  Linux squake supports
     18 320x200x256, the various modeX modes (320x400, 360x400, etc) as well as high
     19 res modes if your card is supported by SVGALib.  Use the Quake console command
     20 vid_describemodes to list supported modes and the command vid_mode <number> to
     21 change modes.
     22 
     23 Full sound support is included.  The default sound rate is 16-bit stereo,
     24 11KHz.  You can change this in the options section below.
     25 
     26 Mouse works great, but SVGALib may not detect a 3-button mouse properly (it
     27 will only use two buttons).  Check your /etc/libvga.config (or
     28 /etc/vga/libvga.config for SlackWare users).
     29 
     30 **Version 1.1 fixes some crash bugs with the mission packs.
     31 
     32 New Command Line Options for Linux SVGAlib Quake
     33 ------------------------------------------------
     34 
     35 -mem <mb>
     36 Specify memory in megabytes to allocate (default is 8MB, which should be fine
     37 for most needs).
     38 
     39 -nostdout
     40 Don't do any output to stdout
     41 
     42 -mdev <device>
     43 Mouse device, default is /dev/mouse
     44 
     45 -mrate <speed>
     46 Mouse baud rate, default is 1200
     47 
     48 -cddev <device>
     49 CD device, default is /dev/cdrom
     50 
     51 -mode <modenum>
     52 Use indicated video mode
     53 
     54 -nokdb
     55 Don't initialize keyboard
     56 
     57 -sndbits <8 or 16>
     58 Set sound bit sample size.  Default is 16 if supported.
     59 
     60 -sndspeed <speed>
     61 Set sound speed.  Usual values are 8000, 11025, 22051 and 44100.
     62 Default is 11025.
     63 
     64 -sndmono
     65 Set mono sound
     66 
     67 -sndstereo
     68 Set stereo sound (default if supported)
     69 
     70 Installation
     71 ------------
     72 
     73 Boot DOS (I know, but you need it to run the Quake install program) and
     74 install Quake from your Quake CD to a DOS parition.
     75 
     76 Boot Linux and make a directory for Quake.  Copy everything from the DOS Quake
     77 directory into it.  i.e.:
     78 	(cd /dos/quake; tar cf - .) | (cd ~/quake; tar xf -)
     79 
     80 Place squake into your Quake directory.  You must make it setuid root (since
     81 Quake access stuff like direct video writes, the raw keyboard mode, CD, etc).
     82 Quake will setuid back to the normal user as soon as it opens these files.
     83 Make Quake suid root as follows:
     84 	chown root squake
     85 	chmod 4755 squake
     86 
     87 Run squake.  I don't recommend running it as root, since all the saved
     88 config.cfg files will be then owned as root.  Use your normal account, unless
     89 you do everything as root, then your mileage will vary.
     90 
     91 squake may segfault if it tries to initialize your sound card and their isn't
     92 one.  Same with the CDROM.  If it dies, try it with -nosound and/or
     93 -nocdaudio.  If you have a sound card it died on and you know it is
     94 supported by USSLite (the driver that comes with the Linux kernel), let me
     95 know and I'll take a look at it.
     96 
     97 It should work with SCSI CDROMs, but is untested.
     98 
     99 Full TCP/IP network support is in, including listen and dedicated server
    100 modes.  squake makes a nice dedicated server as you don't need the X11
    101 libraries kicking around.
    102 
    103 All of the options described in TECHINFO.TXT and MANUAL.TXT from the Quake
    104 distribution will work, 'cept for stuff with vid modes and stuff.
    105 
    106 End Notes
    107 ---------
    108 
    109 Linux SVGALib Quake is *NOT* an officially supported product.  Mail about it
    110 will be deleted.  Do not email id about this product.  If you are having
    111 technical difficultly, you can email me, but make sure you have the correct
    112 kernel, libc, svgalib and other software versions before you email me.
    113 
    114 Dave 'Zoid' Kirsch
    115 zoid (a] threewave.com
    116 Official Quake Unix Port Administrator
    117 
    118 Acks
    119 ----
    120 
    121 Greg Alexander <galexand (a] sietch.bloomington.in.us> for initial work in SVGALib
    122 support.
    123 Dave Taylor <ddt (a] crack.com> for basic Linux support.
    124 id Software for Quake and making me port it. :)
    125 
    126 Lots of people on #linux, #quake for testing.
    127 
    128