legendary-mazes

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


A tiny javascript library for creating legendary mazes :sparkles:

!a legendary maze
!a legendary maze animation

This library is using a _recursive backtracker_ algorithm for maze generation
— but implemented it relatively freely because it was so much fun :smiley:

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

$3

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:

``sh
npx serve
`

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

$3

#### Getting Started

1. Install the module in your project

`sh
npm i legendary-mazes
`

2. Import what you need

`js
import {MazeGrid, RecursiveBacktracker, ...} from 'legendary-mazes';
``

#### API

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