# This Project Is No Longer Being Updated

Breakouts is in "archival" mode. The website and repo will remain available, but no updates will be made. We will not accept any new pull requests or contributions at this point.

Thanks for all the help from everyone! If anyone wants to take over the project, please email me at matt.e.greer@gmail.com

![logo](https://raw.github.com/city41/breakouts/master/logo.png)

last updated: Dec-1-2013

## Helping You Select a JavaScript Game Engine

**tl;dr** Breakouts is to JavaScript game engines what [TodoMVC](http://todomvc.com) is to JavaScript MV\* frameworks.

There are a lot of JavaScript game engines out there, the JavaScript wiki lists [over 80 of them](https://github.com/bebraw/jswiki/wiki/Game-Engines). This project is an attempt to get some insight into the engines out there. This was done by implementing a simple version of the game Breakout in various engines. With the implementations in hand, you can compare and contrast and play with the engines to help get a feel for whether you like them or not.

### Companion Article
There is also a companion article to this project on [BuildNewGames](http://buildnewgames.com/game-engine-comparison/), which goes into detail on the first
three engines that were a part of Breakouts (Impact, Lime and Crafty).

## Breakouts So Far

So far we have Breakout implementations for

* [Crafty](http://craftyjs.com/)
* [CreateJS](http://www.createjs.com)
* [enchant.js](http://enchantjs.com/)
* [Entropy](https://github.com/tdzienniak/entropy)
* [FriGame](http://frigame.org/)
* [Frozen](http://frozenjs.com/)
* [ImpactJS](http://impactjs.com/)
* [KiwiJS](http://www.kiwijs.org)
* [LimeJS](http://www.limejs.com)
* [MelonJS](http://melonjs.org/)
* [Phaser](http://phaser.io)
* [Platypus](https://github.com/PBS-KIDS/Platypus)
* [Quintus](http://www.html5quintus.com/)
* [Stage.js](http://piqnt.com/stage.js/)

## About Breakout

The Breakouts generally look like this:

![screenshot](https://raw.github.com/city41/breakouts/master/breakoutScreenshot.png)

and feature:

* player input (mouse for desktop, touch for mobile)
* frame animation
* scene transitions (menus, game over, etc)
* sound effects
* hit detection
* text rendering

## Play the Breakouts

All of the Breakouts are up and playable at this project's [website](http://www.jsbreakouts.org/)

## Contribute

If you would like to contribute a Breakout implementation, great! Please head over to [the implementation guidelines](https://github.com/city41/breakouts/blob/master/ImplementationGuidelines.md) to get started.

If you have a bug fix, suggestion or anything for any existing implementations or the project as a whole, please send it in. You can fork and do a pull request, submit a defect, whatever makes sense.

## License

All of the various engines have their own licenses, but the Breakout code itself is MIT licensed. Generally speaking, feel free to do whatever you want with it.

This includes the [resources](https://github.com/city41/breakouts/tree/master/resources) (images, sounds, etc)

## Thanks!

Thanks to Addy Osmani, Sindre Sorhus and everyone else involved with TodoMVC for the idea and inspiration. Also thanks to [everyone who is contributing new implementations and suggestions](https://github.com/city41/breakouts/graphs/contributors)