Code Monkey home page Code Monkey logo

astar's Introduction

NPM Discord GPL-3.0-only

Synchronous A* pathfinding for TypeScript

@evilkiwi/astar is an synchronous A* pathfinding implementation in TypeScript.

  • Supports diagonal or manhattan heuristics
  • Optionally supports 3-dimensional grids with elevation
  • Highly configurable (corner cutting, diagonal movement, etc.)
  • First-class TypeScript
  • Fully tested
  • It's not awfully performant, but it works!

Installation

This package is available via NPM:

yarn add @evilkiwi/astar

# or

npm install @evilkiwi/astar

Usage

import { search, type Grid } from '@evilkiwi/astar';

/**
 * The first step is to have a Grid.
 *
 * -1 = un-walkable, like a wall or water.
 *  0 = walkable, optionally any integer above 0 for elevation support
 */
const grid: Grid = [
  [ 0,  5, -1,  0,  0, -1,  0,  0],
  [ 0,  4, -1,  0,  0, -1,  0,  0],
  [ 0,  3, -1,  0,  0, -1,  0,  0],
  [ 0,  2, -1,  0,  0,  0,  0,  0],
  [ 0,  1, -1,  0,  0, -1,  0,  0],
  [ 0,  0, -1,  0,  0, -1,  0,  0],
  [ 0,  0,  0,  0,  0, -1,  0,  0],
  [ 0,  0, -1,  0,  0, -1,  0,  0],
];

/**
 * Once you have a Grid, you can find an efficient tile-based path
 * from one vector to another.
 */
const path = search({
  cutCorners: false,
  diagonal: true,
  from: [0, 0],
  to: [7, 6],
  grid,
});

// Path is either an array of vectors or null (could not find a path)
console.log(path);

The library is immutable/side-effect free, and the grid reference won't be changed when searched.

astar's People

Contributors

oyed avatar veradictus avatar

Stargazers

Pedro Giampietro avatar andmix avatar Lemuel DLS avatar

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.