Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/crashkonijn/GOAP

A multi-threaded GOAP system for Unity
https://github.com/crashkonijn/GOAP

Last synced: 2 months ago
JSON representation

A multi-threaded GOAP system for Unity

Lists

README

        

[![Discord](https://img.shields.io/discord/1093598557480685578?label=Discord)](https://discord.gg/dCPnHaYNrm)
[![Documentation](https://img.shields.io/badge/GitBook-Docu-lightblue)](https://goap.crashkonijn.com/)
[![openupm](https://img.shields.io/npm/v/com.crashkonijn.goap?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.crashkonijn.goap/)
[![Asset Store](https://img.shields.io/badge/Asset%20Store-v2.1.14-blue)](https://assetstore.unity.com/packages/slug/252687)
[![CodeFactor](https://www.codefactor.io/repository/github/crashkonijn/goap/badge)](https://www.codefactor.io/repository/github/crashkonijn/goap)
![test-status](https://github.com/crashkonijn/GOAP/actions/workflows/main.yml/badge.svg?branch=master)
![GitHub](https://img.shields.io/github/license/crashkonijn/GOAP)
![GitHub Repo stars](https://img.shields.io/github/stars/crashkonijn/GOAP?style=social)
![GitHub forks](https://img.shields.io/github/forks/crashkonijn/GOAP?style=social)

# GOAP for Unity
A robust, multi-threaded Goal Oriented Action Planning (GOAP) system designed for Unity, empowering developers to create complex AI behaviors with ease.

This library, a successor to the one used in [Basher Beatdown](https://youtu.be/x653mVuNP0A?t=12s), brings enhanced performance and flexibility to game AI development.

![Screenshot of Demo](Package/Documentation/images/2k_agents_short.gif)

## Key Features
- **High Performance**: Optimized for speed, leveraging Unity's job system for multi-threaded operations.
- **User-Friendly**: Simple setup process, with options for both `ScriptableObjects` and code-based configurations.
- **Visualization Tools**: Includes a GOAP Visualizer for easy debugging and understanding AI decisions.
- **Demo Scenes**: Comes with two illustrative demo scenes showcasing the system's capabilities.
- **Comprehensive Documentation**: Detailed [documentation](https://goap.crashkonijn.com/) for ease of use and integration.
- **Compatibility**: Built using Unity 2022.2, also confirmed to work seamlessly with Unity 2021.3.
- **Tested and Proven**: Rigorously tested to ensure reliability and performance.

## Installation
Integrate GOAP into your Unity project using one of the following methods:

- **Unity Package Manager**:
Add the package via the package manager using this URL:
```
https://github.com/crashkonijn/GOAP.git?path=/Package#2.1.16
```

- **OpenUPM**:
Install through [OpenUPM](https://openupm.com/packages/com.crashkonijn.goap/).

- **Unity Asset Store**:
Available on the [Unity Asset Store](https://assetstore.unity.com/packages/slug/252687).

## Node Viewer
Visualize your GOAP nodes and their interactions with our intuitive Node Viewer.

![Screenshot of NodeViewer](Package/Documentation/images/goap-viewer.png)

## Documentation and Examples
- **Documentation**: Access comprehensive guides and API references in the `Package/Documentation` folder or visit [goap.crashkonijn.com](https://goap.crashkonijn.com/).
- **Demos**: Explore practical implementations in the Demo folder. Simply clone this repository and open the Demo project in Unity to get started.

## References
- **[YouTube tutorials](https://www.youtube.com/playlist?list=PLZWmMt_TbeYeatHa9hntDPu4zGEBAFffn)** on how to use the library.
- **[YouTube references](https://www.youtube.com/playlist?list=PLZWmMt_TbeYdBZKvlsRuuOubPTTfPuZot)** discussing GOAP in general.
- **[YouTube mentions](https://www.youtube.com/playlist?list=PLZWmMt_TbeYdaEY4dkSJt4w2X_b_Pf97T)** about this project.