foster/liabru-matter-js
0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2024-11-27 09:50:52 -05:00
Code Issues Wiki Activity

updated readme

Browse source
This commit is contained in:
liabru 2015-01-22 23:13:21 +00:00
parent 16733ad6dd
commit d2dcc774bd
1 changed files with 51 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

88
README.md
View file

@ -10,37 +10,50 @@
### Demos ### Demos
- [Mixed Shapes](http://brm.io/matter-js-demo#mixed) <table>
- [Solid Shapes](http://brm.io/matter-js-demo#mixedSolid) <tr>
- [Newton's Cradle](http://brm.io/matter-js-demo#newtonsCradle) <td>
- [Wrecking Ball](http://brm.io/matter-js-demo#wreckingBall) <ul>
- [Slingshot Game](http://brm.io/matter-js-demo#slingshot) <li><a href="http://brm.io/matter-js-demo#mixed">Mixed Shapes</a></li>
- [Rounded Corners (Chamfering)](http://brm.io/matter-js-demo#rounded) <li><a href="http://brm.io/matter-js-demo#mixedSolid">Solid Shapes</a></li>
- [Views](http://brm.io/matter-js-demo/#views) <li><a href="http://brm.io/matter-js-demo#newtonsCradle">Newton's Cradle</a></li>
- [Time Scaling](http://brm.io/matter-js-demo/#timescale) <li><a href="http://brm.io/matter-js-demo#wreckingBall">Wrecking Ball</a></li>
- [Raycasting](http://brm.io/matter-js-demo/#raycasting) <li><a href="http://brm.io/matter-js-demo#slingshot">Slingshot Game</a></li>
- [Sprites](http://brm.io/matter-js-demo/#sprites) <li><a href="http://brm.io/matter-js-demo#rounded">Rounded Corners</a></li>
- [Pyramid](http://brm.io/matter-js-demo#pyramid) <li><a href="http://brm.io/matter-js-demo/#views">Views</a></li>
- [Car](http://brm.io/matter-js-demo#car) <li><a href="http://brm.io/matter-js-demo/#timescale">Time Scaling</a></li>
- [Catapult](http://brm.io/matter-js-demo#catapult) <li><a href="http://brm.io/matter-js-demo/#raycasting">Raycasting</a></li>
- [Reverse Gravity](http://brm.io/matter-js-demo#gravity) <li><a href="http://brm.io/matter-js-demo/#sprites">Sprites</a></li>
- [Bridge](http://brm.io/matter-js-demo#bridge) <li><a href="http://brm.io/matter-js-demo#pyramid">Pyramid</a></li>
- [Avalanche](http://brm.io/matter-js-demo#avalanche) <li><a href="http://brm.io/matter-js-demo#car">Car</a></li>
- [Basic Soft Bodies](http://brm.io/matter-js-demo#softBody) <li><a href="http://brm.io/matter-js-demo#catapult">Catapult</a></li>
- [Cloth](http://brm.io/matter-js-demo#cloth) <li><a href="http://brm.io/matter-js-demo#gravity">Reverse Gravity</a></li>
- [Events](http://brm.io/matter-js-demo/#events) <li><a href="http://brm.io/matter-js-demo#bridge">Bridge</a></li>
- [Chains](http://brm.io/matter-js-demo#chains) <li><a href="http://brm.io/matter-js-demo#avalanche">Avalanche</a></li>
- [Ball Pool](http://brm.io/matter-js-demo#ballPool) </ul>
- [Stack](http://brm.io/matter-js-demo#stack) </td>
- [Circle Stack](http://brm.io/matter-js-demo#circleStack) <td>
- [Restitution](http://brm.io/matter-js-demo#restitution) <ul>
- [Friction](http://brm.io/matter-js-demo#friction) <li><a href="http://brm.io/matter-js-demo#softBody">Basic Soft Bodies</a></li>
- [Air Friction](http://brm.io/matter-js-demo#airFriction) <li><a href="http://brm.io/matter-js-demo#cloth">Cloth</a></li>
- [Sleeping](http://brm.io/matter-js-demo#sleeping) <li><a href="http://brm.io/matter-js-demo/#events">Events</a></li>
- [Grid Broadphase](http://brm.io/matter-js-demo#broadphase) <li><a href="http://brm.io/matter-js-demo#chains">Chains</a></li>
- [Beach Balls](http://brm.io/matter-js-demo#beachBalls) <li><a href="http://brm.io/matter-js-demo#ballPool">Ball Pool</a></li>
- [Stress 1](http://brm.io/matter-js-demo#stress) <li><a href="http://brm.io/matter-js-demo#stack">Stack</a></li>
- [Stress 2](http://brm.io/matter-js-demo#stress2) <li><a href="http://brm.io/matter-js-demo#circleStack">Circle Stack</a></li>
<li><a href="http://brm.io/matter-js-demo#restitution">Restitution</a></li>
<li><a href="http://brm.io/matter-js-demo#friction">Friction</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#sleeping">Sleeping</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#beachBalls">Beach Balls</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#stress2">Stress 2</a></li>
</ul>
<br>
</td>
</tr>
</table>
### Features ### Features
@ -70,11 +83,9 @@
### Install ### Install
Download the [latest release](https://github.com/liabru/matter-js/releases) and include the script in your web page: Download the [edge build (master)](https://github.com/liabru/matter-js/blob/master/build/matter.js) or get a [stable release](https://github.com/liabru/matter-js/releases) and include the script in your web page:
<script src="matter-0.8.0.js" type="text/javascript"></script> <script src="matter.js" type="text/javascript"></script>
For the latest features try the [edge version (master)](https://raw.github.com/liabru/matter-js/master/build/matter.js), but it may not be fully stable.
You can also install using the package managers [Bower](http://bower.io/search/?q=matter-js) and [NPM](https://www.npmjs.org/package/matter-js). You can also install using the package managers [Bower](http://bower.io/search/?q=matter-js) and [NPM](https://www.npmjs.org/package/matter-js).
@ -85,12 +96,15 @@ 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>
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/) 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
See the [Matter.js API Docs (v0.8.0)](http://brm.io/matter-js-docs/). Edge build documentation is at [Matter.js API Docs (master)](http://brm.io/matter-js-docs-master/)<br>
<br>If you're using the [edge version (master)](https://raw2.github.com/liabru/matter-js/master/build/matter.js) then see the [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-master/)
### Status ### Status