		--THE MATRIX FOR QUAKE 2--

CONGRATUATIONS!! You are cool for choosing to play this mod.

Hopefully by the end of reading this you will be able to perform 
mad skillz across the net, or on your LAN against yer mates.

Contents:
I. EXPERT'S QUICK GUIDE - for semi l33t to l33t Quake Vets
II. LLAMA'S GUIDE - step by step guide to getting the mod to run. 
	Foo' proof (almost...)
III. HOW TO PLAY - Should be read by Llamas and l33t haxors alike.
IV. VERSION NOTES - Known bugs and things to look out for.
V. FUTURE - Plans for the mod's next few versions.
VI. CREDITS AND ACKNOWLEDGEMENTS - blah. Who cares?

I. EXPERT'S QUICK GUIDE
-----------------------

There is a .cfg named "matrix.cfg". This has all the default 
bindings in. if you're a regular wasd user, use this, or edit
as approriate.

To play the game, just do the ol' "game matrix".

II. LLAMA'S GUIDE
-----------------
If you are using this section, repeat after me "I am a Llama, and 
I am a camping LPB BARSTURD"

Ok? Then we'll begin.

First you must make sure that you have unzipped the zip file into a 
directory (also known as folder) INSIDE the quake2 directory. For 
Example:

your quake2 directory:

X:\QUAKE2\

the Matrix mod directory

X:\QUAKE2\MATRIX

