foster/liabru-matter-js
0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2024-12-24 13:29:01 -05:00
Code Issues Wiki Activity
A 2D rigid body physics engine for the web.
977 commits 9 branches 23 tags 24 MiB
JavaScript 100%
Find a file
liabru 6e15d2fe9a Merge branch 'master' into performance-2 
* master:
  update ci
  update ci
2024-03-03 23:26:55 +00:00
.github/workflows update ci 2024-03-03 23:24:36 +00:00
build release 0.19.0 2023-02-16 14:19:15 +00:00
demo fixed compare tool layer order in demo testbed 2024-02-14 22:40:10 +00:00
examples added body removal to Example.remove 2023-11-25 14:06:04 +00:00
src preserve pair.contacts order 2024-03-03 23:06:38 +00:00
test improve test comparison report 2024-03-03 21:01:45 +00:00
.eslintignore added .eslintignore 2017-11-30 00:13:17 +00:00
.eslintrc remove deprecated Matter.Metrics 2021-03-21 18:58:48 +00:00
.gitignore prevent source map in demo builds 2021-12-15 17:29:18 +00:00
CHANGELOG.md release 0.19.0 2023-02-16 14:19:15 +00:00
CONTRIBUTING.md add demo build config and refactor demo 2021-02-10 00:56:11 +00:00
LICENSE updated license and contributing 2017-05-09 00:46:03 +01:00
package-lock.json bump package lock 2024-03-03 21:09:46 +00:00
package.json improve test comparison report 2024-03-03 21:01:45 +00:00
README.md added readme note about vue watchers 2022-07-27 15:36:41 +01:00
RELEASE.md release 0.19.0 2023-02-16 14:19:15 +00:00
webpack.config.js changed tests to use a production build rather than source 2021-11-21 16:58:29 +00:00
webpack.demo.config.js change dev server source map mode 2022-11-19 15:24:58 +00:00
yuidoc.json changed docs build config 2020-12-05 23:06:02 +00:00

README.md

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

Gallery

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

You can install using package managers npm and Yarn using:

npm install matter-js

Alternatively you can download a stable release or try the latest experimental alpha build (master) and include the script in your web page:

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

Performance with other tools (e.g. Webpack, Vue etc.)

Bundlers and frameworks may reduce real-time performance when using their default configs, especially in development modes.

When using Webpack, the default sourcemap config can have a large impact, for a solution see issue.

When using Vue.js, watchers can have a large impact, for a solution see issue.

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, then run

npm install

This will install the required build dependencies, then run

npm run 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.