Getting Started

Requirements

Component	Requirement
Paper	Minecraft 1.21.11 and later
Java	Java 25
WorldEdit / FAWE	Optional; required for cuboid selections and original-terrain snapshots
WorldGuard	Optional; applies build authorization to Maze Engine world edits
PlaceholderAPI	Optional; registers the mazeengine expansion automatically

Use integration builds compatible with your chosen server version. The basic generator, chat interface, previews, and route guides work without these integrations.

Build from Source

With a Java 25 JDK installed:

1. Clone the repository with git clone https://github.com/Despical/MazeEngine.git.
2. Open the project directory with cd MazeEngine.
3. Build using the included Gradle wrapper:

./gradlew clean build

On Windows PowerShell, use ./gradlew.bat clean build. The plugin JAR is generated in build/libs/.

Optional API Javadocs: run ./gradlew apiJavadoc separately to generate HTML in build/docs/api/.

Install

Use build/libs/mazeengine-1.0.0.jar for every supported server version and run the server with Java 25.

1. Build the Maze Engine repository using the instructions above and select mazeengine-1.0.0.jar from build/libs/.
2. Stop the server and place the plugin JAR in its plugins directory.
3. Install any optional integrations you intend to use.
4. Start the server with Java 25 and check the console for a successful Maze Engine startup.
5. Run /maze help as an operator or an account with the relevant permissions.

The first startup creates plugins/MazeEngine/config.yml, messages.yml, and the bundled preset files. Existing configuration files are retained. Saved maze records and optional snapshots are stored under the same plugin data directory.

Preview Your First Maze

Choose a clear area in your current world and run:

/maze preview garden 11 11 --preset hedge --seed 2026

The dimensions are logical cells, rather than physical blocks. The preview uses display entities visible to you and does not change the terrain. Its chat panel provides Create and Close actions.

Move outside the preview’s entire footprint before choosing Create. You can also confirm the same active preview with:

/maze create garden

A plain create command with the matching name uses the preview’s retained origin, seed, dimensions, and preset. Supplying new options instead starts an ordinary creation request.

Create Directly

/maze create garden 11 11 --preset hedge --seed 2026 --mode SAFE

Without explicit coordinates, the floor origin is three blocks east and south of your position, one block below your feet. Width and depth extend along positive X and Z. SAFE rejects occupied blocks above the floor; its floor permits air and the configured replaceable materials.

Placement changes terrain

The bundled presets use CLEAR placement. This permits existing materials to be replaced across the full maze volume. Choose a suitable area, use SAFE or REPLACE when appropriate, and use --snapshot with WorldEdit or FAWE if you need the original terrain restored later.

Inspect and Explore

/maze list
/maze info garden
/maze tp garden
/maze solve garden

Creation finishes after the world work and final record save complete. The info panel shows the theme, cell and block dimensions, seed, route length, dead ends, snapshot availability, and teleport destination. The route guide is personal and follows the saved cell graph toward the exit.

Remove a Maze

/maze delete garden

Review the deletion panel before confirming. By default, a maze with a saved snapshot restores the original terrain; a maze without one clears its bounded volume to air. The confirmation expires after 60 seconds.

For explicit terrain handling, use /maze delete garden --restore or /maze delete garden --clear. See operations and recovery before clearing a maze containing player-built additions.

Configure and Reload

Edit config.yml, messages.yml, or a file under presets/, then run:

/maze reload

A reload validates the complete replacement configuration before publishing it. Invalid values reject the reload. Existing mazes retain their saved preset and graph; changed presets affect new mazes. Global presentation and operation settings use the newly loaded configuration.

Continue with creating mazes for selection and coordinate workflows, or presets to design a theme.