quakeforge/doc
Ragnvald Maartmann-Moe IV f34dc8f884 A few more backward compatibility cvar links. 2005-03-24 15:12:19 +00:00
..
config A few more backward compatibility cvar links. 2005-03-24 15:12:19 +00:00
data merge the doc trees from nuq and newtree 2001-01-09 06:31:59 +00:00
gib New version of infobot.gib that supports factoid locking, and an 2003-04-11 02:36:10 +00:00
ideas Another test, and reformatting a text file. 2002-02-22 10:24:26 +00:00
man more mailing list corrections 2003-07-12 21:50:22 +00:00
progs start documenting things (progs building still borked) 2004-11-08 23:27:00 +00:00
.gitignore change _FOpenFile to take a dstring for foundname plugging a potential 2003-04-09 05:55:41 +00:00
3dfx.txt merge the doc trees from nuq and newtree 2001-01-09 06:31:59 +00:00
CodingStyle Coding Style clarifications and some new stuff that has been changed 2001-10-15 22:00:52 +00:00
Makefile.am start documenting things (progs building still borked) 2004-11-08 23:27:00 +00:00
QCMenuCondingStyle Added Menu_Enter-/LeaveHook to the CodingStyle as a 2002-03-19 16:20:54 +00:00
QF-HOWTO show_fps -> hud_fps, show_ping -> hud_ping, show_pl -> hud_pl, 2003-07-27 23:20:11 +00:00
bind.txt put my email about the key binding system up 2002-05-14 17:55:23 +00:00
cshifts.txt this is a little more useful here than in the cvs logs 2001-08-08 20:31:20 +00:00
glqnotes.txt merge the doc trees from nuq and newtree 2001-01-09 06:31:59 +00:00
hud.txt initial work on dynamic view support for the console. I'm aware that 2003-05-05 18:50:14 +00:00
net_DoS_protection.txt merge the doc trees from nuq and newtree 2001-01-09 06:31:59 +00:00
progdefs.q1 merge the doc trees from nuq and newtree 2001-01-09 06:31:59 +00:00
progdefs.q2 merge the doc trees from nuq and newtree 2001-01-09 06:31:59 +00:00
qe3.ico merge the doc trees from nuq and newtree 2001-01-09 06:31:59 +00:00
qf-client-3dfx-cvar.txt 3dfx :) 2001-01-10 04:22:17 +00:00
qf-client-glx-cvar.txt sort correctly 2001-01-10 03:33:30 +00:00
qf-client-sdl-cvar.txt qf-client-sdl cvars 2001-01-09 23:54:40 +00:00
qf-client-sgl-cvar.txt ggi and sgl 2001-01-10 03:51:24 +00:00
qf-client-svga-cvar.txt sort correctly 2001-01-10 03:33:30 +00:00
qf-client-x11-cmd.txt add command docs and update cvar docs for qf-server and qf-client-x11 for 2001-02-06 19:21:47 +00:00
qf-client-x11-cvar.txt add command docs and update cvar docs for qf-server and qf-client-x11 for 2001-02-06 19:21:47 +00:00
qf-server-cmd.txt add command docs and update cvar docs for qf-server and qf-client-x11 for 2001-02-06 19:21:47 +00:00
qf-server-cvar.txt add command docs and update cvar docs for qf-server and qf-client-x11 for 2001-02-06 19:21:47 +00:00
qf.ico our very own icon :) 2002-01-21 21:58:29 +00:00
quake.gif merge the doc trees from nuq and newtree 2001-01-09 06:31:59 +00:00
quake.ico merge the doc trees from nuq and newtree 2001-01-09 06:31:59 +00:00
quakeforge-notes.txt put my email about the key binding system up 2002-05-14 17:55:23 +00:00
quakeforge.dox.in start documenting things (progs building still borked) 2004-11-08 23:27:00 +00:00
qw-client-glx-cmd.txt more 0.5 cvar/cmd docs 2001-11-06 20:30:16 +00:00
qw-client-glx-cvar.txt more 0.5 cvar/cmd docs 2001-11-06 20:30:16 +00:00
qw-client-sdl-cmd.txt more 0.5 cvar/cmd docs 2001-11-06 20:30:16 +00:00
qw-client-sdl-cvar.txt more 0.5 cvar/cmd docs 2001-11-06 20:30:16 +00:00
qw-client-sdl32-cmd.txt more 0.5 cvar/cmd docs 2001-11-06 20:30:16 +00:00
qw-client-sdl32-cvar.txt more 0.5 cvar/cmd docs 2001-11-06 20:30:16 +00:00
qw-client-x11-cmd.txt more 0.5 cvar/cmd docs 2001-11-06 20:30:16 +00:00
qw-client-x11-cvar.txt more 0.5 cvar/cmd docs 2001-11-06 20:30:16 +00:00
qw-server-cmd.txt several fixes to cmd.php and cvar.php 2001-11-06 09:43:55 +00:00
qw-server-cvar.txt several fixes to cmd.php and cvar.php 2001-11-06 09:43:55 +00:00
readme.txt merge the doc trees from nuq and newtree 2001-01-09 06:31:59 +00:00
sensitivity.fig it's joy_*amp, not in_joy_*amp :/ 2002-05-10 16:37:41 +00:00
skybox.fig add the new case despair discovered for me 2002-09-23 05:18:53 +00:00
template.c another year goes by... 2004-01-22 07:02:10 +00:00
template.h another year goes by... 2004-01-22 07:02:10 +00:00
timestamps.txt merge the doc trees from nuq and newtree 2001-01-09 06:31:59 +00:00
tracklist.cfg ashridah's file based cd plugin (ie, it will play any sound file QF can 2004-01-20 06:58:42 +00:00
v3_vsync very important info abouyt v3 vsync 2001-08-20 21:38:32 +00:00
wqreadme.txt merge the doc trees from nuq and newtree 2001-01-09 06:31:59 +00:00

