qf/quakeforge-old
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge-old synced 2025-02-18 01:31:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

Serious revamp of README, particularly the filling in of section 4 and

Browse source 
rewording of much of the rest.
This commit is contained in:
Jeff Teunissen 2000-01-13 10:34:27 +00:00
parent c52edec836
commit 053aafee2c
1 changed files with 154 additions and 108 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

262
README
View file

@ -1,50 +1,55 @@
README - release notes for QuakeForge <<<<<<< README
Copyright (C) 1996-1997 Id Software, Inc. QuakeForge - Release Notes
Copyright (C) 1999,2000 contributors of the QuakeForge project Copyright © 1996-1997 Id Software, Inc.
Please see the file "AUTHORS" for a list of contributors. Copyright © 1999,2000 contributors of the QuakeForge Project
Please see the file "AUTHORS" for a list of contributors
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify it
it under the terms of the GNU General Public License as published under the terms of the GNU General Public License as published by the
by the Free Software Foundation; either version 2 of the License, Free Software Foundation; either version 2 of the License, or (at your
or (at your option) any later version. option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful, but
but WITHOUT ANY WARRANTY; without even the implied warranty of WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
GNU General Public License for more details. General Public License for more details.
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software along with this program; if not, write to:
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Free Software Foundation, Inc.
59 Temple Place, Suite 330
Boston, MA 02111-1307 USA
See file COPYING for license details. See file COPYING for license details.
Quake(R) and QuakeWorld(R) are registered trademarks of Id Software, Inc. Quake(R) and QuakeWorld(R) are registered trademarks of Id Software,
The NIN logo is a registered trademark licensed to Nothing Interactive, Inc. Inc. The NIN logo is a registered trademark licensed to Nothing
All other trademarks are the property of their respective owners Interactive, Inc. All other trademarks are the property of their
respective owners
Table of Contents Table of Contents
----------------- ~~~~~~~~~~~~~~~~~
I. Special Thanks 1 Special Thanks
II. System Requirements 2 System Requirements
III. Running and Compiling QuakeForge 3 Compiling and Running QuakeForge
IV. Operating System Specific Issues 4 Platform-Specific Issues
V. Errata and Known Bugs 5 Errata and Known Bugs
VI. Troubleshooting 6 Troubleshooting
VII. Technical Support 7 Technical Support
VIII. Joystick Notes 8 Joystick Notes
IX. Tested Systems 9 Tested Systems
I. Special Thanks 1 Special Thanks
----------------- ~~~~~~~~~~~~~~~~~~~~~~
The QuakeForge Project would like to thank Id Software, Inc. for writing The QuakeForge Project would like to thank Id Software, Inc. for writing
and releasing Quake under the GNU GPL. We'd like to thank John Carmack and and releasing Quake under the GNU GPL. We'd like to thank John Carmack
Dave Kirsch in particular for the support they have provided to us and to and Dave Kirsch in particular for the support they have provided to us
the Free Software community as a whole. and to the Free Software community as a whole.
We would also like to thank the following organizations for their We would also like to thank the following organizations for their
contributions to QuakeForge: contributions to QuakeForge:
@ -53,57 +58,100 @@ contributions to QuakeForge:
3Dfx Interactive, Inc. 3Dfx Interactive, Inc.
And last but certainly not least, we would like to thank every single And last but certainly not least, we would like to thank every single
person who has contributed even one line of code, documentation, or other person who has contributed even one line of code, documentation, or
support to the QuakeForge project. other support to the QuakeForge project.
Without all of you, we would not be where we are right now. Without all of you, we would not be where we are right now.
Id Software, Inc. thanks MPath Interactive and Gandalf Technology for Id Software, Inc. thanks MPath Interactive and Gandalf Technology for
their help and support. their help and support.
If you'd like to contribute code/hardware/support/suggestion/help to the If you'd like to contribute in any way to the QuakeForge project, please
QuakeForge project, contact Nelson Rush at: palisade@quakeforge.net contact our mailing list at quake-devel@lists.sourceforge.net.
II. System Requirements 2 System Requirements
----------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
Raster capable display. ;-) * A Raster capable display. ;-)
8MB RAM (16MB required under Win32) * 8 megabytes of memory beyond operating system footprint. 16 megabytes
Floating-point processor (not strictly required but a Good Idea(TM)) are required for the QuakeWorld-compatible network client and all
30MB free disk space (shareware version, 80MB for registered version) executables running on Win32-based systems)
* A Floating-point processor. While not strictly required, QuakeForge
uses a lot of floating-point math, so a FPU is highly recommended.
* 10MB of free hard disk space to build all targets. In addition to the
base system, you will require game data files. For the default game
("Quake"), you will need either the shareware or registered version of
Quake.
III. Running and Compiling QuakeForge 3 Compiling and Running QuakeForge
------------------------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Read the INSTALL file for more information on compiling. Please read the INSTALL file for more information on compiling.
Autoconf 2.13 or greater and automake 1.3 or greater required to use Autoconf 2.13 or later and automake 1.3 or later are required to use
the bootstrap script. the bootstrap script, which creates the "configure" script.
After you have compiled successfully, you must download the shareware After you have compiled successfully, you must download the shareware
version of Quake 1 to play. Insert the proper binaries in the same version of Quake 1 to play. Insert the proper binaries in the same
directory as the unpacked shareware files, and run. directory as the unpacked shareware files, and run.
We are currently working on a free replacement for this. We are currently working on a free replacement for the Quake game data
files.
IV. Operating System Specific Issues 4 Platform-Specific Issues
------------------------------------ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This section should discuss issues that affect only certain operating This section discusses issues that affect only certain operating
platforms. Issues to be discussed include: platforms.
* Audio Setup 4.1 DOS
* CD Audio Input
* Mouse Setup
* Booting "Clean"
Currently this section is unfinished. If you experience page faults while running Quarterdeck's QDPMI DPMI
server, this is caused by a bug in QDPMI. Workarounds: Remove QDPMI
from CONFIG.SYS, issue the command QDPMI OFF before running QuakeForge,
or get the update patch for QDPMI from Quarterdeck. You may be running
QDPMI without knowing it if you have QEMM installed, because it can be
installed as part of the QEMM installation.
V. Errata and Known Bugs 4.2 Linux
------------------------
Some 3Dfx Voodoo-based 3D accelerators may have issues with the way
QuakeForge uses the "3dfxgl" minidriver to interface to the Glide
library.
Video boards based on the Riva
128/128ZX/TNT/TNT2/TNT2 Ultra/Vanta/GeForce 256 chipsets from nVidia
Corp. using the latest (as of 13 Jan 2000) nVidia OpenGL drivers may
have problems with transparency. Under some conditions, these drivers
may lock the X Window System server, possibly rendering the system
unusable. The currently-recommended drivers for video cards with Riva
128/128ZX/TNT/TNT2/TNT2 Ultra chipsets are those from the Utah GLX
project, located at http://glx.on.openprojects.net/ -- for the Vanta
and GeForce 256 chipsets, there is no suggested hardware-accelerated
OpenGL alternative at this time. We believe the bug to be in nVidia's
drivers, because our code seems to work under other OpenGL
implementations.
4.4 Windows 95/98/Millennium
Currently, we are unable to determine the status of the Windows-based
targets of QuakeForge. Because of our move to GNU Autoconf and the
dearth of "proper" GNU tools available on the Windows platform, our
build system may not work properly on Windows. We are working on
solutions for this problem.
4.5 Windows NT/2000
For the most part, issues for Windows 9x-based operating environments
will be similar. However, because of numerous differences in the way
Windows NT and Windows 9x operate, these systems may have specific
issues.
5 Errata and Known Bugs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Problem: The screen flickers once about every other frame when using GL Problem: The screen flickers once about every other frame when using GL
Solution: Not all GL implementations support a performance hack used to Solution: Not all GL implementations support a performance hack used to
@ -114,30 +162,31 @@ Solution: Not all GL implementations support a performance hack used to
Problem: Zombies can sometimes get "stuck" in the ground. They can be Problem: Zombies can sometimes get "stuck" in the ground. They can be
heard but not killed making it impossible to get 100% on the heard but not killed making it impossible to get 100% on the
current level. current level.
Solution: None found. Solution: None found yet.
Problem: It is possible for players to sometimes get stuck in a room or Problem: It is possible for players to sometimes get stuck in a room or
wall, much like the zombies mentioned above. wall, much like the zombies mentioned above.
Solution: The "kill" console command will un-stick you, but it has the Solution: The "kill" console command will un-stick you, but it has the
unfortunate side effect of killing you in the process (hence the unfortunate side effect of killing you in the process (hence
command's name.) It is a good idea to save your games often. the command's name.) It is a good idea to save your games
often.
Problem: Sometimes durring a game the player's view will not center Problem: Sometimes during a game the player's view will not center
properly. The end result is that the player view is looking up properly. The end result is that the player view is looking
toward the ceiling while walking. up toward the ceiling while walking.
Solution: Use of freelook (mouse or keyboard) may solve this problem, as Solution: Use of freelook (mouse or keyboard) may solve this problem, as
will exiting the level or the "kill" console command. will exiting the level or the "kill" console command.
VI. Troubleshooting 6 Troubleshooting
------------------- ~~~~~~~~~~~~~~~~~~~~~~~
If QuakeForge fails to start up, or has problems not addressed elsewhere If QuakeForge fails to start up, or has problems not addressed elsewhere
in the documentation, try the -safe command line switch, which disables a in the documentation, try the -safe command line switch, which disables
number of parts of QuakeForge that can be problems if there are hardware a number of parts of QuakeForge that can be problems if there are
or configuration problems. The -safe command line switch is equivalent to hardware or configuration problems. The -safe command line switch is
-stdvid, -nosound, -nonet, and -nocdaudio together. Those four switches equivalent to -stdvid, -nosound, -nonet, and -nocdaudio together. Those
do the following: four switches do the following:
-stdvid disables VESA video modes -stdvid disables VESA video modes
-nosound disables sound card support -nosound disables sound card support
@ -145,24 +194,13 @@ do the following:
-nocdaudio disables CD audio support -nocdaudio disables CD audio support
If -safe makes the problem go away, try using each of the switches If -safe makes the problem go away, try using each of the switches
individually to isolate the area in which you're experiencing the problem, individually to isolate the area in which you're experiencing the
then either correct the configuration or hardware problem or play problem, then either correct the configuration or hardware problem or
QuakeForge with that functionality disabled. play QuakeForge with that functionality disabled.
If you still have problems, try booting clean in conjunction with the
-safe command line parameter. For information on booting clean, refer to
"Booting Clean" in section III above.
If you experience page faults while running Quarterdeck's QDPMI DPMI
server, this is caused by a bug in QDPMI. Workarounds: Remove QDPMI from
CONFIG.SYS, issue the command QDPMI OFF before running QuakeForge, or get
the update patch for QDPMI from Quarterdeck. You may be running QDPMI
without knowing it if you have QEMM installed, because it can be
installed as part of the QEMM installation.
VII. Technical Support 7 Technical Support
---------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~
Please do not contact Id Software, Inc regarding technical support Please do not contact Id Software, Inc regarding technical support
issues related to QuakeForge. QuakeForge is heavily modified from the issues related to QuakeForge. QuakeForge is heavily modified from the
@ -175,8 +213,8 @@ support, bugs reports, and help at: http://www.quakeforge.net/
Thank you. Thank you.
VIII. Joystick notes 8 Joystick notes
-------------------- ~~~~~~~~~~~~~~~~~~~~~~
Your joystick must be plugged in when QuakeForge is launched. Your joystick must be plugged in when QuakeForge is launched.
@ -195,32 +233,40 @@ The "mlook" and "sidestep" commands work with a joystick exactly as they
do for a mouse, as does the "invert mouse up/down" menu option. do for a mouse, as does the "invert mouse up/down" menu option.
IX. Tested Systems 9 Tested Systems
------------------ ~~~~~~~~~~~~~~~~~~~~~~
Processors tested: Processors tested:
Intel PI AMD Athlon
Intel PII AMD K6-2
Intel PIII Apple/IBM/Motorola PowerPC
Athlon Compaq/Digital Alpha 21x64
K6-2 IBM Power3
Motorola PowerPC Intel Pentium
Compaq Alpha Intel Pentium II
Intel Pentium III
Sun UltraSPARC Sun UltraSPARC
SGI Indigo 2 SGI Indigo 2
Mips R10k MIPS R10000
Operating systems tested: Operating systems tested:
Linux Linux 2.x
FreeBSD FreeBSD
Solaris Solaris
IRIX SGI Irix
AIX IBM AIX 4.x
Digital Unix/TRU64 Compaq/Digital Tru64 Unix
Windows 98 (Hasn't been tested since we switched to autoconf)
Video cards tested (On Intel-based systems):
Matrox G200 (Linux)
Matrox G400 (Linux)
See file "TESTIFY" for user testimonials on what works, where, and why. See file "TESTIFY" for user testimonials on what works, where, and why.
email user testimonies to: palisade@quakeforge.net Please send user testimonials via e-mail to:
Or to our quake-devel mailing list which you can find more information "Nelson Rush" <palisade@quakeforge.net>
about on our website at: http://www.quakeforge.net/ or to our mailing list, located at:
quake-devel@lists.sourceforge.net
You can find more information on our web site, located at:
http://www.quakeforge.net/