aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: f8c27a4acdc986b8deabcfb9596daed06a6ae10b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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
jake2@bytonic.de.

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:
- run the installer with "java -jar Jake2-Install.jar"
- follow the instructions
- change to the installation directory
- 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:
- if Jake2 does not detect the Quake2 files on startup you have the choice
  to select a baseq2 directory of a Quake2 installation (demo or full version)
  or to download and install the Quake2 demo files

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

3rd party components
--------------------

Jake2 uses:
jogl     OpenGL bindings    https://jogl.dev.java.net
joal     OpenAL bindings    https://joal.dev.java.net
openal   Audio library      http://www.openal.org
izpack	 Installer	        http://www.izforge.com/

the source distribution comes with:
ant      build tool         http://ant.apache.org
xerces   XML library        http://xml.apache.org
proguard obfuscator         http://proguard.sourceforge.net



have fun!

bytonic Software

Holger Zickner <hoz@bytonic.de>
Carsten Weisse <cwei@bytonic.de>
Rene Stoeckel  <rst@bytonic.de>

Use <jake2@bytonic.de> for bug reports and feedback.