Giter Club home page Giter Club logo

astar-typescript's Introduction

AStar-Typescript

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.

astar-typescript's People

Contributors

dependabot[bot] avatar digitsensitive avatar krazyjakee avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

astar-typescript's Issues

suboptimal path with diagonal and manhattan

i changed example to allow diagonal movement and experimented a little with it. seems like manhattan fails to find shortest solution under certain conditions. e.g. it produces this
manhattan
instead of
good
(which is produced by other heuristics)

Are x and y swapped in the grid?

I'm getting TypeError: undefined is not an object (evaluating 'this.gridNodes[position.y][position.x].getIsWalkable') when I try to call aStarInstance.findPath(...). Looking at that error, it looks like the grid in configuration is reversed - shouldn't x be the first dimension of the array, and y the second dimension?

It's causing some weird behavior in my app and am wondering if this is intentional.

Review Lodash dependency

Hello, cool library!

Would it be possible to review the approach to importing lodash? I've seen the PR that recommended the es approach, and agree that was not the way to go.

I think there are two simple solutions:

Option 1. Import with a slash as recommended at the end of the official docs: https://lodash.com/per-method-packages
For example, in astar-finder.ts:

import { minBy, remove } from 'lodash';

Becomes

import minBy from 'lodash/minBy';
import remove from 'lodash/remove';

This should dramatically cut down the bundle size.

Option 2. Alternatively, perhaps set lodash as a peer dependency?
At the moment, if I too use lodash, I end up with a double sized bundle, which would be removed when set as a peer.
(but I still prefer option 2, or maybe even both)

Example of a project using lodash + astar-typescript using lodash 😱
image

Documentation Error: heuristic not heuristicFunction

A mistake in readme documentation

The documentation says that the heuristic function can be set with the heuristicFunction option in the constructor object, it is just heuristic

I thought of making a PR, but I feel dirty having a PR in a bigger project for just a "typo"

Edit: I have made a PR for a Cost feature for nodes, that also fixes this.

accepted tile

Hi!
How i set the accepted tile on the grid? By default, the astar accept the 0 and 1, but I would like to add the 2, 3, 4 ecc up to 9

It doesn't seems to work as expected

I'm having some issue experimenting with the library.
This is what I'm trying to do:

import { AStarFinder } from "astar-typescript"
let astar = new AStarFinder({
    grid: {
        width: 8,
        height: 8
    },
})
let startPos = {x: 0, y: 0}
let goalPos = {x: 3, y: 7}
let myPathway = astar.findPath(startPos, goalPos)
console.log(myPathway)

Thet output is:

Cannot read property '7' of undefined

It works if

goalPos = {x: 2, y:7}

I'm missing something?

Feature Request: "Get as close as possible" option when the path is blocked

Sample Code

let finder = new AStarFinder({
  grid: {
    matrix: [
      [0, 0, 0, 0],
      [0, 1, 1, 0],
      [0, 1, 0, 1],
      [0, 1, 1, 0]
    ]
  },
  heuristic: 'Manhatten',
  diagonalAllowed: false
});

console.log(finder.findPath({ x: 0, y: 0 }, { x: 3, y: 3 }));

Current Behaviour

Because the path is blocked to target there is no path is found.
output: []

Expected Behaviour

Having an option "getAsCloseAsPossible". Which will find to the path to x: 3, y: 1 position.
output: [[1, 0], [2, 0], [3, 0], [3, 1]]

Note:
It is, of course, possible to find an alternative target position manually. But the next available position to the target is the position x: 2, y: 2 which is also not reachable. The complexity of finding the closest available position is lower on finding it in the shortest path algorithm.

Unable to use library in typescript project complied with rollup

I'm importing the package into a typescript project that's compiled with rollup. Unfortunately, when I try to build with this referenced (import { AStarFinder } from "astar-typescript";) rollup fails with the error:

Error: 'AStarFinder' is not exported by node_modules\astar-typescript\dist\astar.js, imported by game.ts

I've fiddled around with various plugin changes and options for plugin-commonjs (stuff like adding it to the includes list to force it to be parsed as a CommonJS module but nothing seems to work. Can someone help me figure out the incantation to get this working with rollup?

This is more of a rollup question I suppose, but if you have any thoughts or ideas around ways to get it working that would be great!

Example not working

getting the following error when running yarn run-example

[webpack-cli] Error: Cannot find module 'Phaser'
Require stack:
...

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.