How to use JOGL native libraries in JaGrLib
===========================================

Table of contents:
------------------
1. Overview
2. Download
3. Installation
4. Using other versions of JOGL

--------------------------------------------------------------------

1. Overview
-----------
In order to be able to use the OpenGL features in JaGrLib it is
necessary to include native libraries when running JaGrLib. The
library used here is JOGL, its homepage is

https://jogl.dev.java.net/

Here you can find information about downloading, installing and
using JOGL in JaGrLib.

--------------------------------------------------------------------

2. Download
-----------
JOGL libraries can be downloaded from

https://jogl.dev.java.net/servlets/ProjectDocumentList
(alternative: follow "Document & Files" link on the JOGL homepage)

Version numbers of dynamic and platform specific libraries (".dll",
".so") MUST match jar version number ("jogl.jar", "gluten-rt.jar").
The current version of jars included in JaGrLib repository is
written in the "JOGL-version.txt" file. Using different versions
is not recommended (see 4. for details).

There is one archive/installation file to be downloaded:

jogl-(version)-(platform).zip

where (version) is the required version number and (platform) is
the name of the relevant platform. Example:

jogl-1.1.1-rc6-windows-i586.zip

.. JOGL version 1.1.1-rc6 running on Windows i586 platform.

--------------------------------------------------------------------

3. Installation
---------------
Unpack downloaded archive and copy the following files to the
"lib" subdirectory of JaGrLib working copy:

lib/gluten-rt.dll
lib/jogl.dll
lib/jogl_awt.dll
lib/jogl_cg.dll

Extensions can differ from one platform to another: ".so"
is used on UNIX platforms, ".dll" on Windows, ".jnilib" on
MacOS X..

--------------------------------------------------------------------

4. Using other versions of JOGL
-------------------------------
In case you need to use a different JOGL version, it is necessary
to update "jogl.jar" and "gluten-rt.jar" files as well.
Versions different from the one included in the JaGrLib repository
can have non-compatible modifications - you would eventually have
to fix compile errors..

You have been warned!
