pathfinding - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #typescript #llm #deep-learning #macos #java #windows #awesome #cli #vue #pytorch #ios

pathfinding

(★ 103)

Java pathfinding framework.

File Explorer

Download Latest Version (.zip)

- .gitignore
- build.gradle
- README.md
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- build.gradle
.gitignore
.travis.yml
build.gradle
CHANGELOG.md
gradlew
gradlew.bat
LICENSE
README.md
settings.gradle

# Installation Guide

1. Get the code

git clone https://github.com/xaguzman/pathfinding

Downloads the entire project code from GitHub to your computer.

cd pathfinding

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

./gradlew build

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://travis-ci.org/xaguzman/pathfinding.svg?branch=master)](https://travis-ci.org/xaguzman/pathfinding)

pathfinding - APACHE LICENSE 2.0
==========

<p>
A java pathfinding library meant to be used for games.
It is generic enough to be used in different kind of graphs (though, right now it only has implementation for grid graphs).

It was heavily inspired by [this](https://github.com/qiao/PathFinding.js/ "Pathfinding.js") javascript library. Code initially was adapted, then
some modifications were made.

This library works with Libgdx's html5 backend, it was even used in my [#1GAM january entry](https://github.com/xaguzman/shiftingislands/ "Shifting Islands Source").

Current versions: 
* 0.2.6

__________

## Installing
The library has been uploaded to sonatype oss repository.
If you are using libgdx you can install it via graddle adding this dependency to your core project:

>	compile "com.github.xaguzman:pathfinding:0.2.6"

There's also the [gdx-bridge](https://github.com/xaguzman/pathfinding/tree/master/gdx-bridge) extension to easily get pathfinding features
in your game directly from your tmx maps.

## Intro
The library works on a bunch of interfaces:
* NavigationNode: this basically just represents a node of a graph. contains some getters and setters meant for navigation. Right now, only implementation is GridCell
* NavigationGrap: a group of navigation nodes. Right now, only implementation is NavigationGrid
* PathFinder: the implementation for the pathfinding algorithm, current options are:
	* AStarFinder
	* AStarGridFinder
	* JumpPointFinder
	* ThetaStarFinder
	* ThetaStarGridFinder

Finders are fed with so called PathFinderOptions, which determine how the pathfinding will work (allowing diagonal movement, for example).

## How to use
You need to create a graph.
Be aware the the NavigationGrid class, expects a bidimensional array of GridCell stored as [x][y]

```java	
//these should be stored as [x][y]
GridCell[][] cells = new GridCell[5][5];
	
//create your cells with whatever data you need
cells = createCells();
	
//create a navigation grid with the cells you just created
NavigationGrid<GridCell> navGrid = new NavigationGrid(cells);
```

Now, you need a finder which can work on your graph.

```java
//create a finder either using the default options
AStarGridFinder<GridCell> finder = new AStarGridFinder(GridCell.class);
	
//or create your own pathfinder options:
GridFinderOptions opt = new GridFinderOptions();
opt.allowDiagonal = false;
	
AStarGridFinder<GridCell> finder = new AStarGridFinder(GridCell.class, opt);
```
Once you have both, a graph and a finder, you can find paths within your graph at any time.

```java
List<GridCell> pathToEnd = finder.findPath(0, 0, 4, 3, navGrid);
```
	
That's pretty much all there is to using the library.