MPath

A high-performance A* implementation for 2D grid navigation, designed primarily for game development (especially Unity) but fully compatible with any .NET project. MPath is optimized for speed and minimal memory allocations, making it ideal for real-time applications.

Features

• Fast A* pathfinding with near-zero garbage collection overhead
• Allocates memory only when necessary to maximize performance
• Designed for 2D grid-based navigation in games
• First-class support for Unity with dedicated integration components
• Fully usable in any standalone .NET application
• Extensively tested with comprehensive unit tests
• Includes performance benchmarks

⚠️ Note: MPath is not yet thread-safe and should not be used across multiple threads.

Benchmarks

For detailed information about MPath's performance benchmarks, including implementation comparisons and path smoothing options, see the benchmarks documentation.

Installation

https://github.com/migus88/MPath.git?path=/src/mpath-unity-project/Packages/MPath#1.0.0

Install-Package Migs.MPath

dotnet add package Migs.MPath

Quick Start

Here's a simple example of using MPath in a .NET project:

// Create matrix of Cells
var cells = new Cell[10, 10];

// Or do it with gameObjects that implements ICellHolder
[SerializeField] private FieldCell[] _cells;

// Create a simple agent
var agent = new SimpleAgent { Size = 1 };

// Or your own player controller that implements IAgent
[SerializeField] private PlayerController _player;

// Create a pathfinder
_pathfinder = new Pathfinder(cells);

// Optionally pass a configuration file (see docs)
_pathfinder = new Pathfinder(cells, config);

// You can also enable path caching
_pathfinder.EnablePathCaching();

// Find a path
var start = new Coordinate(1, 1);
var end = new Coordinate(8, 8);

using var result = pathfinder.GetPath(agent, start, end);

// Use the path
if (result.IsSuccess)
{
    Debug.Log($"Path found with {result.Length} steps!");
}

Documentation

MPath comes with comprehensive documentation:

• Getting Started Guide - Overview and basic usage
• API Reference - Detailed class and interface documentation
• Integration Guides - Specific guides for Unity and .NET projects

The API reference provides detailed information about all public classes, interfaces, and methods, with examples for each component.

Important Notes

• Always dispose PathResult objects after use (use using statements)
• Reuse the pathfinder instance for best performance

License

MPath is licensed under the MIT License. See LICENSE for details.