stephengold / jme3-utilities

Reusable code and assets for jMonkeyEngine games (code has New BSD license)

Jme3-utilities Project

The Jme3-utilities Project contains Java packages and assets, developed for sgold's jMonkeyEngine projects, which might prove useful in similar projects.

It contains 4 subprojects:

1. nifty: the jme3-utilities-nifty library for using NiftyGUI user interfaces with jMonkeyEngine
2. x: the jme3-utilities-x library of experimental software
3. moon-ccbysa: assets for a realistic Moon in SkyControl
4. tests: demos, examples, and test software

The SkyControl library, formerly a subproject, is now a separate project at GitHub.

The textures subproject is now part ofthe SkyControl Project.

The jme3-utilities-heart library, formerly a subproject, is now Heart, a separate project at GitHub.

The jme3-utilities-debug library, formerly a subproject, is now part of the Heart Library.

The jme3-utilities-ui library, formerly a subproject, is now Acorus, a separate project at GitHub.

The Minie library, formerly a subproject, is now a separate project at GitHub.

The Wes library, formerly a subproject, is now a separate project at GitHub.

Complete source code (in Java) is provided under a 3-clause BSD license.

Contents of this document

• How to build Jme3-utilities from source
• Downloads
• Conventions
• History
• Acknowledgments

How to build Jme3-utilities from source

1. Install a Java Development Kit (JDK), if you don't already have one.
2. 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 '

3. Download and extract the Jme3-utilities source code from GitHub:

• git clone https://github.com/stephengold/jme3-utilities.git
• cd jme3-utilities
• git checkout -b latest nifty-0.9.37

4. Run the Gradle wrapper:

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

After a successful build, Maven artifacts will be found in "*/build/libs".

You can install the artifacts to your local Maven repository:

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

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

Jump to the table of contents

Downloads

Recent releases can be downloaded from GitHub.

Recent Maven artifacts (since nifty v0.9.18 and x v0.2.20) are available from MavenCentral: nifty and x.

Jump to the table of contents

Conventions

Most package names begin with jme3utilities. Packages copied from jMonkeyEngine, however, retain their original names, which began with com.jme3.

The source code is compatible with JDK 7. The pre-built libraries are compatible with JDK 8.

Jump to the table of contents

History

Since September 2015, the Jme3-utilities Project has been hosted at GitHub.

From November 2013 to September 2015, it was hosted at Google Code.

The evolution of each subproject is chronicled in its release notes:

• debug
• nifty
• x

Jump to the table of contents

Acknowledgments

Like most projects, the Jme3-utilities Project builds on the work of many who have gone before. I therefore acknowledge the following software developers:

• Paul Speed, for helpful insights which got me unstuck during debugging
• Rémy Bouquet (aka "nehon") for many helpful insights
• the creators of (and contributors to) the following software:
  • Adobe Photoshop Elements
  • the Ant and Gradle build tools
  • the Checkstyle tool
  • the FindBugs source-code analyzer
  • the Firefox and Google Chrome web browsers
  • the Git and Subversion revision-control systems
  • the GitKraken client
  • Guava core libraries for Java
  • the IntelliJ IDEA and NetBeans integrated development environments
  • the Java compiler, standard doclet, and virtual machine
  • the JCommander Java framework
  • jMonkeyEngine and the jME3 Software Development Kit
  • the Linux Mint operating system
  • LWJGL, the Lightweight Java Game Library
  • the Markdown document-conversion tool
  • the Meld visual merge tool
  • Microsoft Windows
  • the Nifty graphical user-interface library
  • the PMD source-code analyzer
  • the WinMerge differencing and merging tool

I am grateful to GitHub, Sonatype, JFrog, and Imgur for providing free hosting for this project and many other open-source projects.

I'm also grateful to my dear Holly, for keeping me sane.

If I've misattributed anything or left anyone out, please let me know, so I can correct the situation: [e-mail]

Jump to the table of contents