Git Product home page Git Product logo

random-walk-map's Introduction

random-walk-map

Two-dimensional maps generator using random walk. For procedural generation using a seed, check out procedural-map.

Installation

Install via npm:

$ npm install --save random-walk-map

Usage

Call the function exposed by the package to generate a two-dimensional map with connected paths. It returns a matrix (an array of arrays), where each postion contains 0 (default) or 1 (a path).

  let generateMap = require('random-walk-map');

  //Generate a map with default config
  let map = generateMap();

  /* Example output:
  *   map =[[0, 0, 0, 0, 1],
  *         [0, 0, 0, 0, 1],
  *         [0, 1, 1, 0, 1],
  *         [0, 0, 1, 1, 1],
  *         [0, 0, 0, 0, 0]]
  */

Configuration

The generator can take a config object, with any of the following parameters:

  let map = generateMap({
      numberOfPaths: 10,           //Number of paths to draw
      minPathLength: 1,            //Minimal length of a path
      maxPathLength: 5,            //Maximal length of a path
      maxWidth: 24,                //Maximum width of the map - x index will go from 0 to 23
      maxHeight: 18,               //Maximum height of the map - y index will go from 0 to 17
      startPosition: {x: 0, y: 0}  //Position at which random walk is started
  });

random-walk-map's People

Contributors

alex-c avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

notmoo

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.