GameReadyGoap 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package GameReadyGoap --version 1.0.0                
NuGet\Install-Package GameReadyGoap -Version 1.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="GameReadyGoap" Version="1.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add GameReadyGoap --version 1.0.0                
#r "nuget: GameReadyGoap, 1.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install GameReadyGoap as a Cake Addin
#addin nuget:?package=GameReadyGoap&version=1.0.0

// Install GameReadyGoap as a Cake Tool
#tool nuget:?package=GameReadyGoap&version=1.0.0                

<img src="https://github.com/Joy-less/GameReadyGoap/blob/main/Assets/Icon.jpg?raw=true" width=256/>

Game Ready Goap

An easy-to-use implementation of GOAP (Goal-Oriented Action Planning) to control game characters in C#.

Features

  • Simple and performant, made for game development
  • Expressive with minimal boilerplate
  • Get as close as possible to "best-effort" goals

Usage

First, create an agent with initial states, goals and actions:

GoapAgent Agent = new() {
    // These describe the current state of your agent (character).
    States = new() {
        ...
    },
    // These are the states your agent is trying to achieve.
    Goals = [
        ...
    ],
    // These are the ways your agent can change their states.
    Actions = [
        ...
    ],
};

Then, finding a plan is easy:

Agent.FindPlan(); // or Agent.FindPlan(Goal);

Example

A farmer is balancing tending to his crops with resting. He can farm to increase his crop health, which requires energy, or sleep to increase his energy.

GoapAgent Farmer = new() {
    States = new() {
        ["Energy"] = 100,
        ["CropHealth"] = 0,
    },
    Goals = [
        new GoapGoal("TendToCrops") {
            Objectives = [
                new GoapCondition() {
                    State = "CropHealth",
                    Comparison = GoapComparison.GreaterThanOrEqualTo,
                    Value = 100,
                    BestEffort = true,
                },
            ],
        },
    ],
    Actions = [
        new GoapAction("Farm") {
            Effects = [
                new GoapEffect() {
                    State = "CropHealth",
                    Operation = GoapOperation.IncreaseBy,
                    Value = 20,
                },
                new GoapEffect() {
                    State = "Energy",
                    Operation = GoapOperation.DecreaseBy,
                    Value = 30,
                },
            ],
            Requirements = [
                new GoapCondition() {
                    State = "Energy",
                    Comparison = GoapComparison.GreaterThanOrEqualTo,
                    Value = 30,
                },
            ],
        },
        new GoapAction("Sleep") {
            Effects = [
                new GoapEffect() {
                    State = "Energy",
                    Operation = GoapOperation.IncreaseBy,
                    Value = 5,
                },
            ],
        },
    ],
};
Farmer.FindPlan();

We get 15 actions which bring us to our goal:

Action Energy Crop Health
- 100 0
Farm 70 20
Farm 40 40
Farm 10 60
Sleep 15 60
Sleep 20 60
Sleep 25 60
Sleep 30 60
Farm 0 80
Sleep 5 80
Sleep 10 80
Sleep 15 80
Sleep 20 80
Sleep 25 80
Sleep 30 80
Farm 0 100

Special Thanks

  • F.E.A.R. for creating the GOAP algorithm.
  • This Is Vini for explaining the GOAP algorithm.
  • SimpleGOAP for guidance when implementing the action planner.
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.0 132 10/18/2024
2.0.0 76 10/7/2024
1.2.0 82 10/5/2024
1.1.0 86 10/5/2024
1.0.0 81 10/5/2024