docs: The documentation needs improvements

[colbymaloy]

it doesnt really provide much to give an understanding of how to use the library. the readme should have more info on fixtures, and show all the shape types. as well as using sprites, and just more examples.

I figured out that you just can add the sprite as a child of the box component, and that really the phrasing around this should be that you use the box component as the root of a component to add physics&hitboxes. Clarify that thats the only component, and you add children to it from the flame lib.

[spydon]

Yeah, the documentation definitely needs improvement. If you're using it together with Flame there are quite a lot of examples here: https://examples.flame-engine.org/#/flame_forge2d_Blob_example
And a little bit of docs here: https://docs.flame-engine.org/latest/bridge_packages/flame_forge2d/flame_forge2d.html

[colbymaloy]

awesome. but i need a kinematic body component that bounces off the edge of the screen? like a platform that player can stand on?

[spydon]

@colbymaloy if you're using a kinematic body you need to handle the bouncing yourself (standing on it should work out of the box though), see an explanation about kinematic bodies here:
https://www.iforce2d.net/b2dtut/bodies