jMonkeyEngine/jmonkeyengine

A complete 3-D game development suite written in Java. http://jmonkeyengine.org

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.jmonkeyengine:jMonkeyEngine:3.8.0-alpha2'
	}

	dependencies {
		implementation("com.github.jmonkeyengine:jMonkeyEngine:3.8.0-alpha2")
	}

	<dependency>
	    <groupId>com.github.jmonkeyengine</groupId>
	    <artifactId>jMonkeyEngine</artifactId>
	    <version>3.8.0-alpha2</version>
	</dependency>


                            
    libraryDependencies += "com.github.jmonkeyengine" % "jMonkeyEngine" % "3.8.0-alpha2"


                            
    :dependencies [[com.github.jmonkeyengine/jMonkeyEngine "3.8.0-alpha2"]]

Readme

jMonkeyEngine

jMonkeyEngine is a 3-D game engine for adventurous Java developers. It’s open-source, cross-platform, and cutting-edge. v3.8.0 is the latest stable version of the engine.

The engine is used by several commercial game studios and computer-science courses. Here's a taste:

jME3 Games Mashup

Getting Started

Go to https://github.com/jMonkeyEngine/sdk/releases to download the jMonkeyEngine SDK. Read the wiki for the installation guide and tutorials. Join the discussion forum to participate in our community, get your questions answered, and share your projects.

Note: The master branch on GitHub is a development version of the engine and is NOT MEANT TO BE USED IN PRODUCTION.

Technology Stack

windowed, multi-platform IDE derived from NetBeans
libraries for GUI, networking, physics, SFX, terrain, importing assets, etc.
platform-neutral core library for scene graph, animation, rendering, math, etc.
LWJGL v2/v3 (to access GLFW, OpenAL, OpenGL, and OpenVR) or Android or iOS
Java Virtual Machine (v8 or higher)

Documentation

Did you miss it? Don't sweat it, here it is again.

Contributing

Read our contribution guide.

License

New BSD (3-clause) License

How to Build the Engine from Source

Install a Java Development Kit (JDK), if you don't already have one.
Point the JAVA_HOME environment variable to your JDK installation: (In other words, set it to the path of a directory/folder containing a "bin" that contains a Java executable. That path might look something like "C:\Program Files\Eclipse Adoptium\jdk-17.0.3.7-hotspot" or "/usr/lib/jvm/java-17-openjdk-amd64/" or "/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home" .)
- using Bash or Zsh: export JAVA_HOME=" path to installation "
- using Fish: set -g JAVA_HOME " path to installation "
- using Windows Command Prompt: set JAVA_HOME=" path to installation "
- using PowerShell: $env:JAVA_HOME = ' path to installation '
Download and extract the engine source code from GitHub:
- using Git:
  - git clone https://github.com/jMonkeyEngine/jmonkeyengine.git
  - cd jmonkeyengine
  - git checkout -b latest v3.7.0-stable (unless you plan to do development)
- using a web browser:
  - browse to the latest release
  - follow the "Source code (zip)" link at the bottom of the page
  - save the ZIP file
  - extract the contents of the saved ZIP file
  - cd to the extracted directory/folder
Run the Gradle wrapper:
- using Bash or Fish or PowerShell or Zsh: ./gradlew build
- using Windows Command Prompt: .\gradlew build

After a successful build, fresh JARs will be found in "*/build/libs".

You can install the JARs to your local Maven repository:

using Bash or Fish or PowerShell or Zsh: ./gradlew install
using Windows Command Prompt: .\gradlew install

You can run the "jme3-examples" app:

using Bash or Fish or PowerShell or Zsh: ./gradlew run
using Windows Command Prompt: .\gradlew run

You can restore the project to a pristine state:

using Bash or Fish or PowerShell or Zsh: ./gradlew clean
using Windows Command Prompt: .\gradlew clean

Running examples

The engine comes with some examples that you can run with:

./gradlew runExamples

You can optionally use the -Pexample property to specify an example to start without the need to navigate the test chooser, e.g.:

./gradlew runExamples -Pexample=jme3test.light.pbr.TestPBRSimple

Android examples

You can run the Android examples on a local android emulator with:

./gradlew -PbuildAndroidExamples=true -PbuildNativeProjects=true runAndroidExamples 
# or for a specific example:
# ./gradlew -PbuildAndroidExamples=true -PbuildNativeProjects=true runAndroidExamples -Pexample=jme3test.post.TestBloom

Make sure to have the SDK and NDK installed and configured properly, and the emulator running before executing the command.

Running Tests

To run all tests and generate a JaCoCo code coverage report, run the testCodeCoverageReport Gradle task. To avoid the generation of the report, use the test task instead.

This runs all subproject tests and produces two sets of HTML reports:

Aggregated report (all modules combined): build/reports/jacoco/testCodeCoverageReport/html/index.html
Per-module reports: <module>/build/reports/jacoco/test/html/index.html

A summary index linking to every per-module report is also generated at: build/reports/jacoco/index.html