reactphysics3d/README.md

52 lines
2.1 KiB
Markdown
Raw Normal View History

[![Travis Build Status](https://travis-ci.org/DanielChappuis/reactphysics3d.svg?branch=master)](https://travis-ci.org/DanielChappuis/reactphysics3d)
2015-02-16 21:36:45 +00:00
## ReactPhysics3D
ReactPhysics3D is an open source C++ physics engine library that can be used in 3D simulations and games.
Website : [http://www.reactphysics3d.com](http://www.reactphysics3d.com)
2015-03-02 19:28:37 +00:00
Author : Daniel Chappuis
2016-04-15 20:00:43 +00:00
<img src="https://raw.githubusercontent.com/DanielChappuis/reactphysics3d/master/documentation/UserManual/images/testbed.png" alt="Drawing" height="400" />
2016-04-14 20:49:58 +00:00
2015-02-16 21:36:45 +00:00
## Features
ReactPhysics3D has the following features :
- Rigid body dynamics
- Discrete collision detection
2016-04-14 20:33:31 +00:00
- Collision shapes (Sphere, Box, Cone, Cylinder, Capsule, Convex Mesh, static Concave Mesh, Height Field)
2015-02-16 21:36:45 +00:00
- Multiple collision shapes per body
- Broadphase collision detection (Dynamic AABB tree)
- Narrowphase collision detection (GJK/EPA)
- 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
- Integrated Profiler
- Multi-platform (Windows, Linux, Mac OS X)
2016-04-14 20:33:31 +00:00
- No dependencies (only OpenGL for the testbed application)
2015-02-16 21:36:45 +00:00
- Documentation (User manual and Doxygen API)
2016-04-14 20:33:31 +00:00
- Testbed application with demo scenes
2015-02-16 21:36:45 +00:00
- Unit tests
## License
The ReactPhysics3D library is released under the open-source [ZLib license](http://opensource.org/licenses/zlib).
## Documentation
You can find the User Manual and the Doxygen API Documentation [here](http://www.reactphysics3d.com/documentation.html)
2015-03-02 19:43:47 +00:00
## Branches
2015-04-08 20:09:58 +00:00
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,
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.
2015-02-16 21:36:45 +00:00
## Issues
If you find any issue with the library, you can report it on the issue tracker [here](https://github.com/DanielChappuis/reactphysics3d/issues).