botaccount
/
limboai
mirror of https://github.com/limbonaut/limboai.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc: Update README and setup_gdextension.sh

This commit is contained in:
Serhii Snitsaruk 2024-02-18 22:51:22 +01:00
parent d393784bbe
commit 9d99e8bf9f
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -36,7 +36,7 @@ Behavior Trees are powerful hierarchical structures used to model and control th
- Blackboard: Share data seamlessly between tasks using the `Blackboard`. - Blackboard: Share data seamlessly between tasks using the `Blackboard`.
- Blackboard plans: Define variables in the BehaviorTree resource and override their values in the BTPlayer node. - Blackboard plans: Define variables in the BehaviorTree resource and override their values in the BTPlayer node.
- Blackboard scopes: Isolate variable namespaces and enable advanced techniques like sharing data between several agents in a group. - Blackboard scopes: Isolate variable namespaces and enable advanced techniques like sharing data between several agents in a group.
- Blackboard parameters: Export BB parameter, for which user can provide a value or bind it to a blackboard variable (can be used in custom tasks). - Blackboard parameters: Export a BB parameter, for which user can provide a value or bind it to a blackboard variable (can be used in custom tasks).
- Editor support: Blackboard plan editor, and inspector property editor for exported string properties ending with "_var". - Editor support: Blackboard plan editor, and inspector property editor for exported string properties ending with "_var".
- Use the `BTSubtree` task to execute a tree from a different resource file, promoting organization and reusability. - Use the `BTSubtree` task to execute a tree from a different resource file, promoting organization and reusability.
- Visual Debugger: Inspect the execution of any BT in a running scene to identify and troubleshoot issues. - Visual Debugger: Inspect the execution of any BT in a running scene to identify and troubleshoot issues.
@ -69,6 +69,8 @@ LimboAI can be used as either a C++ module or as a GDExtension shared library. G
### Compiling from source ### Compiling from source
>**🛈 For GDExtension:** Refer to comments in [setup_gdextension.sh](./gdextension/setup_gdextension.sh) file.
- Download the Godot Engine source code and put this module source into the `modules/limboai` directory. - Download the Godot Engine source code and put this module source into the `modules/limboai` directory.
- Consult the Godot Engine documentation for instructions on [how to build from source code](https://docs.godotengine.org/en/stable/contributing/development/compiling/index.html). - Consult the Godot Engine documentation for instructions on [how to build from source code](https://docs.godotengine.org/en/stable/contributing/development/compiling/index.html).
- If you plan to export a game utilizing the LimboAI module, you'll also need to build export templates. - If you plan to export a game utilizing the LimboAI module, you'll also need to build export templates.

10
gdextension/setup_gdextension.sh
View File

@ -13,9 +13,13 @@
## Directory layout: ## Directory layout:
## project/ -- call this script from here, directory name doesn't matter. ## project/ -- call this script from here, directory name doesn't matter.
## project/limboai/ -- LimboAI repository should be here after you clone it. ## project/limboai/ -- LimboAI repository should be here after you clone it.
## project/godot-cpp/ -- will be created by this script. ## project/godot-cpp/ -- will be created by this script, unless cloned manually.
## project/demo/ -- symbolic link that will be created by this script. ## project/demo/ -- symbolic link (leads to limboai/demo).
## project/SConstruct -- symbolic link that will be created by this script. ## project/demo/addons/limboai/limboai.gdextension -- symbolid link (leads to limboai/gdextension/limboai.gdextension).
## project/demo/addons/limboai/icons/ -- symbolic link (leads to icons/).
## project/SConstruct -- symbolic link (leads to limboai/gdextension/SContruct).
##
## Note: Symbolic links will be created by this script.
## ##
## Dependencies: bash, git, python3. ## Dependencies: bash, git, python3.