README.md

matter-springs

A DHO springs plugin for matter.js

This plugin allows you to add Damped Harmonic Oscillator (DHO) springs to your project

Install

Get the matter-springs.js file directly

Dependencies

• matter.js

Usage

Matter.use('matter-springs');
// or
Matter.use(MatterSprings);

See Using Plugins for more information.

Basic usage

const circle = Bodies.circle(400, 300, 30, {density: 0.005});
World.add(world, circle);

world.plugin.springs = [
  Spring.create({
    bodyA: circle, 
    pointB: {x: 200, y: 200}, 
    stiffness: 0.5, 
    damping: 1
  })
]

Documentation

See the API docs.

Important Note

This code is actually wrong right now, since it doesn't take into account that the bodies maybe already be travelling at some velocity which is irrelevant to the spring. However, it is good enough for our use case (connecting a body B to a point A), so this will be fixed for 2 connected bodies at a later time.