stephengold / jme3-maze

Game: explore a randomly-generated 3-D maze with a Pharaonic Egypt theme (New BSD license)

The Jme3-maze Project is creating a first-person, single-player game with a mouse-oriented GUI. Its logline is:

Explore a randomly-generated three-dimensional maze with a Pharaonic Egypt theme.

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

It uses jMonkeyEngine, tonegodGUI, and jme3-utilities.

How to build and run Jme3-maze 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. (The path might be something like "C:\Program Files\Java\jre1.8.0_301" or "/usr/lib/jvm/java-8-openjdk-amd64" or "/Library/Java/JavaVirtualMachines/liberica-jdk-17-full.jdk/Contents/Home" .)

• using Bash or Zsh: export 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-maze source code from GitHub:

• using Git:
  • git clone https://github.com/stephengold/jme3-maze.git
  • cd jme3-maze
• using a web browser:
  • Browse to https://github.com/stephengold/jme3-maze/archive/refs/heads/master.zip
  • save the ZIP file
  • extract the contents of the saved ZIP file
  • cd to the extracted directory/folder

4. Run the Gradle wrapper:

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

You can run the local build using the Gradle wrapper:

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

You can restore the project to a pristine state:

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

Jump to table of contents

Acknowledgments

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

• Cris (aka "t0neg0d") for creating tonegodGUI and adapting it to my needs
• the creators of (and contributors to) the following software:
  • Adobe Photoshop Elements
  • the Blender 3-D animation suite
  • the Checkstyle tool
  • the FindBugs source-code analyzer
  • the Firefox and Google Chrome web browsers
  • the Git revision-control system and GitK commit viewer
  • the GitKraken client
  • the Gradle build tool
  • the IntelliJ IDEA and NetBeans integrated development environments
  • the Java compiler, standard doclet, and runtime environment
  • jMonkeyEngine and the jME3 Software Development Kit
  • the Linux Mint operating system
  • LWJGL, the Lightweight Java Game Library
  • the MakeHuman 3-D character creation tool
  • the Markdown document-conversion tool
  • the Meld visual merge tool
  • Microsoft Windows
  • the PMD source-code analyzer
  • the Subversion revision-control system
  • the WinMerge differencing and merging tool

I am grateful to JFrog, Google, Github, 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 table of contents