You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ import {Maze} from "@thewizardbear/maze_generator";
57
57
Alternately, you can you `require`:
58
58
59
59
```javascript
60
-
let {Maze} =require("@thewizardbear/maze_generator")`
60
+
let {Maze} =require("@thewizardbear/maze_generator")
61
61
```
62
62
63
63
Please note that Node version 14+ is required as `maze_generator` makes use of some ES2020 features such as the nullish coalescing operator (`??`).
@@ -101,7 +101,7 @@ These are all the properties of the object you can pass in when you write `Maze.
101
101
|-|-|-|-|
102
102
| width (or xSize) | The width of the maze. (How many columns there should be.) | A positive integer. | height or `30`|
103
103
| height (or ySize) | The height of the maze. (How many rows there should be.) | A positive integer. | width or `30`|
104
-
| algorithm | The algorithm to use. | Any one of the following:`"recursive backtracker"`, `"eller's"`, `"sidewinder"`, `"kruskal's"`, `"simplified prim's"`, `"modified prim's"`, `"true prim's"`, `"hunt and kill"`, `"binary tree"`, `"aldous broder"`, `"recursive division"`, `"wilson's"`, `"10 print"`, `"random"` (random algorithm). This isn't case sensitive. Characters other than the letters a-z and digits 0-9 are ignored. | `"recursive backtracker"` (`"prims"` defaults to `"true prims"`) |
104
+
| algorithm | The algorithm to use. | Any one of the following: `"recursive backtracker"`, `"eller's"`, `"sidewinder"`, `"kruskal's"`, `"simplified prim's"`, `"modified prim's"`, `"true prim's"`, `"hunt and kill"`, `"binary tree"`, `"aldous broder"`, `"recursive division"`, `"wilson's"`, `"10 print"`, `"random"` (random algorithm). This isn't case sensitive. Characters other than the letters a-z and digits 0-9 are ignored. |`"recursive backtracker"` (`"prim's"` defaults to `"true prim's"`) |
105
105
| start | Where to start the maze generation from (if there is an option). | An object with both an `x` and `y` property (both integers) or a string referencing a certain point (`"random"` or a certain side or corner such as `"north east"`) |`"random"` for all algorithms except Eller's, binary tree and sidewinder, which are all `{x: 0, y: 0}`. |
106
106
| entrance | Where the solution should start from. | An object with both an `x` and `y` property (and an optional `direction` property: `"N"`, `"S"`, `"E"`, or `"W"`) or a string referencing a certain point (`"random"` or a certain side or corner such as `"north east"`) |`"top left"`|
107
107
| exit | Where the solution should end. | An object with both an `x` and `y` property (and an optional `direction` property: `"N"`, `"S"`, `"E"`, or `"W"`) or a string referencing a certain point (`"random"` or a certain side or corner such as `"north east"`) |`"bottom right"`|
0 commit comments