Matter.js Skill
Workflow
- Confirm environment (plain HTML, React, or canvas-only) and rendering approach (Matter.Render for debug vs custom renderer).
- Provide a minimal Engine/World/Render/Runner setup and add bodies.
- Add interactions (mouse constraint) or constraints only if requested.
- Share cleanup steps for SPA or teardown scenarios.
Minimal setup
<script>
const { Engine, Render, Runner, Bodies, Composite } = Matter;
const engine = Engine.create();
const render = Render.create({
element: document.body,
engine: engine,
options: {
width: 800,
height: 600,
wireframes: false
}
});
const runner = Runner.create();
Runner.run(runner, engine);
Render.run(render);
const ground = Bodies.rectangle(400, 610, 810, 60, { isStatic: true });
const box = Bodies.rectangle(400, 200, 80, 80);
Composite.add(engine.world, [ground, box]);
</script>
Common patterns
- Use
Composite.add(engine.world, [...]) to add bodies to the world.
- Use
Render.create({ element, engine }) to create a canvas automatically, or pass a canvas you create yourself.
- Set
render.options.wireframes = false for solid rendering.
- Use
Runner.run(runner, engine) for a simple loop, or call Engine.update in your own loop if you need custom timing.
Mouse interaction (optional)
const { Mouse, MouseConstraint } = Matter;
const mouse = Mouse.create(render.canvas);
const mouseConstraint = MouseConstraint.create(engine, { mouse });
Composite.add(engine.world, mouseConstraint);
render.mouse = mouse;
Cleanup checklist (SPA)
- Stop the runner with
Runner.stop(runner).
- Remove the render canvas from the DOM.
- Clear engine and world if needed.
Questions to ask when specs are missing
- What viewport size and scaling should the canvas use?
- Are we using Matter.Render or a custom renderer?
- Do you want mouse/touch drag interaction?
- Should the simulation loop be paused when offscreen?
1---2name: matterjs3description: Use when implementing 2D physics interactions with Matter.js, including Engine/World setup, Render/Runner configuration, adding bodies and constraints, and scroll/interaction-friendly canvas scenes.4metadata:5 source: https://skillmd.com/skills/mengto/matterjs6---78# Matter.js Skill910## Workflow111. Confirm environment (plain HTML, React, or canvas-only) and rendering approach (Matter.Render for debug vs custom renderer).122. Provide a minimal Engine/World/Render/Runner setup and add bodies.133. Add interactions (mouse constraint) or constraints only if requested.144. Share cleanup steps for SPA or teardown scenarios.1516## Minimal setup17```html18<script>19 const { Engine, Render, Runner, Bodies, Composite } = Matter;2021 const engine = Engine.create();2223 const render = Render.create({24 element: document.body,25 engine: engine,26 options: {27 width: 800,28 height: 600,29 wireframes: false30 }31 });3233 const runner = Runner.create();34 Runner.run(runner, engine);35 Render.run(render);3637 const ground = Bodies.rectangle(400, 610, 810, 60, { isStatic: true });38 const box = Bodies.rectangle(400, 200, 80, 80);3940 Composite.add(engine.world, [ground, box]);41</script>42```4344## Common patterns45- Use `Composite.add(engine.world, [...])` to add bodies to the world.46- Use `Render.create({ element, engine })` to create a canvas automatically, or pass a `canvas` you create yourself.47- Set `render.options.wireframes = false` for solid rendering.48- Use `Runner.run(runner, engine)` for a simple loop, or call `Engine.update` in your own loop if you need custom timing.4950## Mouse interaction (optional)51```js52const { Mouse, MouseConstraint } = Matter;53const mouse = Mouse.create(render.canvas);54const mouseConstraint = MouseConstraint.create(engine, { mouse });55Composite.add(engine.world, mouseConstraint);56render.mouse = mouse;57```5859## Cleanup checklist (SPA)60- Stop the runner with `Runner.stop(runner)`.61- Remove the render canvas from the DOM.62- Clear engine and world if needed.6364## Questions to ask when specs are missing65- What viewport size and scaling should the canvas use?66- Are we using Matter.Render or a custom renderer?67- Do you want mouse/touch drag interaction?68- Should the simulation loop be paused when offscreen?