You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-31Lines changed: 29 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,18 +8,15 @@ Phaser is a fast, free and fun open source HTML5 game framework. It uses [Pixi.j
8
8
9
9
Along with the fantastic open source community Phaser is actively developed and maintained by [Photon Storm Limited](http://www.photonstorm.com). As a result of rapid support and a developer friendly API Phaser is currently one of the [most starred](https://github.com/showcases/javascript-game-engines) game frameworks on Github.
10
10
11
-
Thousands of developers worldwide use it. From indies to multi-national digital agencies. Each creating their own incredible games. Grab the source and join in the fun!
12
-
13
-
* The [official website](http://phaser.io)
14
-
*[Twitter](https://twitter.com/photonstorm) (feel free to use #phaserjs when tweeting)
15
-
*[API Documentation](http://docs.phaser.io)
16
-
*[Support Forum][forum]
17
-
* 400+ [Code Examples](http://examples.phaser.io) (also available in this [git repo][examples])
18
-
* Subscribe to the [Phaser Newsletter](https://confirmsubscription.com/h/r/369DE48E3E86AF1E)
*[#phaserio IRC channel](http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/) on freenode
22
-
* Please support our work via [Gratipay](https://gratipay.com/photonstorm/)
11
+
Thousands of developers worldwide use it. From indies and multi-national digital agencies to schools and Universities. Each creating their own incredible games. Grab the source and join in the fun!
12
+
13
+
***Visit:** The [Phaser website](http://phaser.io) and follow on [Twitter](https://twitter.com/photonstorm) (feel free to use #phaserjs)
14
+
***Learn:**[API Documentation](http://docs.phaser.io), [Support Forum][forum] and [StackOverflow](http://stackoverflow.com/questions/tagged/phaser-framework)
15
+
***Code:** 400+ [Source Examples](http://examples.phaser.io) (also available in this [git repo][examples])
16
+
***Read:** Subscribe to the [Newsletter](https://confirmsubscription.com/h/r/369DE48E3E86AF1E) and grab our [Phaser Books](https://leanpub.com/u/photonstorm)
17
+
***Chat:**[#phaserio IRC channel](http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/) on freenode
18
+
***Extend:** With [Phaser Plugins](https://github.com/photonstorm/phaser-plugins)
19
+
***Be awesome:** Support our work via [Gratipay](https://gratipay.com/photonstorm/)
@@ -180,13 +177,13 @@ Phaser is released under the [MIT License](http://opensource.org/licenses/MIT).
180
177
181
178
We have a [Getting Started Guide](http://phaser.io/getting-started-js.php) which covers all you need to begin developing games with Phaser. From setting up a web server to picking an IDE to coding your first game.
182
179
183
-
Lynda.com have published a free **video course**: [HTML5 Game Development with Phaser](http://www.lynda.com/Phaser-tutorials/HTML5-Game-Development-Phaser/163641-2.html)
180
+
Prefer **videos** to reading? Lynda.com have published a free course: [HTML5 Game Development with Phaser](http://www.lynda.com/Phaser-tutorials/HTML5-Game-Development-Phaser/163641-2.html)
184
181
185
-
We wrote a comprehensive [How to Learn Phaser](http://gamedevelopment.tutsplus.com/articles/how-to-learn-the-phaser-html5-game-engine--gamedev-13643) guide for GameDevTuts+ which covers finding tutorials, examples and support.
182
+
Use the [How to Learn Phaser](http://gamedevelopment.tutsplus.com/articles/how-to-learn-the-phaser-html5-game-engine--gamedev-13643) guide we wrote for GameDevTuts+. It covers finding tutorials, examples and support.
186
183
187
-
Although it's currently a bit of a "wall of text" we urge you to check out the **News** section of the [Phaser web site](http://phaser.io). You'll find fresh links *daily* including loads of tutorials.
184
+
Although currently a bit of a "wall of text" we urge you to check out the **News** section of the [Phaser web site](http://phaser.io). You'll find fresh links posted there *daily*.
188
185
189
-
If you're using Phaser with TypeScript then we'd strongly recommend this great series of tutorials on [Game From Scratch](http://www.gamefromscratch.com/page/Adventures-in-Phaser-with-TypeScript-tutorial-series.aspx).
186
+
Using Phaser with **TypeScript**? Then we strongly recommend this great series of [Game From Scratch](http://www.gamefromscratch.com/page/Adventures-in-Phaser-with-TypeScript-tutorial-series.aspx) tutorials.
190
187
191
188
### Source Code Examples
192
189
@@ -203,7 +200,7 @@ We've been busy writing books about Phaser. Available now:
203
200
*[A Guide to the Phaser Tween Manager](https://leanpub.com/phasertweenmanager) Book + Code Bundle
204
201
*[A Guide to the Phaser Scale Manager](https://leanpub.com/phaserscalemanager)
205
202
206
-
With more on the way. [Vote on the next title](http://www.html5gamedevs.com/topic/10962-which-phaser-book-would-you-like-to-see-next/)!
203
+
With more on the way. [Vote on the next title](http://www.html5gamedevs.com/topic/10962-which-phaser-book-would-you-like-to-see-next/) to be written.
207
204
208
205
### Game Mechanic Explorer
209
206
@@ -220,7 +217,7 @@ The [Game Mechanic Explorer](http://gamemechanicexplorer.com) is a great interac
220
217
221
218
Phaser is provided ready compiled in the `build` folder of the repository. There are both plain and minified versions. The plain version is for use during development and the minified version for production.
222
219
223
-
This current release of Phaser is 153 KB *gzipped and minified* with both **Arcade Physics** and **P2 Physics** included. We also provide streamlined custom builds.
220
+
This current release of Phaser is 153 KB *gzipped and minified* with both **Arcade Physics** and **P2 Physics** included. We also provide smaller custom builds.
224
221
225
222
### Custom Builds
226
223
@@ -232,9 +229,9 @@ If you don't require P2 then use the custom build: `phaser-arcade-physics.js`. T
232
229
233
230
If you don't need physics at all, or are implementing your own, there is an even smaller build: `phaser-no-physics.js`. This doesn't include Tilemaps or Particle Emitter support either, as both rely on Arcade Physics, but is even smaller as a result.
234
231
235
-
Finally there is `phaser-no-libs.js` which is Phaser without any physics support or Pixi.js. Phaser requires Pixi.js to work, but this build allows you to use your own version of Pixi instead of using the one Phaser provides.
232
+
Finally there is `phaser-no-libs.js` which is Phaser without any physics support *or* Pixi.js. Phaser requires Pixi.js to work, but this build allows you to use your own version of Pixi instead of the one Phaser provides.
236
233
237
-
See the manifests files in the `tasks` folder to create your own custom builds.
234
+
Want to create your own custom builds? Take a look at the manifests files in the `tasks` folder.
238
235
239
236
### Building from source
240
237
@@ -266,7 +263,7 @@ Thousands of games have been made in Phaser. From game jam entries to titles for
Find lots more on the [HTML5 Game Devs Forum](http://www.html5gamedevs.com/forum/8-game-showcase/).
272
269
@@ -328,9 +325,9 @@ Here are some of the features planned for future releases. Not all are promised
328
325
329
326
Development has begun on Phaser 3. At the moment it's still in the very early stages. We are asking for suggestions and feedback in [this forum thread](http://www.html5gamedevs.com/topic/7949-the-phaser-3-wishlist-thread/) so be sure to add your voice.
330
327
331
-
We are currently experimenting with an ES6 based module system and we're keen for Phaser 3 to use as many native ES6 features as possible. It will be a significant refactoring of the code base, but never at the expense of features or ease-of-use. Development will be made public when the time is right.
328
+
We are currently experimenting with an ES6 based module system and we're keen for Phaser 3 to use as many native ES6 features as possible. It will be a significant refactoring of the code base, but never at the expense of features or ease-of-use.
332
329
333
-
We don't anticipate a release until Summer 2015. Phaser 2 still has roadmap features left that we'd like to implement, but after 2.3 it will be in maintenance mode as we work on Phaser 3.
330
+
We don't anticipate a release until Summer 2015 and will support Phaser 2 fully in the meantime.
334
331
335
332
If you are an exceptional JavaScript developer and would like to join the Phaser 3 development team then let us know. We have a limited budget available to pay towards your time.
336
333
@@ -345,23 +342,24 @@ Please read the [Contributors Guide][contribute] for full details on helping wit
345
342
346
343
- Pull Requests should only be made against the `dev` branch. *Never* against `master`.
347
344
348
-
- Before submitting a Pull Request run your code through [JSHint](http://www.jshint.com/). Use our grunt JSHint task and config.
345
+
- Before submitting a Pull Request run your code through [JSHint](http://www.jshint.com/) using our [config](https://github.com/photonstorm/phaser/blob/master/.jshintrc).
349
346
350
-
- Before contributing, please read the [code of conduct](https://github.com/photonstorm/phaser/blob/master/CODE_OF_CONDUCT.md).
347
+
- Before contributing please read the [code of conduct](https://github.com/photonstorm/phaser/blob/master/CODE_OF_CONDUCT.md).
351
348
352
-
Written something cool that shows Phaser in use? Please tell us about it!
353
-
Post it to our [forum][forum] or email: rich@photonstorm.com
349
+
Written something cool that shows Phaser in use? Please tell us about it in our [forum][forum] or email: rich@photonstorm.com
0 commit comments