MoonTools.Bonk/README.md

18 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2020-02-21 02:07:59 +00:00
# MoonTools.Bonk
2019-10-25 21:08:55 +00:00
2020-02-21 02:07:59 +00:00
[![NuGet Badge](https://buildstats.info/nuget/MoonTools.Bonk)](https://www.nuget.org/packages/MoonTools.Bonk/)
2020-02-21 02:39:41 +00:00
[![Build Status](https://drone.moonside.games/api/badges/MoonsideGames/MoonTools.Bonk/status.svg)](https://drone.moonside.games/MoonsideGames/MoonTools.Bonk)
2019-10-25 21:08:55 +00:00
2019-11-01 17:50:42 +00:00
Bonk is a fast and modular collision detection system for .NET that is part of the MoonTools suite. It can be used with any .NET-based game engine.
2019-10-25 21:06:31 +00:00
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.
2019-12-02 06:30:17 +00:00
Bonk is designed for performance and memory efficiency. Defining shapes and performing collision tests require no heap allocations and put no pressure on the garbage collector. If you reuse spatial hashes, Bonk will never cause garbage collection.
2019-10-25 21:06:31 +00:00
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.
2019-09-19 00:06:29 +00:00
## Documentation
2019-10-25 21:06:31 +00:00
https://moontools-docs.github.io/bonk/