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 🙏

© 2024 – Pkg Stats / Ryan Hefner

sokoban-generator

v1.1.5

Published

A generator for Sokoban levels

Downloads

18

Readme

Sokoban Level Generator (JavaScript)

npm

A procedural level generator for Sokoban, written in JavaScript.

Install

npm i sokoban-generator

Demo

Play Sokoban created by this generator in action!

The website above uses the default options for the generator, except that it specifies the initial position of the player.

Usage

// es6
import {generateSokobanLevel} from sokoban-generator;
generateSokobanLevel();

// es5 or older
var sokobanGenerator = require("sokoban-generator");
sokobanGenerator.generateSokobanLevel();

The generator accepts an optional options, and can return either a string representation of the level, or a grid class.

If will return null if no solution is found. Increasing attempts might help.

const options = {
  width: 9, // the width of the sokoban grid 
  height: 9, // the height of the sokoban grid
  boxes: 3, // the boxes on the grid
  minWalls: 13, // the minimum number of walls on the grid
  attempts: 5000, // when generating the map, the maximum attempts
  seed: Date.now(), // map seed. See note below
  initialPosition: { // The initial position of player
    x: 0,
    y: 0
  },
  type: "string", // the return type, either "string" or "class" 
};

let level = generateSokobanLevel(options);

Note

  • Seed is only expected to generate the same map under the same options. This means, for example,
    generateSokobanLevel({seed: 1, boxes: 2}) and generateSokobanLevel({seed: 1, boxes: 3}) will probably generate different levels.

Performance

The time it takes to generate a level is greatly increased when the number of size and walls are increased.

It took ~1 seconds to generate a result on default settings on a 2015 Ultrabook Laptop on Node, but it took only less than a second on runkit.

License

GNU GPLv3

Reference

The whole algorithm is partially based on this paper