foster/liabru-matter-js
0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2024-12-26 13:49:01 -05:00
Code Issues Wiki Activity
A 2D rigid body physics engine for the web.
25 commits 9 branches 23 tags 24 MiB
JavaScript 100%
Find a file
liabru 730d688699 added jsdoc for engine events
2014-03-11 01:16:20 +00:00
build added new build tasks for development build 2014-03-07 16:58:57 +00:00
demo added events example to dev demo 2014-03-10 21:57:38 +00:00
src added jsdoc for engine events 2014-03-11 01:16:20 +00:00
.gitignore added yuidoc build tasks 2014-02-28 18:23:25 +00:00
.jshintrc initial commit 2014-02-19 14:15:05 +00:00
.travis.yml added travis-ci integration 2014-02-28 18:38:39 +00:00
bower.json updated package files 2014-02-20 18:00:38 +00:00
Gruntfile.js added new build tasks for development build 2014-03-07 16:58:57 +00:00
LICENSE initial commit 2014-02-19 14:15:05 +00:00
package.json Add main field to package.json 2014-02-28 21:14:39 -08:00
README.md updated readme 2014-03-01 16:40:14 +00:00

README.md

Matter.js

Matter.js is a 2D rigid body physics engine for the web written in JavaScript (yes, another)

brm.io/matter-js

Build Status

Features - Status - Install - Usage - Docs - Implementation - References - License

Demos

Features

  • Physical properties (mass, area, density etc.)
  • Rigid bodies of any convex polygon
  • Stable stacking and resting
  • Restitution (elastic and inelastic collisions)
  • Conservation of momentum
  • Friction and resistance
  • Constraints
  • Gravity
  • Composite bodies
  • Sleeping and static bodies
  • Original JavaScript physics implementation (not a port)
  • HTML5 canvas renderer
  • Mobile-compatible (touch, scaleable)
  • Cross-browser (chrome, firefox, IE8+)
  • World state serialisation (requires resurrect.js)
  • Built in GUI for testing (requires dat.gui.js)
  • Time scaling (slow-mo, speed-up)
  • Broad-phase, mid-phase and narrow-phase collisions

Status

Matter.js is currently only alpha status, so production use should be avoided.

This engine is the result of learning game physics and getting a bit carried away.
There's no intention to compete with other engines, so I'm not sure yet if it will be developed further.
That said, the engine is reasonably stable and performs well, it's just not feature complete.

Though if I get time and people are interested, I may continue working on it.
Contributions are also welcome, if you'd like to help.

Install

Download matter.js or matter.min.js and include the script in your HTML file:

<script src="matter.js" type="text/javascript"></script>

Usage

See Demo.js and DemoMobile.js for many usage examples.
When loaded, all functions are under the global Matter.* namespace.

Documentation

See the Matter.js API Docs.

Implementation

The technical details for physics nerds and game devs.
This engine is using the following techniques:

  • Time-corrected position Verlet integrator
  • Adaptive grid broad-phase detection
  • AABB mid-phase detection
  • SAT narrow-phase detection
  • Iterative sequential impulse solver and position solver
  • Resting collisions with resting constraints ala Erin Catto's method (GDC08)
  • Temporal coherence impulse caching and warming
  • Collision pairs, contacts and impulses maintained with a pair manager
  • Approximate Coulomb friction model using friction constraints
  • Constraints solved with the Gauss-Siedel method
  • Semi-variable time step, synced with rendering
  • A basic sleeping strategy
  • HTML5 canvas renderer

References

See my post on Game physics for beginners.

License

Matter.js is licensed under The MIT License (MIT)
Copyright (c) 2014 Liam Brummitt

This license is also supplied with the release and source code.
As stated in the license, absolutely no warranty is provided.

Similar Projects

If you need a more complete engine, check out jswiki's list of Physics libraries