UNPKG

maze

Version:

Flexible perfect maze generator

github.com/semibran/maze

semibran/maze

27 lines (18 loc) • 1.06 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# maze > Flexible perfect maze generator This module generates "perfect mazes" (i.e. no loops) by connecting "nodes" from a given list. ![Isometric maze](maze.png "Spunky rendering engine not included.") Note that a "node" does not necessarily have to be a regular grid cell - it can be of any shape or size! ## install ```sh npm install maze ``` ## usage See [`test.js`](https://github.com/semibran/maze/blob/master/test.js) for an extensive example. You could also clone this repository and run the script locally if you'd like to run the maze generator on your machine. ### `maze = generate(nodes, adjacent, choose)` Maps each node in `nodes` to a list of connections and stores the resulting `Map` in `maze`. - `nodes`: A list of nodes to connect - `adjacent`: A function of the form `adjacent(a, b)` which determines if node `a` and node `b` can be connected - `choose`: A function of the form `choose(array)` which chooses a random item from `array` ## license [MIT](https://opensource.org/licenses/MIT) © [Brandon Semilla](https://git.io/semibran)