Jake2 README
============

Jake2 is a port of the GPL'd Quake2 engine from id Software to Java. Jake2 is
distributed under the terms of the GPL (see LICENSE).

The port was done completely in Java. No native libraries are used for the
game functionality. We use the jogl Java OpenGL bindings for graphics rendering
and Java OpenAL (joal) for sound.

Jake2 is still under development. Send bug reports and feedback to
[email protected].

Currently Jake2 supports Linux and Windows2000/XP. We have feedback that it
works on OS X too with the right native jogl libraries.

requirements:
400 MHz CPU
Geforce2 MX or better graphics accelerator
JRE 1.4 or higher

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

from binary distribution:
- unpack jake2-version.tar.gz or jake2-version.zip
- copy the baseq2 directory from your full version of Quake2 or from the 
  demo version to the Jake2 base directory, in fact You need only
  baseq2/pak0.pak
- run the game with Jake2.sh or Jake2.bat

build from source:
- unpack jake2src-version.tar.gz or jake2-version.zip
- set JAVA_HOME environment variable to Your J2SDK1.4 installation
- run "build.sh bindist" or "build.bat bindist" to build the binary
  distribution

installation of Quake2 data:
- download ftp://ftp.idsoftware.com/idstuff/quake2/q2-314-demo-x86.exe (37 MB)
- extract the directory Install\Data\baseq2 from q2-314-demo-x86.exe with unzip
  or Winzip
- copy the baseq2 directory to the Jake2 directory      

If you want to have the latest experimental features you can grab the latest
Jake2 sources from CVS.
- "cvs -d:pserver:[email protected]:/cvsroot/jake2 login"
- when askesd for password simply press the Enter key
- "cvs -d:pserver:[email protected]:/cvsroot/jake2 co jake2"
- procced with the build from source instructions

have fun!

bytonic Software

Holger Zickner <[email protected]>
Carsten Weisse <[email protected]>
Rene Stoeckel  <[email protected]>

Use <[email protected]> for bug reports and feedback.