readme.txt

This is the complete source code for winquake, glquake, quakeworld, and 
glquakeworld.

The projects have been tested with visual C++ 6.0, but masm is also required 
to build the assembly language files.  It is possible to change a #define and 
build with only C code, but the software rendering versions lose almost half 
its speed.  The OpenGL versions will not be effected very much.  The 
gas2masm tool was created to allow us to use the same source for the dos, 
linux, and windows versions, but I don't really recommend anyone mess 
with the asm code.

The original dos version of Quake should also be buildable from these 
sources, but we didn't bother trying.

The code is all licensed under the terms of the GPL (gnu public license).  
You should read the entire license, but the gist of it is that you can do 
anything you want with the code, including sell your new version.  The catch 
is that if you distribute new binary versions, you are required to make the 
entire source code available for free to everyone.

Our previous code releases have been under licenses that preclude 
commercial exploitation, but have no clause forcing sharing of source code.  
There have been some unfortunate losses to the community as a result of 
mod teams keeping their sources closed (and sometimes losing them).  If 
you are going to publicly release modified versions of this code, you must 
also make source code available.  I would encourage teams to even go a step 
farther and investigate using public CVS servers for development where 
possible.

The primary intent of this release is for entertainment and educational 
purposes, but the GPL does allow commercial exploitation if you obey the 
full license.  If you want to do something commercial and you just can't bear 
to have your source changes released, we could still negotiate a separate 
license agreement (for $$$), but I would encourage you to just live with the 
GPL.

All of the Quake data files remain copyrighted and licensed under the 
original terms, so you cannot redistribute data from the original game, but if 
you do a true total conversion, you can create a standalone game based on 
this code.

I will see about having the license changed on the shareware episode of 
quake to allow it to be duplicated more freely (for linux distributions, for 
example), but I can't give a timeframe for it.  You can still download one of 
the original quake demos and use that data with the code, but there are 
restrictions on the redistribution of the demo data.

If you never actually bought a complete version of Quake, you might want 
to rummage around in a local software bargain bin for one of the originals, 
or perhaps find a copy of the "Quake: the offering" boxed set with both 
mission packs.

Thanks to Dave "Zoid" Kirsh and Robert Duffy for doing the grunt work of 
building this release.

John Carmack
Id Software