foster/liabru-matter-js
0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2024-11-23 09:26:51 -05:00
Code Issues Wiki Activity
A 2D rigid body physics engine for the web.
352 commits 9 branches 23 tags 24 MiB
JavaScript 100%
Find a file
liabru 3ce6c3a017 fix travis
2015-08-04 19:51:28 +01:00
build updated edge build 2015-05-22 00:33:26 +01:00
demo added testDemo to grunt test 2015-08-04 00:37:40 +01:00
src added body sleepStart and sleepEnd events, closes #91 2015-05-24 15:56:54 +01:00
tests/browser updated browser test refs 2015-08-04 00:53:31 +01:00
.gitignore added testDemo to grunt test 2015-08-04 00:37:40 +01:00
.jshintrc demo tweaks 2015-05-03 17:47:52 +01:00
.npmignore publish to npm 2014-06-13 10:09:44 +01:00
.travis.yml fix travis 2015-08-04 19:51:28 +01:00
bower.json release 0.8.0 2014-05-05 19:32:51 +01:00
CHANGELOG.md release 0.8.0 2014-05-05 19:32:51 +01:00
CONTRIBUTING.md added CONTRIBUTING.md 2014-05-10 16:15:18 +01:00
Gruntfile.js added testDemo to grunt test 2015-08-04 00:37:40 +01:00
LICENSE initial commit 2014-02-19 14:15:05 +00:00
package.json implemented automated browser tests 2015-08-03 21:00:54 +01:00
README.md updated readme 2015-01-22 23:15:44 +00:00

README.md

Matter.js

Matter.js is a JavaScript 2D rigid body physics engine for the web

brm.io/matter-js

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

Build Status

Demos

Features

  • Physical properties (mass, area, density etc.)
  • Rigid bodies of any convex polygon
  • Stable stacking and resting
  • Collisions (broad-phase, mid-phase and narrow-phase)
  • Restitution (elastic and inelastic collisions)
  • Conservation of momentum
  • Friction and resistance
  • Constraints
  • Gravity
  • Composite bodies
  • Sleeping and static bodies
  • Events
  • Rounded corners (chamfering)
  • Views (translate, zoom)
  • Collision queries (raycasting, region tests)
  • Time scaling (slow-mo, speed-up)
  • Canvas renderer (supports vectors and textures)
  • WebGL renderer (requires pixi.js)
  • MatterTools for creating, testing and debugging worlds
  • World state serialisation (requires resurrect.js)
  • Cross-browser (Chrome, Firefox, Safari, IE8+)
  • Mobile-compatible (touch, responsive)
  • An original JavaScript physics implementation (not a port)

Install

Download the edge build (master) or get a stable release and include the script in your web page:

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

You can also install using the package managers Bower and NPM.

bower install matter-js
npm install matter-js

Usage

See the Getting started wiki page for a minimal usage example.

Matter.js includes a sample renderer, but this is optional and it's easy to use your own.
See the Rendering wiki page for information, including on how to use your own custom game loop.

Check out the demo page for more examples and then refer to Demo.js to see how they work. Some of the demos are also available on codepen, where you can easily experiment with them.

Documentation

Edge build documentation is at Matter.js API Docs (master)
Stable release documentation is at Matter.js API Docs (v0.8.0)

Status

Matter.js is currently in alpha status, meaning the API is still in development and may change occasionally.
The library is reasonably stable as-is, but it is not yet feature complete.

Building and Contributing

To build you must first install node.js and grunt, then run

npm install

This will install the required build dependencies, then run

grunt dev

which is a task that builds the matter-dev.js file, spawns a connect and watch server, then opens demo/dev.html in your browser. Any changes you make to the source will automatically rebuild matter-dev.js and reload your browser for quick and easy testing.

Contributions are welcome, please ensure they follow the same style and architecture as the rest of the code. You should run grunt test to ensure jshint gives no errors. Please do not include any changes to the files in the build directory.

If you'd like to contribute but not sure what to work on, feel free to message me. Thanks!

Changelog

To see what's new or changed in the latest version, see the changelog.

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 / WebGL 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.