Meikyuu documentation
Meikyuu 迷宮 — Maze generator and maze game
Generate seeded mazes and arrow puzzles, follow numbered levels, and play on flat grids or three-dimensional surfaces.
Install
npm install @johnmorrisdotca/meikyuu
Start here
Entry points
| Import it | What it is | Size |
|---|---|---|
@johnmorrisdotca/SVG grids · 31 exports | Meikyuu's drawing: a maze or an arrow board as SVG text, with its boards, its line colours, the style that gives the drawing its look, and the words it says in English and Japanese. | 8.7 kB |
@johnmorrisdotca/Playable boards · 34 exports | Meikyuu, played in a page: mountMeikyuu draws a maze, an arrow puzzle or a mixed one into any element and plays it by touch and mouse, with zoom and pan for big mazes, page left beside the board to scroll by, a tall maze that lies down on a wide screen, Undo, Restart, Hint, a celebration that respects prefers-reduced-motion, optional sounds, and the words in English and Japanese. | 50.2 kB |
@johnmorrisdotca/Puzzle elements · 4 exports | 52.8 kB | |
@johnmorrisdotca/Register puzzles · 4 exports | Defines the <meikyuu-board> element on the page. | 52.8 kB |
@johnmorrisdotca/Numbered puzzle levels · 21 exports | 20.6 kB | |
@johnmorrisdotca/Tall maze levels · 12 exports | 21.8 kB | |
@johnmorrisdotca/Colossal maze levels · 10 exports | 5.6 kB | |
@johnmorrisdotca/Original numbered levels · 4 exports | 34.4 kB | |
@johnmorrisdotca/Surface maze rules and geometry · 65 exports | Meikyuu over the surface of a solid: a perfect maze on a cube, a globe, the other dice (a tetrahedron, an octahedron, an icosahedron, a ten-sided, a twelve-sided and more) or a shape (a box, a cross of cubes, a ring, a torus, a star, a heart), with the line drawn from one face to the next across the edges. | 20.3 kB |
@johnmorrisdotca/Playable surface mazes · 7 exports | A maze over a solid, played in a page: mountSolid draws a cube, a globe or a solid of triangles with a maze over its surface into any element and plays it by touch and mouse. | 30.2 kB |
@johnmorrisdotca/Numbered surface levels · 14 exports | 20.7 kB | |
@johnmorrisdotca/Dice surface levels · 14 exports | 28.6 kB | |
@johnmorrisdotca/Solid shape levels · 14 exports | 23.8 kB | |
@johnmorrisdotca/Surface recipe readers · 2 exports | 31.5 kB | |
@johnmorrisdotca/All surface collections · 20 exports | 70.3 kB | |
@johnmorrisdotca/Mazes, arrows and mixed boards · 155 exports | Meikyuu 迷宮, a maze game: the rules and the making, with no page needed. | 12.7 kB |
Guides
How-to
- Choose geometry, algorithms and modesKeep the full recipe when sharing a reproducible puzzle.
- Read flat, tall and surface levelsUse one-based numbers inside the right collection and pin versions.
- Play arrows and mixed boardsRespect blockers, locks and the result of each attempted removal.
- Keep a native maze runStore the exact recipe alongside native path and stone state.
- Draw and embed a native boardUse SVG for an image or a native mount for controls and cleanup.
Explanation
- Cell graphs, views and surface mazesKeep graph identity separate from projection and pointer geometry.
- Architecture and difficultyUnderstand the graph, game, view and measured score layers.