2021-12-23 21:09:51 +00:00
< 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 >
2021-12-28 21:16:17 +00:00
< p align = "center" > < a href = "https://www.reactphysics3d.com" > www.reactphysics3d.com< / a > < / p >
2021-12-23 21:09:51 +00:00
< 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" >
2021-12-31 14:22:03 +00:00
< img src = "https://github.com/DanielChappuis/reactphysics3d/blob/images/showreel.gif?raw=true" alt = "Drawing" / >
2021-12-23 21:09:51 +00:00
< / p >
2015-03-02 19:28:37 +00:00
2021-12-31 14:22:03 +00:00
## :dart: Features
2015-02-16 21:36:45 +00:00
2018-05-01 04:45:10 +00:00
- 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
2020-05-17 21:14:05 +00:00
- Integrated profiler
- Debugging renderer
2018-05-01 04:45:10 +00:00
- Logs
- Unit tests
2015-02-16 21:36:45 +00:00
2021-12-31 14:22:03 +00:00
## :book: Documentation
2015-02-16 21:36:45 +00:00
2021-12-31 14:31:40 +00:00
You can find the user manual and the Doxygen API documentation < a href = "https://www.reactphysics3d.com/documentation.html" target = "_blank" > here< / a > .
2015-02-16 21:36:45 +00:00
2021-12-31 14:22:03 +00:00
## :information_source: Branches
2015-03-02 19:43:47 +00:00
2021-12-31 14:22:03 +00:00
The "master" branch always contains the last released version of the library and some possible hot fixes. This is the most stable version. On the other side,
2015-03-02 19:43:47 +00:00
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.
2021-12-31 14:22:03 +00:00
## :question: Questions
2021-12-31 14:31:40 +00:00
If you have any questions about the library and how to use it, you should use < a href = "https://github.com/DanielChappuis/reactphysics3d/discussions" target = "_blank" > Github Discussions< / a > to read previous questions and answers or to ask new questions. If you want, you can also share your project there if you are using the ReactPhysics3D library.
2021-12-28 21:16:17 +00:00
2021-12-31 14:22:03 +00:00
## :warning: Issues
2015-02-16 21:36:45 +00:00
2021-12-31 14:31:40 +00:00
If you find any issue with the library, you can report it on the issue tracker < a href = "https://github.com/DanielChappuis/reactphysics3d/issues" target = "_blank" > here< / a > .
2019-01-22 22:02:24 +00:00
2021-12-31 14:22:03 +00:00
## :man: Author
2021-12-28 21:16:17 +00:00
2021-12-31 14:31:40 +00:00
The ReactPhysics3D library has been created and is maintained by < a href = "https://github.com/DanielChappuis" target = "_blank" > Daniel Chappuis< / a > .
2021-12-28 21:16:17 +00:00
2021-12-31 14:22:03 +00:00
## :copyright: License
2021-12-28 21:16:17 +00:00
2021-12-31 14:31:40 +00:00
The ReactPhysics3D library is released under the open-source < a href = "http://opensource.org/licenses/zlib" target = "_blank" > ZLib license< / a > .
2021-12-28 21:16:17 +00:00
2021-12-31 14:22:03 +00:00
## :+1: Sponsorship
2021-12-28 21:16:17 +00:00
2021-12-31 14:31:40 +00:00
If you are using this library and want to support its development, you can sponsor it < a href = "https://github.com/sponsors/DanielChappuis" target = "_blank" > here< / a > .
2021-12-28 21:16:17 +00:00
2021-12-31 14:22:03 +00:00
## :clap: Credits
2019-01-22 22:02:24 +00:00
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.
2021-12-31 14:22:03 +00:00
Thanks to all the contributors that have reported issues or have taken the time to send pull requests.
2021-11-30 21:19:54 +00:00
- [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))
