ihorbeliasnyk / ellerjs

A JavaScript implementation of Eller's maze generation algoritm.

ellerjs

A JavaScript implementation of Eller's maze generation algoritm. this algorithm creates mazes that have a path between any two cells.

Rendered example

Installation

npm i ellerjs

Usage

const eller = require('ellerjs');
const maze = eller(15, 15);

Maze is two-dimensional array representing rows and cells. Cell structure:

interface Cell {
  top: boolean; // true if cell has a wall in this direction, false if not
  bottom: boolean;
  left: boolean;
  right: boolean;
}

ellerjs's Issues

The lines below the first do not have a top property

I found a probable undesired behavior while running the package:

Steps to reproduce:

Run the following JavaScript code with the package installed:

const eller = require('ellerjs');

const maze = eller(2, 2);

console.log(JSON.stringify(maze, null, 2));

Current result:

[
  [
    {
      "top": true,
      "bottom": false,
      "left": true,
      "right": true,
      "_set": 1
    },
    {
      "top": true,
      "bottom": false,
      "left": true,
      "right": true,
      "_set": 2
    }
  ],
  [
    {
      "_set": 1,
      "right": false,
      "left": true,
      "bottom": true
    },
    {
      "_set": 1,
      "right": true,
      "left": false,
      "bottom": true
    }
  ]
]

Expected result:

[
  [
    {
      "top": "true|false",
      "bottom": false,
      "left": true,
      "right": true
    },
    {
      "top": "true|false",
      "bottom": false,
      "left": true,
      "right": true
    }
  ],
  [
    {
      "top": "true|false",
      "right": false,
      "left": true,
      "bottom": true
    },
    {
      "top": "true|false",
      "right": true,
      "left": false,
      "bottom": true
    }
  ]
]

As mentioned in the title, the top property of the cells is not present in the second line, and this is concisely the case for larger mazes. And the internal _set property can be found in the output generated, being shadowed by the type defined in index.d.ts.

Thank you in advance!