odejs/README.md

3D physics engine

![Image of ODE](http://www.ode.org/pix2/odelogo.jpg)

# ODE.js
ODE is an high performance library for simulating rigid body dynamics, it has advanced joint types and integrated collision detection with friction. ODE is useful for simulating vehicles, objects in virtual reality environments and virtual creatures.

[Russell Smith](http://www.q12.org/) is the original author of **ODE**.

## New in V1.1.0 :
Since V1.1.0, **ODE** is compiled to [WebAssembly](https://webassembly.org/) through [emscripten](http://emscripten.org), this adds an asynchronous step, the API add a promise wich is resolved when ODE engine is ready! 

```HTML
    <script src="node_module/odejs/lib/libode.js"></script>
```
```JavaScript
    ODE.readyPromise.then(function() {

            var world = new ODE.World();
            [...]
    });
```

## Installation :
``` npm install odejs ```

## Online Examples :

**Babylon.js :**
 * [Boxstack](http://ricku34.github.io/ODE.js/examples/BabylonJs%20-%20boxstack.html) : Drop primitives & mesh object
 * [Chain](http://ricku34.github.io/ODE.js/examples/BabylonJs%20-%20chain.html) : simulate a chain using 30 rigid body with [Ball and Socket anchor joint](http://ode.org/ode-latest-userguide.html#sec_7_3_1)
 * [HeightField](http://ricku34.github.io/ODE.js/examples/BabylonJs%20-%20Heightmap.html) : Drop primitives & mesh object on HeightMap 
 * [Jeep](http://ricku34.github.io/ODE.js/examples/BabylonJs%20-%20Jeep.html) : simulate a jeep using  [Hinge-2 joint](http://ode.org/ode-latest-userguide.html#sec_7_3_5)
 * [Basket](http://ricku34.github.io/ODE.js/examples/BabylonJs%20-%20Basket.html) : play basketball using **triangleMesh collider**

**Three.js :**
 * [Boxstack](http://ricku34.github.io/ODE.js/examples/three.js%20-%20boxstack.html) : Drop random objects 

## Documentation :
A start of API documentation generated by [jsdoc](https://github.com/jsdoc3/jsdoc) can be found  [HERE](http://ricku34.github.io/ODE.js/docs/).
The original manual can be found at [http://ode.org/ode-latest-userguide.html](http://ode.org/ode-latest-userguide.html)