Home - frasergeorgeking/UE4_BP_MazeGen_MIT GitHub Wiki

images/home/home_header.png

Welcome to the UE4_BP_MazeGen_MIT Wiki!

This wiki acts as the official source of documentation for the project and will highlight how to use the maze generator, as well as how to extend the project with custom tile geometry and other functionality.

Please find the main repository here. Any work-in-progress updates are accessible through the dev branch here (please note that this branch may contain bugs and unfinished implementations of features - use at your own caution!).

Current Project Details

  • Latest Main Branch Release: v2.0.1
  • Unreal Engine Compatibility:
    • 4.25.x (current master branch project version)
    • 4.26.x (available via release or in-place upgrade)
    • 5.0 EA (available via release - in-place upgrade not recommended due to UE5 UI changes)
      • Please note that this Wiki only contains UE4-specific instructions (differences should be fairly minimal, however)
  • Wiki Last Updated: 24/07/2021

Quick Links

Getting Started Using the Generator Custom Extensions
[images/home/getting_started.png]]](/frasergeorgeking/UE4_BP_MazeGen_MIT/wiki/[[images/home/how_to.png) images/home/custom_extension.png
Getting Started Using the Generator Custom Extensions
Prerequisites & project setup Generation properties, CSV functionality & more Extend functionality with bespoke geometry & behaviour

Key Functionality

  • Maze generator creates perfect, solvable mazes through the implementation of a sidewinder algorithm
  • Tile-based not wall-based, allowing for a complex range of custom tile geometry to be utilised
  • Implements Unreal Engine 4's stream-based RNG, thereby enabling the use of custom seeds (ideal for synchronising states over a network etc...)
  • Import/Export maze state from .CSV
  • Custom Utility Widget for detailed in-engine generation
  • Free and Open Source via MIT License

Example Gallery

images/home/renders/render_01.png

images/home/renders/render_02.png

PSX Stone Tileset, included with project as example tiles. Renders taken with DaveFace's Retro Shader Pack applied.

images/home/renders/render_03.png

images/home/renders/render_04.png

Mystic Bridge Tileset by Katie Millar. Additional set-dressing applied with POLYGON assets.

images/home/renders/render_05.png

Shinto Tileset by Sam McMillan. Additional set-dressing applied with POLYGON assets.