92 lines
3.8 KiB
Markdown
92 lines
3.8 KiB
Markdown
<h1 align="center">
|
|
<a href="https://www.reactphysics3d.com"><img src="https://github.com/DanielChappuis/reactphysics3d/blob/62e17155e3fc187f4a90f7328c1154fc47e41d69/documentation/UserManual/images/ReactPhysics3DLogo.png" alt="ReactPhysics3D" width="300"></a>
|
|
<br>
|
|
ReactPhysics3D
|
|
<br>
|
|
</h1>
|
|
|
|
<h4 align="center">ReactPhysics3D is an open source C++ physics engine library that can be used in 3D simulations and games.</h4>
|
|
<p align="center"><a href="https://www.reactphysics3d.com">www.reactphysics3d.com</a></p>
|
|
<p align="center">
|
|
<a href="https://github.com/DanielChappuis/reactphysics3d/actions/workflows/build-and-test.yml">
|
|
<img src="https://github.com/DanielChappuis/reactphysics3d/actions/workflows/build-and-test.yml/badge.svg"
|
|
alt="Build">
|
|
</a>
|
|
<a href="https://www.codacy.com/app/chappuis.daniel/reactphysics3d?utm_source=github.com&utm_medium=referral&utm_content=DanielChappuis/reactphysics3d&utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/3ae24e998e304e4da78ec848eade9e3a"></a>
|
|
<a href="https://codecov.io/github/DanielChappuis/reactphysics3d?branch=master">
|
|
<img src="https://codecov.io/github/DanielChappuis/reactphysics3d/coverage.svg?branch=master">
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#features">Features</a> •
|
|
<a href="#documentation">Documentation</a> •
|
|
<a href="#branches">Branches</a> •
|
|
<a href="#questions">Questions</a> •
|
|
<a href="#issues">Issues</a> •
|
|
<a href="#author">Author</a> •
|
|
<a href="#license">License</a> •
|
|
<a href="#support">Support</a> •
|
|
<a href="#credits">Credits</a>
|
|
</p>
|
|
|
|
<img src="https://raw.githubusercontent.com/DanielChappuis/reactphysics3d/master/documentation/UserManual/images/testbed.png" alt="Drawing" height="400" />
|
|
|
|
## Features
|
|
|
|
- Rigid body dynamics
|
|
- Discrete collision detection
|
|
- Collision shapes (Sphere, Box, Capsule, Convex Mesh, Static Concave Mesh, Height Field)
|
|
- Multiple collision shapes per body
|
|
- Broadphase collision detection (Dynamic AABB tree)
|
|
- Narrowphase collision detection (SAT/GJK)
|
|
- Collision response and friction (Sequential Impulses Solver)
|
|
- Joints (Ball and Socket, Hinge, Slider, Fixed)
|
|
- Collision filtering with categories
|
|
- Ray casting
|
|
- Sleeping technique for inactive bodies
|
|
- Multi-platform (Windows, Linux, Mac OS X)
|
|
- No external libraries (do not use STL containers)
|
|
- Documentation (user manual and Doxygen API)
|
|
- Testbed application with demos
|
|
- Integrated profiler
|
|
- Debugging renderer
|
|
- Logs
|
|
- Unit tests
|
|
|
|
## Documentation
|
|
|
|
You can find the user manual and the Doxygen API documentation [here](https://www.reactphysics3d.com/documentation.html)
|
|
|
|
## Branches
|
|
|
|
The "master" branch always contains the last released version of the library and some possible bug fixes. This is the most stable version. On the other side,
|
|
the "develop" branch is used for development. This branch is frequently updated and can be quite unstable. Therefore, if you want to use the library in
|
|
your application, it is recommended to checkout the "master" branch.
|
|
|
|
## Questions
|
|
|
|
## Issues
|
|
|
|
If you find any issue with the library, you can report it on the issue tracker [here](https://github.com/DanielChappuis/reactphysics3d/issues).
|
|
|
|
## Author
|
|
|
|
The ReactPhysics3D library has been created and is maintained by [Daniel Chappuis](https://github.com/DanielChappuis).
|
|
|
|
## License
|
|
|
|
The ReactPhysics3D library is released under the open-source [ZLib license](http://opensource.org/licenses/zlib).
|
|
|
|
## Support
|
|
|
|
...
|
|
|
|
## Credits
|
|
|
|
Thanks a lot to Erin Catto, Dirk Gregorius, Erwin Coumans, Pierre Terdiman and Christer Ericson for their amazing GDC presentations,
|
|
their physics engines, their books or articles and their contributions on many physics engine forums.
|
|
|
|
- [Artbake Graphics](https://sketchfab.com/ismir) for the static castle 3D model used in testbed application ([CC license](https://creativecommons.org/licenses/by/4.0))
|
|
|