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
+18-19Lines changed: 18 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,13 +22,13 @@ Try out the [Phaser Test Suite](http://gametest.mobi/phaser/)
22
22
Welcome to Phaser
23
23
-----------------
24
24
25
-
It's staggering to think just how much has been achieved in the short time the 1.0 branch of Phaser has been available. We've seen literally hundreds of bug fixes and updates. Exciting new features and enhancements have been merged into the core library thanks to contributions from the community. We also completely overhauled the Examples Suite, removed the requirement for PHP, rebuilt it in html+js and filled it with over 150 examples to dig in to and learn from. And more importantly we've got our first pass at the API docs online and ready too.
25
+
It's staggering to think just how much has been achieved in the short time Phaser has been alive. We've implemented literally hundreds of bug fixes and updates, thanks to the effort the community puts in to reporting issues they find. Exciting new features have been merged into the core and we revisited old ones and pimped them out. We also completely overhauled the Examples Suite, removed the requirement for PHP, rebuilt it and filled it with over 150 examples to dig in and learn from. And more importantly we've got our first pass at the API docs ready too.
26
26
27
-
There is still more to be done of course. The API docs, while a good start, still need to be backed up with a proper comprehensive manual. And we desperately need to write some 'best practises' and 'getting started' tutorials. But at least now you don't have to flounder around in the dark and can turn to the examples and docs.
27
+
There is still more to be done of course. The API docs, while a good start, are lacking in places and still need to be backed up with a proper comprehensive manual. And we desperately need to write some 'best practises' and 'getting started' tutorials too. But we hope you appreciate the amount of effort that has been put in by the team so far.
28
28
29
-
There are so many exciting new features and tweaks in this build that we felt it warranted a proper full point release: 1.1. A few things have also changed, so games that were in development in the 1.0 version may need refactoring for 1.1, but we feel those changes have benefitted the framework as a whole.
29
+
There are many exciting new features and tweaks in this build that we felt it warranted a proper point release, hence the shift to version 1.1. Because of several core changes games that were in development in a 1.0.x version of Phaser may need refactoring for 1.1, but we feel those changes have helped the framework grow and mature as a whole.
30
30
31
-
As before "Thank you!" to everyone who has encouraged us along the way. To those of you who worked with Phaser during its various incarnations, and who released full games with it despite there being zero API documentation available: you are our heroes. It's your kind words and enthusiasm, as well as our commercial need for Phaser that has kept us going.
31
+
As before we offer a heart-felt "Thank you!" to everyone who has encouraged us along the way. To those of you who worked with Phaser during its various incarnations, and who released full games with it despite there being zero API documentation available: you are our heroes. It's your kind words and enthusiasm that has kept us going.
32
32
33
33
Phaser is everything we ever wanted from an HTML5 game framework. It powers all of our client work in build today and remains our single most important product, and we've only just scratched the surface of what we have planned for it.
34
34
@@ -42,6 +42,7 @@ Version 1.1
42
42
43
43
* JSDoc is go! We've added jsdoc3 blocks to every property and function, in every file.
44
44
* Brand new Example system (no more php!) and over 150 examples to learn from too.
45
+
* New TypeScript definitions file generated (in the build folder).
45
46
* Added World.postUpdate - all sprite position changes, as a result of physics, happen here before the render.
46
47
* Complete overhaul of Physics.Arcade.Body - now significantly more stable and faster too.
47
48
* Updated ArcadePhysics.separateX/Y to use new body system - much better results now.
@@ -134,6 +135,10 @@ Version 1.1
134
135
* Added AnimationManager.refreshFrame - will reset the texture being used for a Sprite (useful after a crop rect clear)
135
136
* You can now null a Sprite.crop and it will clear down the crop rect area correctly.
136
137
* The default Game.antialias value is now 'true', so graphics will be smoothed automatically in canvas. Disable it via the Game constructor or Canvas utils.
138
+
* Added Physics.overlap(sprite1, sprite2) for quick body vs. body overlap tests with no separation performed.
139
+
* Fixed Issue 111 - calling Kill on a Phaser.Graphics instance causes error on undefined events.
140
+
141
+
137
142
138
143
Outstanding Tasks
139
144
-----------------
@@ -145,14 +150,13 @@ Outstanding Tasks
145
150
* TODO: Sound.addMarker hh:mm:ss:ms
146
151
* TODO: swap state (non-destructive shift)
147
152
* TODO: rotation offset
148
-
* TODO: check stage bgc on droid (http://www.html5gamedevs.com/topic/1629-stage-background-color-not-working-on-android-chrome/)
149
153
150
154
Requirements
151
155
------------
152
156
153
157
Games created with Phaser require a modern web browser that supports the canvas tag. This includes Internet Explorer 9+, Firefox, Chrome, Safari and Opera. It also works on mobile web browsers including stock Android 2.x browser and above and iOS5 Mobile Safari and above.
154
158
155
-
For developing with Phaser you can use either a plain-vanilla JavaScript approach or [TypeScript](https://typescript.codeplex.com/). We made no assumptions about how you like to code your games, and were careful not to impose any form of class/inheritance/structure upon you.
159
+
For developing with Phaser you can use either a plain-vanilla JavaScript approach or [TypeScript](https://typescript.codeplex.com/) using the provided TypeScript definitions file. We made no assumptions about how you like to code your games, and were careful not to impose any form of class/inheritance/structure upon you.
156
160
157
161
Phaser is 275 KB minified and 62 KB gzipped.
158
162
@@ -226,11 +230,6 @@ Although Phaser 1.0 is a brand new release it is born from years of experience b
* The TypeScript definition file isn't yet complete.
233
-
234
233
Future Plans
235
234
------------
236
235
@@ -248,20 +247,20 @@ The following list is not exhaustive and is subject to change:
248
247
* Flash CC html output support.
249
248
* Game parameters read from Google Docs.
250
249
251
-
Test Suite
252
-
----------
250
+
Learn By Example
251
+
----------------
253
252
254
-
Phaser comes with an ever growing Test Suite. Personally we learn better by looking at small refined code examples, so we create lots of them to test each new feature we add. Inside the Tests folder you'll find the current set. If you write a particularly good test then please send it to us.
253
+
Phaser comes with an ever growing suite of Examples. Personally I feel that we learn better by looking at small refined code examples, so we created over 150 of them and create new ones to test every new feature added. Inside the `examples` folder you'll find the current set. If you write a particularly good example then please send it to us.
255
254
256
-
The tests need running through a local web server (to avoid file access permission errors from your browser).
255
+
The examples need running through a local web server (to avoid file access permission errors from your browser).
257
256
258
-
Make sure you can browse to the Tests folder via your web server. If you've got php installed then launch:
257
+
Browse to the examples folder via your web server.
259
258
260
-
examples/index.php
259
+
examples/index.html
261
260
262
-
Right now the Test Suite requires PHP, but we will remove this requirement soon.
261
+
There is a new 'Side View' example viewer as well. This loads all the examples into a left-hand frame for faster navigation.
263
262
264
-
You can also browse the[Phaser Test Suite](http://gametest.mobi/phaser/) online.
263
+
You can also browse all[Phaser Examples](http://gametest.mobi/phaser/) online.
0 commit comments