npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@alekstar79/maze-generator

v1.0.1

Published

High-performance TypeScript library for generating perfect mazes using Eller's algorithm and organic caves using cellular automata.

Readme

Maze Generator

npm version npm bundle size License: MIT TypeScript Coverage

A modern, zero-dependency TypeScript library for generating perfect mazes using Eller's Algorithm and organic caves using Cellular Automata. Designed for seamless integration with Canvas, Vue, React, or any other UI framework.

maze

🚀 Key Features

  • Eller's Algorithm – Guarantees the generation of perfect mazes (no loops, no isolated regions) with a time complexity of O(N).
  • Animated Generation Support – Built-in generator (yield) that yields control after processing each row, enabling smooth step-by-step rendering.
  • Cellular Automaton Cave Generation – Simulates organic cave structures using configurable birthLimit and deathLimit rules.
  • Pathfinding – Integrated Wave Algorithm (BFS) to find the shortest path between any two points.
  • Serialization – Full support for saving and loading mazes/caves in both human-readable .txt and .json formats.
  • Strict TypeScript – Fully typed, offering excellent IDE autocompletion and type safety.
  • 100% Test Coverage – Comprehensive unit tests covering all core functionality (lines, functions, and branches).

📦 Installation

npm install @alekstar79/maze-generator

🧩 Basic Usage (Instant Generation)

import { MazeFacade } from '@alekstar79/maze-generator';

// Create the facade instance
const facade = new MazeFacade();

// Generate a 10x10 maze instantly
facade.generateMaze(10, 10);

// Export the maze in plain text (compatible with original C++ format)
const text = facade.maze.toTXT();
console.log(text);

// Export the maze as JSON
const json = facade.maze.toJSON();
console.log(json);

🎥 Animated Generation (Step-by-Step)

The library provides a built-in generator that yields after each row is processed, making it perfect for live animation (Canvas, HTML, Vue, etc.):

import { MazeFacade } from '@alekstar79/maze-generator';

const facade = new MazeFacade();

// Get the generator
const generator = facade.generateMazeStepByStep(10, 10);

// Iterate with a delay (e.g., 100ms per step)
for await (const processedRow of generator) {
  // processRow is the index of the row just completed.
  // Here you would call your draw/update method.
  await new Promise(resolve => setTimeout(resolve, 100));
  // canvas.drawMaze();
}

🌍 Cave Generation (Cellular Automaton)

facade.generateCave({
  rows: 10,
  cols: 10,
  birthLimit: 4,
  deathLimit: 3,
  chance: 50 // initial alive probability (%)
});

// Step the simulation manually
facade.stepCave();

// Export the cave
console.log(facade.cave.toTXT());

🧠 Pathfinding (Wave Algorithm)

Once a maze is generated, find the shortest path between two points:

const start = { x: 0, y: 0 };
const end = { x: 5, y: 5 };

const path = facade.findPath(start, end);
// path returns an array of { x, y } coordinates

📚 API Reference

  • MazeFacade – Main entry point.
  • Maze – Core maze model with generateMaze, toTXT, toJSON.
  • Cave – Core cave model with generateMap, updateMap, toTXT.
  • Pacman – Pathfinding logic.
  • Matrix – Lightweight 2D boolean matrix for wall representation.

🛠️ Development & Demo

This repository includes a demo/ folder with a complete Vue 3 + Vite application showcasing the library. To run the demo locally:

cd demo
npm install
npm run dev

📝 License

MIT License. See LICENSE for more information.

🤝 Contributing

Issues and pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.