reactphysics3d/README.md

[![Travis Build Status](https://travis-ci.org/DanielChappuis/reactphysics3d.svg?branch=master)](https://travis-ci.org/DanielChappuis/reactphysics3d)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3ae24e998e304e4da78ec848eade9e3a)](https://www.codacy.com/app/chappuis.daniel/reactphysics3d?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=DanielChappuis/reactphysics3d&amp;utm_campaign=Badge_Grade)
[![codecov.io](https://codecov.io/github/DanielChappuis/reactphysics3d/coverage.svg?branch=develop)](https://codecov.io/github/DanielChappuis/reactphysics3d?branch=develop)

## 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)

Author : Daniel Chappuis

<img src="https://raw.githubusercontent.com/DanielChappuis/reactphysics3d/master/documentation/UserManual/images/testbed.png" alt="Drawing" height="400" />

## Features

ReactPhysics3D has the following 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
    - Logs
    - 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)

## 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.

## Issues

If you find any issue with the library, you can report it on the issue tracker [here](https://github.com/DanielChappuis/reactphysics3d/issues).
Add Travis build status picture in README file 2015-07-12 09:59:33 +00:00			`[![Travis Build Status](https://travis-ci.org/DanielChappuis/reactphysics3d.svg?branch=master)](https://travis-ci.org/DanielChappuis/reactphysics3d)`
Update Readme file 2018-03-15 22:13:34 +00:00			`[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3ae24e998e304e4da78ec848eade9e3a)](https://www.codacy.com/app/chappuis.daniel/reactphysics3d?utm_source=github.com&utm_medium=referral&utm_content=DanielChappuis/reactphysics3d&utm_campaign=Badge_Grade)`
Update CMakeList.txt 2018-04-04 19:53:01 +00:00			`[![codecov.io](https://codecov.io/github/DanielChappuis/reactphysics3d/coverage.svg?branch=develop)](https://codecov.io/github/DanielChappuis/reactphysics3d?branch=develop)`
Add Travis build status picture in README file 2015-07-12 09:59:33 +00:00
Update Readme file 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)`

Modify Readme file 2015-03-02 19:28:37 +00:00			`Author : Daniel Chappuis`

Update Readme file 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" />`
Update Readme file 2016-04-14 20:49:58 +00:00
Update Readme file 2015-02-16 21:36:45 +00:00			`## Features`

			`ReactPhysics3D has the following features :`

Update Readme file 2018-03-15 22:13:34 +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`
			`- Integrated Profiler`
			`- Logs`
			`- Unit tests`
Update Readme file 2015-02-16 21:36:45 +00:00
			`## 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)`

Modification in Readme file 2015-03-02 19:43:47 +00:00			`## Branches`

Modification of the README file 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,`
Modification in Readme file 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.`

Update Readme file 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).`