UNPKG

1.73 kBMarkdownView Raw
1# SplatJS
2
3A 2d HTML5 Canvas game engine
4
5SplatJS is a 2d game engine made for creating multi-platform games entirely in JavaScript.
6
7# Features
8
9* Retangles!
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
17# Supported Platforms
18
19* Chrome (desktop & mobile)
20* Firefox
21* Internet Explorer (desktop & mobile)
22* Safari (desktop & mobile)
23* iOS using [Ejecta](http://impactjs.com/ejecta)
24* Chrome Web Store
25
26SplatJS works in PhoneGap/Cordova, but it seems like the apps it produces lack hardware acceleration, making games unplayable.
27
28# Download a standalone SplatJS:
29
30* 0.1.6 [uncompressed](https://splatjs.github.io/download/splat-0.1.6.js) - [minified](https://splatjs.github.io/download/splat-0.1.6.min.js)
31
32# Install through [NPM](https://www.npmjs.org)
33
34```
35$ npm install --save splatjs
36```
37Then require SplatJS into your game:
38```
39var Splat = require("splat");
40```
41Then use [browserify](http://browserify.org/) to bundle your game as a single JavaScript file for the browser.
42
43# Games using SplatJS
44
45* [Splat Pong](https://github.com/SplatJS/splatpong) is a good tutorial project to read through.
46* [Mr. Fluffykin's Great Sorting Adventure](http://twoscoopgames.com/fluffykins/)
47* [Arkeynoid](http://mintchipleaf.com/games/ludum/)
48* [Kickbot](http://twoscoopgames.com/kickbot/)
49* [base.jump](http://mintchipleaf.com/games/basejump/)
50* [Apartment 213](http://twoscoopgames.com/apartment213/)
51* [Scurry](http://twoscoopgames.com/scurry/)
52* [Echo Bat](http://mintchipleaf.com/games/echobat/)
53
54Send a pull request to add your game to the list!