(X is an example, it may be C. Mine is E, other's may be D. Whatever)

Look in the matrix directory. If a file called "readme" or "readme.txt"
is there, everything should be find. Depending on your viewing options,
you may or may not see other files called "gamex86.dll" or "matrix.cfg".
If so, fine. You should only really be worried if there are NO files.
If there is a directory within X:\QUAKE2\MATRIX called matrix 
(X:\QUAKE2\MATRIX\MATRIX), then you created a directory called 
X:\QUAKE2\MATRIX and winzip automatically created another folder within 
this. MAKE SURE YOU POINT THE UNZIP DESTINATION TO X:\QUAKE2\

Ok, next step is running the mod. There are two ways of doing the fist step:

1. Start quake2 as normal and wait for the demo to load. Press the console 
toggle button, normally tilde (~ or `) directly to the left of "1" and
Below "Esc".

OR

2. Click Start->Run. a Window comes up. Click browse. Find Quake2.exe
and click on open. Now you have a line of text with quake2.exe's path.
click in the box twice (not a double click) so that the text is NOT 
highlighted. Now add "<space>+" (don't TYPE <space> just press space once.
Then click OK and quake 2 will start in the console.


Now, for both methods, type "game matrix" in the console. PRESS ENTER.

Wait for quake2 to reset. Type "exec matrix.cfg".

If you want to play a single player game type "map base1"

If you want to play a multiplayer game (with you as the host) type
"deathmatch 1" then "map q2dm1".

If you want to connect to a multiplayer server, find a server ip, 
for instance, Fury.net's Matrix quake server: 195.82.123.5:27950
Connect to the internet with your normal internet connection. In 
quake 2 go to the multiplayer menu (esc) and choose "address book"
enter the above ip number, and press esc. Now you should see a 
net-match listing on the list. go down and select it by pressing enter.

III. HOW TO PLAY
----------------

Hopefully you've seen the film "The Matrix". In this film, KEEENOOO Reeevz
ponces around in black suits with many many gunz akimbo. And scews with 
your brain in the process.

The basic idea is that he "disbelieves" the reality he lives in and is able
to do all manner of physically impossible things: jump huge distances, hover 
and eventually fly, run up walls, stop bullets in their path, and bend spoons
(sorry, that last one IS possible. Silly of me. Sorry Yuri G).

In this mod you'll be able to run up walls, stop bullets, switch bodies with
people better than you, and upgrade your stamina, health, speed and
damage.

	Running up walls
	----------------
	Because I am cool, this couldn't be easier. Simply jump at a wall and
	HOLD on jump. You will then scale the wall like KEEENU in the film.
	To flip off, either press e (boot) or backwards. N.B. it helps holding
	forward AND jump when running up walls.

	Stop Bullets
	------------
	Not Available - YET

	TelePossess
	-----------
	Not Available - YET

	Roll on Landing
	---------------
	If you fall far enough to hurt yourself, you can roll to quater the 
	damage. to do this you must be holding the duck button on landing, 
	WITHOUT holding the jump key. you'll roll and take approximately
	1/4 damage (rounded to the nearest point of damage).

	IR Vision
	---------
	Makes everyone appear red. Costs 75 mana for 30 seconds.

	Matrix Jump
	-----------
	Press q (command "matrixjump") to do this. it will propell you up
	and in the direction you are looking. Costs 50 mana

	Upgrade Stuff - Stamina/Mana etc.
	-------------
	****************
	New!!
	Simple upgrading
	Press Tab (binding - inven) and you get an upgrade menu. easy to follow.
	****************

	This gets a little complex. When you play, you'll notice a new icon 
	above your health - a blue cross. This represents your stamina, or 
	mana if you will. If you punch, kick, and run up walls, you'll see
	this value decrease. To charge up, stand still. Crouching and staying 
	still charges up faster still, although you will still charge up if you
	crouch and move. If you get below 5 stamina, you will be slowed down A 
	LOT, making you supceptible to attacks.

	When your stamina is a 100, try pressing 0 on the right hand side of the
	keyboard. It is also  known as kp_ins. The command used on this key is
	"bank" . It moves 50 stamina into your "mana bank"- a black cross, 
	rather than red or blue which appears above stamina. The stamina has 
	transformed into "mana". Mana will not be used up by punching, kicking, 
	and running up walls. You can only transfer stamina into your mana bank 
	when your stamina is at 100 or more. The maximum storage of the mana bank 
	is only 100, but you will need to use it ATLEAST once if you want to upgrade
	stuff.
	
	*** NEW!!!! ***
	Command "autobank" (0/1)
	If you toggle this to on (defaults to on), when you crouch AND have 100 Stamina
	or more you will automatically bank 50 stamina. I find this much easier to use.
	***************

	Now try waiting until you have 100 stamina again. You can put this in the
	bank if you want to, OR you can buy a level-up, which cost 150 generic 
	points (that is, either stamina OR mana points). Points will be deducted 
	fromyou mana bank before they are deducted from your stamina.
	
	Here are the level-ups you can buy when you have at least 150 points.

	Damage up.	Increases damage buy an extra half.
	Press 9 on the keypad. 		Command: up_damage.

	Speed up.	Increases running speed.
	Press 6 on the keypad.		Command: up_speed.

	Stamina up.	Increases stamina capacity by 50 Points.
	Press 3 on the keypad.		Command: up_stamina.

	Health up.	Increases health capacity by 50 Points.
	Press ./Del on the keypad.	Command: up_health.

	When you buy a powerup, the numbers by the icons in the top right of the 
	screen will go up buy 1. The Quad damage icon indicates damage level, the
	stoopid looking arrow is speed, the blue cross is stamina capacity and the
 	red cross is health capacity. You can have a maximum number of levels, e.g.
	if sv_maxlevels is set to 3, you may buy 3 separate level-ups. You may NOT
	buy 3 levels of each catagory. If you die, your levels are set back to zero.
	
	A new buying system by Fear allows you to toggle through the level ups as you 
	your inventory. press i to go left through the powerups (prevup) o to go right 
	(nextup) and keypad enter to select the powerup (selectup)
	
	Speed Boost
	-----------
	If your speed level is 1 or above and you have less that 150 mana (not enough
	for a level up) you can buy 20 seconds of speed for 25 mana by pressing 6
	on the keypad (up_speed).

	Fighting
	--------
	Pressing E (command "boot") makes you punch. This will eventually be changed 
	to kick, and an	actual weapon will be set aside for punching, with the kicking
	being secondary fire/offhand kick for other weapons.

	At the moment if you duck and punch you'll do an upper cut and send an opponent
	flying (like kickme quake - sorry for pluggin). if you stand you'll slap 'em. If
	you jump and tap E rapidly, you'll hover until your stamina runs out, kind of 
	like the flying quadruple kick KEENOO does in the film. This will change to this
	in a later version, when i do the player models etc.

	Flipping
	--------
	You'll automatically do side/back flips if you press strafe/back and jump 
	together. It just looks cool especially if you use it well (run halfway up 
	a wall and press backwards. you flip off the wall. D00d!!).

	Blocking
	--------
	If you stand still, any damage done to you is halved, but the amount of damage
	points you would have taken is taken off your stamina. Remeber if you have low 
	stamina, you won't be able to punch, kick, or run up walls. IF YOUR STAMINA IS 
	LESS THAN 5 YOU WILL TAKE DAMAGE. DUCK TO STOP THIS.

	Third Person Perspective
	------------------------
	To toggle Spine Design's TPP, press c (command: thirdperson).
	I recommend this if you have a fast connection and are doing hand to hand stuff.
	And to show off.


IV. VERSION NOTES
-----------------
This release is around 54% complete.

I don't THINK there's any other bugs.

The speed trails are of the SERVER's model and skin, not necessarily thr guy who's
speeding. i have an idead of how to fix this.

V. FUTURE
---------
Spells will be available. Stopping bullets and telepossesion already planned.
So is a force pull type move where you grab your opponent's weapon, leaving them disarmed. 
Other suggestions truely welcome.

There will be a new weapon for fists AND kicks. (2 attack buttons).

Tapping or holding the fire button with this weapon will produce differet affects.

Tapping will generally Jab. Holding will generally do a higher power but slower 
attack - uppercut, hook, falling skull cruncher.

(power = kick * damage)

There will be MANY akimbo pistols. You will not reload, only throw away weapons,
like in the film. There will be a sniper rifle, cos every mod needs one. ALL
bullets will be affected by gravity, rather than adding a random spread to your fire.
Bullets will be entities (like the blaster bolt), not hit-scan, so that they can 
physically be stopped in mid-air. The sniper rifle bullet may not be an entity, but
will still drop with distance.

There's going to be loads of play modes: 
regular teamplay (already possible i guess)
last man standing
team last man standing
ctf
ctb
teamplay with TANK
TANK, as in the guy from the film. An observer on each team will be able to spawn
items and powerups using his/her mana, kind of like Tank did in the film (gave them
weapons etc.)

Ammo boxes will be replaced by stamina and mana boxes. THey'll look like blue health.
Since you can't reload, you'll have no need for ammo. If you want guns, just pick up 
a new weapon. The respawn times for these will be quicker to compensate.

MORE STUFF.... l8r.

VI. CREDITS AND ACKNOWLEDGEMENTS
--------------------------------
Team Spasm:
	PainBerry	Project Leader, Main Programmer, Main Modeler. d00d.
			PainBerry@hotmail.com	PainBerry@planetquake,com
	Fear		Co-Programmer.
			david.hiller2@virgin.net
	GrumbleFish	Head of linux Dept, Server Getter, beer lover

	www.planetquake.com/kickme
	www.planetquake.com/kickme/matrix Soon moving to www.planetquake.com/matrix

Spine Design 
	- for TPP code

	www.planetquake.com/spine

Mr_Grim 
	- for giving me an idea of how to start the run-up-walls code and
		general pep-talks. 

	ahl.telefragged.com - lead coder
	www.planetquake.com/brazen - lead coder(!)
	www.planetquake.com/brazen/dirty - lead coder (!!)
	www.planetquake.com/paranoid - lead coder (d00d!!!)

Warner Bros + The Matrix
	- for giving me a direction for my mod to go in. Oh, and please 
		don't sue me/shut me down. OK? ok.

	www.whatisthematrix.com - very high traffic site.

Microsoft in Cambridge
	- for paying me 300 a week under the pretence that i'm making them
		a Bill Gates q2ppm. I'm not just modding or anything. No no no.

Command List:
-------------
thirdperson - toggles thirdperson

boot (off hand attack)

	jump backwards to backflip.
	jump sideways (strafing) to sideflip.

 "bank" // put 50 mana into bank form stamina
 "UP_DAMAGE" //buy damage
 "UP_SPEED" //buy speed
 "UP_STAMINA" //buy stamina-max-up
 "UP_HEALTH" //buy health-max-up

tap "boot" to hover in air. - temporarily OUT
sv_maxlevels - sets maximum level-ups allowed per life.
"inven" tap once for powerup menu, twice for regular inventory.
irvision
cloak