NavPath2D is a GUI-based tool designed to simplify the creation and management of navigation paths for 2D entities in Unity. It allows you to draw paths (that entities such as your AI should follow) directly in your Unity Editor scene.
These paths can then be saved as prefabs and assigned to entities. These entities will then randomly select a path to move on, eliminating the need for complex A* pathfinding algorithms.
This package is particularly suitable for simpler cases where detailed pathfinding is not required, offering a straightforward alternative to more complex solutions. You also have the flexibility to expand upon the basic functionality, making it adaptable to various genres and project requirements.
Join my Discord if you want to give feedback on this plugin or to help me update it: https://discord.gg/FnD8355w
Please note that this tool is meant for simple navigation, and it will not give you the uniqueness that you can achieve through the use of A Pathfinding algorithms. There are plenty of tools out there, many paid and expensive, so this tool was made to be an easy and affordable solution to 2D navigation issues.
- GUI-based Path Creation: Users can draw paths directly in the Unity Editor scene, providing a visual and intuitive way to define movement paths for 2D entities. This feature allows for the creation of paths that can navigate around obstacles, follow specific routes, and more, offering flexibility in how paths are formed.
- Multiple Path Selection: Once paths are created, they can be saved as prefabs. This functionality facilitates easy reuse and assignment to different entities within the project. Additionally, entities can be assigned multiple paths, enabling them to randomly decide which path to follow, adding an element of unpredictability to their movement.
- Entity Movement Along Paths: Entities can be assigned paths, enabling them to move along the defined waypoints. This feature eliminates the need for complex A* pathfinding algorithms, simplifying path management for 2D games and making it easier to implement straightforward movement patterns.
- Simplified Pathfinding for 2D: This package addresses the lack of a built-in NavMesh feature for 2D in Unity by offering a straightforward solution for pathfinding. It provides a simple yet effective way to manage entity movement in 2D environments.
- Customizable and Expandable: The package is designed to be a simple solution for basic pathfinding needs but also allows for expansion and customization to fit more complex scenarios. Users can add their movement customizability by defining more randomization in movement, animations, and more, making the package adaptable to a wide range of gameplay requirements.
Download the NavPath2D package and import it into your Unity project.
Ensure you have an AI entity set up in your Unity project.
In your game scene, add a new empty GameObject and rename it to something like "Path_01".
Attach the Path.cs script to this GameObject. This script (which can be found in the Scripts/NavPath2D folder) allows you to draw paths onto your scene via the PathEditor.cs (found in ssets/Editor/NavPath2D/) Editor script as it holds the Waypoints that we add.
With the GameObject selected, you can start adding, removing, and moving waypoints.
- To add a waypoint, SHIFT-click in the scene window.
- To move a waypoint, click on the waypoint gizmo in the scene window.
- To remove a waypoint, CTRL-click on the waypoint gizmo in the scene window.
- To add a waypoint to an existing waypoint, select it and SHIFT-click a new waypoint.
You can add multiple GameObjects with the Path.cs script added to it to create multiple paths.
Once you're done creating paths, drag the GameObject into your directory to turn it into a Prefab. This allows you to assign it to your entity. You can remove this prefab from the scene hierarchy.
Select your entity and attach the Walker.cs (which can be found in the Scripts/NavPath2D folder) script to it. This is a demo script which allows you to assign the path prefabs to your entity, enabling it to randomly move along the paths. You can expand this script to include logic for breaks within movement, animations, etc., or combine it with your existing scripts.
In the script:
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
public class RandomWalker : MonoBehaviour
{
private Path currentPath; // path it chooses to walk on
private int currentWaypointIndex = -1; // waypoint index
public float speed = 2f; //entity speed - how fast it will move
public float waypointTolerance = 1f; //how close it stays to path - the lower this value, the more accurate it is (do not set to 0).
public List<GameObject> pathPrefabs; //path options entity can select from
void Start()
{
// Randomly choose and instantiate a path from the path prefabs addded
GameObject pathGO = Instantiate(pathPrefabs[Random.Range(0, pathPrefabs.Count)]);
currentPath = pathGO.GetComponent<Path>();
}
void Update()
{
// Move entity randomly on the waypoints of chosen path
if (currentPath.waypoints.Count == 0) return;
if (currentWaypointIndex == -1 || Vector3.Distance(transform.position, currentPath.waypoints[currentWaypointIndex].position) < waypointTolerance)
{
if (currentWaypointIndex == -1)
{
currentWaypointIndex = Random.Range(0, currentPath.waypoints.Count);
}
else
{
int nextWaypointIndex = currentPath.waypoints[currentWaypointIndex].GetRandomConnectedWaypointIndex(); // found in Waypoint.cs
if (nextWaypointIndex != -1)
{
currentWaypointIndex = nextWaypointIndex;
}
else
{
currentWaypointIndex = Random.Range(0, currentPath.waypoints.Count);
}
}
}
Vector3 waypointPosition = currentPath.waypoints[currentWaypointIndex].position;
transform.position = Vector3.MoveTowards(transform.position, waypointPosition, speed * Time.deltaTime);
}
}
}
Now add the path prefabs that you created to the waypoint list on the script attached to your Entity.
Finally, run your scene. Your entity should now choose a path to move on and move between the waypoints. Remember, the lower the waypointTolerance variable value, the closer the entity will walk to the waypoint path.
