# legendary-mazes

> A tiny javascript module for creating legendary mazes ;-)

Latest version **1.2.0** (published 2020-07-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install legendary-mazes
pnpm add legendary-mazes
yarn add legendary-mazes
bun add legendary-mazes
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2020-07-08 |
| First published | 2020-07-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Wolfger Schramm |
| Maintainers | spearwolf |

## Links

- npm: https://www.npmjs.com/package/legendary-mazes
- Repository: https://github.com/spearwolf/legendary-mazes
- Homepage: https://github.com/spearwolf/legendary-mazes#readme
- Issues: https://github.com/spearwolf/legendary-mazes/issues
- npm.io page: https://npm.io/package/legendary-mazes

## Recent versions

- 1.2.0 (latest) — 2020-07-08
- 1.1.1 — 2020-07-07
- 1.1.0 — 2020-07-01

## README

L E G E N D A R Y &nbsp; M A Z E S

[![npm version](https://badge.fury.io/js/legendary-mazes.svg)](https://badge.fury.io/js/legendary-mazes)

A tiny javascript library for creating legendary mazes :sparkles:

![a legendary maze](./legendary-maze-1.png)
![a legendary maze animation](./legendary-maze.gif)

This library is using a _recursive backtracker_ [algorithm for maze generation](https://en.wikipedia.org/wiki/Maze_generation_algorithm)
&mdash; 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!

### 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:

```sh
npx serve
```

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


### Documentation

#### 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](./demo.js) or [./codepen/](./codepen/) for examples how to use this library.

---
_Source: https://npm.io/package/legendary-mazes · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
