UNPKG

nylira-maze

Version:

A library for generating mazes.

github.com/nylira/nylira-maze

103 lines (80 loc) • 6.89 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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# nylira-maze A JavaScript library for generating maze data. _________________________________________________________________________________ |█|█|█|█|█|█|█|█|█|█|__ | |█|█|█|█|█|█|█|█| | __ | |█|█|█| ______ |█|█|█| |█|█|█|█|█|█|█|█| __ |___|________ |█|█|█|█| |___|█| | |_________|█|█|█| |█|█|█| |█|█|█|█|█|█|█|█|___|______ |█|█|█|____ |█|█| |█|█|█|___|█|█|█| __ |█|█| |█| | |█|█|█|█|█|█|█|█|█|█|█|█| _| ____ | _|█|█| |█|█|█| | _____| _| ___| _| | | |█|█|█|█|█|█|█|█|█|█|_____|█| |__ |█|█| |█|█|█| |___|█| ___|█|____ | | _| | | |█|█|█|█|█|█|█|█|█|█|█|█|█|█| | |█|_______|█|█| _|█|█| _|█|█|█| | | | |█| | |______ | |█|█|█|█|█|█|█|█|█| |________ |█|█|█|______ |___________| |___| |█| | |█| |___| |█|█|█|█|█|█|█|█|█| |█|█|█|█| | ________ |__ |█|█|█|█|█|__ |█|__ | | |█| | |█|█|________________ |█| |█|█|█|█|___|█|█|█|█|_____|█|█|█|█|█|█| | | | |_____|______ |█|█|█|█| _____|█| |█|█|█|█|█|█|█| ________ |█|█|█|█|█|█| | | | | | __ |█|█|█| |█|█|█|█| | __ |█| |█|█|█|█|█|█|█|____ |█|█|______ |█|█|█|___| | | |__ | | _____|█|█| | | |█|_____| |█|█|█|█|█|█|█| |█|█| _____|█|█|█|█|█| | | | _|___| _________| |___|█| __ | |__________ | | |█|█| |█| |█|_________| | |______ | |█|█|█|█|█| | |█| | _| |█|█|█|█|█| | |___|█|█|_____| |█|█|█|█|█| _| | _____| |█|█|█|█|█| | | |█| |_____|█|█|█|█|█| | |█|█|█|█| _____|█|█|█|█|█|__ | | _______|█|█|█|█|█| | |__ |__ |█|█|█|█|█|█|█| | |█|█|█|█| |█|█|█|█|█|█|█|█|█| | |__ |█|█|█|█|█|█|█|█|___|█| |█|______ |█|█|█|█| | |█|█|█|█|__________ |█|█|█|█| | | _|█|█|█|█|█|█|█|█|█|█|█| |█|█| ___| |█|█|___|█| |█|█|█|█|█| ___|█|█| | | | | | ___|█|█|█|█|█|█|█| |█|█|____ | | |█|█|█| | |█|█|█|█|█|___________| | | |___|___|█|█|█|█|█|█|█|█|█|_____________|_________|___|█|█|█|█|█|█|█|█|█|█|█|___| ## Installation npm i nylira-maze --save ## Usage Basic usage: var maze = require('nylira-maze') // returns a 2d array of values for a 10x10 maze maze() // returns a 2d array of values for a 20x20 maze maze(20) // returns a 2d array of values for a 15x23 maze maze(15, 23) ## Parameters maze(31, 23, 'growing-tree:newest', 0.65, undefined, true) * **Parameter 1:** Width. * **Parameter 2:** Height. * **Parameter 3:** The maze generation algorithm. Options: * `"growing-tree"`: The Growing Tree algorithm. Defaults to `random`. * `"growing-tree:random"`: Lots of dead ends, similar to Prim's Algorithm * `"growing-tree:newest"`: Long windy passages, similar to `"backtracker"` * `"growing-tree:middle"`: Lots of long straight passages. * `"growing-tree:oldest"`: Only long straight passages. * `"backtracker"`: The Recursive Backtracker algorithm. Tends towards long and twisted passages. * **Parameter 4:** Sparseness. A sparse maze will have some of its nodes removed. If you type in a value less than 1, e.g. 0.25, the maze will be 25% sparse. If you enter an integer value more than 1, e.g. 5, the maze will remove 5 nodes from each of its dead ends. * **Parameter 5:** The integer seed for the maze. Putting a value here will guaranteee you can recreate the maze over and over again. * **Parameter 6:** You can preview the grid by passing in `true` as the fifth parameter. That function call above will generate the following: _______________________________________________________________ |█|█|█|____________________ |█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█| |█|█|█|█|█|█|█|█|█|█|█|█|█|__ | _|█|█|█|█|█| |█|█|█|█|█|█|█|█| |█|█|█|█|█|█|█|█|█|█|█|█|█|█|__ |█|█|█|█|█| _|█|█|█|█|█|█|█|█| |█|█|█|____ |█|█|█|█|█|█|█|█|█| |█|█|█|█| _|█|█|█|█| ___|█|█| |█|█|█|█|█|________ |█|█|__ |█| |█|█|█|█| |█|█|█|█| _|█|█|█|█| |█|█|█|█|█|█|█|█|█| |█|█|█|__ |____ | ________ ___|█|█|█|█|█| |█|█|█|█|█| |█|█| ______ | ______ _|█|█|█|█|_____|█|█|█|█|█| |█|█|█|█|█|__ | |█|█|█|___|█|█| ____ |█|█|█|█|█|█|█|█|█|█| |█|____ ____ _| |█|█|█|█|█| __ |█|█| |____ |█|█|█|█|█|█|█|█| |█|█| _|█|█| |█|_|█|█|█|█| _|█| |█| |█|█| _________|█|█|█| |█|___|█|█|█| |█|█|█| __ _|█|█| | |█|__ |█| |█|█|█|█|█|█|█|█| |█|█|█|█|█|█|_|█|█|█| |█|_|█|█| _| |█|█| |█|__ |█|█|█|█|█|█|█| |█|█|█|█|█|█|█|█|█| _|█|█|█|█| |█| |█|█|____ |__ __________ | |█|█|█|█|█|█|█|█|█| |█|█|█|█|█| |█| |█|█|█| _|█|__ |█|█| | |█|█|█|█|█|█| |█| _|█|█|█| ___|█| |█|█| |█|█|█| | |█|█| | | |█|█|█|__ ______ |█|█|█|█| |█|█|█| | |█|█| |█|█|█| | |█|█| | | |█|█|█|█| |█|█|█| |█|█|█|█| |█|█| _| |█|█| |█|█|█| | |█|█| |_| |█| _____|█|█|█| |█|█|_____|█| _|█| |█|█| |█|█| _| |█|█| |█| |█|_|█|█| __ | |█|█|█|█|█|█| |█|█|_____|____ | |█|_|█|█|_|█| |█|█|█|___|█|___|_|█|█|█|█|█| __ |█|█|█|█|█| |_|█|█|█|█|█|█| |█|█|█|█|█|█|█|█|█|█|█|█|█|█|_|_|█|_|█|█|█|█|█|_|█|█|█|█|█|█|█| |█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█| |█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█|█| The maze at the top of the README was generated with this function: maze(40, 20, 'growingtree:newest', 0.47, undefined, true) ## Test Check out a demo. npm test ## License MIT