https://github.com/thepat02/behaviourtoolkit

A collection of tools for AI Behaviour in the Godot 4 Game Engine!
https://github.com/thepat02/behaviourtoolkit

behaviour-tree finite-state-machine godot

Last synced: 4 days ago
JSON representation

A collection of tools for AI Behaviour in the Godot 4 Game Engine!

• Host: GitHub
• URL: https://github.com/thepat02/behaviourtoolkit
• Owner: ThePat02
• License: mit
• Created: 2023-10-19T10:24:26.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-19T13:41:33.000Z (14 days ago)
• Last Synced: 2024-12-22T17:05:04.883Z (11 days ago)
• Topics: behaviour-tree, finite-state-machine, godot
• Language: GDScript
• Homepage:
• Size: 1.39 MB
• Stars: 421
• Watchers: 5
• Forks: 15
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
![Thumbnail](docs/thumbnail.svg)

# BehaviourToolkit for Godot 4

This plugin provides a set of tools to create custom and complex behaviour in the Godot 4.x Game Engine.

### Features

- ![GEAR ICON](addons/behaviour_toolkit/icons/Gear.svg) Behaviour Architectures

    - ![FMS ICON](addons/behaviour_toolkit/icons/FiniteStateMachine.svg) Finite State Machine

    - ![BT ICON](addons/behaviour_toolkit/icons/BTRoot.svg) Behaviour Tree with generic utility 

    - ![Integration Icon](addons/behaviour_toolkit/icons/BTCompositeIntegration.svg) Nest Behaviour Trees inside State Machines and vice versa!

- ![BLACKBOARD ICON](addons/behaviour_toolkit/icons/Blackboard.svg) Blackboard Resource

- Editor Interface with shortcuts

- [Templates](docs/documentation.md#using-script-templates) for easy extension and integration

- Example Scene

When a new version is available on GitHub, the plugin will display a notification in the Toolbox! 

## Installation

- Clone the `main` branch of this repository to your machine

- Download the latest release from the [Godot Asset Lib](https://godotengine.org/asset-library/asset)

- Add the `submodule` branch as [Git Submodule](https://git-scm.com/docs/git-submodule) to your own repo

  - The `submodule` branch is **always** up to date with `main` and will allow you to consistently use the newest version by `pulling`

  - If you are not confident in your CL skills, you can use a client like GitKraken to set this up

## Usage

Make sure the clones the `addons` and `script_templates` directories into your project.

1. Add a `FiniteStateMachine` or `BTRoot` node to your scene.

2. A toolbox will appear in the editor, allowing you to add behaviour nodes to the scene.

3. Setup and configure your behaviour nodes in the inspector.

4. Right-click your `FSMState`/`FSMTransition`/`BTLeaf` and extend the script.

Now you can implement your own behaviour logic using the virtual methods provided by the script templates.

## Documentation

- [Documentation](docs/documentation.md)

  -   [Finite State Machine](docs/documentation.md#finite-state-machine)

  -   [Behaviour Tree](docs/documentation.md#behaviour-tree)

  -   [Blackboard](docs/documentation.md#-blackboard)

  -   [Nesting Behaviours inside Behaviours](docs/documentation.md#nesting-behaviours-inside-behaviours)

  

![Screenshot](docs/screenshot-ui.PNG)

## Notes 

This is the first time I've ever made a bigger plugin for Godot, so I am happy for any suggestions, feedback and contributions. If you need help or have any questions, feel free to contact me on Discord (`thepat02`) or open an issue on GitHub!

You can also [buy me a coffee](https://ko-fi.com/pat02) if you like the plugin and feel like supporting me :D

Have fun creating awesome behaviours!

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=ThePat02/BehaviourToolkit&type=Timeline)](https://star-history.com/#ThePat02/BehaviourToolkit&Timeline)