maze_generator (WIP)

maze_generator is a module for easily generating mazes.

⚠️ This is work-in-progress, and feedback is welcome.

Almost everything is subject to change so this is all very unstable.

This module is heavily influenced by Jamis Buck's Coffeescript mazes. It is structured a little differently though and is written entirely in Javascript rather than Coffeescript. It also functions as a module, rather than a library. I aim to eventually add all the functionality that Jamis's CS maze library has.

Example Usage

import {Maze} from "https://deno.land/x/maze_generator/mod.js"

let mazeSettings = {
  width: 12,
  height: 12,
  algorithm: "recursive backtracker"
}

//initialize the maze
let m = Maze.create(mazeSettings);

//generate it
m.generate();


console.log(JSON.stringify(m));

Other examples

See the examples folder for more examples.

Also see this OpenProcessing sketch: https://openprocessing.org/sketch/908761.

Maze.create()

To create a new maze, use Maze.create(). You can optionally pass in an object with the settings (see below).

Maze settings object

These are all the properties of the object you can pass in when you write Maze.create(mazeSettings)

Algorithms coming soon:

• True Prim's
• Wilson's

.step()

Call .step() to advance the maze one step.

Returns true if the maze hasn't finished generating yet and false if there are no more steps left to take. You can also check if a maze has finished generating with .finishedGenerating, which is a boolean value.

.generate()

This method calls .step() repeatedly until the maze has finished generating (or it has given up). Returns the finished maze

display() (very unstable)

This is the function which displays the maze.

It takes in an object with the properties listed below. All of them are optional except the maze property.

Example usage

let m = Maze.create({
  width: 20,
  height: 20,
  algorithm: "Kruskal's"
})

display({
  maze: m,
  canvas: document.getElementById("maze-canvas") //replace this with your canvas element you want to display the maze on
})