Node Maze Generator

Generate perfect mazes with Node using a growing tree algorithm.

█████████████████████
█░░░░░░░░░█░░░░░░░░██
██░░░░░░░░█░█████░███
█░░░░░░░░░░░█░░██░░░█
█░░░░░░░░░█░█░█████░█
█░░░░░░░░░█░░░█░░░█░█
█░░░░░░░░░█████░█░█░█
███░░░░██░░░░░░░█░░░█
███░███████████████░█
█░░░█░░░░░█░░░░░░░░░█
█░███░███░█░█████████
█░█░░░███░█░█░░░░░░░█
█░█░███░█░█░█░█████░█
█░█░██░░█░█░░░█░░██░█
█░█░██░░█░█████░███░█
█░░░█░░░░░░░█░░░░░█░█
█░███░░░░░░░█░███░█░█
█░██░░█░░░░░█░█░░░█░█
█░███░█░█████░█░███░█
█░░░░░█░░░░░░░█░░░░░█
█████████████████████
    

Generated data structure

    {
        grid: [
          [
            Cell {
              x: 0,
              y: 0,
              exits: [],
              blocked: true,
              displayed: false,
              visited: false
            },
            ...
          ]
        ]
        rooms: [
            Room {
                x: 0,
                y: 0,
                width: 0,
                height: 0
            }
        ]
    }

Installation

npm install node-maze-generator

Quick use

const nmg = require('node-maze-generator');
const generator = new nmg.generators.maze({}, {width: 10, height: 10});
const renderer = new nmg.renderer(generator);

Random

utils.js contains a custom pseudo-random seed generator static class called Random. Seeed the Random class with an integer before generating the maze in order to generate consistent data.

const nmg = require('node-maze-generator');
const Random = nmg.utils.Random;

const SEED = 42;
Random.seed(SEED);    // Initialize random
Random.range(0, 10);  // Get a number within range
Random.next();        // Get random integer

Generator classes

Generator classes can be passed as an optional array of objects to the maze generator.

The shape of this data structure is as follows:

    [
        {
            generator: <generator class>,
            options: <options object>
        },
        ...
    ]

Generator (src/generator.js) will iterate over each generator class and instantiate it.

Example

The following example shows how to generate a maze with rooms using the provided room generator.

(also see src/main.js)

const nmg = require('node-maze-generator');
const generator = new nmg.generators.generator([
    {
        generator: nmg.generators.maze,
        options: {
            ...
        },
        generator: nmg.generators.room,
        options: {
        ...
        }
    }
]});
new nmg.renderer(generator);

Multi-floor maze

Use the floors option to generate a multi-floor maze.

Use the src.generators.stairs generator to connect the floors with stairs.

Floor 0
█████████████████████
█░██░░░░░██░░░░░░░░░█
█░███░█░███░░░░░█░█░█
█░░░█░█░░░░░█░░░█░█░█
███▼█░█░█████████░█░█
█░░░█░█░░░█░░░░░█░███
█░███░███░█░███░█░███
█░█░░░░██░█░█░░░█░░░█
█░█░█████░█░█░█░█░░░█
█░█░░░░░█░███░█░█░░░█
█░█░░██░█░███░█░█░░░█
█░█░░░█░█░░░░░█░░░█░█
█░███░█░███░░░░░█░█░█
█░██░░█░░░░░░░█░░░█░█
█░███████████░█░███░█
█░░░█░░░█░░░█░░░█░░░█
███░█░█░█░█░█████░█░█
███░░░█░█░█░░░░░░░█░█
█░█████░█░███░░░░░█░█
█░░░░░░░░░██░░░░░░░░█
█████████████████████
Floor 1
█████████████████████
█░░░░░░░░░█░░░░░░░░██
██░░░░░░░░█░█████░███
█░░░░░░░░░░░█░░██░░░█
█░░▲░░░░░░█░█░█████░█
█░░░░░░░░░█░░░█░░░█░█
█░░░░░░░░░█████░█░█░█
███░░░░██░░░░░░░█░░░█
███░███████████████░█
█░░░█░░░░░█░░░░░░░░░█
█░███░███░█░█████████
█░█░░░███░█░█░░░░░░░█
█░█░███░█░█░█░█████░█
█░█░██░░█░█░░░█░░██░█
█░█░██░░█░█████░███░█
█░░░█░░░░░░░█░░░░░█░█
█░███░░░░░░░█░███░█░█
█░██░░█░░░░░█░█░░░█░█
█░███░█░█████░█░███░█
█░░░░░█░░░░░░░█░░░░░█
█████████████████████

⚙ = stairs
█ = wall
░ = floor

Custom generator classes

Custom generators should match the following pattern.

class SomeGenerator {
    constructor (data: {}, options: {}) {
        // do something with the data object
        this.data.someProperty = 'someValue';
    }
}

See src/room.js and src/maze.js for complete examples along with a list of optional arguments that each class takes.

Development

See CONTRIBUTING.md

License

MIT

Tests

Run unit tests

npm run test

Command line maze generation and rendering

npm run start

Contributors

• @w4ffl35