Skip to content

a tiny javascript library for creating legendary mazes ;-)

License

Notifications You must be signed in to change notification settings

spearwolf/legendary-mazes

Repository files navigation

L E G E N D A R Y   M A Z E S

npm version

A tiny javascript library for creating legendary mazes ✨

a legendary maze a legendary maze animation

This library is using a recursive backtracker algorithm for maze generation — I implemented it relatively freely because it was so much fun 😃

Feel free to adapt, improve and extend the algorithm according to your needs - PR's are always welcome!

Demo or Die

Just look at this codepen: https://codepen.io/spearwolf/full/yLePxBw

In order to run the local demo app you need to start a local http server:

npx serve

Then simply call the following url with a browser of your choice: http://localhost:5000/

Documentation

Getting Started

  1. Install the module in your project
npm i legendary-mazes
  1. Import what you need
import {
  MazeGrid,
  RecursiveBacktracker,
  DistanceGrid,
  MazeCanvasRenderer
} from 'legendary-mazes';

API

Take a look into ./demo.js or ./codepen/ for examples how to use this library.