| 1 | # SplatJS
|
| 2 |
|
| 3 | A 2d HTML5 Canvas game engine
|
| 4 |
|
| 5 | SplatJS is a 2d game engine made for creating multi-platform games entirely in JavaScript.
|
| 6 |
|
| 7 | # Features
|
| 8 |
|
| 9 | * Rectangles!
|
| 10 | * Keyboard, mouse, and touch input
|
| 11 | * Sounds and music (Web Audio API and HTML5 Audio)
|
| 12 | * Sprite animation
|
| 13 | * Asset loading, and built-in loading screen
|
| 14 | * Games work well on phones, tablets, and desktop browsers.
|
| 15 | * A\* Pathfinding
|
| 16 | * Particles
|
| 17 |
|
| 18 | # Supported Platforms
|
| 19 |
|
| 20 | * Chrome (desktop & mobile)
|
| 21 | * Firefox
|
| 22 | * Internet Explorer (desktop & mobile)
|
| 23 | * Safari (desktop & mobile)
|
| 24 | * iOS using [Ejecta](http://impactjs.com/ejecta)
|
| 25 | * Chrome Web Store
|
| 26 |
|
| 27 | SplatJS works in PhoneGap/Cordova, but it seems like the apps it produces lack hardware acceleration, making games unplayable.
|
| 28 |
|
| 29 | # Download a standalone SplatJS:
|
| 30 |
|
| 31 | * 3.0.0 [uncompressed](https://splatjs.github.io/download/splat-3.0.0.js) - [minified](https://splatjs.github.io/download/splat-3.0.0.min.js)
|
| 32 |
|
| 33 | # Install through [NPM](https://www.npmjs.org)
|
| 34 |
|
| 35 | ```
|
| 36 | $ npm install --save splatjs
|
| 37 | ```
|
| 38 | Then require SplatJS into your game:
|
| 39 | ```
|
| 40 | var Splat = require("splat");
|
| 41 | ```
|
| 42 | Then use [browserify](http://browserify.org/) to bundle your game as a single JavaScript file for the browser.
|
| 43 |
|
| 44 | # Games using SplatJS
|
| 45 |
|
| 46 | * [Splat Pong](https://github.com/SplatJS/splatpong) is a good tutorial project to read through.
|
| 47 | * [SyRUSH](http://twoscoopgames.com/syrush/)
|
| 48 | * [Stanley Squeaks and the Emerald Burrito](http://twoscoopgames.com/stanleysqueaks/)
|
| 49 | * [Mr. Fluffykin's Great Sorting Adventure](http://twoscoopgames.com/fluffykins/)
|
| 50 | * [Arkeynoid](http://mintchipleaf.com/games/ludum/)
|
| 51 | * [Kickbot](http://twoscoopgames.com/kickbot/)
|
| 52 | * [base.jump](http://mintchipleaf.com/games/basejump/)
|
| 53 | * [Apartment 213](http://twoscoopgames.com/apartment213/)
|
| 54 | * [Scurry](http://twoscoopgames.com/scurry/)
|
| 55 | * [Echo Bat](http://mintchipleaf.com/games/echobat/)
|
| 56 |
|
| 57 | Send a pull request to add your game to the list!
|