Skip to content

Commit ea83fa7

Browse files
authored
include more examples from wild + refactor readme slightly (#76)
More examples + slight refactor before putting put announcements on Reddit
1 parent 5fabebf commit ea83fa7

2 files changed

Lines changed: 10 additions & 13 deletions

File tree

README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ pip install bonsai-bt
5050

5151
See [`bonsai-py/`](bonsai-py/) for examples.
5252

53+
## Example of use
54+
55+
See [Examples](examples/README.md) folder.
56+
5357
## What is a Behavior Tree?
5458

5559
A _Behavior Tree_ (BT) is a data structure in which we can set the rules of how certain _behavior's_ can occur, and the order in which they would execute. BTs are a very efficient way of creating complex systems that are both modular and reactive. These properties are crucial in many applications, which has led to the spread of BT from computer game programming to many branches of AI and Robotics.
@@ -79,16 +83,3 @@ See the `Behavior` enum for more information.
7983
To make sure that the behavior tree is always responsive, it is important that the actions that are created executes instantly so that they do not block the tree traversal. If you have long-running tasks/functions that can take seconds or minutes to execute - either `async` or `sync` - then we can dispatch those jobs into background threads, and get status of the task through a channel.
8084

8185
see *async drone* example in the `/examples` folder for more details.
82-
83-
## Example of use
84-
85-
See [Examples](examples/README.md) folder.
86-
87-
## Similar Crates
88-
89-
Bonsai is inspired by many other crates out there, here's a few worth mentioning:
90-
91-
* [ai_behavior](https://github.com/PistonDevelopers/ai_behavior) (bonsai is a continuation of this crate)
92-
* [aspen](https://gitlab.com/neachdainn/aspen)
93-
* [behavior-tree](https://github.com/darthdeus/behavior-tree)
94-
* [stackbt](https://github.com/eaglgenes101/stackbt)

examples/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Examples
22

3+
The examples below are minimal, made-up scenarios to help you get going. For real-world usage of `bonsai-bt` in the wild, see:
4+
5+
* [utahrobotics/utah-lunabotics-2026](https://github.com/utahrobotics/utah-lunabotics-2026) — orchestrates core autonomy on a lunar rover. The team placed 3rd out of 50 in the autonomy challenge at [NASA Lunabotics 2026](https://www.nasa.gov/learning-resources/lunabotics-challenge/).
6+
* [catornot/bp-ort](https://github.com/catornot/bp-ort) — NPC plugins for Titanfall 2 mod servers (Northstar). [Live demo](https://www.youtube.com/watch?v=uT3aAuB4ej4&t=60s).
7+
* [AnotherlandServer/anotherland](https://github.com/AnotherlandServer/anotherland) — NPC behaviors for the Anotherland MMORPG.
8+
39
`cargo build --package examples`
410

511
## Game NPC AI console application

0 commit comments

Comments
 (0)