Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/barsonax/pathfindax
Pathfinding framework
https://github.com/barsonax/pathfindax
algorithm astar-algorithm c-sharp csharp dotnet duality flowfield graph pathfinding pathfinding-framework potential-fields
Last synced: 2 months ago
JSON representation
Pathfinding framework
- Host: GitHub
- URL: https://github.com/barsonax/pathfindax
- Owner: Barsonax
- License: agpl-3.0
- Created: 2017-01-26T15:01:23.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-02T07:50:45.000Z (about 5 years ago)
- Last Synced: 2024-05-29T08:10:44.352Z (7 months ago)
- Topics: algorithm, astar-algorithm, c-sharp, csharp, dotnet, duality, flowfield, graph, pathfinding, pathfinding-framework, potential-fields
- Language: C#
- Homepage:
- Size: 21.6 MB
- Stars: 25
- Watchers: 8
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Pathfindax
[](https://discord.gg/cKFnjjk) [](https://www.nuget.org/packages/Pathfindax/) [](https://dev.azure.com/Barsonax/Pathfindax/_build/latest?definitionId=10&branchName=master)  [](https://sonarcloud.io/dashboard?id=Barsonax_Pathfindax) [](https://sonarcloud.io/dashboard?id=Barsonax_Pathfindax) [](https://sonarcloud.io/dashboard?id=Barsonax_Pathfindax) 
## Features
Pathfindax is a pathfinding framework that can be used to get a path to a destination in a network of nodes. Currently A*, potential fields and flowfield are implemented. These implementations support the following features:
- Support for up to 32 collision layers
- Support for multiple agent sizes
- Support for movement costs
- Support for the duality game engine and the tilemap plugin through the `Duality.Plugins.Pathfindax.core` and `Duality.Plugins.Pathfindax.Tilemaps.core` nuget packages
Some examples of what pathfindax can do:
## Getting Started
### Installing
Pathfindax can be installed through the nuget packages which you can find at the bottom of this readme. When using duality there are also some extra packages you can install to make it easier to use pathfindax in duality. If you just want to use pathfindax you only have to install the `Pathfindax` nuget package.
For more info on how to install nuget packages see [this](https://docs.microsoft.com/en-us/nuget/consume-packages/ways-to-install-a-package).
For more info on how to install duality packages see [this](https://github.com/AdamsLair/duality/wiki/Package-Management).
### A Simple example
The following example will show you how to create a nodegrid and find a path through it:
```cs
//Setup the nodegrid and pathfinder.
var pathfindaxManager = new PathfindaxManager();
var factory = new DefinitionNodeGridFactory();
var nodeGrid = factory.GeneratePreFilledArray(GenerateNodeGridConnections.All, 3, 3);
var nodeNetwork = new DefinitionNodeGrid(nodeGrid, new Vector2(1, 1));
var pathfinder = pathfindaxManager.CreateAstarPathfinder(nodeNetwork, new ManhattanDistance());
//Request a path.
var pathRequest = pathfinder.RequestPath(nodeNetwork.NodeGrid.ToIndex(0, 0), nodeNetwork.NodeGrid.ToIndex(2, 0));
Console.WriteLine($"Solving path from {pathRequest.PathStart} to {pathRequest.PathEnd}...");
//Poll the status to check when the pathfinder is finished.
while (pathRequest.Status == PathRequestStatus.Solving) { }
switch (pathRequest.Status)
{
case PathRequestStatus.Solved:
Console.WriteLine($"Solved path! {pathRequest.CompletedPath}");
break;
case PathRequestStatus.NoPathFound:
Console.WriteLine("Could not find a path");
break;
}
Console.ReadKey();
```
More examples can be found [here](https://github.com/Barsonax/Pathfindax/blob/master/Source/Code/Pathfindax.Example/Program.cs).
### Pathfindax inside duality
The duality packages make it easier to use pathfindax by abstracting most of the boilerplate code you see in the example above. A tutorial covering how to use pathfindax in duality can be found [here](https://github.com/Barsonax/Pathfindax/wiki/Using-pathfindax-with-duality-tilemaps).
Additionally some example components can be found [here](https://github.com/Barsonax/Pathfindax/tree/master/Source/Code/Duality.Plugins.Pathfindax.Examples/Components).
## Other
### Nuget
| Library | Version |
|-------------|--------|
| Pathfindax | [](https://www.nuget.org/packages/Pathfindax/) |
| Duality.Plugins.Pathfindax.core | [](https://www.nuget.org/packages/Duality.Plugins.Pathfindax.core/)|
| Duality.Plugins.Pathfindax.Tilemaps.core | [](https://www.nuget.org/packages/Duality.Plugins.Pathfindax.Tilemaps.core/)|
### Donations
Donations can be done through my Patreon page: https://www.patreon.com/rickthephotogrammer
### Licensing
Licensed under AGPL however this might not be fit for all commercial works as it requires you to open source your work if you modify Pathfindax. If you require a different license please contact me.