search

Apostolique / Apos.Spatial

Spatial partitioning library for MonoGame.
https://apostolique.github.io/Apos.Spatial/
MIT License
1 stars 1 forks source link

Documentation "Coming soon!" should link to actual documentation #2

Open vchelaru opened 5 months ago

vchelaru commented 5 months ago

This library came up in the MonoGame chat today, but the person interested in using it was not sure how to integrate it into their game.

The main page readme indicates the documentation is "Coming soon!". An intro tutorial would go a long way for new users, especially those who are very new to the concept of spatial partitioning.

Apostolique commented 5 months ago

I'm not ready to write docs just yet, at least not until a version 1.0.0 is done. For now you can read the example project.

https://github.com/Apostolique/Apos.Spatial/blob/b26766ec401b8f3213e6b800282a19f7437ac98b/Example/Game/Entity.cs

https://github.com/Apostolique/Apos.Spatial/blob/b26766ec401b8f3213e6b800282a19f7437ac98b/Example/Game/GameRoot.cs#L96-L98

For a bigger project, there's https://github.com/Apostolique/Mitten/blob/main/Game/GameRoot.cs you can see how the API is used on the _tree data structure.

axelei commented 5 months ago

Hello! I'm said person. I'm interested in implementing spatial partition in my game for object collisions and found your project.

I appreciate you bothered to create an example, but I think it'll be more helping with comments and more explainatory variable names. This way you won't even need documentation!

axelei commented 5 months ago

For the time being I wrote a small tutorial. Please check the PR #3 !