	Q2K4 - Yet another GLQuake-based engine
	<http://www.inovagames.com/q2k4>


===============
Q2K4 Demo map 1
===============

	This is a small map I made to demonstrate some Q2K4 exclusive features
	(and also others non-exclusive but pretty standard among other engines).
	There is some specific QuakeC  code used  in customized entities, but 
	nothing  really complicated. The goal of this map and code is to serve 
	as a hands-on guide to any modder willing to use Q2K4 as base to any 
	project, so all sources are available as reference.
	As you may suspect by now, this map won't work as expected in other
	engines or even not load at all (although crashes are unlikely).

===============
Features tested
===============

	These are the main features that can be tested with this map:

		* Colored lights 
		* model interpolation
		* rotate & item bobbing fxs
		* models shadows
		* easy to use rotating brushes 
		* BSP models bound box fix
		* fog
		* change base directory for textures (changing r_textdir 
		and reloading the map)
		* Quake II MD2 loading support
		* Quake II skyboxes support
		* JPG, PNG or TGA texture loading (even with different 
		dimensions from original texture, up to 4096x4096 pixels or 
		your video card limit)
		* MIDI playback support
		* support for transparent textures
		* sky scrolling speed control by cvars
		* scrollable textures (to simulate liquids, treads, computer 
		screens, etc)
		* support for polygon-level collision detection
		* Quake II modified effects (EF_DARKFIELD, EF_DARKLIGHT, 
		EF_LIGHT, EF_NODRAW)
		* experimental dynamic texture generation

	Most of the time there is a button to activate/deactivate
	the feature and a trigger telling you what the button does,
	so the map it's pretty self explanatory. However there are some 
	features (such base directory to artwork change) that needs to 
	be tested from the console. 

======================
Warnings & disclaimers
======================

	This is NOT a playable mod. It's a technology demo only.

	The dynamic texture generation is available on the current release
	of Q2K4 (1.62) as an experimental feature, and may (actually, will)
	change in future releases. The current version is controlled by 
	2 cvars:
	
	r_dyntexenable (0|1)
		Toggles the dynamic texture generation on/off.
		
	r_dyntexfps
		Defines which frequency the texture is updated. 10Hz is a good
		value for low end systems (such mine).

	Future releases of Q2K4 may have more cvars to a more flexible use
	of the dyntex or even (worst case scenario) remove the feature if 
	becomes too hard to fix the problems it's causing, so better do not 
	use it in your project yet - it's too unstable anyway, and it's here 
	just to show that can be done. :)


==============
How to install
==============

	Just unzip the contents of the .zip file into a Q2K4DEMO folder under your 
	Quake installation. Assuming you installed Quake in	C:\QUAKE, the folder 
	should be created as:
	
	C:\QUAKE\Q2K4DEMO
	
	And you can run it as you would run any Quake mod:
	
	C:\QUAKE\Q2K4.exe -game q2k4demo (plus any other command line parameter
	you normally use)

	The embedded autoexec.cfg will take care of set up everything and
	run the demo map (demo01.bsp). To change the graphic theme, bring
	the console down (~) and change the r_textdir cvar value:
	
	r_textdir main (no external textures there, so Q2K4 uses the original ones)
	
	or 
	
	r_textdir medieval
	
	or
	
	r_textdir toon
	
	You must restart the map to changes makes effect:
	
	map demo01

==========================
Credits & Acknowledgements
==========================

	This map uses several textures collected from the internet for 
	some years now, and	I lost track from every source to put the 
	name here, so if you think any of that are yours and want your 
	name here, just send me an e-mail :). 
	
	The Robocop MD2 model is made by Conor O'Kane, and can be 
	downloaded from Polycount <http://www.planetquake.com/polycount>.
	
	The ugly medieval Robocop skin was made by myself, as well all
	textures and skins under the "toon" theme folder (yeah, I know
	they're awful, but that's the idea).
	
	The annoying MIDI file is available for download in too many
	places on the net, and I don't remember from where I got it. 
	The author is unknown (at least there is no author information 
	in the file).
	
	Finally, the excellent Doom skybox was made by Jako Malan (PHOSTOXIN)
	<dfmal@iafrica.com> and can be downloaded from the WadFather site
	<http://www.planethalflife.com/wadfather> among many others skyboxes.
	
===========
Bug reports
===========

	While I am aware of several bugs in the current version of Q2K4,
	(many of them easily noticeable from this demo) any feedback is 
	welcome. To report a bug, please send an e-mail	to:
	
	carloshp@centroin.com.br
	
	with subject: "Q2K4 bug" and enough information to replicate your 
	error. 