README.md

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

• Behaviour Architectures
  • Finite State Machine
  • Behaviour Tree with generic utility
  • Nest Behaviour Trees inside State Machines and vice versa!
• Blackboard Resource
• Editor Interface with shortcuts
• 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
• Add the submodule branch as 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
  • Finite State Machine
  • Behaviour Tree
  • Blackboard
  • Nesting Behaviours inside Behaviours

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 if you like the plugin and feel like supporting me :D

Have fun creating awesome behaviours!

Star History