Quake-III-Arena

Quake III Arena GPL Source Release
Log | Files | Refs

README.Linux (14069B)


      1 +----------------------------------------+
      2 | Q3Test                                 |
      3 | The Official Quake 3: Arena TEST       |
      4 | Linux version                          |
      5 | Revision 1.08                          |
      6 | Released Aug 3, 1999                   |
      7 | Copyright (C) 1999 id Software, inc.   |
      8 +----------------------------------------+
      9 | Documentation: Paul Jaquays            |
     10 |                Dave Kirsch             |
     11 +----------------------------------------+
     12 
     13 Outline:
     14 
     15 1.  Introduction
     16 2.  Bug Reporting
     17 3.  Installing Q3Test
     18 4.  Running Q3Test.  Operating Instructions
     19 5.  Known Issues
     20 
     21 ==================
     22 == Section 1.   ==
     23 == INTRODUCTION ==
     24 ==================
     25 
     26 This is the Linux version of the test.
     27 
     28 Before proceeding onward, please read the README.EULA file. This is
     29 the End User License Agreement. It's the agreement between you and id
     30 regarding this test.  Read it. Understand that the acts of loading or
     31 running the software, or placing it on your computer hard drive, RAM,
     32 or other storage, you are agreeing to be bound by the terms of the End
     33 User License Agreement. So it's best to know what you are agreeing to.
     34 
     35 The operating instructions for the test are included in the 
     36 separate "README.Q3Test" file.  For the most part, the game functions
     37 are the same across all platforms.  Differences will be noted when necessary.
     38 
     39 +----------------+
     40 | THIS IS A TEST |
     41 +----------------+
     42 
     43 We want to set the record straight from the outset. This is neither a
     44 demo nor an ALPHA version of the final game and should not be expected
     45 to behave as such. Q3Test is a test of Quake3: Arena's network technology
     46 and graphics compatibility. While many of the game features that you will
     47 see in this test are in a highly polished state, do not confuse this with
     48 being anything other than what it is intended to be: a test. By running
     49 this test openly on the Internet and on a multitude of local networks,
     50 we hope to expose problems that could not otherwise be discovered on the
     51 limited number of in-house systems and computer. That's why we need your
     52 assistance for this test.
     53 
     54 Furthermore, it is anticipated that there may be revisions and additions
     55 made to the test that will make it incompatible with earlier versions.
     56 
     57 +---------------------+
     58 | SYSTEM REQUIREMENTS |
     59 +---------------------+
     60 
     61 There is no software-only version of the game. If your computer is not
     62 hardware accelerated with a game compatible graphics card, you will NOT be
     63 able to run Q3Test. Currently, 3DFX based cards are the only
     64 tested compatible cards. If your computer does not meet the 
     65 minimum requirements, you are unlikely to be able to run a satisfactory 
     66 game experience.
     67 
     68 A glibc compatible Linux installation is required.  An easy to determine
     69 if you have glibc support is to type this:
     70 
     71 	ls -l /lib/libc*
     72 
     73 If you get a report of libc6 (you may also have libc5), you have a
     74 glibc based system.
     75 
     76 The Linux version requires a supported hardware 3D acceleration card. The
     77 following are currently supported:
     78 
     79         o 3Dfx Voodoo Graphics based cards
     80         o 3Dfx Voodoo2 based cards
     81 
     82 Other cards of similar make and model may work, but are not supported.
     83 
     84 Other X11 OpenGL libraries may work with a supported hardware
     85 accelerator, but have not been extensively tested.  Performance on
     86 untested OpenGL configurations may not produce acceptable game
     87 speed.
     88 
     89 For 3Dfx based products, Linux Q3Test is distributed with a version of Mesa
     90 3-D specifically compiled for Voodoo support. You must have 3Dfx Linux Glide
     91 drivers installed however. These drivers are available from:
     92 
     93 		http://glide.xxedgexx.com/3DfxRPMS.html
     94 
     95 Make sure that you download and install the glibc versions of the drivers
     96 (found at the bottom of the page).
     97 
     98 Mirrors for this site are can be found at:
     99 
    100 		http://glide.mirrors.sonic.net 
    101 		http://glide.samiam.org 
    102 
    103 Please follow the installation instructions presented there for adding the
    104 correct drivers for your 3D-acceleration card. Note that there are two ways
    105 to install the 3DFX drivers-one with support for a /dev/3dfx device that
    106 does not require root permissions in order to use the card. If you choose to
    107 not use the /dev/3dfx method, you will have to run Q3Test as the root user.
    108 
    109 NOTE:  Linux Q3Test will try to load "libGL.so" before using 3Dfx drivers.
    110 This can cause problems if you have a software or third party OpenGL driver
    111 installed.  You can specifically target the included 3Dfx based Mesa driver
    112 by using the following command line:
    113 
    114 	./linuxquake3 +set r_glDriver libMesaVoodooGL.so.3.1
    115 
    116 For 3DFX users, you may disable the vertical sync refresh.  This can improve
    117 proformance at the cost of some visual tearing of the image.  Entering the
    118 following command into your shell before running Q3Test will turn off
    119 the vertical sync:
    120 
    121 	export FX_GLIDE_SWAPINTERVAL=0
    122 
    123 Then run Linux Q3Test from the same command line normally.
    124 
    125 +-----------+
    126 | X11 Setup |
    127 +-----------+
    128 
    129 Linux Q3Test requires X11 to run. There is no console-based version as in
    130 previous id products such as GLQuake and Quake2. XFree86 version 3.2 or
    131 later is required.
    132 
    133 There are two ways that mouse input is handled under XFree86:
    134 
    135         o By default, Q3Test will attempt to use DGA mouse handling. DGA
    136           support features direct reading of the mouse motion and provides
    137           more accurate control while playing the game. By default this
    138           support is enabled, but can be disabled by adding "+set
    139           in_dgamouse 0" to the command line at startup.
    140         o The non-DGA method of mouse input uses pointer grabbing and warps
    141           the pointer to the middle of the window on each mouse update. On
    142           systems with a slow frame rate and a lot of mouse user input, the
    143           motion can get "clipped" to the window boundaries. This method of
    144           input is more compatible however.
    145 
    146 Q3Test uses the XFree86 VidModeExtension facilities if available to provide
    147 fullscreen play. This does not apply to 3Dfx passthrough based cards, since
    148 the passthrough cable takes over the video display upon activation anyway.
    149 
    150 When configuring your X11 server, make sure that you include lower
    151 resolution modes such as 640x480 and 800x600. Q3Test will auto-switch to
    152 these modes using the VidModeExtension if you select fullscreen from the
    153 graphics options menu. If the lower resolution modes are not listed in the
    154 XFree86 configuration file, Q3Test will be unable to switch to the desired
    155 resolution for fullscreen play.
    156 
    157 +-------------------------+
    158 | Sound Support and Setup |
    159 +-------------------------+
    160 
    161 Q3Test uses the /dev/dsp sound device for sound support under Linux. This is
    162 the default device provided by the sound drivers included with the Linux
    163 kernel. Please note that at the time of this writing, PCI based sound cards
    164 such as the SoundBlaster Live and Diamond Monster MX series were not
    165 supported. They may be supported in the future. Check
    166 http://www.opensound.com/ for support in the future.
    167 
    168 If you do not run Q3Test as root (recommended), you may need to make sure
    169 the permissions for the /dev/dsp device are read and write by the user
    170 running Q3Test. The cheap and easy way to make this happen is to do "chmod
    171 o+rw /dev/dsp" as root. For the more security conscious, a special sound
    172 group could be created and Q3Test could be made setgid to the sound group to
    173 access the device.
    174 
    175 Q3Test uses mmap() to map the sound buffers on /dev/dsp directly in order to
    176 provide responsive sound needs. Sound cards must be able to support this
    177 feature in order to work. SoundBlaster 16, AWE32 and AWE64 cards are known
    178 to work.
    179 
    180 +----------------------+
    181 | WHAT'S IN THIS TEST? |
    182 +----------------------+
    183 
    184 We have included three maps with this test version of Quake3: Arena. They
    185 are q3test1, q3test2,  and q3tourney.
    186 
    187 q3test1    for 4-8 players    on Internet or LAN play   Best with 6 players
    188 q3test2    for 3-8 players    Primarily for LAN play    Best with 3 players 
    189 q3tourney is the tournament map
    190 
    191 ===================
    192 == Section 2.    ==
    193 == BUG REPORTING ==
    194 ===================
    195 
    196 What we would like from our testers are emails with descriptions of
    197 problems that are encountered, particularly those involving video or
    198 network bugs. Do NOT send reports to individual id employees.  All bug
    199 reports should go to the following e-mail address:
    200 
    201 q3feedback@idsoftware.com
    202 
    203 In your subject line, please describe the system the game is being played
    204 on (Mac, Linux, Win32) and the type of problem you are reporting: video,
    205 network, sound or game. Example Subject Line:  "Mac/video problem" or
    206 "Linux/network connection problem."
    207 
    208 In the body of your letter (no attached files please), briefly list and
    209 describe the problems.  Detailed descriptions of problems are good, but
    210 remember that brevity is best. Please do NOT send screen shots unless
    211 they are the ONLY way to show a problem.
    212 
    213 While we realize that you may have comments and suggestions regarding
    214 specific game play features, please refrain from submitting such along
    215 with bug reports. Comments on game play can be made on the official
    216 Quake 3: Arena message board at:
    217 
    218 http://www.quake3arena.com 
    219 
    220 ========================
    221 == Section 3.         ==
    222 == INSTALLING Q3TEST  ==
    223 ========================
    224 
    225 After you have installed the needed hardware drivers for your 3D
    226 acceleration and sound hardware, you need to install the Q3Test package.
    227 
    228 Q3Test is available as a Red Hat RPM file or as a tar file. To install the
    229 RPM file, enter the following when logged in as the root user:
    230 
    231 rpm -Uvh q3test-1.00-glibc-1.i386.rpm
    232 
    233 The rpm installs the game and data files in /usr/local/games/q3test.
    234 
    235 [ Note: If you have not installed (or do not wish to install) the Linux
    236 glide drivers, you may get an error message about not having libglide2x.so 
    237 installed.  This can be ignored and installation can be forced by adding 
    238 the --nodeps option to the rpm command line as follows: 
    239 rpm --nodeps -Uvh q3test-1.00-glibc-1.i386.rpm ]
    240 
    241 If you are going to install the tar version, make a directory for
    242 installation, untar the file as follows:
    243 
    244 tar xzvf q3test-1.00-glibc-i386.tar.gz
    245 
    246 This will untar the files into a q3test subdirectory under the current
    247 directory.
    248 
    249 ====================
    250 == Section 4.     ==
    251 == RUNNING Q3TEST ==
    252 ====================
    253 
    254 It is recommended that you do not run Q3Test using the root account or with
    255 root privileges. There are two exceptions to this:
    256 
    257         o If you are using a 3Dfx based accelerator card and do not install
    258           the /dev/3dfx configuration option. (You will have to run as root
    259           in order to access the card).
    260         o If you do not have access to the /dev/dsp device and do not wish
    261           to change the mode of the device so that non-root accounts can
    262           access it.
    263 
    264 You will have to be running under X11 or have the DISPLAY variable pointed
    265 to a OpenGL glX capable X Server.
    266 
    267 By default, Q3Test tries to find the following OpenGL libraries in this
    268 order:
    269 
    270         o libGL.so.1
    271         o libMesaVoodooGL.so.3.1
    272 
    273 You can override the library name by entering, "+set r_glDriver <libname>"
    274 on the command line. This may be needed if you are using a non-standard set
    275 up and have a different name for the OpenGL shared library.
    276 
    277 If everything proceeds successfully, you should have a Q3Test window on your
    278 desktop with a menu displayed (3DFX owners will get a full screen view). If
    279 you want to use full screen, go to the System Configuration, Graphics
    280 Options, Fullscreen, change the value to Yes, and hit enter to apply it.
    281 
    282 If you intend to connect to the Internet to play Q3Test, make certain
    283 that your net connection is open and working first.
    284 
    285 ======================
    286 == Section 5.       ==
    287 == KNOWN ISSUES     ==
    288 ======================
    289 
    290 Q. My mouse is erratic. My player is constantly looking up or down and
    291 I can't seem to move him.
    292 
    293 A. This happens with two issues. Some versions of XFree86 have a bug in
    294 DGA mouse handling that confuses Q3Test. You can try turning off DGA mouse
    295 support by entering "+set in_dgamouse 0" on the command line when you
    296 start Q3Test. This problem can also occur after a restart of the video
    297 system (such as after a graphic setting change). This is because some
    298 sort of event occurred to jam up the mouse. Restarting the video system
    299 another time and not moving the mouse during the restart should clear it.
    300 
    301 
    302 Q. When I do a video restart (for example, selecting Apply in the Graphics
    303 Options menu), Q3Test exits with a Sig11.
    304 
    305 A. This is a driver related problem.  
    306 On 3DFX hardware that is using the /dev/3dfx device and you are NOT running 
    307 as root, it seems that the restart doesn't clear some sort of permission. 
    308 Running Q3Test as root will fix this problem.  
    309 
    310 
    311 Q. Performance is so slow I can't play! The frame rate looks like one
    312 frame per second!
    313 
    314 A. Most of the current drivers for Linux do not support hardware
    315 acceleration at any bit depth other than 15 or 16 bit color. Make sure
    316 that you specify 16 bit color when you run your X11 Server, such as:
    317 
    318 	startx -- -bpp 16
    319 
    320 
    321 Q. I have a Voodoo3.  When I start the game, I send up at a low resolution
    322 version of my desktop.
    323 
    324 A. The current Voodoo3 X11 Servers have problems with DGA Mouse support.
    325 This is a known driver issue and will be fixed in newer revisions of the
    326 Voodoo3 X11 Server.  Run the game with the following to disable it:
    327 	./linuxquake3 +set in_dgamouse 0
    328 
    329 
    330 Q. I'm running Gnome with Englightenment and sound doesn't work.
    331 
    332 A. If you are using the Enlightenment Sound Daemon (esd), it will not release
    333 the sound hardware for Quake3 Test's usage.  You can disable it before running
    334 the test as follows:
    335 		esdctl off  # turn it off
    336 		start q3test the normal way
    337 		esdctl on   # turn it back on
    338 
    339 
    340 Q. I try to run Q3Test, but sound doesn't work.  The console says "Can't
    341 open /dev/dsp.  /dev/dsp:  Can't allocate memory."
    342 
    343 A. This can happen if the vmware kernel modules are loaded.  You can unload
    344 them by typing when logged as root:
    345 	/etc/rc.d/init.d/vmware stop
    346 Assuming you are using a RedHat system.
    347 
    348 
    349 Q. I was playing Q3Test and suddenly it quit and reported a signal error.
    350 
    351 A. This is probably a bug. Please report it.
    352