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

astar-typescript

v1.2.7

Published

A*(a-star) pathfinding in TypeScript

Downloads

1,278

Readme

AStar-Typescript

GitHub Stars GitHub Stars GitHub Forks GitHub Issues Current Version

The A-star search algorithm library in TypeScript

AStar-TypeScript is an A-star pathfinding API written in TypeScript to use for your HTML5 games or other browser-based projects.

This library was influenced and inspired by @qioa - PathFinding.js, @bgrins - javascript-astar, @prettymuchbryce - easystarjs and @redblobgames.

Buy me a coffee

Whether you use this project, have learned something from it, or just like it, please consider supporting it by buying me a coffee.

Live example

Select a folder, navigate to it, and clone this repository with this command-line:

git clone https://github.com/digitsensitive/astar-typescript.git

Install the dependencies:

yarn install

Run the live example:

yarn run-example

Installation

yarn add astar-typescript
npm install astar-typescript --save
bower install astar-typescript --save

Import

TypeScript

import { AStarFinder } from 'astar-typescript';

Javascript

let AStarFinder = require('astar-typescript');

AMD

define(function (require, exports, module) {
  let AStarFinder = require('astar-typescript');
});

Basic Usage

Create an astar instance:

private aStarInstance: AStarFinder;

Load grid data:

Using an array (hardcoded or from a Tilemap-Editor)

0 = walkable 1 = not walkable

let myMatrix = [
  [0, 0, 0, 0, 0, 0, 0, 0],
  [0, 0, 0, 0, 0, 0, 0, 1],
  [0, 0, 1, 1, 0, 1, 1, 0],
  [0, 0, 1, 0, 0, 0, 1, 0],
  [0, 0, 0, 0, 0, 0, 1, 0],
  [1, 1, 1, 0, 1, 0, 1, 0],
  [0, 0, 0, 0, 1, 0, 1, 0],
  [0, 0, 1, 0, 0, 0, 0, 0]
];

this.aStarInstance = new AStarFinder({
  grid: {
    matrix: myMatrix
  }
});

or randomly generated array from width and height

this.aStarInstance = new AStarFinder({
  grid: {
    width: 8,
    height: 8
  }
});

Get the path:

let startPos = { x: 0, y: 0 };
let goalPos = { x: 4, y: 5 };

let myPathway = this.aStarInstance.findPath(startPos, goalPos);

Advanced Usage

Additional parameters may be passed to adapt your finder.

Diagonal movements

If you want to disable diagonal movements:

this.aStarInstance = new AStarFinder({
  grid: {
    width: 8,
    height: 8
  },
  diagonalAllowed: false
});

Heuristic function

Set the heuristic function (Manhattan, Euclidean, Chebyshev or Octile):

this.aStarInstance = new AStarFinder({
  grid: {
    width: 8,
    height: 8
  },
  heuristic: 'Manhattan'
});

It is possible to adjust the weight of the heuristic function. For example if you use 0, every heuristic function will return zero. That is how you can turn A* into Dijkstra’s Algorithm. Depending on the weight value you can decide if you prefer speed or accuracy. The lower the weight is, the lower will the heuristic function get, which will make the A* slower.

this.aStarInstance = new AStarFinder({
  grid: {
    width: 8,
    height: 8
  },
  weight: 0.7
});

Start and End Node

Include or Exclude the start and end node:

this.aStarInstance = new AStarFinder({
  grid: {
    width: 8,
    height: 8
  },
  includeStartNode: true,
  includeEndNode: true
});

Allow path as close as possible

this.aStarInstance = new AStarFinder({
  grid: {
    width: 8,
    height: 8
  },
  allowPathAsCloseAsPossible: true
});

Prettier

This library uses Prettier. The configuration used can be seen in the .prettierrc file. More informations about the format options can be found here.

License

MIT License

Copyright (c) 2017 - 2023 digitsensitive [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.