PathFinding.js

To manually compile the browser-ready files from the development source:

1. Download the source zip from GitHub and extract it.
2. Navigate to the extracted folder.
3. Install dependencies using npm install.
4. Compile the browser builds using gulp compile.

The resulting pathfinding-browser.js and pathfinding-browser.min.js files will be located in the lib folder.

You can initialize a PF.Grid with obstacles by passing a 2D array (matrix) to the constructor. In this matrix, 1 represents an obstacle (non-walkable) and 0 represents a walkable cell.

var walkabilityMatrix = [[0, 0, 0, 0, 0],
                         [1, 1, 1, 1, 0],
                         [0, 0, 0, 0, 0],
                         [0, 1, 1, 1, 1],
                         [0, 0, 0, 0, 0],
                         [1, 1, 1, 1, 0],
                         [0, 0, 0, 0, 0]];
var grid = new PF.Grid(walkabilityMatrix);

To manually install the latest development version for a server environment:

1. Download the source zip from GitHub.
2. Extract the contents into your node_modules folder.
3. Rename the extracted folder from PathFinding.js-master to pathfinding.

Node.js

Install via npm:

npm install pathfinding

Then require it in your program:

var PF = require('pathfinding');

Browser

Install via bower:

bower install pathfinding

Include the minified browser file in your HTML:

<script type="text/javascript" src="path/to/bower_components/pathfinding/pathfinding-browser.min.js"></script>

Alternatively, you can download a release from the GitHub Releases page.

To use PathFinding.js in a web browser, include the minified browser script via a <script> tag in your HTML file.

<script type="text/javascript" src="path/to/pathfinding-browser.min.js"></script>

You can control whether the pathfinder allows diagonal movement by passing a diagonalMovement option to the finder's configuration object. This option is set using the PF.DiagonalMovement enumeration.

var finder = new PF.AStarFinder({
    diagonalMovement: PF.DiagonalMovement.Never
});

PathFinding.js is a JavaScript library designed to find paths on a 2D square grid. It is compatible with both Node.js and browser environments. To find a path, you must define a walkability matrix where 0 represents a walkable cell and 1 represents a non-walkable cell. You then initialize a PF.Grid with this matrix and use a finder (such as PF.AStarFinder) to calculate the path between two coordinates.

//Walkability matrix. Zero is walkable, One is not
var matrix = [
    [0, 0, 0, 1, 0],
    [1, 0, 0, 0, 1],
    [0, 0, 1, 0, 0],
];
var grid = new PF.Grid(matrix);
var finder = new PF.AStarFinder();
//Find path from (1, 2) to (4, 2)
var path = finder.findPath(1, 2, 4, 2, grid);

To use PathFinding.js in a Node.js environment, import the package using require.

var PF = require('pathfinding');

When instantiating a finder, you can pass an options object to customize behavior.

Movement Options

• allowDiagonal: (boolean) Set to true to allow diagonal movement. Default is false.
• dontCrossCorners: (boolean) When allowDiagonal is true, this prevents the path from touching the corners of occupied grid blocks. Supported by all algorithms except JumpPointFinder.

Heuristic Options

For AStarFinder, BestFirstFinder, and their bi-directional variants, you can specify a heuristic function or use predefined constants:

• PF.Heuristic.manhattan (default)
• PF.Heuristic.chebyshev
• PF.Heuristic.euclidean
• PF.Heuristic.octile

You can also provide a custom function: function(dx, dy) { ... }.

var finder = new PF.AStarFinder({
    allowDiagonal: true,
    dontCrossCorners: true,
    heuristic: PF.Heuristic.chebyshev
});