diff --git a/README.md b/README.md index 9420e04..d28bb65 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ A Behavior Tree (BT) is a powerful hierarchical structure used to model and cont > 🛈 See also: [Introduction to Behavior Trees](./doc/getting-started.md). -![Textured screenshot](doc/images/behavior-tree-editor.png) +![Textured screenshot](doc/images/behavior-tree-editor-debugger.png) -![Textured screenshot](doc/images/behavior-tree-debugger.png) + ## Features @@ -79,7 +79,7 @@ Features and improvements that may be implemented in the future: - ~~Tests and CI.~~ 🗸 - Expanding the library of commonly useful tasks. - Creating a non-trivial demo project to showcase the capabilities of LimboAI. -- Exploring the execution history of Behavior Trees in the Visual Debugger. -- Implementing an ignore list for tasks that users may want to hide in the task panel. +- Exploring the execution history of behavior trees in the visual debugger. +- Per-project ignore list for tasks that users may want to hide in the task palette. - GUI editor for state machines. - Supporting GDExtension in the future, once it matures. diff --git a/doc/getting-started.md b/doc/getting-started.md index 4a5b2d1..c974f28 100644 --- a/doc/getting-started.md +++ b/doc/getting-started.md @@ -11,6 +11,7 @@ ## TL;DR +- Next section gives a brief explanation of behavior trees. - To create your own actions, extend the `BTAction` class. - To create your own conditions, extend the `BTCondition` class. - In-editor class documentation is available. Try searching `BTTask` and `BehaviorTree`. @@ -57,11 +58,11 @@ func _generate_name() -> String: func _setup() -> void: pass -# Called when task is entered. +# Called when the task is entered. func _enter() -> void: pass -# Called when task is exited. +# Called when the task is exited. func _exit() -> void: pass @@ -101,7 +102,7 @@ func _setup() -> void: _max_distance_squared = distance_max * distance_max -# Called when task is executed. +# Called when the task is executed. func _tick(_delta: float) -> Status: var target: Node2D = blackboard.get_var(target_var, null) if not is_instance_valid(target): diff --git a/doc/images/behavior-tree-debugger.png b/doc/images/behavior-tree-debugger.png deleted file mode 100644 index 06acdc8..0000000 Binary files a/doc/images/behavior-tree-debugger.png and /dev/null differ diff --git a/doc/images/behavior-tree-editor-debugger.png b/doc/images/behavior-tree-editor-debugger.png new file mode 100644 index 0000000..51ea456 Binary files /dev/null and b/doc/images/behavior-tree-editor-debugger.png differ diff --git a/doc/images/behavior-tree-editor.png b/doc/images/behavior-tree-editor.png deleted file mode 100644 index d981622..0000000 Binary files a/doc/images/behavior-tree-editor.png and /dev/null differ