Maze Engine Documentation

Maze Engine

Maze Engine builds persistent mazes directly in your Minecraft world. Choose a theme, preview its layout, and create a maze with a reproducible seed. Manage the finished structure through interactive chat panels, guide players to its exit, rebuild it, or restore the terrain captured before construction.

Compare all 30 themes in the preset gallery, or explore previews and route guides for in-game examples. Select any screenshot to enlarge it without leaving the documentation.

Maze Engine supports Paper and compatible forks such as Purpur for Minecraft 1.21.11 and later and requires Java 25. Folia is not supported. WorldEdit or FastAsyncWorldEdit, WorldGuard, and PlaceholderAPI are optional integrations.

Download Maze Engine

Download the latest plugin JAR from Hub or SpigotMC, then follow the installation guide. You do not need to compile the plugin yourself.

You can also visit the BuiltByBit and Modrinth project pages. Downloads there will be available once those pages are published. The plugin is free and open source under GPL-3.0-or-later.

Start Building

Getting Started Install the plugin, check requirements, and build your first maze.

Core Concepts Understand the terms in in-game help: cells, seeds, presets, placement, and snapshots.

Creating Mazes Choose cell dimensions, world coordinates, placement rules, and WorldEdit selections.

Previews and Route Guides Inspect a private visual preview and follow a personal route to the exit.

Themes and Generation

The plugin includes 30 editable presets, from open hedge gardens and desert passages to roofed dungeons, copper halls, and volcanic corridors. Presets control physical geometry, block palettes, decorations, generation settings, and display metadata.

Preset Reference Create custom themes with weighted palettes, roofs, lighting, caps, and wall inlays.

Generation and Geometry Understand deterministic seeds, perfect and braided graphs, physical size, and complexity.

Preset Gallery Compare all 30 themes from above, from the side, and inside their corridors.

Server Administration

Commands Every public command, accepted option, and practical example.

Permissions Action permissions, maze ownership, management rights, and protection bypass.

config.yml Control operation budgets, size limits, terrain protection, and visual sessions.

messages.yml Customize MiniMessage text, chat panels, buttons, and hover information.

Integrations WorldEdit selections and snapshots, WorldGuard checks, and PlaceholderAPI.

PlaceholderAPI Use global, named-maze, player-location, and ownership placeholders.

Operations and Recovery Understand saved records, removal modes, interrupted work, and backups.

Developer API

The public API exposes immutable maze descriptions, preset metadata, graph routes, operation handles, and completion events. Integrations use the same permission, ownership, and region checks as commands.

API Getting Started Load the Bukkit service and query mazes, destinations, routes, and presets.

Operations and Events Submit creation, regeneration, repair, and removal, then observe their outcomes.

Troubleshooting Diagnose rejected regions, unavailable integrations, failed records, and visual sessions.

Source Code Read the implementation, report a reproducible issue, or contribute on GitHub.