game: explore a randomly-generated 3-D maze with a Pharaonic Egypt theme (New BSD licence)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gradle/wrapper
nbproject
src/main
.gitignore
README.md
build.gradle
gradlew
gradlew.bat
settings.gradle

README.md

Jme3-maze Project

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

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

Uses jMonkeyEngine, tonegodGUI, and jme3-utilities.

How to install the SDK and the Jme3-maze Project

jMonkeyEngine3 (jME3) Software Development Kit (SDK)

The Jme3-maze Project currently targets Version 3.2.2 of jMonkeyEngine. You are welcome to use the Engine without also using the SDK, but I use the SDK, and the following installation instructions assume you will too.

The hardware and software requirements of the SDK are documented at https://jmonkeyengine.github.io/wiki/jme3/requirements.html

  1. Download a jMonkeyEngine 3.2 SDK from https://github.com/jMonkeyEngine/sdk/releases
  2. Install the SDK, which includes:
  • the engine itself,
  • an integrated development environment (IDE) based on NetBeans,
  • various plugins, and
  • the Blender 3D application.
  1. To open the Minie project in the IDE (or NetBeans), you will need the Gradle Support plugin. Download and install it before proceeding. If this plugin isn't shown in the IDE's "Plugins" tool, you can download it from GitHub.

Source files

Clone the jme3-maze repository using Git:

  1. Open the Clone wizard in the IDE:
  • Menu bar -> "Team" -> "Remote" -> "Clone..."
  1. For "Repository URL:" specify https://github.com/stephengold/jme3-maze.git
  2. Clear the "User:" and "Password:" text boxes.
  3. For "Clone into:" specify a writable folder (on a local filesystem) which doesn't already contain "jme3-maze".
  4. Click on the "Next >" button.
  5. Make sure the "master" remote branch is checked.
  6. Click on the "Next >" button again.
  7. Make sure the Checkout Branch is set to "master".
  8. Make sure the "Scan for NetBeans Projects after Clone" box is checked.
  9. Click on the "Finish" button.
  10. When the "Clone Complete" dialog appears, click on the "Open Project..." button.

Asset conversion

Before you run the game itself, you'll need to convert the Blender assets to native J3O format. To do this, run the AssetProcessor.java file in the jme3maze package:

  1. Right-click on the "jme3-maze" project in the "Projects" window.
  2. Select "Tasks" -> "runAssetProcessor"

Next steps

To run the game:

  1. Right-click on the "jme3-maze" project in the "Projects" window.
  2. Select "Run"

Acknowledgments

Like most projects, the Minie Project 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 3D animation suite
    • the FindBugs source code analyzer
    • the Git and Subversion revision control systems
    • the Google Chrome web browser
    • the Java compiler, standard doclet, and runtime environment
    • jMonkeyEngine and the jME3 Software Development Kit
    • LWJGL, the Lightweight Java Game Library
    • the MakeHuman 3D character creation tool
    • Microsoft Windows
    • the NetBeans integrated development environment
    • the PMD source code analyzer
    • the WinMerge differencing and merging tool

I am grateful to JFrog, Google, and Github for providing free hosting for the Jme3-maze 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.