dusk/godot_boids
dusk/godot_boids
1
0
Fork 0
Code Issues Pull Requests Actions Releases 1 Activity

docs: update readme again

Browse Source
This commit is contained in:
dusk 2024-08-30 18:33:58 +03:00
parent 0840707ebb
commit 8c3411ab5b
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,18 +1,27 @@
# boids
Addon for Godot that adds 2D / 3D boids (flocking).
addon for Godot that adds 2D / 3D boids (flocking).
![boids](./resources/boids.gif)
## Usage
## usage
Clone the repository and copy over the `addons` folder into your project root.
Check the examples for more info.
clone the repository and copy over the `addons` folder into your project root.
check the examples for more info.
## TODO
## development
it's just a standard rust project under `rust`, so make sure you have the latest stable rust toolchain installed.
also don't forget to have godot installed and available in your `PATH` (the extension currently targets 4.3).
- **cargo features**
- enable `stats` feature to let the extension log into godot console some times for how its processing the boids.
## todo
- [ ] memoize calculated distances
- [ ] implement avoidance (point avoidance, edge avoidance)
- [ ] implement nodes for these (for 2d, point and a rect node and 3d point and a cube node, circle / sphere too)
- [ ] implement partitioning (quadtree/octree)
- [ ] do we just use `spatialtree` crate?
- [ ] write better usage documentation