https://github.com/mikewesthad/phaser-matter-collision-plugin

A plugin for making it easier to manage collisions with Phaser 3 + Matter.js
https://github.com/mikewesthad/phaser-matter-collision-plugin

Last synced: 13 days ago
JSON representation

A plugin for making it easier to manage collisions with Phaser 3 + Matter.js

• Host: GitHub
• URL: https://github.com/mikewesthad/phaser-matter-collision-plugin
• Owner: mikewesthad
• License: mit
• Created: 2018-08-10T20:06:10.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-04-29T02:22:22.000Z (about 1 year ago)
• Last Synced: 2024-03-14T20:53:42.667Z (4 months ago)
• Language: CSS
• Homepage:
• Size: 5.61 MB
• Stars: 97
• Watchers: 4
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• gamedev-awesome - phaser-matter-collision-plugin

README

        
# Phaser Matter Collision Plugin 💥 

A plugin for making it easier to manage collisions with the [Phaser](https://phaser.io/) game engine and the [Matter.js](http://brm.io/matter-js/) physics engine.

Matter is one of the cool physics engine choices you have in Phaser 3. Phaser has a thin wrapper over Matter's API, so you need to dig into Matter's native collision event system if you want to detect and respond to collisions. That system just gives you a dump of all the pairs of bodies that collided in a tick of the engine. This plugin wraps up that collision logic in a more useful way:

```js

const player = this.matter.add.sprite(0, 0, "player");

const trapDoor = this.matter.add.sprite(200, 0, "door");

this.matterCollision.addOnCollideStart({

  objectA: player,

  objectB: trapDoor,

  callback: () => console.log("Player touched door!")

});

```

Or in a slightly more complicated example:

[![](./doc-source-assets/collision-simple-demo.gif)](https://raw.githubusercontent.com/mikewesthad/phaser-matter-collision-plugin/master/doc-source-assets/collision-simple-demo.gif)

_See interactive versions of that example on CodeSandbox in [JavaScript](https://codesandbox.io/s/0o0917m23l) or [TypeScript](https://codesandbox.io/s/my3oyyqj39)._

If you are reading this on Github or NPM, check out the full HTML documentation [here](https://mikewesthad.github.io/phaser-matter-collision-plugin/docs/).

## Info

This repository uses yarn workspaces to keep the plugin source code together with some example JavaScript and TypeScript projects. See the individual workspaces for more info on each:

- `workspaces/plugin`

- `workspaces/javascript-example`

- `workspaces/typescript-example`

- `workspaces/javascript-no-module-example`

If you are looking for the plugin readme, you can find it [here](https://github.com/mikewesthad/phaser-matter-collision-plugin/tree/master/workspaces/plugin).

## Development

If you are contributing to this library, here is how to get started:

- Install [Node](https://nodejs.org/en/).

- `npm install --global yarn`.

- Open the root folder of this repository and run `yarn` to install and link dependencies.

- Head to the workspace you plan to work on and use `yarn run XYZ` to run a script from that workspace.