Downloading and installing JOGL

Before you can build a project that uses JOGL in your IDE or on the command line, you'll need to download and install the JOGL JAR files and native JARs or native library files (.dll/.so/.jnilib files).

You have a choice of JOGL versions to download. The [/deployment/jogamp-current/archive/ latest stable version] is the safest, but lags behind in features. The [/deployment/autobuilds/master/ latest automatic build] contains all checked-in code, but may be failing some tests.

= Downloading the latest stable version =

Go to [/deployment/jogamp-current/archive/ this page] and download the all-in-one 7z archive file:


 * [/deployment/jogamp-current/archive/jogamp-all-platforms.7z jogamp-all-platforms.7z]

Using the 7z jogamp-all-platforms archive
After inflating the file with 7zip, you will have the general directory structure:

&lt;jogamp-all-platforms&gt;/ &lt;jogamp-all-platforms&gt;/etc/test.sh &lt;jogamp-all-platforms&gt;/etc/test.bat &lt;jogamp-all-platforms&gt;/etc/test_dbg.sh &lt;jogamp-all-platforms&gt;/etc/test_dbg.bat &lt;jogamp-all-platforms&gt;/jar/&lt;module&gt;.jar &lt;jogamp-all-platforms&gt;/jar/&lt;module&gt;-natives-&lt;os.and.arch&gt;.jar &lt;jogamp-all-platforms&gt;/lib/ &lt;jogamp-all-platforms&gt;/&lt;module&gt;-java-src.zip* Legend:
 * [/jogl/doc/deployment/JOGL-DEPLOYMENT.html#NativeJARFileNameConvention os.and.arch]
 * module: gluegen, joal, jogl or jocl

Now you can test the archive as described in runtime version check and runtime debug test.

If anything doesn't work as predicted, please follow our bugreport guide.

While keeping the above directory structure as-is, you can go ahead and
 * add the non-native JAR files to your CLASSPATH (IDE, manual, ..)
 * attach the java-source files to the non-native JAR files (IDE)

.. now you are set to start using JogAmp module in your project.

The above is detailed in Eclipse Project and Eclipse User Library.

= Downloading the latest aggregated autobuild =

Got to [/deployment/archive/master/?C=M;O=D this page] and navigate into the first folder, which shall be the latest aggregated autobuild.

Then navigate further down to archive and download the file jogamp-all-platforms.7z.

For example, on 13-Mar-2013 20:19 CET, the latest aggregated autobuild was:

[/deployment/archive/master/gluegen_646-joal_408-jogl_930-jocl_756/archive/jogamp-all-platforms.7z /deployment/archive/master/gluegen_646-joal_408-jogl_930-jocl_756/archive/jogamp-all-platforms.7z]

Now you can continue here.

= Downloading the latest automatic build =

For the latest automatic build, we have to download gluegen and jogl separately.

First, go to [/deployment/autobuilds/master/?C=M;O=D this page] and click on the most recent gluegen-b* directory. Then download one of these files for each platform you're developing on:


 * 32-bit Windows: gluegen-2.0-bvvv-20yymmdd-windows-i586.7z
 * 64-bit Windows: gluegen-2.0-bvvv-20yymmdd-windows-amd64.7z
 * 32/64-bit Mac OS X: gluegen-2.0-bvvv-20yymmdd-macosx-universal.7z
 * 32-bit Linux: gluegen-2.0-bvvv-20yymmdd-linux-i586.7z
 * 64-bit Linux: gluegen-2.0-bvvv-20yymmdd-linux-amd64.7z</tt>
 * 32-bit Solaris: gluegen-2.0-bvvv-20yymmdd-solaris-i586.7z</tt>
 * 64-bit Solaris: gluegen-2.0-bvvv-20yymmdd-solaris-amd64.7z</tt>

Then, go back to [/deployment/autobuilds/master/?C=M;O=D this page] and click on the most recent jogl-b*</tt> directory. Then download one of these files for each platform you're developing on:


 * 32-bit Windows: jogl-2.0-bvvv-20yymmdd-windows-i586.7z</tt>
 * 64-bit Windows: jogl-2.0-bvvv-20yymmdd-windows-amd64.7z</tt>
 * 32/64-bit Mac OS X: jogl-2.0-bvvv-20yymmdd-macosx-universal.7z</tt>
 * 32-bit Linux: jogl-2.0-bvvv-20yymmdd-linux-i586.7z</tt>
 * 64-bit Linux: jogl-2.0-bvvv-20yymmdd-linux-amd64.7z</tt>
 * 32-bit Solaris: jogl-2.0-bvvv-20yymmdd-solaris-i586.7z</tt>
 * 64-bit Solaris: jogl-2.0-bvvv-20yymmdd-solaris-amd64.7z</tt>

Note that these automatic builds may not have passed all the regression tests. You can check the test results on the build server to make sure you're not downloading a broken build.

Native JARs vs. native library files
JOGL uses native libraries to interface with each platform's OpenGL library. You can either download these native libraries wrapped up in JAR files (the "native JARs" option), or you can download them as separate .dll</tt>/.so</tt>/.jnilib</tt> files (the "native library files" option).

When using native JARs, JOGL automatically unzips the native JARs at startup into a temporary directory, then loads the resulting .dll</tt>/.so</tt>/<tt>.jnilib</tt> files from there. When using native library files, JOGL just loads them directly from where they sit, with no unzipping.

Using native JARs is usually easiest, since there are fewer files to manage and it allows different platforms' native library files to coexist in the same directory. Only use the native library files directly if you need fine control over native library file placement or if your app doesn't have permissions to create temporary directories.

Unzipping the files
Unzip all the downloaded files with 7zip. An unzipped file has this general directory structure:

&lt;archive&gt;/ &lt;archive&gt;/jar/ &lt;archive&gt;/lib/ &lt;archive&gt;/&lt;module&gt;-java-src.zip*

Now you may copy the required JARs out of each <tt>jar</tt> folder and the native library files (if you're using them) out of each <tt>lib</tt> folder. For a full desktop installation using native JARs, here are the files you need. Note that the native JAR names are different for each platform, so you can use some or all of the native JARs together to create a multi-platform installation.

For a full desktop installation using native library files, here are the files you need. Note that the native library files have the same names for 32-bit and 64-bit platforms, so 32-bit and 64-bit platforms can't coexist in one installation.

= Maven = Alternatively, the Jogamp packages are available through Maven.

See the maven instructions for a guide to using Jogamp in Maven projects.

= More information =

JogAmp follows a release scheme, which describes the following locations to download the 7z archives from:


 * [/deployment/ Deployment Home]
 * [/deployment/jogamp-current/archive/ Signed Release]
 * [/deployment/jogamp-next/archive/ Signed Candidate]
 * [/deployment/jogamp-next/v2.0-rc3archive/ Specific Version]

[/jogl/doc/deployment/JOGL-DEPLOYMENT.html JOGL Deployment] describes the content of the 7z archive files.

These installations contain all of JOGL. If you want to remove parts you don't use, see [/jogl/doc/deployment/JOGL-DEPLOYMENT.html JOGL Deployment] for more information.