# js-pathfind

> Javascript A* implementation

Latest version **0.1.1** (published 2015-03-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install js-pathfind
pnpm add js-pathfind
yarn add js-pathfind
bun add js-pathfind
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2015-03-15 |
| First published | 2015-03-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Edward Smyth |
| Maintainers | zoby |

## Links

- npm: https://www.npmjs.com/package/js-pathfind
- Repository: https://github.com/zoby/pathfind
- Issues: https://github.com/zoby/pathfind/issues
- npm.io page: https://npm.io/package/js-pathfind

## Recent versions

- 0.1.1 (latest) — 2015-03-15
- 0.1.0 — 2015-03-15

## README

# Javascript A* Pathfind
> Javascript implementation of A* Pathfinding, developed for use with [http://jsiso.com](http://jsiso.com)

## Getting Started
This script is developed to work with Node.js and in the Browser.

### Node
```shell
npm install js-pathfind
```

```js
var Pathfind = require('js-pathfind');
```

### Browser
```html
<script type="text/javascript" src="build/pathfind.min.js"></script>
```

```js
var Pathfind = window.Pathfind;
```


## Pathfind

### Pathfind(start, end, map);
#### start
Type: `array`
Starting location x and y co-ordinate: [x, y]

#### end
Type: `array`
Ending location x and y co-ordinate: [x, y]

#### Map
Type: `array`
2d array of any size which holds all the co-ordinates on the map. 0 = open square, 1 or above = blocked square
x values  = columns
y values = rows (first row = 0)


### Return
Type: `array` or `boolean`
The returned value will be an array of co-ordinates showing the route through the map or false if not route is possible.


## Example
```js
var start = [0,0];
var end = [4,4];
var map = [
    [0, 0, 0, 1, 0],
    [1, 0, 0, 0, 1],
    [0, 0, 1, 0, 0],
    [0, 0, 1, 1, 0],
    [0, 0, 1, 1, 0]
];
var path = Pathfind(start, end, map);
console.log(path); // Output = [ [ 0, 0 ], [ 1, 1 ], [ 1, 2 ], [ 2, 3 ], [ 3, 4 ], [ 4, 4 ] ]

start = [0, 4]; // Start Bottom left
path = Pathfind(start, end, map);
console.log(path); // Output = false
```


## License
MIT License 2013-2015 Edward Smyth

---
_Source: https://npm.io/package/js-pathfind · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._