@isaac-mason/jolt-physics v0.0.0-testing-type-changes-2023-04-16-1

JoltPhysics.js

This project enables using Jolt Physics in JavaScript.

Demos

• Falling Shapes Demo - Shows supported shape types.
• Constraints Demo - Shows supported constraint types.
• Stress Test Demo - Shows big pile of blocks.

Using

This library comes in 3 flavours:

• wasm-compat - A WASM version with the WASM file (encoded in base64) embedded in the bundle
• wasm - A WASM version with a separate WASM file
• asm - A JavaScript version that uses asm.js

See falling_shapes.html for a example on how to use the library.

Not all of the Jolt interface has been exposed yet. If you need something, just add it to JoltJS.idl and JoltJS.h and send a pull request.

Installation

This library is distributed as ECMAScript modules on npm:

npm install jolt-physics

The different flavours are available via entrypoints on the npm package:

// WASM embedded in the bundle
import Jolt from 'jolt-physics';
import Jolt from 'jolt-physics/wasm-compat';

// WASM
import Jolt from 'jolt-physics/wasm';

// asm.js
import Jolt from 'jolt-physics/asm';

You can also import esm bundles with unpkg:

<script type="module">
    // import latest
    import Jolt from 'https://www.unpkg.com/jolt-physics/dist/jolt-physics.wasm-compat.js';

    // or import a specific version
    import Jolt from 'https://www.unpkg.com/jolt-physics@0.0.2/dist/jolt-physics.wasm-compat.js';
</script>

Using the WASM flavour

To use the wasm flavour, you must either serve the WASM file jolt-physics.wasm.wasm alongside jolt-physics.wasm.js, or use a bundler that supports importing an asset as a url, and tell Jolt where to find the WASM file.

To specify where to retrieve the WASM file from, you can pass a locateFile function to the default export of jolt-physics/wasm. For example, using vite this would look like:

import initJolt from "jolt-physics";
import joltWasmUrl from "jolt-physics/jolt-physics.wasm.wasm?url";

const Jolt = await initJolt({
  locateFile: () => joltWasmUrl,
});

For more information on the locateFile function, see the Emscripten documentation.

Building

This project has only been compiled under Linux.

• Install emscripten and ensure that its environment variables have been setup
• Install cmake
• Run ./build.sh for the optimized build or ./build.sh Debug for the debug build

Running

By default the examples use the WASM version of Jolt. This requires serving the html file using a web server rather than opening the html file directly. Use e.g. serve to quickly host the file.

If you need to debug the C++ code take a look at WASM debugging.

Credits

This project was started from the Ammo.js code, but little remains of it as the Jolt Physics API is very different from the Bullet API.

License

The project is distributed under the MIT license.