README.md

box2d-wasm

Box2D compiled to WebAssembly.

Showcase

• Shapes and rope
• Lunar Survey
  • Demonstrates custom gravity
• Fluid simulation
  • Uses liquidfun release
  • High-performance main loop
  • WebGL rendering

Usage

Install the box2d-wasm npm package

npm i box2d-wasm

Then check out the documentation.

Alternative distributions

For additional functionality:

• fluid simulation
• particle simulation
• soft-body collisions

You can install from the liquidfun branch like so:

npm i "box2d-wasm@npm:liquidfun-wasm@6.0.4-lf.1"

License

Zlib-licensed.
Links against MIT-licensed code from Erin Catto's Box2D.
Compiles Zlib-licensed code from Alon Zakai's box2d.js.

Project

Compared to the existing box2d.js package: box2d-wasm aims to support Box2D v2.4.0+ and TypeScript.

• Comparison with box2d.js
• Project aims

Developing in this monorepo

See README.dev.md.