phsim v0.3.0-alpha

phsim

PhSim (which stands for "Physics Simulator") is a library built by @mjduniverse that runs on top of Matter.js. PhSim allows one to easily create a physics simulation without much hassle. PhSim could be used to create games as well..

• GitHub Repository
• Distribution Downloads
• Readme
• Documentation

Demos

To get a clearer picture of what PhSim is and what it does, I have provided you demos. Here is an example of a PhSim simulation's code:

var o = {
    "objUniverse": [

        // Platform

        {
            "shape": "rectangle",
            "x": 25,
            "y": 528,
            "w": 749,
            "h": 47,
            "strokeStyle": "#0000ff",
            "lineWidth": 4,
            "fillStyle": "#333333",
            "locked": true
        },

        // Green rectangle

        {
            "shape": "rectangle",
            "x": 367,
            "y": 231,
            "w": 91,
            "h": 93,
            "strokeStyle": "#000000",
            "lineWidth": 4,
            "fillStyle": "#33cf33",
            "widgets": [
                {
                    "type": "keyboardControls",
                    "up": 10,
                    "down": 10,
                    "left": 10,
                    "right": 10
                }
            ]
        }
    ],
    "name": "Untitled Layer"
};

var phSim = new PhSim(o);

phSim.play();

To see it in action, you can view the demo here (it is the second simulation): https://mjduniverse.github.io/phsim/docs/tutorial-Creating%20PhSim%20Simulation.html

Installation

PhSim requires the libaries Matter.js and poly-decomp. Download them and then include them in your page. After doing that, look for a release to download. However, you could also download the bleeding edge build, which might be unstable.

After downloading it, you should include it into your desired HTML file. If you put the files in a directory named js, then include these tags in the html page:

<script src="./js/decomp.min.js"></script>
<script src="./js/matter.min.js"></script>
<script src="./js/phsim.min.js"></script>

If you are using PhSim in a project, including phsim.js instead might make it easier to develop, as it retains the JSDoc comments and the code is not minified.

In addition, the latest stable build is avaliable as an NPM module: https://www.npmjs.com/package/phsim. One can install PhSim by executing npm install phsim if they have NPM installed on their computer.

Some of the features:

Rendering

PhSim has a in-built renderer known as PhRender. It allows one to add gradients and sprites to objects. Sprites are stored in a catche object called PhSim.Sprites.spriteImgObj.

Widgets

A widget is something that extends the functionality of widgets and simulations. There are widgets that make objects undergo various forms of motion. The PhSim.Widgets namespace contains the built in widgets of the library. Here are some widgets that are built into the library:

• Constraints: Constraints make objects constrained to an object or a point. They can be added using the constraint widget.

• Circular Constraints: Circular Constraints can be added using the circularConstraints widget

• Motion Widgets: Various forms of motion, such as rotation, velocity, position change, accelration, force and more can be triggered by widgets.

• Audio: Audio can be played using the playAudio widget.

• wFunctions: Special functions known as wFunctions that allow one to deal with events and time in an easier way.

• Draggable Objects:: Objects can be dragged by the mouse using the draggable widget

Making games

One can create basic games on PhSim using the PhSim.Game object. The library provides widgets that make objects act as coins, health and hazards. However, one can build their own game engine if they do not like the in built one.