mirror of
https://github.com/photonstorm/phaser
synced 2024-12-11 22:03:09 +00:00
364 lines
22 KiB
Markdown
364 lines
22 KiB
Markdown
|
|
|
|
# Phaser
|
|
|
|
<img src="http://phaser.io/images/github/jump.jpg" align="right">
|
|
|
|
Phaser is a fast, free and fun open source HTML5 game framework. It uses [Pixi.js](https://github.com/GoodBoyDigital/pixi.js/) for WebGL and Canvas rendering across desktop and mobile web browsers. Games can be compiled to iOS and Android apps via 3rd party tools.
|
|
|
|
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.
|
|
|
|
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!
|
|
|
|
* **Visit:** The [Phaser website](http://phaser.io) and follow on [Twitter](https://twitter.com/photonstorm) (#phaserjs)
|
|
* **Learn:** [API Documentation](http://phaser.io/docs), [Support Forum][forum] and [StackOverflow](http://stackoverflow.com/questions/tagged/phaser-framework)
|
|
* **Code:** 550+ [Source Examples](http://phaser.io/examples) (also available in this [git repo][examples])
|
|
* **Read:** Subscribe to the [Newsletter](https://confirmsubscription.com/h/r/369DE48E3E86AF1E) and grab our [Phaser Books](http://phaser.io/shop)
|
|
* **Chat:** [#phaserio IRC channel](http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/) on freenode
|
|
* **Extend:** With [Phaser Plugins](https://github.com/photonstorm/phaser-plugins)
|
|
* **Be awesome:** Support the future of Phaser on [Patreon](https://www.patreon.com/photonstorm) or by buying our [books](http://phaser.io/shop/books) and [plugins](http://phaser.io/shop/plugins)
|
|
|
|
|
|
|
|
## Index
|
|
|
|
- [What's New?](#whats-new)
|
|
- [Support Phaser](#patreon)
|
|
- [Download Phaser](#download)
|
|
- [Getting Started](#getting-started)
|
|
- [Using Phaser](#using-phaser)
|
|
- [Games made with Phaser](#games)
|
|
- [Requirements](#requirements)
|
|
- [Road Map](#road-map)
|
|
- [Change Log](#change-log)
|
|
- [Contributing](#contributing)
|
|
|
|
|
|
|
|
<a name="whats-new"></a>
|
|
## What's new in Phaser 2.4.4
|
|
|
|
<div align="center"><img src="http://phaser.io/images/github/news.jpg"></div>
|
|
|
|
> 24th August 2015
|
|
|
|
The release of Phaser 2.4.4 continues our work with bug fixes, new features and continued optimizations. As before it's a point-release, making it a safe upgrade for anyone using a previous 2.4 build.
|
|
|
|
As well as working on this release we've also been busily writing tutorials for the first issue of [Interphase](http://phaser.io/interphase/), our new publication for Phaser developers. Packed full of exclusive content we've been coding games, writing tutorials and authoring deep-dive articles for the first issue. It's been a blast so far and I'm excited for it's release in early September - and if you [pre-order now](http://phaser.io/interphase) with the discount code 'earlybird' you can save 15% on the cover price.
|
|
|
|
Finally we'd be extremely grateful if you could get involved with our [Phaser Patreon campaign](https://www.patreon.com/photonstorm). The uptake so far has been fantastic. Thank you to everyone who now supports Phaser development and shares our belief in the future of HTML5 gaming and Phasers role in that.
|
|
|
|
Happy coding everyone! See you on the forums.
|
|
|
|
Cheers,
|
|
|
|
Rich - [@photonstorm](https://twitter.com/photonstorm)
|
|
|
|
|
|
|
|
|
|
|
|
<a name="patreon"></a>
|
|
## Support Phaser on Patreon
|
|
|
|
|
|
|
|
Please help support the future development of Phaser through our [Patreon campaign](https://www.patreon.com/photonstorm). We've some exciting plans and there's so much we'd like to do. Let's see if we can all work together to make this possible.
|
|
|
|
### Phaser Sponsors
|
|
|
|
Phaser is [sponsored](https://www.patreon.com/photonstorm) by the following great companies:
|
|
|
|
|
|
|
|
QICI Engine: [A powerful one-stop integrated Phaser game editor](http://www.qiciengine.com/)
|
|
|
|
|
|
|
|
Zenva Academy: [Online courses on Phaser, HTML5 and native app development](https://academy.zenva.com/?zva_src=phaserpatreon)
|
|
|
|
<a name="download"></a>
|
|
## Download Phaser
|
|
|
|
Phaser is [hosted on Github][phaser]. There are a number of ways to download it:
|
|
|
|
* Clone the git repository via [https][clone-http], [ssh][clone-ssh] or with the Github [Windows][clone-ghwin] or [Mac][clone-ghmac] clients.
|
|
* Download as [zip][get-zip] or [tar.gz][get-tgz]
|
|
* Download just the build files: [phaser.js][get-js] and [phaser.min.js][get-minjs]
|
|
* Checkout with [svn][clone-svn]
|
|
|
|
### Bower / npm
|
|
|
|
Install via [bower](http://bower.io)
|
|
|
|
`bower install phaser`
|
|
|
|
Install via [npm](https://www.npmjs.com)
|
|
|
|
`npm install phaser`
|
|
|
|
### CDN
|
|
|
|
[jsDelivr](http://www.jsdelivr.com/#!phaser) is a "super-fast CDN for developers". Include the following in your html:
|
|
|
|
`<script src="//cdn.jsdelivr.net/phaser/2.4.4/phaser.js"></script>`
|
|
|
|
or the minified version:
|
|
|
|
`<script src="//cdn.jsdelivr.net/phaser/2.4.4/phaser.min.js"></script>`
|
|
|
|
[cdnjs.com](https://cdnjs.com/libraries/phaser) also offers a free CDN service. They have all versions of Phaser and even the custom builds:
|
|
|
|
`<script src="https://cdnjs.cloudflare.com/ajax/libs/phaser/2.4.4/phaser.js"></script>`
|
|
|
|
### Phaser Sandbox
|
|
|
|
If you'd like to try coding in Phaser right now, with nothing more than your web browser then you can head over to the [Phaser Sandbox](http://phaser.io/sandbox). You'll find Quick Start templates and a user-friendly editor filled with handy code-completion features.
|
|
|
|
### Koding
|
|
|
|
Want to try Phaser without downloading anything? The site [Koding](https://koding.com) offer a complete browser-based virtual machine to work in, allowing you to clone the Phaser repo and start work immediately.
|
|
|
|
### License
|
|
|
|
Phaser is released under the [MIT License](http://opensource.org/licenses/MIT).
|
|
|
|
|
|
|
|
<a name="getting-started"></a>
|
|
## Getting Started
|
|
|
|
<img src="http://phaser.io/images/github/learn.jpg" align="right">
|
|
|
|
We have a [Getting Started Guide](http://phaser.io/tutorials/getting-started) which covers all you need to begin developing games with Phaser. From setting up a web server, to picking an IDE and coding your first game.
|
|
|
|
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)
|
|
|
|
The single biggest Phaser resource is the new [Phaser web site](http://phaser.io/news). It has hundreds of tutorials listed and fresh ones are added every week, so keep coming back to see what's new!
|
|
|
|
Using Phaser with **TypeScript**? Check out this great series of [Game From Scratch](http://www.gamefromscratch.com/page/Adventures-in-Phaser-with-TypeScript-tutorial-series.aspx) tutorials.
|
|
|
|
### Source Code Examples
|
|
|
|
Ever since we started Phaser we've been growing and expanding our extensive set of source code examples. Currently there are over 500 of them!
|
|
|
|
Browse the [Phaser Examples](http://phaser.io/examples) or clone the [examples repo][examples] and eat your heart out!
|
|
|
|
### Phaser Books
|
|
|
|
<div align="center"><img src="http://phaser.io/images/github/books.jpg"></div>
|
|
|
|
We've been busy writing books about Phaser. Available now:
|
|
|
|
* [A Guide to the Phaser Tween Manager](https://leanpub.com/phasertweenmanager) Book + Code Bundle
|
|
* [A Guide to the Phaser Scale Manager](https://leanpub.com/phaserscalemanager)
|
|
|
|
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.
|
|
|
|
### Game Mechanic Explorer
|
|
|
|
The [Game Mechanic Explorer](http://gamemechanicexplorer.com) is a great interactive way to learn how to develop specific game mechanics in Phaser. Well worth exploring once you've got your dev environment set-up.
|
|
|
|
### Mighty Editor - Visual Game Editor
|
|
|
|
[MightyEditor](http://mightyfingers.com/) is a browser-based visual Phaser game editor. Create your maps with ease, position objects and share them in seconds. It also exports to native Phaser code. Excellent for quickly setting-up levels and scenes.
|
|
|
|
|
|
|
|
<a name="using-phaser"></a>
|
|
## Using Phaser
|
|
|
|
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.
|
|
|
|
### Custom Builds
|
|
|
|
Starting from Phaser 2.3.0 we now include a brand new build system which allows you to strip out lots of additional features you may not require, saving hundreds of KB in the process. Don't use any Sound in your game? Then you can now exclude the entire sound system. Don't need Keyboard support? That can be stripped out too.
|
|
|
|
As a result of this work the minimum build size of Phaser is now just 80KB minified and gzipped.
|
|
|
|
See the [Creating a Custom Phaser Build](http://phaser.io/tutorials/creating-custom-phaser-builds) tutorial for details.
|
|
|
|
### Building from source
|
|
|
|
Should you wish to build Phaser from source you can take advantage of the provided [Grunt](http://gruntjs.com/) scripts. Ensure you have the required packages by running `npm install` first.
|
|
|
|
Run `grunt` to perform a default build to the `dist` folder.
|
|
|
|
|
|
|
|
<a name="games"></a>
|
|
## Games made with Phaser
|
|
|
|
Thousands of games have been made in Phaser. From game jam entries to titles by some of the largest entertainment brands in the world. Here is a tiny sample:
|
|
|
|
[][game10]
|
|
[][game11]
|
|
[][game12]
|
|
[][game13]
|
|
[][game14]
|
|
[][game15]
|
|
[][game16]
|
|
[][game17]
|
|
[][game18]
|
|
[][game1]
|
|
[][game2]
|
|
[][game3]
|
|
[][game4]
|
|
[][game5]
|
|
[][game6]
|
|
[][game7]
|
|
[][game8]
|
|
[][game9]
|
|
|
|
Artwork copyright their respective owners.
|
|
|
|
We add [new games](http://phaser.io/news/category/game) to the Phaser site weekly, so be sure to send us yours when it's finished!
|
|
|
|
|
|
|
|
<a name="requirements"></a>
|
|
## Requirements
|
|
|
|
Phaser requires a web browser that supports the [canvas tag](http://caniuse.com/#feat=canvas). This includes Internet Explorer 9+, Firefox, Chrome, Safari and Opera on desktop. iOS Safari, Android Browser and Chrome for Android are supported on mobile.
|
|
|
|
While Phaser does its best to ensure a consistent cross-platform experience always be aware of browser and device limitations. This is especially important with regard to memory and GPU limitations on mobile, and legacy browser HTML5 compatibility.
|
|
|
|
### IE9
|
|
|
|
If you need to support IE9 / Android 2.x **and** use P2 physics then you must use the polyfill in the `resources/IE9 Polyfill` folder. If you don't use P2 (or don't care about IE9!) you can skip this.
|
|
|
|
### JavaScript and TypeScript
|
|
|
|
Phaser is developed in JavaScript. We've made no assumptions about how you like to code and were careful not to impose a strict structure upon you. You won't find Phaser split into modules, requiring a build step, or making you use a class / inheritance OOP approach. That doesn't mean you can't do so, it just means we don't *force* you to. It's your choice.
|
|
|
|
If you code with [TypeScript](http://www.typescriptlang.org/) there are comprehensive definition files in the `typescript` folder. They are for TypeScript 1.4+.
|
|
|
|
|
|
|
|
<a name="road-map"></a>
|
|
## Road Map
|
|
|
|
All Phaser development is now taking place on the Phaser 3 project. The Phaser 2 branch will still be supported and issues fixed, but roadmap features have been migrated over to Phaser 3.
|
|
|
|
<a name="phaser3"></a>
|
|
## Phaser 3
|
|
|
|
We're now a good way in to development of Phaser 3. We've been working hard on creating a brand new and extremely powerful renderer. Progress reports are posted to the [web site](http://phaser.io/labs) and [Phaser 3 repo](https://github.com/photonstorm/phaser3).
|
|
|
|
There is still plenty of time to add your suggestions and feedback in [this forum thread](http://www.html5gamedevs.com/topic/7949-the-phaser-3-wishlist-thread/).
|
|
|
|
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.
|
|
|
|
|
|
|
|
<a name="change-log"></a>
|
|
## Change Log
|
|
|
|
## Version 2.4.4 - "Amador" - in dev
|
|
|
|
### New Features
|
|
|
|
* Emitter.emitParticle now has 4 new optional arguments: `x`, `y`, `key` and `frame`. These allow you to override whatever the Emitter default values may be and emit the particle from the given coordinates and with a new texture.
|
|
* Group.resetChild is a new method that allows you to call both `child.reset` and/or `child.loadTexture` on the given child object. This is used internally by `getFirstDead` and similar, but is made public so you can use it as a group iteration callback. Note that the child must have public `reset` and `loadTexture` methods to be valid for the call.
|
|
* Group.getFirstDead, Group.getFirstAlive and Group.getFirstExists all have new optional arguments: `createIfNull`, `x`, `y`, `key` and `frame`. If the method you call cannot find a matching child (i.e. getFirstDead cannot find any dead children) then the optional `createIfNull` allows you to instantly create a new child in the group using the position and texture arguments to do so. This allows you to always get a child back from the Group and remove the need to do null checks and Group inserts from your game code. The same arguments can also be used in a different way: if `createIfNull` is false AND you provide the extra arguments AND a child is found then it will be passed to the new `Group.resetChild` method. This allows you to retrieve a child from the Group and have it reset and instantly ready for use in your game without any extra code.
|
|
* P2.Body.removeCollisionGroup allows you to remove the given CollisionGroup, or array of CollisionGroups, from the list of groups that a body will collide with and updates the collision masks (thanks @Garbanas #2047)
|
|
* Filter.addToWorld allows you to quickly create a Phaser.Image object at the given position and size, with the Filter ready applied to it. This can eliminate lots of duplicate code.
|
|
* Tiled 0.13.0 added support for layer data compression when exporting as JSON. This means that any .tmx stored using base64 encoding will start exporting layer data as a base64 encoded string rather than a native array. This update adds in automatic support for this as long as the data isn't compressed. For IE9 support you'll need to use the new polyfill found in the resources folder (thanks @noidexe #2084)
|
|
* You can now load single layer Pyxel Edit TileMaps as an atlas (thanks @joshpmcghee #2050)
|
|
|
|
### Updates
|
|
|
|
* TypeScript definitions fixes and updates (thanks @clark-stevenson @milkey-mouse @timotei @qdrj @Garbanas @cloakedninjas)
|
|
* Docs typo fixes (thanks @rwrountree @yeluoqiuzhi @pnstickne @fonsecas72)
|
|
* Math.average has been optimized (thanks @rwrountree #2025)
|
|
* When calling GameObject.revive the `heal` method is called to apply the health value, allowing it to take into consideration a `maxHealth` value if set (thanks @bsparks #2027)
|
|
* Change splice.call(arguments, ..) to use slice instead (thanks @pnstickne #2034 #2032)
|
|
* BitmapData.move, moveH and moveV have a new optional `wrap` argument allowing you to control if the contents of the BitmapData are wrapped around the edges (true) or simply scrolled off (false).
|
|
* Time.desiredFps has moved to a getter / setter.
|
|
* Time.physicsElapsed and Time.physicsElapsedMS are no longer calculated every frame, but only when the desiredFps is changed.
|
|
* Time.update has been streamlined and the `updateSetTimeout` and `updateRAF` methods merged and duplicate code removed.
|
|
* Time.desiredFpsMult is a pre-calculated multiplier used in Game.update.
|
|
* Time.refresh updates the `Time.time` and `Time.elapsedMS` values and is called automatically by Game.update.
|
|
* DeviceButton was setting a `duration` property on itself, which went against the read only getter of duration (thanks @winstonwolff)
|
|
* Added Node.js v4 stable to Travis config (thanks @phillipalexander #2070)
|
|
|
|
### Bug Fixes
|
|
|
|
* Loader.bitmapFont wouldn't automatically set the `atlasURL` value if just the key was given.
|
|
* The Loader would put the baseURL and/or path in front of `data:` and `blob` URLs (thanks @rblopes #2044)
|
|
* When the Text width was being calculated it would add the `strokeThickness` value twice, causing an alignment offset (thanks @nickryall #2039)
|
|
* Sound.onEndedHandler has a fix for AudioBufferSourceNode listener memory leak (thanks @Pappa #2069)
|
|
* Game.update could call `updateLogic` multiple times in a single frame when catching up with slow device frame rates. This would cause Tweens to advance at twice the speed they should have done (thanks @mkristo)
|
|
* Added useCapture flags to removeEventListener in MSPointer class (thanks @pmcmonagle #2055)
|
|
* Under setTimeOut (or when `forceSetTimeOut` was true) the Time was incorrectly setting `Time.timeExpected` causing game updates to lag (thanks @satan6 #2087)
|
|
|
|
For changes in previous releases please see the extensive [Version History](https://github.com/photonstorm/phaser/blob/master/CHANGELOG.md).
|
|
|
|
|
|
|
|
<a name="contributing"></a>
|
|
## Contributing
|
|
|
|
Please read the [Contributors Guide][contribute] for full details on helping with Phaser, but the main points are:
|
|
|
|
- Found a bug? Report it on [GitHub Issues][issues] and include a code sample.
|
|
|
|
- Pull Requests should only be made against the `dev` branch. *Never* against `master`.
|
|
|
|
- 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).
|
|
|
|
- Before contributing please read the [code of conduct](https://github.com/photonstorm/phaser/blob/master/CODE_OF_CONDUCT.md).
|
|
|
|
Written something cool that shows Phaser in use? Please tell us about it in our [forum][forum] or email: support@phaser.io
|
|
|
|
[](https://travis-ci.org/photonstorm/phaser)
|
|
|
|
|
|
|
|
|
|
|
|
Phaser is a [Photon Storm](http://www.photonstorm.com) production.
|
|
|
|
Created by [Richard Davey](mailto:rich@photonstorm.com). Powered by coffee, anime, pixels and love.
|
|
|
|
The Phaser logo and characters are © 2015 Photon Storm Limited.
|
|
|
|
All rights reserved.
|
|
|
|
"Above all, video games are meant to be just one thing: fun. Fun for everyone." - Satoru Iwata
|
|
|
|
[](https://github.com/igrigorik/ga-beacon)
|
|
|
|
[get-js]: https://github.com/photonstorm/phaser/releases/download/v2.4.4/phaser.js
|
|
[get-minjs]: https://github.com/photonstorm/phaser/releases/download/v2.4.4/phaser.min.js
|
|
[get-zip]: https://github.com/photonstorm/phaser/archive/v2.4.4.zip
|
|
[get-tgz]: https://github.com/photonstorm/phaser/archive/v2.4.4.tar.gz
|
|
[clone-http]: https://github.com/photonstorm/phaser.git
|
|
[clone-ssh]: git@github.com:photonstorm/phaser.git
|
|
[clone-svn]: https://github.com/photonstorm/phaser
|
|
[clone-ghwin]: github-windows://openRepo/https://github.com/photonstorm/phaser
|
|
[clone-ghmac]: github-mac://openRepo/https://github.com/photonstorm/phaser
|
|
[phaser]: https://github.com/photonstorm/phaser
|
|
[issues]: https://github.com/photonstorm/phaser/issues
|
|
[examples]: https://github.com/photonstorm/phaser-examples
|
|
[contribute]: https://github.com/photonstorm/phaser/blob/master/CONTRIBUTING.md
|
|
[forum]: http://www.html5gamedevs.com/forum/14-phaser/
|
|
|
|
[game1]: https://www.prodigygame.com/Fun-Math-Games/
|
|
[game2]: http://www.bbc.co.uk/cbbc/games/deadly-defenders-game
|
|
[game3]: http://www.defiantfew.com/
|
|
[game4]: http://www.pawpatrol.com/fun.php
|
|
[game5]: http://www.fyretale.com/
|
|
[game6]: http://www.pocoyo.com/juegos-ninos/caramelos
|
|
[game7]: http://www.html5gamedevs.com/topic/11179-phaser-cocoonjs-tap-tap-submarine/
|
|
[game8]: http://www.gamepix.com/project/footchinko/
|
|
[game9]: http://orcattack.thehobbit.com
|
|
[game10]: http://phaser.io/news/2015/06/bubble-academy
|
|
[game11]: http://phaser.io/news/2015/07/woodventure
|
|
[game12]: http://phaser.io/news/2015/04/hopsop-journey-to-the-top
|
|
[game13]: http://phaser.io/news/2015/05/banana-mania
|
|
[game14]: http://phaser.io/news/2015/06/salazar-the-alchemist
|
|
[game15]: http://phaser.io/news/2015/05/phaser-shmup
|
|
[game16]: http://phaser.io/news/2015/05/trappy-trap
|
|
[game17]: http://phaser.io/news/2015/04/runaway-ruins
|
|
[game18]: http://phaser.io/news/2015/04/ananias
|