Installation¶
Get the RGS GOAP Framework installed in your Unity project.
Requirements¶
| Dependency | Minimum Version |
|---|---|
| Unity | 2022.3.0f1 (LTS) or later |
| Burst | 1.8.0 |
| Collections | 2.1.0 |
| Mathematics | 1.2.0 |
Note
Burst, Collections, and Mathematics are pulled in automatically as package dependencies. You do not need to install them manually.
Install via the Unity Asset Store¶
This is the recommended installation method.
- Purchase the RGS GOAP Framework from the Unity Asset Store.
- Open your Unity project (2022.3 LTS or later).
- Open Window > Package Manager.
- In the top-left dropdown, select My Assets.
- Find RGS GOAP Framework in the list and click Import.
- Accept all files in the import dialog and click Import.
Unity will compile the package and resolve dependencies automatically.
Install via UPM from Disk¶
If you have the package as a local folder (e.g., from a development build):
- Open Window > Package Manager.
- Click the + button in the top-left corner.
- Select Add package from disk....
- Navigate to the package folder and select its
package.jsonfile. - Unity will import the package and resolve dependencies.
Verify the Installation¶
After importing, confirm everything is working:
- Check for compile errors — the Console window should be clean. If you see errors related to Burst or Collections, ensure your Unity version meets the minimum requirements above.
- Open the GOAP Hub — select any GameObject in the scene, add a
GoapAgentcomponent, and click the Open GOAP Suite button in the inspector. The GOAP Hub editor window should appear. - Check assemblies — in the Project window, search for
RGS.GOAP.Core. You should see the assembly definition file, confirming the framework is installed.
Tip
If you see "Missing Script" errors on any ScriptableObject assets, the most common cause is a broken assembly reference. Check that your .asmdef files reference RGS.GOAP.Core correctly.
Assemblies¶
The framework is organized into four assemblies:
| Assembly | Purpose |
|---|---|
RGS.GOAP.Core |
Runtime framework — planner, executor, blackboard, agents |
RGS.GOAP.Sensors |
Built-in sensor implementations (Optical, Auditory, Sphere, Waypoint) |
RGS.GOAP.Demos |
Demo scenes and example strategies |
RGS.GOAP.Editor |
GOAP Hub editor window (editor-only) |
When creating custom extensions (strategies, sensors, beliefs), your assembly definition should reference RGS.GOAP.Core.
See Also
- Troubleshooting — Fixing assembly reference and missing script issues
- Glossary — Quick definitions for Brain, Strategy, and other framework terms
What's Next¶
- GOAP Hub Overview — Learn the visual editor before building anything.
- Your First Agent — Create a working AI agent step by step.
- What is GOAP? — Understand the concepts behind the framework.