@quenty/pathfindingutils/README.md

Utilities involving pathfinding in Roblox

## PathfindingUtils
<div align="center">
  <a href="http://quenty.github.io/NevermoreEngine/">
    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
  </a>
  <a href="https://discord.gg/mhtGUS8">
    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
  </a>
  <a href="https://github.com/Quenty/NevermoreEngine/actions">
    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
  </a>
</div>

Utilities involving pathfinding in Roblox

<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/PathfindingUtils">View docs →</a></div>

## Installation
```
npm install @quenty/pathfindingutils --save
```

## Usage
Usage is designed to be simple.

### `PathfindingUtils.promiseComputeAsync(path, start, finish)`

### `PathfindingUtils.promiseCheckOcclusion(path, startIndex)`

### `PathfindingUtils.visualizePath(path)`