

Clean Quake 3
A Quake3 Engine Project
by Justin Thyme
http://tremor.quakedev.com            
						
based on Quake 3:Arena source 			
by id Software				        
						
							
-----------------------------				
Overview						
-----------------------------				  

With the release of the Quake 3 Arena engine source code, id Software has
continued it's tradition of releasing source code to their legacy games.

The sole purpose of this project is to compile all the known bug fixes
into one code base which others may use as a starting point for their
own projects.  As such, there will be minimal changes other than what is
essential in fixing existing bugs.  Additionally, any non-essential files
have been removed from this engine/game code distribution, such as LCC, 
Q3ASM and Splines.  These aren't likelty to see a lot of modification.
The utility source code will be maintained and distributed seperately, 
but will continue to be fully compatible.

In order to facilitate mod makers getting up and running, this engine 
will allow you to run mods with just the original Quake 3 demo pak0.pk3.
Keep in mind that due to this, many existing Q3 mods won't work properly, 
since the content of the other pak's is missing.

This package includes both source code and binarys, with the game code
being DLL's.  If you desire to work with the QVM's, you can use the
tools provided with the original game source code release by id Software
to compile them.

Check the ToDo list and Known Bugs below for a list of planned 
features/changes and known issues.


-----------------------------
Contact Info
-----------------------------

Justin Thyme (justinthyme AT quakedev DOT com)
http://tremor.quakedev.com

Development system:

Athlon 2600+, nVidia GeForce6600 w/2568MB, 1.5GB RAM, WinXP, MSVC2003


-----------------------------
Copyright
-----------------------------

This program and its contents are copyright by Mike Melzer, 2005, with the
exception of materials which are covered under applicable copyright of the
original creator.  This material may be modified and distributed under GPL
with proper credit given to the creator.  Proprietary content from id
Software or other individuals is still protected under applicable law.
Refer to the section below titled "Special Thanks/Credits" for information
on individuals rights.

Where ever possible, explicit permission has been obtained for use of
materials which I did not personally create, and proper credit given.


-----------------------------
Disclaimer
-----------------------------

I accept no responsibility if this file or program in any way causes a cold, 
causes your wife/girlfriend to run off with your best friend, or blows up 
your computer.  There is no warranty expressed or implied.

This project requires the registered version of Quake3.  It can be found for 
under $15 in numerous places.  Support the developers who have put their 
effort into this game you love so much.


-----------------------------
Installation
-----------------------------

Extract this archive to your directory of choice and open quake3.vcproj.


-----------------------------				
Features						
-----------------------------			

- Includes debugged SDK game source by TTK-Bandit
- All releases are full rebuilds, not incremental
- Great starting point for those wishing to create their own games
- Includes Dairyman's sample Team Arena style scripted menus and HUD for
use with regular Quake3 *next release*


-----------------------------
Controls/Configuration
-----------------------------

Joystick support has been removed.  
Any changes will be outline in this section.


-----------------------------
Known Bugs/Issues
-----------------------------

- Doesn't work properly with only the demo pak0.pak yet (I could 
probably get it working easier with Q3TA pak0.pak)


-----------------------------
Version History
-----------------------------

Clean Quake 3 v0.5.2:

- Implemented SV_Kick_f fix from ensiform which fixes kicking bots
- Implemented misantropia's snaps fix
- Removed Team Arena option from main menu, still accessabile under MODS
- Implemented ensiform's ATi skybox fix
- Implemented Kaziganthe's TA menu fix that allows showing all gametypes 
in Skirmish menu

Clean Quake 3 v0.5.1:

- Fixed Dlights shining through walls
- Modified main menu to fix overlapping menu options due to allowing the
running of mods with the demo version
- Removed joystick support
- Fixed menu bug where it wouldn't show the Controls menu
- Slowed down how often FPS display is updated to make it more readable

Clean Quake 3 v0.5.0:

- More QSG bug fixes
- Implemented bug fixes from Quake3World.Com
- Got source code to compile with 17 warnings, but no errors
- Add #pragma to silence warnings for now
- A couple of basic bug fixes
- Increased hunk to 128MB default, 64MB min
- Integrated TTK-Bandit's Clean game source
- Disabled the id logo cinematic at startup
- Removed restriction to allow running mods with demo pak
- Tweaked compile settings
- Added Pheonix's long server uptime bug fix
- Numerous small bug fixes as mentioned on QSG


-----------------------------
ToDo List
-----------------------------

- Resolve all compile warnings (17 of them) - *done v0.5.0*
- Increase hunk size - *done v0.5.0*
- Read up on all command line switches
- Replace strcat with Q_strcat in CL_rcon_f
- Remove CD Key check ?
- Remove CD check ?
- Remove check with authentication server ?
- Remove registration check (allow running mods with demo pak0.pk3) - *done v0.5.0*
- Remove unnecessary #IF's and #IFDEF's
- Add back lens flare for dlights
- Implement Dairyman's Team Arena style menus for standard Q3 
- Implement Dairyman's Team Arena style hud for standard Q3 ?
- Fix compile warning regarding /LTCG
- Look into bot chat and MOD stuff
- Look into bot AI
- Change FPS counter to only update once/sec for better readability - *done v0.5.1*
- Review max player limit
- Center main HUD elements
- Add generic Save/Load game functionality ?
- Continue implementing bug fixes as found - *ongoing*
- Add light blooms
- Change snaps cap to equal servers FPS setting - *done v0.5.2*
- Fix bots getting dropped in password protected game - *done v0.5.2*
- Remove Team Arena from main menu (still accessable under MODS) - *done v0.5.2*
- Make blood stain/impact decals not fade


-----------------------------
Special Thanks/Credits
-----------------------------

id Software - For not only releasing such a cutting edge program (of it's day), 
but also for releasing the source code so that the community can continue to 
make it flourish, long after the core game has gone past its prime.
Spike, Echon, Entar, CheapHack and Tei - For patiently answering newbie 
programming questions on www.quakeworld.nu and QuakeSrc.org.
TTK-Bandit - For creating the original Clean Game Source for Quake 3.
All the people at QuakeDev.com, QuakeSrc.org and Quake3World.com.
Dairyman - For his work on the Team Arena scripted menu and HUD system for use
with regular Quake3.




-----------------------------
Working Notes
-----------------------------

- HUD stuff in cg_draw.c
- Particle system in cg_effects.c and cg_marks.c
- TR_GRAVITY defined in bg_misc.c (change GL arc)
- alt-tab disabled in win_wndproc.c
