============
Pocket Quake
============

MIPS build

Ported from the original GNU GPL 
ID Software source code by Dan East

PocketQuake@pocketmatrix.com
http://www.pocketmatrix.com/pocketquake

*BETA TEST v0.041*
02-25-2001


=LEGAL=========
Use this software at your own risk.  Back up your device before installing or using this software.  The iPaq has a flash-rom which contains the operating system.  It *is* possible for your device to be rendered completely unusable by software error alone.  Dan East will not be held responsible for your participation in testing this beta software.  This software depicts graphic violence and blood, and is probably rated for those over 17 years of age.  


=Description==
This software is a port of ID Software's groundbreaking, first-person, 3D simulation game QUAKE.  At the present time the Compaq iPaq and the @migo are the only known palm-sized portable computing devices capable of rendering Quake at a playable speed.  Performance is substantially less than what will be achieved after thorough optimization.


=PAK Game File Required==
The software contained in this archive is only the engine which processes a game file (PAK).  You must obtain the shareware Quake PAK file, named PAK0.PAK, which has been compressed with the gzip utility (http://www.gzip.org).  The compressed PAK0.PAK file's size is around 8.5 MB.  This file can be downloaded directly from http://www.pocketmatrix.com/pocketquake/downloads/pak0.pak.gz.zip.  If you own the registered version of Quake, then you may copy the registered pak files from your Quake CD-ROM onto your device if they will fit (storage card required).  The registered pak files can also be gzipped to substantially reduce their size (which increases game load times).

=INSTALLATION==
This software currently contains no installer - you must manually copy the files onto your device.  This is a very simple process:

1) Connect your iPaq to your desktop PC, and make sure that the ActiveSync connection is patent.

2) Press the Explore button on the Microsoft ActiveSync window.

3) Create the directory /quake (note: do not create this in My Documents, create it in the root of "My Pocket PC"), then create a directory within quake called ID1: /quake/ID1/

4) If you retrieved the pak0.pak.gz file from our website, then the file will be zipped (pak0.pak.gz.zip).  This is necessary because some web browsers were automatically decompressing the .gz file, which resulted in  a 24 MB file.  If the file is zipped (ends with .zip), then you need to extract the file ONCE, so that it is pak0.pak.gz.

5) Copy the pak0.pak.gz file into the /quake/ID1/ directory you created.

6) Also copy the autoexec.cfg file into the /quake/ID1/ directory you created. (Note that this config file is REQUIRED for proper sound production, and is also needed to make use of 999's custom control / cheat layout).

7) Copy GX.DLL into the /Windows/ directory of your device.  This file can be obtained from Microsoft at http://www.microsoft.com/mobile/downloads/developer/gapi.asp.  The archive contains 8 files.  The only file you need is the gx.dll file in the "arm" subdirectory.

8) Copy PocketQuake.exe onto your device.  Placing it in /Windows/Start Menu/Programs/Games will make it easy to access.

9) Run Pocket Quake!

=Advanced installation options==
If you have a storage card you may place the pak0.pak there to save space on your device.  Create a /quake/ID1 directory on your storage card and copy the file there.  Note that this will result in the slowest load times (using a compressed pak file on a storage card).  If you have a storage card with at least 18.5 MB free, then you can decompress the pak0.pak.gz file into an 18 MB pak0.pak file.  This will result in faster loading.  Optimally, if you have a 64 MB iPaq with at least 18.5 MB free storage space, then placing the uncompressed pak file directly on your device will result in the fastest possible loading.

If you are using your own cfg file (in place of the included autoexec.cfg), then you need to include the following entry for sound to work correctly:
_snd_mixahead "0.2"

Quake will save games (s0.sav, s1,sav, etc) and other settings (config.cfg) in the same directory that the pak file resides in.  Also place your custom config files in that directory.  Note that each saved game entry can take a substantial amount of space (up to 150k).  Make sure you have enough storage space available for the number of games you wish to have saved simultaneously.  Also, Pocket Quake save game files are 100% compatible with the original Quake save games, so you can copy these files back and forth from desktop Quake.  Also, you can swap these saved games with your friends.

=Performance==
*Currently Quake runs at a playable speed, although much improvement is needed.  We hope to achieve this through optimization of the source code in the near future.

*If you place the pak files on a storage card then it will take longer to read from those files.  This affects the time required to initially start Quake, pull up menus, and load new levels.  This has no affect on the fps.

*Using compressed (gzipped) pak files also greatly slows down file access, as described above.  However, for the majority of people, this is the only available option to play Quake, unless they have a storage card with enough free space on which to store the uncompressed pak files.  Placing a compressed pak file on a Storage Card will compound the problem.  


=Known Outstanding Issues==
*Some SIP keys do not register (+, -, _, etc).

*If you tell quake to exit via windows (using a program like GigaBar), then any unsaved configuration settings will not be saved.  This problem exists in the Windows version of Quake as well.

*When Quake is running it pretty much takes over your device.  Other programs will not run properly while Quake is running.


=Contributors==
999 - Awesome control bitmap


=Version History==
0.03 - 02-15-2001
	* Pocket Quake now considered a "beta" version.
	* Sound support added.
	* Multiplayer TCP/IP Network support added.
0.02 - 01-23-2001 
	* Uses .5 MB less RAM
	* Supports WAD files residing on Storage Cards (regardless of device language).
	* Added crosshair support (Command = "crosshair [0/1]")  
	* Added onscreen controls, including MLOOK.
	* Automatic SIP handling with Console.
	* Record hardware button is now mappable (as AUX5).

0.01 - 01-20-2001 
	**Initial Release**