mirror of
https://github.com/photonstorm/phaser
synced 2024-11-27 07:01:20 +00:00
readme updates
This commit is contained in:
parent
2449c71331
commit
9135b05ff7
1 changed files with 15 additions and 11 deletions
26
README.md
26
README.md
|
@ -2,8 +2,6 @@
|
||||||
|
|
||||||
# Phaser 2.0.4
|
# Phaser 2.0.4
|
||||||
|
|
||||||
![hr](http://phaser.io/images/ghdiv1.png)
|
|
||||||
|
|
||||||
Phaser is a fast, free and fun open source game framework for making desktop and mobile browser HTML5 games. It uses [Pixi.js](https://github.com/GoodBoyDigital/pixi.js/) internally for fast 2D Canvas and WebGL rendering.
|
Phaser is a fast, free and fun open source game framework for making desktop and mobile browser HTML5 games. It uses [Pixi.js](https://github.com/GoodBoyDigital/pixi.js/) internally for fast 2D Canvas and WebGL rendering.
|
||||||
|
|
||||||
Version: 2.0.4 "Mos Shirare" - Released: 29th April 2014
|
Version: 2.0.4 "Mos Shirare" - Released: 29th April 2014
|
||||||
|
@ -18,12 +16,10 @@ By Richard Davey, [Photon Storm](http://www.photonstorm.com)
|
||||||
* Join our [#phaserio IRC channel](http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/) on freenode
|
* Join our [#phaserio IRC channel](http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/) on freenode
|
||||||
* Subscribe to the [Phaser Newsletter](https://confirmsubscription.com/h/r/369DE48E3E86AF1E) and we'll email you when new versions are released.
|
* Subscribe to the [Phaser Newsletter](https://confirmsubscription.com/h/r/369DE48E3E86AF1E) and we'll email you when new versions are released.
|
||||||
|
|
||||||
![hr](http://phaser.io/images/ghdiv2.png)
|
![div](http://phaser.io/images/div4.png)
|
||||||
|
|
||||||
## Welcome to Phaser and What's new in 2.0.4?
|
## Welcome to Phaser and What's new in 2.0.4?
|
||||||
|
|
||||||
![hr](http://phaser.io/images/ghdiv1.png)
|
|
||||||
|
|
||||||
We've had the vast majority of this version ready for a few days now, but held off releasing due to Ludum Dare 48. Ludum Dare contests are always peak times for Phaser, we see an influx of new devs downloading for the first time. So it's not the best day to release a new version :) Now that LD48 has finished we present Phaser 2.0.4. This is the latest version in our bi-weekly sprint release schedule, and the change log is (which you can see in full below) is significant to say the least.
|
We've had the vast majority of this version ready for a few days now, but held off releasing due to Ludum Dare 48. Ludum Dare contests are always peak times for Phaser, we see an influx of new devs downloading for the first time. So it's not the best day to release a new version :) Now that LD48 has finished we present Phaser 2.0.4. This is the latest version in our bi-weekly sprint release schedule, and the change log is (which you can see in full below) is significant to say the least.
|
||||||
|
|
||||||
We've made some deep internal changes to how game pause and resume is handled, which means Phaser.Timers now behave themselves properly. Again with this version we've updated to the latet Pixi and P2 releases, bringing new features and enhancements with them. In terms of new features we've overhauled the Color, Point and BitmapData classes, with significant new features for each of them. From HSL palette shifting and color extraction, to Point dot products to proper endianess handling in Color, the new features are powerful additions to the library. We've also marked a bunch of methods as deprecated and will remove them in Phaser 2.1. Most have fully working replacements and you'll see them flagged as such in the API docs.
|
We've made some deep internal changes to how game pause and resume is handled, which means Phaser.Timers now behave themselves properly. Again with this version we've updated to the latet Pixi and P2 releases, bringing new features and enhancements with them. In terms of new features we've overhauled the Color, Point and BitmapData classes, with significant new features for each of them. From HSL palette shifting and color extraction, to Point dot products to proper endianess handling in Color, the new features are powerful additions to the library. We've also marked a bunch of methods as deprecated and will remove them in Phaser 2.1. Most have fully working replacements and you'll see them flagged as such in the API docs.
|
||||||
|
@ -38,12 +34,10 @@ Until then happy coding everyone! And we hope to see you on the forums.
|
||||||
|
|
||||||
![boogie](http://www.phaser.io/images/spacedancer.gif)
|
![boogie](http://www.phaser.io/images/spacedancer.gif)
|
||||||
|
|
||||||
![hr](http://phaser.io/images/ghdiv2.png)
|
![div](http://phaser.io/images/div1.png)
|
||||||
|
|
||||||
## Getting Started Guides
|
## Getting Started Guides
|
||||||
|
|
||||||
![hr](http://phaser.io/images/ghdiv1.png)
|
|
||||||
|
|
||||||
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. If you're new to HTML5 game development, or are coming from another language like AS3, then we recommend starting there.
|
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. If you're new to HTML5 game development, or are coming from another language like AS3, then we recommend starting there.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
@ -54,12 +48,12 @@ Finally the list of [community authored Phaser Tutorials](http://www.lessmilk.co
|
||||||
|
|
||||||
![Phaser Logo](http://www.photonstorm.com/wp-content/uploads/2013/09/phaser_10_release.jpg)
|
![Phaser Logo](http://www.photonstorm.com/wp-content/uploads/2013/09/phaser_10_release.jpg)
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div2.png)
|
||||||
|
|
||||||
## Change Log
|
## Change Log
|
||||||
|
|
||||||
Version 2.0.4 - "Mos Shirare" - 29th April 2014
|
Version 2.0.4 - "Mos Shirare" - 29th April 2014
|
||||||
|
|
||||||
|
|
||||||
### Updates
|
### Updates
|
||||||
|
|
||||||
* Updated to [Pixi.js 1.5.3](https://github.com/GoodBoyDigital/pixi.js/releases/tag/v1.5.3)
|
* Updated to [Pixi.js 1.5.3](https://github.com/GoodBoyDigital/pixi.js/releases/tag/v1.5.3)
|
||||||
|
@ -88,7 +82,6 @@ Version 2.0.4 - "Mos Shirare" - 29th April 2014
|
||||||
* Math.smoothstep and Math.smootherstep have been updated to work regardless if a is > or < b (thanks @gre, fix #772)
|
* Math.smoothstep and Math.smootherstep have been updated to work regardless if a is > or < b (thanks @gre, fix #772)
|
||||||
* Text.updateText now sets the lineCap to `round` to avoid occassional font glitching issues in Chrome.
|
* Text.updateText now sets the lineCap to `round` to avoid occassional font glitching issues in Chrome.
|
||||||
|
|
||||||
|
|
||||||
### New Features
|
### New Features
|
||||||
|
|
||||||
* New Phaser Project Template specifically for requireJS in the `resources/Project Templates` folder (many thanks @ashatch)
|
* New Phaser Project Template specifically for requireJS in the `resources/Project Templates` folder (many thanks @ashatch)
|
||||||
|
@ -146,7 +139,6 @@ Version 2.0.4 - "Mos Shirare" - 29th April 2014
|
||||||
* BitmapData.extract scans this BitmapData for all pixels matching the given r,g,b values and then draws them into the given destination BitmapData.
|
* BitmapData.extract scans this BitmapData for all pixels matching the given r,g,b values and then draws them into the given destination BitmapData.
|
||||||
* BitmapData.circle draws a filled Circle to the BitmapData at the given x, y coordinates and radius in size.
|
* BitmapData.circle draws a filled Circle to the BitmapData at the given x, y coordinates and radius in size.
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|
||||||
* The main Timer loop could incorrectly remove a TimerEvent if a new one was added specifically during an event callback (thanks @garyyeap, fix #710)
|
* The main Timer loop could incorrectly remove a TimerEvent if a new one was added specifically during an event callback (thanks @garyyeap, fix #710)
|
||||||
|
@ -178,6 +170,7 @@ There is an extensive [Migration Guide](https://github.com/photonstorm/phaser/bl
|
||||||
|
|
||||||
The full Change Log is at https://github.com/photonstorm/phaser/blob/master/CHANGELOG.md
|
The full Change Log is at https://github.com/photonstorm/phaser/blob/master/CHANGELOG.md
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div3.png)
|
||||||
|
|
||||||
## How to Build
|
## How to Build
|
||||||
|
|
||||||
|
@ -193,11 +186,13 @@ If you replace Pixi or p2 then run `grunt replace` to patch their UMD strings so
|
||||||
|
|
||||||
Note: Some of you may not be aware, but the `phaser.min.js` file in the build folder contains all 3 physics systems bundled in. If you only need Arcade Physics then you can use `build\custom\phaser-arcade-physics.min.js` instead. This will save you 180KB from the minified file size.
|
Note: Some of you may not be aware, but the `phaser.min.js` file in the build folder contains all 3 physics systems bundled in. If you only need Arcade Physics then you can use `build\custom\phaser-arcade-physics.min.js` instead. This will save you 180KB from the minified file size.
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div4.png)
|
||||||
|
|
||||||
## Koding
|
## Koding
|
||||||
|
|
||||||
You can [![clone the Phaser repo in Koding](http://learn.koding.com/btn/clone_d.png)][koding] and then start editing and previewing code right away using their web based VM development system.
|
You can [![clone the Phaser repo in Koding](http://learn.koding.com/btn/clone_d.png)][koding] and then start editing and previewing code right away using their web based VM development system.
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div5.png)
|
||||||
|
|
||||||
## Bower
|
## Bower
|
||||||
|
|
||||||
|
@ -209,6 +204,7 @@ Nice and easy :)
|
||||||
|
|
||||||
![Tanks](http://www.photonstorm.com/wp-content/uploads/2013/10/phaser_tanks-640x480.png)
|
![Tanks](http://www.photonstorm.com/wp-content/uploads/2013/10/phaser_tanks-640x480.png)
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div6.png)
|
||||||
|
|
||||||
## CDNJS
|
## CDNJS
|
||||||
|
|
||||||
|
@ -220,6 +216,7 @@ Or if you prefer you can leave the protocol off, so it works via http and https:
|
||||||
|
|
||||||
`//cdnjs.cloudflare.com/ajax/libs/phaser/2.0.4/phaser.min.js`
|
`//cdnjs.cloudflare.com/ajax/libs/phaser/2.0.4/phaser.min.js`
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div1.png)
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
|
@ -239,6 +236,7 @@ Phaser is 128 KB gzipped (576 KB minified) when including all 3 physics engines.
|
||||||
|
|
||||||
Note: The `phaser.min.js` file in the build folder contains all 3 physics systems bundled in. If you only need Arcade Physics then you can use `build\custom\phaser-arcade-physics.min.js` instead. This will save you 180 KB from the minified file size.
|
Note: The `phaser.min.js` file in the build folder contains all 3 physics systems bundled in. If you only need Arcade Physics then you can use `build\custom\phaser-arcade-physics.min.js` instead. This will save you 180 KB from the minified file size.
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div3.png)
|
||||||
|
|
||||||
## Learn By Example
|
## Learn By Example
|
||||||
|
|
||||||
|
@ -262,6 +260,7 @@ There is a 'Side View' example viewer as well. This loads all the examples into
|
||||||
|
|
||||||
You can also browse all [Phaser Examples](http://examples.phaser.io) online.
|
You can also browse all [Phaser Examples](http://examples.phaser.io) online.
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div4.png)
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
@ -332,6 +331,7 @@ Phaser has been used to create hundreds of games, which receive millions of play
|
||||||
|
|
||||||
![FruitParty](http://www.photonstorm.com/wp-content/uploads/2013/10/phaser_fruit_particles-640x480.png)
|
![FruitParty](http://www.photonstorm.com/wp-content/uploads/2013/10/phaser_fruit_particles-640x480.png)
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div6.png)
|
||||||
|
|
||||||
## Road Map
|
## Road Map
|
||||||
|
|
||||||
|
@ -363,11 +363,13 @@ Beyond version 2.0 here are some of the features planned for the future:
|
||||||
* Allow for complex assets like Bitmap Fonts to be stored within a texture atlas.
|
* Allow for complex assets like Bitmap Fonts to be stored within a texture atlas.
|
||||||
* Look at XDomainRequest for IE9 CORs issues.
|
* Look at XDomainRequest for IE9 CORs issues.
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div1.png)
|
||||||
|
|
||||||
## Nadion
|
## Nadion
|
||||||
|
|
||||||
[Nadion](https://github.com/jcd-as/nadion) is a set of powerful enhancements for Phaser that makes level building even easier. It includes features such as Trigger, Area, Alarms and Emitters, debug panels, state machines, parallax layer scrolling, 'developer mode' short-cuts and more.
|
[Nadion](https://github.com/jcd-as/nadion) is a set of powerful enhancements for Phaser that makes level building even easier. It includes features such as Trigger, Area, Alarms and Emitters, debug panels, state machines, parallax layer scrolling, 'developer mode' short-cuts and more.
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div2.png)
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
@ -383,6 +385,7 @@ We now have a full [Contributors Guide][contribute] which goes into the process
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/photonstorm/phaser.png?branch=dev)](https://travis-ci.org/photonstorm/phaser)
|
[![Build Status](https://travis-ci.org/photonstorm/phaser.png?branch=dev)](https://travis-ci.org/photonstorm/phaser)
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div3.png)
|
||||||
|
|
||||||
## Bugs?
|
## Bugs?
|
||||||
|
|
||||||
|
@ -392,6 +395,7 @@ Please add them to the [Issue Tracker][issues] with as much info as possible, es
|
||||||
|
|
||||||
"Being negative is not how we make progress" - Larry Page, Google
|
"Being negative is not how we make progress" - Larry Page, Google
|
||||||
|
|
||||||
|
![div](http://phaser.io/images/div4.png)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue