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

doc: Add TOC, links and fixes

This commit is contained in:
Serhii Snitsaruk 2023-10-31 18:59:35 +01:00
parent 0cb62ea051
commit f4bac67aa9
2 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -46,8 +46,8 @@ A Behavior Tree (BT) is a powerful hierarchical structure used to model and cont
### Precompiled builds
- For the most recent builds, navigate to "Actions → All Builds", select a build from the list, and scroll down until you find the "Artifacts" section.
- For release builds, check [Releases](https://github.com/limbonaut/limboai/releases).
- For the most recent builds, navigate to **Actions** → [**All Builds**](https://github.com/limbonaut/limboai/actions/workflows/all_builds.yml), select a build from the list, and scroll down until you find the **Artifacts** section.
- For release builds, check [**Releases**](https://github.com/limbonaut/limboai/releases).
### Compiling from source
@ -56,6 +56,14 @@ A Behavior Tree (BT) is a powerful hierarchical structure used to model and cont
- If you plan to export a game utilizing the LimboAI module, you'll also need to build export templates.
- To execute unit tests, compile the engine with `tests=yes` and run it with `--test --tc="*[LimboAI]*"`.
## Using the module
<!-- - [Getting Started](./doc/getting-started.md#getting-started) -->
- [Introduction to Behavior Trees](./doc/getting-started.md#introduction-to-behavior-trees)
- [Creating custom tasks in GDScript](./doc/getting-started.md#creating-custom-tasks-in-gdscript)
- [Task anatomy](./doc/getting-started.md#task-anatomy)
- [Custom task example](./doc/getting-started.md#custom-task-example)
## Contributing
All contributions are welcome! Feel free to open issues with bug reports and feature requests, and submit PRs.

11
doc/getting-started.md
View File

@ -1,13 +1,20 @@
# Getting Started
> **🛈 Getting the module:** [README: Getting LimboAI](../README.md#getting-limboai).
> **🛈 See also:** [**How to get LimboAI**](../README.md#getting-limboai).
- [Getting Started](#getting-started)
- [TL;DR](#tldr)
- [Introduction to Behavior Trees](#introduction-to-behavior-trees)
- [Creating custom tasks in GDScript](#creating-custom-tasks-in-gdscript)
- [Task anatomy](#task-anatomy)
- [Custom task example](#custom-task-example)
## TL;DR
- To create your own actions, extend the `BTAction` class.
- To create your own conditions, extend the `BTCondition` class.
- Use script template (available in "Misc → Create script template")
- In-editor class documentation is available. Try searching `BTTask` and `BehaviorTree`.
- Add a script template with "Misc → Create script template".
## Introduction to Behavior Trees