0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2024-11-27 09:50:52 -05:00
A 2D rigid body physics engine for the web.
Find a file
2019-09-15 19:50:51 +01:00
build release 0.14.2 2018-06-11 23:15:03 +01:00
demo changed demo to auto populate examples with sourceLink and init 2019-09-15 18:36:26 +01:00
examples changed demo to auto populate examples with sourceLink and init 2019-09-15 18:36:26 +01:00
src fix lint issues 2019-09-15 18:43:28 +01:00
test changed example tests to use jest 2019-09-14 19:31:31 +01:00
.eslintignore added .eslintignore 2017-11-30 00:13:17 +00:00
.eslintrc added webpack build script 2019-09-14 18:38:33 +01:00
.gitignore changed example tests to use jest 2019-09-14 19:31:31 +01:00
.travis.yml updated ci 2019-09-15 19:01:34 +01:00
bower.json release 0.14.2 2018-06-11 23:15:03 +01:00
CHANGELOG.md release 0.14.2 2018-06-11 23:15:03 +01:00
CONTRIBUTING.md changed demo to serve without sub-directory 2019-09-15 18:34:04 +01:00
Gulpfile.js removed yuidocjs dev dependency 2019-09-15 19:50:51 +01:00
LICENSE updated license and contributing 2017-05-09 00:46:03 +01:00
package-lock.json removed yuidocjs dev dependency 2019-09-15 19:50:51 +01:00
package.json removed yuidocjs dev dependency 2019-09-15 19:50:51 +01:00
README.md updated readme 2017-03-07 22:20:07 +00:00
webpack.config.js changed demo to serve without sub-directory 2019-09-15 18:34:04 +01:00
webpack.examples.config.js added webpack build script 2019-09-14 18:38:33 +01:00
yuidoc.json removed yuidocjs dev dependency 2019-09-15 19:50:51 +01:00

Matter.js

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

brm.io/matter-js

Demos - Gallery - Features - Plugins - Install - Usage - Examples - Docs - Wiki - References - License

Build Status

Demos


See how others are using matter.js physics

Features

  • Rigid bodies
  • Compound bodies
  • Composite bodies
  • Concave and convex hulls
  • Physical properties (mass, area, density etc.)
  • Restitution (elastic and inelastic collisions)
  • Collisions (broad-phase, mid-phase and narrow-phase)
  • Stable stacking and resting
  • Conservation of momentum
  • Friction and resistance
  • Events
  • Constraints
  • Gravity
  • Sleeping and static bodies
  • Plugins
  • Rounded corners (chamfering)
  • Views (translate, zoom)
  • Collision queries (raycasting, region tests)
  • Time scaling (slow-mo, speed-up)
  • Canvas renderer (supports vectors and textures)
  • MatterTools for creating, testing and debugging worlds
  • World state serialisation (requires resurrect.js)
  • Cross-browser and Node.js support (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

Visit the Getting started wiki page for a minimal usage example which should work in both browsers and Node.js.
Also see the Running and Rendering wiki pages, which show how to use your own game and rendering loops.

Tutorials

See the list of tutorials.

Examples

See the examples directory which contains the source for all demos.
There are even more examples on codepen.

Plugins

The engine can be extended through plugins, see these resources:

Documentation

See the API Documentation and the wiki

Building and Contributing

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

npm install

This will install the required build dependencies, then run

gulp dev

to spawn a development server. For information on contributing see CONTRIBUTING.md.

Changelog

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

References

See the wiki page on References.

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.