-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathindex.html
More file actions
107 lines (70 loc) · 5.03 KB
/
index.html
File metadata and controls
107 lines (70 loc) · 5.03 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Home</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Home</h1>
<h3> </h3>
<section>
<article><h1>SplatJS</h1><p>A 2d HTML5 Canvas game engine</p>
<p>SplatJS is a 2d game engine made for creating multi-platform games entirely in JavaScript.</p>
<h1>Features</h1><ul>
<li>Rectangles!</li>
<li>Keyboard, mouse, and touch input</li>
<li>Sounds and music (Web Audio API and HTML5 Audio)</li>
<li>Sprite animation</li>
<li>Asset loading, and built-in loading screen</li>
<li>Games work well on phones, tablets, and desktop browsers.</li>
<li>A* Pathfinding</li>
<li>Particles</li>
</ul>
<h1>Supported Platforms</h1><ul>
<li>Chrome (desktop & mobile)</li>
<li>Firefox</li>
<li>Internet Explorer (desktop & mobile)</li>
<li>Safari (desktop & mobile)</li>
<li>iOS using <a href="http://impactjs.com/ejecta">Ejecta</a></li>
<li>Chrome Web Store</li>
</ul>
<p>SplatJS works in PhoneGap/Cordova, but it seems like the apps it produces lack hardware acceleration, making games unplayable.</p>
<h1>Download a standalone SplatJS:</h1><ul>
<li>3.1.0 <a href="https://splatjs.github.io/download/splat-3.1.0.js">uncompressed</a> - <a href="https://splatjs.github.io/download/splat-3.1.0.min.js">minified</a></li>
</ul>
<h1>Install through <a href="https://www.npmjs.org">NPM</a></h1><pre class="prettyprint source"><code>$ npm install --save splatjs</code></pre><p>Then require SplatJS into your game:</p>
<pre class="prettyprint source"><code>var Splat = require("splat");</code></pre><p>Then use <a href="http://browserify.org/">browserify</a> to bundle your game as a single JavaScript file for the browser.</p>
<h1>Games using SplatJS</h1><ul>
<li><a href="https://github.com/SplatJS/splatpong">Splat Pong</a> is a good tutorial project to read through.</li>
<li><a href="http://twoscoopgames.com/syrush/">SyRUSH</a></li>
<li><a href="http://twoscoopgames.com/stanleysqueaks/">Stanley Squeaks and the Emerald Burrito</a></li>
<li><a href="http://twoscoopgames.com/fluffykins/">Mr. Fluffykin's Great Sorting Adventure</a></li>
<li><a href="http://mintchipleaf.com/games/ludum/">Arkeynoid</a></li>
<li><a href="http://twoscoopgames.com/kickbot/">Kickbot</a></li>
<li><a href="http://mintchipleaf.com/games/basejump/">base.jump</a></li>
<li><a href="http://twoscoopgames.com/apartment213/">Apartment 213</a></li>
<li><a href="http://twoscoopgames.com/scurry/">Scurry</a></li>
<li><a href="http://mintchipleaf.com/games/echobat/">Echo Bat</a></li>
</ul>
<p>Send a pull request to add your game to the list!</p></article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-buffer.html">buffer</a></li><li><a href="module-KeyMap.html">KeyMap</a></li></ul><h3>Externals</h3><ul><li><a href="external-AudioContext.html">AudioContext</a></li><li><a href="external-canvas.html">canvas</a></li><li><a href="external-CanvasRenderingContext2D.html">CanvasRenderingContext2D</a></li><li><a href="external-image.html">image</a></li></ul><h3>Classes</h3><ul><li><a href="Accelerometer.html">Accelerometer</a></li><li><a href="Animation.html">Animation</a></li><li><a href="AnimationLoader.html">AnimationLoader</a></li><li><a href="FontLoader.html">FontLoader</a></li><li><a href="ImageLoader.html">ImageLoader</a></li><li><a href="Keyboard.html">Keyboard</a></li><li><a href="Mouse.html">Mouse</a></li><li><a href="SceneManager.html">SceneManager</a></li><li><a href="SoundLoader.html">SoundLoader</a></li><li><a href="Splat.AnimatedEntity.html">AnimatedEntity</a></li><li><a href="Splat.AStar.html">AStar</a></li><li><a href="Splat.BinaryHeap.html">BinaryHeap</a></li><li><a href="Splat.Camera.html">Camera</a></li><li><a href="Splat.Entity.html">Entity</a></li><li><a href="Splat.EntityBoxCamera.html">EntityBoxCamera</a></li><li><a href="Splat.Game.html">Game</a></li><li><a href="Splat.math.Random.html">Random</a></li><li><a href="Splat.NinePatch.html">NinePatch</a></li><li><a href="Splat.Scene.html">Scene</a></li><li><a href="Splat.Timer.html">Timer</a></li></ul><h3>Namespaces</h3><ul><li><a href="Splat.html">Splat</a></li><li><a href="Splat.ads.html">ads</a></li><li><a href="Splat.leaderboards.html">leaderboards</a></li><li><a href="Splat.math.html">math</a></li><li><a href="Splat.saveData.html">saveData</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Thu Sep 17 2015 23:22:42 GMT-0400 (EDT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>