Unity-Formation-Movement

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

Unity-Formation-Movement

★ 19 Open GitHub ↗

Unity formation movement system compatible with Unity NavMesh, A* and A* Pro packages, with optional manual integration support.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Unity Formation Movement

## Description
A formation system for Unity that positions and moves units in dynamic layouts (e.g. Wedge, Circle, etc) formations. Suitable for RTS, TD and other strategy game genres.
Supports **historical** and **live** positioning modes.
The implementation provides integration for both [Unity NavMesh](https://docs.unity3d.com/Packages/com.unity.ai.navigation@2.0/manual/index.html) and [A* Pathfinding Project](https://arongranberg.com/astar/docs/index.html) packages.
The system supports manual integration without requiring **A*** **Pathfinding** or **Unity NavMesh** packages. Read more on **Technical Overview** and **Manual Integration** sections.

## Features
<details><summary>Dynamic Formation Changes</summary><img src="https://i.imgur.com/qIsx3WN.gif" width="800" height="450"></details>
<details><summary>Follower Removal</summary><img src="https://i.imgur.com/V4LLChH.gif" width="800" height="450"></details>
<details><summary>Visual Leader (cosmetic)</summary><img src="https://i.imgur.com/JOqiDGc.gif" width="800" height="450"></details>
<details><summary>Adaptive positioning fallback</summary><img src="https://media0.giphy.com/media/v1.Y2lkPTc5MGI3NjExaWV1eTh1NGZ1eGs5Mmd6YXVkeGVieW0wNmNnNnR2Z2YxbzZoMWk0MCZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/8WjpcEHUtURA6kVxnj/giphy.gif" width="800" height="450"></details>

<details><summary>Simulation Types Support</summary>

 
* Historical
* Live
 
</details>

<details><summary>ScriptableObjects Formation Layouts</summary>

 
* Arc
* Circle
* Triangle
* Wedge
* Matrix
* Horizontal Line
* Shield Wall
* Vertical Line
 
</details>

Note: *Click on above items to expand*.

## Quick Start Guide
**Requirements:** Unity 6000.0 or later, although 2022.3 LTS or lower should work.
1. Download and import [A* Pathfinding Project](https://arongranberg.com/astar/download) or [Unity NavMesh](https://docs.unity3d.com/Packages/com.unity.ai.navigation@2.0/manual/InstallAINav.html) package.
2. Download and import [Formation Movement](https://github.com/Flameshot/Unity-Formation-Movement-AStar/raw/refs/heads/main/Assets/FormationMovementPackage.unitypackage) package.
3. Delete from the **FormationMovement** imported folder, the integration you are **NOT** using:
   - Using **A*** **Pathfinding Project**, delete **NavMesh** folders.
   - Using **Unity NavMesh**, delete **AStar** folders.
5. Search and open **FormationExample** scene for a ready-to-use setup.
6. Press play and see your formation in action!

## Notes for Unity NavMesh Users
In order to avoid **Followers** struggling to avoid each other when a formation change happens, tweak **Formation Scriptable Objects** values.

## Notes for A* Pro Users
This implementation supports all A* Pro package features, like [Local Avoidance](https://arongranberg.com/astar/docs/localavoidance.html) and [Movement Scripts](https://arongranberg.com/astar/docs/movementscripts.html). 
Generate your desired Graph type and replace the **AIPath** component from both **FormationLeader** and **Followers** prefabs with desired movement script (ex. RichAI, FollowerEntity etc.) component.

## Technical Overview
The system creates formations using virtual **Formation Grid Points** positioned relative to a hidden **Formation Leader**. **Followers** move toward their assigned **Formation Grid Point** to maintain formation.
* **Formation**: Holds formation related data such as **Formation Grid Point**, **Formation Follower** and handles formation changes (e.g. spawning, placement, switching and related functionality).
* **Formation Leader**: The brain unit, always placed ahead of formation. Generates **Formation Grid Point** for each **Follower** and records movement history. It is invisible. 
* **Visual Leader**: Any unit that appears to "lead" the formation (optional, purely cosmetic).
* **Follower**: Unit that follows their assigned **FormationGridPoint** to maintain formation layout.
* **Formation Grid Point**: Virtual targets defining where each **Follower** should move. Constantly updated by the **Formation Leader**.
* **FormationTypeSO**: ScriptableObject system used to define different formation layouts in a modular way.

**Positioning Modes**: **Historical** and **Live**
* **Historical** - **Formation Grid Points** use sampled historical positions of the **Formation Leader**. This results in smooth and natural **Follower** movement.
* **Live** - **Followers** track real-time offsets relative to the **Formation Leader**. Suitable for simple, tight formations (e.g. Wedge, Circle, Arc).
* Switching between modes can be made from formation scriptable object (e.g. **WedgeFormation**) found in ScriptableObjects folder.

## Manual Integration
To use the system without A* or Unity NavMesh, manual integration is required. This requires that a movement system for units is already implemented which will be hooked to the **Formation Movement** system.
1. Create two new classes, one **Follower** and the other **Leader**. They should hold your movement system.
2. Inherit **FormationAI** class on both **Follower** and **Leader** classes. Link class overrides to your movement system.
3. Inherit **IFormationLeader** on **Leader** and **IFormationUnit** on **Follower**. Link interfaces overrides to your movements systems, altough, in this point, most of them should be already linked from previous step.
4. Create your **Follower** and **Leader** prefabs with their new scripts attached.
5. In **Formation Scriptable Objects** change **Follower** reference with your prefab.

## Known issues
* For **Historical** simulation type, **Adaptive Positioning Fallback** doesn't always return the best path direction for some formation layouts.

## Contribution
Help make this better! Bugs are expected. Feel free to:
* Open issues for bug reports or suggestions.
* Submit Pull Requests with improvements or fixes.
* All contributions are welcome, thank you!

Unity-Formation-Movement

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README