docs: update readme
This commit is contained in:
parent
54a4feb82c
commit
86c77d5da5
17
README.md
17
README.md
@ -1,17 +1,18 @@
|
|||||||
# boid_2d
|
# boids
|
||||||
|
|
||||||
Addon for Godot that adds a 2D node for simulating boids / flocking.
|
Addon for Godot that adds 2D / 3D boids (flocking).
|
||||||
|
|
||||||
![boids](./resources/boids.gif)
|
![boids](./resources/boids.gif)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Clone the repository and copy over the addon.
|
Clone the repository and copy over the `addons` folder into your project root.
|
||||||
Make an inherited scene from `boid.tscn`, add a `Sprite2D` (or whatever visuals you have) and instantiate and spawn many.
|
Check the examples for more info.
|
||||||
Checkout the examples on how to use it more.
|
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
- [ ] fix weird spasming behaviour
|
- [ ] memoize calculated distances
|
||||||
- [ ] improve collision (dont only bounce, maybe follow wall in some conditions etc.)
|
- [ ] implement avoidance (point avoidance, edge avoidance)
|
||||||
- [ ] improve performance (BoidManager autoload that tracks and manages every boid?)
|
- [ ] 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)
|
||||||
|
- [ ] write better usage documentation
|
||||||
|
Loading…
Reference in New Issue
Block a user