MoonsideGames
/
MoonTools.Bonk
1
1
Fork 1
Code Issues Pull Requests Releases 4 Wiki Activity

update README

pull/3/head
Evan Hemsley 2019-10-25 14:06:31 -07:00
parent d9084257b1
commit ac368404c5
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,5 +1,13 @@
# MoonTools.Core.Bonk
.NET Core Collision Detection for MonoGame
Bonk is a fast and modular collision detection system for MonoGame that is part of the MoonTools suite.
Bonk is designed to help you figure out if two shapes are overlapping and by how much.
Bonk is not a physics simulator and it will not help you execute collision responses.
Bonk is designed for performance and memory efficiency. Defining most shapes and performing collision tests require no heap allocations and thus put no pressure on the garbage collector. If you reuse spatial hashes and avoid using arbitrary polygons, Bonk will never cause garbage collection.
Bonk is licensed under the LGPL-3 license. In summary: feel free to include it in your closed-source game and modify it internally at will, but if you make changes that you intend to redistribute, you must freely publish your changes.
## Documentation
Detailed docs can be found here: https://moontools-docs.github.io/bonk/
https://moontools-docs.github.io/bonk/