You are welcome to try out the new jME3, and contribute patches and features! This document shows how to download, set up, build, and run the latest development version from the sources. These instructions work in NetBeans IDE 6 or better.
Note: In the following, always replace "~" with the path to your home directory.
Check out the sources from the repository. (The following NetBeans instructions are equivalent to executing
cd ~/NetBeansProjects; svn checkout http://jmonkeyengine.googlecode.com/svn/branches/3.0final/engine jme3 on the commandline.)
- In NetBeans go to Team > Subversion > Checkout
- Repository URL:
- You can leave user/pw blank for anonymous access.
- Click Next
- Repository Folders:
- Enable the checkbox to Skip "engine" and only checkout its contents.
- Local Folder:
- Click Finish and wait.
The jme3 project opens in the Project window. It already includes a working ANT build script for building and running.
Look into the Libraries node and confirm that the project depends on the following libraries in the classpath:
For a detailed description of the separate jar files see this list.
- Right-click the jme3 project node and "Clean and Build" the project.
- In the Projects window, open the
Testfolder which contains the sample apps.
- Every file with a Main class (for example
jme3test.game/CubeField.java) is an app.
- Right-click a sample app and choose "Run File" (Shift-F6).
- Generally in sample apps:
- the mouse and the WASD keys control movement
- the Esc key exits the application
If you are working on the jme3 sources:
- In the Projects window, right-click the jme3 project and choose Generate Javadoc. Wait.
- Confirm in the Files window that the javadoc has been created in
- In the editor, place the caret in a jme class and press ctrl-space to view javadoc.
If you are working on a game project that depends on jme3:
- First follow the previous tip. (In the future, we may offer jme javadoc as download instead.)
- In your game project, right-click the Libraries node and choose "Properties".
- In the Library properties, select jme3.jar and click the Edit button.
- For the Javadoc field, browse to
~/NetBeansProjects/jme3/dist/javadoc. Check "as relative path" and click select.
- For the Sources field, browse to
~/NetBeansProjects/jme3/src. Check "as relative path" and click select.
- Click OK.
- In the editor, place the caret in a jme class and press ctrl-space to view javadoc. Ctrl-click any jme3 method to jump to its definition in the sources.
This tip works for any third-party JAR library that you use. (You may have to download the javadoc/sources from their home page separately).