foster/liabru-matter-js
0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2025-02-07 19:06:26 -05:00
Code Issues Wiki Activity

updated readme

Browse source
This commit is contained in:
liabru 2015-12-23 15:42:20 +00:00
parent dff0e30cbc
commit 8f2f8eea27
1 changed files with 56 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

103
README.md
View file

@ -4,7 +4,7 @@
[brm.io/matter-js](http://brm.io/matter-js) [brm.io/matter-js](http://brm.io/matter-js)
[Features](#features) - [Status](#status) - [Install](#install) - [Usage](#usage) - [Docs](http://brm.io/matter-js-docs/) - [Implementation](#implementation) - [References](#references) - [License](#license) [Features](#features) - [Install](#install) - [Usage](#usage) - [Docs](http://brm.io/matter-js-docs/) - [Implementation](#implementation) - [References](#references) - [License](#license)
[![Build Status](https://travis-ci.org/liabru/matter-js.png?branch=master)](https://travis-ci.org/liabru/matter-js) [![Build Status](https://travis-ci.org/liabru/matter-js.png?branch=master)](https://travis-ci.org/liabru/matter-js)
@ -14,41 +14,50 @@
<tr> <tr>
<td> <td>
<ul> <ul>
<li><a href="http://brm.io/matter-js-demo#mixed">Mixed Shapes</a></li> <li><a href="http://brm.io/matter-js-demo-master#mixed">Mixed Shapes</a></li>
<li><a href="http://brm.io/matter-js-demo#mixedSolid">Solid Shapes</a></li> <li><a href="http://brm.io/matter-js-demo-master#mixedSolid">Solid Shapes</a></li>
<li><a href="http://brm.io/matter-js-demo#newtonsCradle">Newton's Cradle</a></li> <li><a href="http://brm.io/matter-js-demo-master#svg">Concave SVG Paths</a></li>
<li><a href="http://brm.io/matter-js-demo#wreckingBall">Wrecking Ball</a></li> <li><a href="http://brm.io/matter-js-demo-master#terrain">Concave Terrain</a></li>
<li><a href="http://brm.io/matter-js-demo#slingshot">Slingshot Game</a></li> <li><a href="http://brm.io/matter-js-demo-master#concave">Concave Bodies</a></li>
<li><a href="http://brm.io/matter-js-demo#rounded">Rounded Corners</a></li> <li><a href="http://brm.io/matter-js-demo-master#compound">Compound Bodies</a></li>
<li><a href="http://brm.io/matter-js-demo/#views">Views</a></li> <li><a href="http://brm.io/matter-js-demo-master#newtonsCradle">Newton's Cradle</a></li>
<li><a href="http://brm.io/matter-js-demo/#timescale">Time Scaling</a></li> <li><a href="http://brm.io/matter-js-demo-master#wreckingBall">Wrecking Ball</a></li>
<li><a href="http://brm.io/matter-js-demo/#raycasting">Raycasting</a></li> <li><a href="http://brm.io/matter-js-demo-master#slingshot">Slingshot Game</a></li>
<li><a href="http://brm.io/matter-js-demo/#sprites">Sprites</a></li> <li><a href="http://brm.io/matter-js-demo-master#rounded">Rounded Corners</a></li>
<li><a href="http://brm.io/matter-js-demo#pyramid">Pyramid</a></li> <li><a href="http://brm.io/matter-js-demo-master#views">Views</a></li>
<li><a href="http://brm.io/matter-js-demo#car">Car</a></li> <li><a href="http://brm.io/matter-js-demo-master#timescale">Time Scaling</a></li>
<li><a href="http://brm.io/matter-js-demo#catapult">Catapult</a></li> <li><a href="http://brm.io/matter-js-demo-master#manipulation">Body Manipulation</a></li>
<li><a href="http://brm.io/matter-js-demo#gravity">Reverse Gravity</a></li> <li><a href="http://brm.io/matter-js-demo-master#compositeManipulation">Composite Manipulation</a></li>
<li><a href="http://brm.io/matter-js-demo#bridge">Bridge</a></li> <li><a href="http://brm.io/matter-js-demo-master#raycasting">Raycasting</a></li>
<li><a href="http://brm.io/matter-js-demo#avalanche">Avalanche</a></li> <li><a href="http://brm.io/matter-js-demo-master#sprites">Sprites</a></li>
<li><a href="http://brm.io/matter-js-demo-master#pyramid">Pyramid</a></li>
<li><a href="http://brm.io/matter-js-demo-master#car">Car</a></li>
<li><a href="http://brm.io/matter-js-demo-master#catapult">Catapult</a></li>
<li><a href="http://brm.io/matter-js-demo-master#gravity">Reverse Gravity</a></li>
</ul> </ul>
</td> </td>
<td> <td>
<ul> <ul>
<li><a href="http://brm.io/matter-js-demo#softBody">Basic Soft Bodies</a></li> <li><a href="http://brm.io/matter-js-demo-master#bridge">Bridge</a></li>
<li><a href="http://brm.io/matter-js-demo#cloth">Cloth</a></li> <li><a href="http://brm.io/matter-js-demo-master#avalanche">Avalanche</a></li>
<li><a href="http://brm.io/matter-js-demo/#events">Events</a></li> <li><a href="http://brm.io/matter-js-demo-master#softBody">Basic Soft Bodies</a></li>
<li><a href="http://brm.io/matter-js-demo#chains">Chains</a></li> <li><a href="http://brm.io/matter-js-demo-master#cloth">Cloth</a></li>
<li><a href="http://brm.io/matter-js-demo#ballPool">Ball Pool</a></li> <li><a href="http://brm.io/matter-js-demo-master#events">Events</a></li>
<li><a href="http://brm.io/matter-js-demo#stack">Stack</a></li> <li><a href="http://brm.io/matter-js-demo-master#collisionFiltering">Collision Filtering</a></li>
<li><a href="http://brm.io/matter-js-demo#circleStack">Circle Stack</a></li> <li><a href="http://brm.io/matter-js-demo-master#chains">Chains</a></li>
<li><a href="http://brm.io/matter-js-demo#restitution">Restitution</a></li> <li><a href="http://brm.io/matter-js-demo-master#ballPool">Ball Pool</a></li>
<li><a href="http://brm.io/matter-js-demo#friction">Friction</a></li> <li><a href="http://brm.io/matter-js-demo-master#stack">Stack</a></li>
<li><a href="http://brm.io/matter-js-demo#airFriction">Air Friction</a></li> <li><a href="http://brm.io/matter-js-demo-master#circleStack">Circle Stack</a></li>
<li><a href="http://brm.io/matter-js-demo#sleeping">Sleeping</a></li> <li><a href="http://brm.io/matter-js-demo-master#compoundStack">Compound Stack</a></li>
<li><a href="http://brm.io/matter-js-demo#broadphase">Grid Broadphase</a></li> <li><a href="http://brm.io/matter-js-demo-master#restitution">Restitution</a></li>
<li><a href="http://brm.io/matter-js-demo#beachBalls">Beach Balls</a></li> <li><a href="http://brm.io/matter-js-demo-master#friction">Friction</a></li>
<li><a href="http://brm.io/matter-js-demo#stress">Stress 1</a></li> <li><a href="http://brm.io/matter-js-demo-master#airFriction">Air Friction</a></li>
<li><a href="http://brm.io/matter-js-demo#stress2">Stress 2</a></li> <li><a href="http://brm.io/matter-js-demo-master#staticFriction">Static Friction</a></li>
<li><a href="http://brm.io/matter-js-demo-master#sleeping">Sleeping</a></li>
<li><a href="http://brm.io/matter-js-demo-master#broadphase">Grid Broadphase</a></li>
<li><a href="http://brm.io/matter-js-demo-master#beachBalls">Beach Balls</a></li>
<li><a href="http://brm.io/matter-js-demo-master#stress">Stress 1</a></li>
<li><a href="http://brm.io/matter-js-demo-master#stress2">Stress 2</a></li>
</ul> </ul>
<br> <br>
</td> </td>
@ -57,18 +66,20 @@
### Features ### Features
- Rigid bodies
- Compound bodies
- Composite bodies
- Concave and convex hulls
- Physical properties (mass, area, density etc.) - Physical properties (mass, area, density etc.)
- Rigid bodies of any convex polygon
- Stable stacking and resting
- Collisions (broad-phase, mid-phase and narrow-phase)
- Restitution (elastic and inelastic collisions) - Restitution (elastic and inelastic collisions)
- Collisions (broad-phase, mid-phase and narrow-phase)
- Stable stacking and resting
- Conservation of momentum - Conservation of momentum
- Friction and resistance - Friction and resistance
- Events
- Constraints - Constraints
- Gravity - Gravity
- Composite bodies
- Sleeping and static bodies - Sleeping and static bodies
- Events
- Rounded corners (chamfering) - Rounded corners (chamfering)
- Views (translate, zoom) - Views (translate, zoom)
- Collision queries (raycasting, region tests) - Collision queries (raycasting, region tests)
@ -96,21 +107,16 @@ You can also install using the package managers [Bower](http://bower.io/search/?
See the [Getting started](https://github.com/liabru/matter-js/wiki/Getting-started) wiki page for a minimal usage example. See the [Getting started](https://github.com/liabru/matter-js/wiki/Getting-started) wiki page for a minimal usage example.
Matter.js includes a sample renderer, but this is optional and it's easy to use your own.<br> Matter.js includes a sample renderer, but this is optional and it's easy to use your own.
See the [Rendering](https://github.com/liabru/matter-js/wiki/Rendering) wiki page for information, including on how to use your own custom game loop. See the [Rendering](https://github.com/liabru/matter-js/wiki/Rendering) wiki page for information, including on how to use your own custom game loop.
Check out the [demo page](http://brm.io/matter-js-demo/) for more examples and then refer to [Demo.js](https://github.com/liabru/matter-js/blob/master/demo/js/Demo.js) to see how they work. Some of the demos are also available on [codepen](http://codepen.io/collection/Fuagy/), where you can easily experiment with them. Check out the [demo page](http://brm.io/matter-js-demo-master/) for more examples and then refer to [Demo.js](https://github.com/liabru/matter-js/blob/master/demo/js/Demo.js) to see how they work. Some of the demos are also available on [codepen](http://codepen.io/collection/Fuagy/), where you can easily experiment with them.
### Documentation ### Documentation
Edge build documentation is at [Matter.js API Docs (master)](http://brm.io/matter-js-docs-master/)<br> Edge build documentation is at [Matter.js API Docs (master)](http://brm.io/matter-js-docs-master/)
Stable release documentation is at [Matter.js API Docs (v0.8.0)](http://brm.io/matter-js-docs/) Stable release documentation is at [Matter.js API Docs (v0.8.0)](http://brm.io/matter-js-docs/)
### Status
Matter.js is currently in *alpha* status, meaning the API is still in development and may change occasionally.<br>
The library is reasonably stable as-is, but it is not yet feature complete.
### Building and Contributing ### Building and Contributing
To build you must first install [node.js](http://nodejs.org/) and [gulp](http://gulpjs.com/), then run To build you must first install [node.js](http://nodejs.org/) and [gulp](http://gulpjs.com/), then run
@ -133,8 +139,7 @@ To see what's new or changed in the latest version, see the [changelog](https://
### Implementation ### Implementation
The technical details for physics nerds and game devs. The engine uses the following techniques:
<br>This engine is using the following techniques:
- Time-corrected position Verlet integrator - Time-corrected position Verlet integrator
- Adaptive grid broad-phase detection - Adaptive grid broad-phase detection
@ -159,7 +164,7 @@ See my post on [Game physics for beginners](http://brm.io/game-physics-for-begin
### License ### License
Matter.js is licensed under [The MIT License (MIT)](http://opensource.org/licenses/MIT) Matter.js is licensed under [The MIT License (MIT)](http://opensource.org/licenses/MIT)
<br/>Copyright (c) 2014 Liam Brummitt Copyright (c) 2014 Liam Brummitt
This license is also supplied with the release and source code. This license is also supplied with the release and source code.
<br/>As stated in the license, absolutely no warranty is provided. As stated in the license, absolutely no warranty is provided.