From 1359f1e606e174d59cbacb3345f7f3e9ce52d4fe Mon Sep 17 00:00:00 2001 From: namelessvoid Date: Tue, 17 Dec 2024 00:33:47 +0100 Subject: [PATCH] Merge BT debugging docs into 'Creating BT' chapter --- doc/source/behavior-trees/create-tree.rst | 18 ++++++++++++++++-- doc/source/behavior-trees/debugging.rst | 8 -------- doc/source/index.rst | 4 ---- 3 files changed, 16 insertions(+), 14 deletions(-) delete mode 100644 doc/source/behavior-trees/debugging.rst diff --git a/doc/source/behavior-trees/create-tree.rst b/doc/source/behavior-trees/create-tree.rst index 175dec1..6ab0f92 100644 --- a/doc/source/behavior-trees/create-tree.rst +++ b/doc/source/behavior-trees/create-tree.rst @@ -1,10 +1,24 @@ .. _create_tree:: -Creating your own Behavior Trees -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Creating Behavior Trees +======================= + +This chapter describes how to create and debug behavior trees. + +Add a Behavior Tree to an agent +------------------------------- + +Follow these steps to add a behavior tree to a new or existing agent: 1. Make a scene file for your agent, or open an existing scene. 2. Add a :ref:`BTPlayer` node to your scene. 3. Select :ref:`BTPlayer`, and create a new behavior tree in the inspector. 4. Optionally, you can save the behavior tree to a file using the property's context menu. 5. Click the behavior tree property to open it in the LimboAI editor. + +Debugging Behavior Trees +------------------------ + +In Godot Engine, follow to "Bottom Panel > Debugger > LimboAI" tab. With the LimboAI debugger, +you can inspect any currently active behavior tree within the running project. The debugger can be detached +from the main editor window, which can be particularly useful if you have a HiDPI or a secondary display. \ No newline at end of file diff --git a/doc/source/behavior-trees/debugging.rst b/doc/source/behavior-trees/debugging.rst deleted file mode 100644 index d92e095..0000000 --- a/doc/source/behavior-trees/debugging.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _debugging: - -Debugging Behavior Trees -======================== - -In Godot Engine, follow to "Bottom Panel > Debugger > LimboAI" tab. With the LimboAI debugger, -you can inspect any currently active behavior tree within the running project. The debugger can be detached -from the main editor window, which can be particularly useful if you have a HiDPI or a secondary display. diff --git a/doc/source/index.rst b/doc/source/index.rst index 6cbd948..2d598ea 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,9 +1,6 @@ LimboAI Documentation ===================== -About ------ - **LimboAI** is an open-source C++ module for **Godot Engine 4** providing a combination of **Behavior Trees** and **State Machines** for crafting your game’s AI. It comes with a behavior tree editor, built-in documentation, visual debugger, and more! While @@ -40,7 +37,6 @@ one big state machine into multiple smaller ones. behavior-trees/custom-tasks behavior-trees/using-blackboard behavior-trees/accessing-nodes - behavior-trees/debugging .. toctree:: :hidden: