Phaser 2.0.1

Phaser is a fast, free and fun open source game framework for making desktop and mobile browser HTML5 games. It uses Pixi.js internally for fast 2D Canvas and WebGL rendering.

Version: 2.0.1 "Aes Sedai" - Released: -in development-

By Richard Davey, Photon Storm

• View the Official Website
• Follow on Twitter
• Join the Forum
• Source code for 250+ Phaser Examples
• Read the documentation online
• Browse the Examples online
• Join our #phaserio IRC channel on freenode

Subscribe to our new Phaser Newsletter. We'll email you when new versions are released as well as send you our regular Phaser game making magazine.

Welcome to Phaser

Exactly 6 months ago we released Phaser 1.0 into the world. Suffice to say that since then we've been overwhelmed at the huge surge of developers taking to it! Our github repository is consistently in the top JavaScript lists, we've over 3200 stars at the time of writing, and a wonderful, vibrant and friendly community. Phaser 2 is a natural evolution of what we started. We've focused specifically on performance and expansion with this release. Lots of developers have already reported to us considerably speed increases just by swapping to Phaser 2 (reports of 200% faster speeds on mobile aren't unheard of!). There's also a full-body physics system available now, in the form of the excellent p2.js. The upgrade to Pixi 1.5 under the hood bought lots of new visual effects in, including blend modes and tints.

And we're also really pleased to have closed down over 550 issues reported on github. We literally went through every last bug reported to us, and fixed it. All kinds of little things that as a whole make the library that much more solid. With the 2.0 release we're now freezing the API. Before we have to admit that the API changed somewhat on a whim, and we moved things around and changed things without too much consideration for fellow developers. With 2.0 that stops - we've spent long enough on this release that we're now extremely happy with the organisation of classes and methods, and while we may still need to make small tweaks in the future, none of them will be API breaking without prior community approval first. This means if you're using Phaser to teach in classes, or writing a book / tutorials around it, this is the version to base off.

If you want to port a Phaser 1.x game over to 2 then please see our Migration Guide for help.

So what's next? We do have a roadmap (which you can find at the bottom of this document), but we're going to sit back and take stock for a while, building up the tutorials and sample games. We will of course jump on bug fixes quickly, and we appreciate that our TypeScript definitions are now slightly out of date again (an eternal quest we appear to be on!), but this is definitely the best release of Phaser ever. The most features, the fastest, the most stable and just generally the most fun to use.

Happy coding everyone! See you on the forums.

Getting Started Guides

We have a new Getting Started Guide 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.

There is a comprehensive How to Learn Phaser guide on the GameDevTuts+ site which is a great place to learn where to find tutorials, examples and support.

There is also an un-official Getting Started Guide.

Change Log

Version 2.0.1 - "Aes Sedai" - -in development-

Bug Fixes

• The Static, Kinematic and Dynamic consts that P2.Body uses were incorrect (fixes #563)
• Sprite.destroy would fail if it had an Arcade Physics body, now added.
• Group.getAt comparison updated (fixes #578)
• Fixed the IE11 version check (fixes #579)
• Ninja world collision to check right and bottom bounds (thanks dreadhorse, fix #571)
• Group enableBody parameter was incorrectly assigned to the debug var (thanks BurnedToast, fix #565)
• Fixed Tile callback check in Arcade Physics (fix #562)
• Removed the examples build script from the Gruntfile (fix #592)
• The P2 World wouldn't clear down fully on a State change, now properly clears out contacts, resets the bitmask, etc.
• Button.onInputUpHandler wouldn't set an upFrame for a frame ID of zero, made the check more strict.
• Fixed the Loader.preloadSprite crop effect on WebGL.
• Fixed Grunt script that stopped the P2 constraint classes from building properly.
• World.destroy incorrectly clashed with the Group.destroy method it over-rode, renamed to World.shutdown and updated StateManager accordingly.
• World.shutdown now removes all children iteratively, calling destroy on each one, ultimately performing a soft reset of the World.
• Objects with a scale.x or y of 0 are no longer considered valid for input (fix #602)
• InputHandler will set the browser pointer back to default if destroyed while over (fix #602)
• ArcadePhysics.separate doesn't pass over to seperateX/Y if overlapOnly is true (fix #604)
• ArcadePhysics.collideSpriteVsSprite checks if both objects have bodies before processing.

Updated:

• Updated Device.isConsoleOpen as it no longer works in Chrome. Revised code and documentation accordingly (fix #593)
• Removed State.destroy empty method and replaced with State.shutdown, as that is what the StateManager expects (fix #586)
• P2.removeBody will check if the body is part of the world before removing, this avoids a TypeError from the p2 layer.
• Tilemap.createFromObjects has a new parameter: adjustY, which is true by default. Because Tiled uses a bottom-left coordinate system Phaser used to set the Sprite anchor to 0,1 to compensate. If adjustY is true it now reduces the y value by the object height instead.
• Swapped the order of the _pollGamepads gamepads check, to stop the Chrome 'webkitGamepads is deprecated' error in the console.
• Lots of TypeScript definitions updates (thanks as always to clark for these)
• Removed Device.patchAndroidClearRectBug as it's no longer used internally.
• Math.wrapAngle now supports radians (thanks Cryszon, #597)
• Group.replace will now return the old child, the one that was replaced in the Group.
• Group.destroy has a new parameter: soft. A soft destruction won't remove the Group from its parent or null game references. Default is false.
• InputHandler.validForInput is a new method that checks if the handler and its owner should be considered for Pointer input handling or not.
• ArcadePhysics.Body now checks the ArcadePhysics.World bounds, not the game bounds.
• ArcadePhysics.Body has reverted to the 1.1.3 method of preUpdate, so you can now position sprites with x/y, drag them, etc, regardless of the Body.moves flag (issue #606)
• ArcadePhysics.World now has setBounds and setBoundsToWorld methods, which are called automatically on world resizing.
• ArcadePhysics.Body no longer sets the offset to match the anchor.

New Features:

• Device.getUserMedia boolean added, useful if you need access to the webcam or microphone.
• Math.removeRandom allows you to remove (and return) a random object from an array.

TODO:

• Check Group.create exists = false, is body added to world on next step? http://www.html5gamedevs.com/topic/4786-how-to-avoid-physics-body-when-creating-a-new-sprite/#entry29313

Version 2.0.0 - "Aes Sedai" - March 13th 2014

There is an extensive Migration Guide available. In the guide we detail the API breaking changes and approach to our new physics system. The following is a list of all the other new features, updates and bug fixes present in this release.

New features:

• Phaser.Image is a brand new display object perfect for logos, backgrounds, etc. You can scale, rotate, tint, blend an get input events from an Image, but it has no animation or physics body.
• You can now use the hitArea property on Sprites and Image objects. hitArea can be a geometry object (Rectangle, Circle, Polygon, Ellipse) and is used in pointerOver checks.
• InputManager.getLocalPosition(displayObject, pointer, output) will return the local coordinates of the specified displayObject and pointer.
• InputManager.hitTest will test for pointer hits against a Sprite/Image, its hitArea (if set) or any of its children.
• Text has lots of new methods to help style it: Text.fill, Text.align, Text.stroke, etc.
• Text now works happily with font names with spaces in them.
• Text.setShadow applies a drop shadow to the Text being rendered. Control the x, y, color and blur.
• Text.lineSpacing allows you to set additional spacing between each line that is rendered.
• Text.inputEnabled allows you to enable all input events over Text objects: dragging, clicking, etc - anything that works on a Sprite works on Text now too.
• Phaser.Ellipse added. A fully compatible port of the PIXI.Ellipse class, can be used in Sprite/Image hitArea tests.
• Phaser.Polygon added. A fully compatible port of the PIXI.Polygon class, can be used in Sprite/Image hitArea tests.
• InputHandler.pixelPerfectOver - performs a pixel perfect check to see if any pointer is over the current object (warning: very expensive!)
• InputHandler.pixelPerfectClick - performs a pixel perfect check but only when the pointer touches/clicks on the current object.
• TileSprite can now use a frame from a texture atlas or a sprite sheet.
• TileSprites can now be animated. See new example :)
• TileSprites have a new method: autoScroll(x, y) which sets an automatic scroll running (until stopped with TileSprite.stopScroll).
• BitmapText now uses the new XML parser which should work under CocoonJS without clashes.
• BitmapText signature changed so you can support fonts with spaces in their names.
• Loader.bitmapFont now has 2 extra parameters: xSpacing and ySpacing. These allow you to add extra spacing to each letter or line of the font.
• Added the new RetroFont class. This is for rendering fixed-width bitmap fonts into an Image object. It's a texture you can apply to a Sprite/Image.
• Added Cache.updateFrameData which is really useful for swapping FrameData blocks in the cache.
• Loader.physics now lets you load Lime + Corona JSON Physics data, which can be used with Body.loadPolygon and Body.loadData.
• Cache.addPhysicsData and Cache.getPhysicsData allow you to store parsed JSON physics data in the cache, for sharing between Bodies.
• fixedToCamera now works across all display objects. When enabled it will fix at its current x/y coordinate, but can be changed via cameraOffset.
• fixedToCamrea now works for Groups as well :) You can fix a Group to the camera and it will influence its children.
• Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world.
• Loader can now load JSON files specifically (game.load.json) and they are parsed and stored in the Game.Cache. Retrieve with game.cache.getJSON(key).
• TileSprites can now receive full Input events, dragging, etc and be positioned in-world and fixed to cameras.
• The StateManager now looks for a function called 'resumed' which is called when a game un-pauses.
• Key.onHold added. This event is dispatched every time the browser sends a keydown event and the key is already being held down.
• Stage.smoothed allows you to set if sprites will be smoothed when rendered. Set to false if you're using pixel art in your game. Default is true. Works in Canvas and WebGL.
• Sprite.smoothed and Image.smoothed allows you to set per-Sprite smoothing, perfect if you just want to keep a few sprites smoothed (or not)
• StateManager.start can now have as many parameters as you like. The order is: start(key, clearWorld, clearCache, ...) - they are passed to State.init() (NOT create!)
• Loader.script now has callback (and callbackContext) parameters, so you can specify a function to run once the JS has been injected into the body.
• Phaser.Timer.stop has a new parameter: clearEvents (default true), if true all the events in Timer will be cleared, otherwise they will remain (fixes #383)
• All GameObjects now have a 'destroyChildren' boolean as a parameter to their destroy method. It's default is true and the value propogates down its children.
• Pixi GrayFilter ported over (thanks nickryall #404)
• Animation.speed added. You can now change the animation speed on the fly, without re-starting the animation (feature request #458)
• Brand new Grunt task - creates each core library as its own file and a combined phaser.js.
• New build script now cleanly splits Phaser, Pixi and p2 so they are each UMD wrapped and each available in the global scope (now more requireJS friendly!).
• phaser-no-libs.js allows you to use your own version of p2.js or pixi.js with Phaser. Warning: This is totally unsupported. If you hit bugs, you fix them yourself.
• Group.sendToBottom(child) is the handy opposite of Group.bringToTop()
• Group.moveUp(child) will move a child up the display list, swapping with the child above it.
• Group.moveDown(child) will move a child down the display list, swapping with the child below it.
• Device.windowsPhone is now tested for.
• The Debug panel now works in WebGL mode. Pay attention to the warning at the top of the Debug docs (feature request #499)
• You can now create blank Tilemaps and then populate them with data later.
• A single Animation object now has 3 new events: onStart, onLoop and onComplete.
• Animation.loopCount holds the number of times the animation has looped since it last started.
• Tween.generateData(frameRate) allows you to generate tween data into an array, which can then be used however you wish (see new examples)
• Group.xy(index, x, y) allows you to set the x and y coordinates of a Group child at the given index.
• Group.reverse() reverses the display order of all children in the Group.
• Tweens are now bound to their own TweenManager, not always the global game one. So you can create your own managers now (for you clark :)
• ScaleManager.fullScreenTarget allows you to change the DOM element that the fullscreen API is called on (feature request #526)
• Merged Georges p2 BodyDebug and reformatted for jshint pass. Looks awesome :)
• ArcadePhysics.Body has a new gravityScale property, which is a modifier multiplied against the world gravity value on a Body.
• Line.coordinatesOnLine will return all coordinates on the line using Bresenhams line algorithm.
• Line now has x, y, width, height, top, bottom, left and right properties, so you can effectively get its bounds.
• TilemapLayer.getRayCastTiles will let you get all tiles that hit the given line for further processing.

Updates:

• Massive thanks to clark-stevenson for doing an amazing job update the TypeScript definitions file.
• Debug.renderRectangle has a new parameter: filled. If true it renders as with fillRect, if false strokeRect.
• Phaser.AnimationParser now sets the trimmed data directly for Pixi Texture frames. Tested across JSON Hash, JSON Data, Sprite Sheet and XML.
• Game.add.renderTexture now has the addToCache parameter. If set the texture will be stored in Game.Cache and can be retrieved with Cache.getTexture(key).
• Game.add.bitmapData now has the addToCache parameter. If set the texture will be stored in Game.Cache and can be retrieved with Cache.getBitmapData(key).
• The InputManager now sets the canvas style cursor to 'inherit' instead of 'default'.
• World.reset now calls Camera.reset which sends the camera back to 0,0 and un-follows any object it may have been tracking.
• Added hostname: '*' to the grunt-connect in Gruntfile.js (fixes #426)
• Device, Canvas and GamePad classes all updated for better CocoonJS support (thanks Videlais)
• BitmapData.alphaMask will draw the given image onto a BitmapData using an image as an alpha mask.
• The new GameObjectCreator (which you access via game.make or State.make) lets you easily create an object but NOT add it to the display list.
• TilemapParser will now throw a warning if the tileset image isn't the right size for the tile dimensions.
• We now force IE11 into Canvas mode to avoid a Pixi bug with pre-multiplied alpha. Will remove once that is fixed, sorry, but it's better than no game at all, right? :(
• Loader.setPreloadSprite() will now set sprite.visible = true once the crop has been applied. Should help avoid issues (#430) on super-slow connections.
• Updated the way the page visibility is checked, should now be more compatible across more browsers.
• Phaser.Input.Key.isUp now defaults to 'true', as does GamepadButton.isUp (#474)
• Vastly improved visibility API support + pageshow/pagehide + focus/blur. Working across Chrome, IE, Firefox, iOS, Android (also fixes #161)
• Pausing the game will now mute audio and resuming will un-mute, unless it was muted via the game (fixes #439)
• ScaleManager has 2 new events: ScaleManager.enterFullScreen and ScaleManager.leaveFullScreen, so you can respond to fullscreen changes directly.
• RandomDataGenerator.integerInRange(min, max) now includes both min and max within its range (#501)
• Tween no longer copies all the object properties into the _valuesStart object on creation.
• Completely empty Tilemaps can now be created. This allows for dynamic map generation at runtime.
• Keyboard.event now stores the most recent DOM keyboard event.
• Animation.stop has a new parameter: dispatchComplete. If true it'll dispatch an Animation.onComplete event.
• TileSprites now have a physics body property and call it in the pre and post updates. As with all physics bodies it's null by default.
• json is now the default tilemap format when not defined (thanks RyanDansie, #528)
• The Particle Emitter now remembers the frames given to it and resets it when a new particle is emitted.
• Game.focusLoss and focusGain methods and onBlur and onFocus Signals added, allowing for more fine-grained control over game pause vs. focus loss.
• Keyboard.removeKey method added (thanks qdrj, #550)
• Key.event now stores the most recent DOM event that triggered it.

Bug Fixes:

• Explicitly paused Timer continues if you un-focus and focus the browser window (thanks georgiee)
• Added TimerEvent.pendingDelete and checks in Timer.update, so that removing an event in a callback no longer throws an exception (thanks georgiee)
• Fixed TypeScript defs on lines 1741-1748 (thanks wombatbuddy)
• Previously if you used Sprite.crop() it would crop all Sprites that shared the same base image. It now takes a local copy of the texture data and crops just that.
• Tilemap had the wrong @method signatures so most were missing from the docs.
• Fixed bug where changing State would cause the camera to not reset if it was following an object.
• Tile had 2 properties (callback and callbackContext) that were never assigned, updated to use the proper names (thanks ratkingsimon)
• Fixed an error that would occur if you used InputHandler.onInputUp and the Sprite destroys itself during the event.
• IE11 didn't populate the Device.ieVersion value. Now extracted from Trident revision, but still use Device.trident instead for IE11+ checks.
• Fixed bug in Math.angleBetween where it was using the coordinates in the wrong order.
• Previously using a Pixel Perfect check didn't work if the Sprite was rotated or had a non-zero anchor point, now works under all conditions + atlas frames.
• If pixelPerfect Input Sprites overlapped each other the pixel check wasn't taken into consieration in the Pointer move method.
• Updated Input.Mouse to use event.button not event.which, so the const reference from input.mouse.button is correct (thanks grimor)
• Text that was fixedToCamera would 'jitter' if the world scrolled. Now works as expected across all fixed objects.
• Fixed a bug where Sound.play wouldn't pick-up the local loop setting if not specified in the parameter.
• Active animations now monitor if the game pauses, and resume normally when the game un-pauses (fixes #179)
• Swapping between tabs will now pause the game correctly on mobile browsers (iOS7+)
• Swapping between tabs will pause and resume tweens correctly, allowing their onComplete events to still fire (fixes #292)
• Fullscreen mode now uses window.outerWidth/Height when using EXACT_FIT as the scale mode, which fixes input coordinate errors (fixes #232)
• Fullscreen mode now works in Internet Explorer and uses the new fullscreen non-prefix call.
• Fixed TilemapParser - would spit out a tileset warning if margin/spacing were set (fix #485, thanks Cybolic)
• AnimationParser.spriteSheet wasn't taking the margin or spacing into account when calculating the numbers of sprites per row/column, nor was it allowing for extra power-of-two padding at the end (fix #482, thanks yig)
• AnimationManager.add documentation said that 'frames' could be null, but the code couldn't handle this so it defaults to an empty array if none given (thanks yig)
• Fixed issue stopping SoundManager.volume from working correctly on a global volume basis (fixes #488)
• Phaser.Timer will no longer create negative ticks during game boot, no matter how small the Timer delay is (fixes #366)
• Phaser.Timer will no longer resume if it was previously paused and the game loses focus and then resumes (fixes #383)
• Tweens now resume correctly if the game pauses (focus loss) while they are paused.
• Tweens don't double pause if they were already paused and the game pauses.
• Buttons are now cleanly destroyed if part of a Group without leaving their InputHandler running.
• You can now safely destroy a Group and the 'destroyChildren' boolean will propogate fully down the display list.
• Calling destroy on an already destroyed object would throw a run-time error. Now checked for and aborted.
• Calling destroy while in an Input Event callback now works for either the parent Group or the calling object itself.
• Loader.replaceInFileList wouldn't over-write the previous entry correctly, which caused the Loader.image overwrite parameter to fail (thanks basoko, fixes #493)
• If the game was set to NO_SCALE and you swapped orientation, it would pause and resize, then fail to resize when you swapped back (thanks starnut, fixes #258)
• Device no longer things a Windows Phone or Windows Tablet are desktop devices (thanks wombatbuddy, fixes #506)
• Sound.onMarkerComplete event is now dispatched when a marker stops. See Sound.onLoop for a looping marker event (thanks registered99, fixes #500)
• Events.onInputUp would be dispatched twice if the Sprite had drag enabled, now only dispatched once (thanks Overbryd, fixes #502)
• You can now load in CSV Tilemaps again and they get created properly (fixes #391)
• Tilemap.putTile can now insert a tile into a null/blank area of the map (before it could only replace existing tiles)
• Tilemap.putTile now correctly re-calculates the collision data based on the new collideIndexes array (fixes #371)
• Circle.circumferencePoint using the asDegrees parameter would apply degToRad instead of radToDeg (thanks Ziriax, fixes #509)
• InputHandler.enableSnap now correctly assigns the snap offset parameters (fixes #515)
• Objects that are 'fixedToCamera' are now still correctly placed even if the camera is scaled (#512)
• Changed the define function calls to use named modules, allows pixi, phaser and p2 to reside in 1 file and still be located by requirejs (thanks brejep, #531)
• Cache.destroy fixed to clear up properly (thanks Dumtard, #537)

You can view the Change Log for all previous versions at https://github.com/photonstorm/phaser/changelog.md

How to Build

We provide a fully compiled version of Phaser in the build directory, in both plain and minified formats.

We also provide a Grunt script that will build Phaser from source along with all the examples.

Run grunt to perform a default build to the dist folder and update the examples.

If you replace Pixi or p2 then run grunt replace to patch their UMD strings so they work properly with Phaser and requireJS.

Koding

You can and then start editing and previewing code right away using their web based VM development system.

Bower

If you use bowser you can install phaser with:

bower install phaser

Nice and easy :)

CDNJS

Thanks to a community member Phaser is now available on CDNJS. You can include the following in your html:

http://cdnjs.cloudflare.com/ajax/libs/phaser/2.0.0/phaser.min.js

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.0/phaser.min.js

Requirements

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.

For developing with Phaser you can use either a plain-vanilla JavaScript approach or TypeScript 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.

Phaser is 576 KB minified (including all 3 physics engines, 311 KB without) and 128 KB gzipped (67 KB without physics libs).

Learn By Example

Ever since we started Phaser we've been growing and expanding our extensive set of Examples. Currently over 250 of them!

They used to be bundled in the main Phaser repo, but because they got so large and in order to help with versioning we've moved them to their own repo.

Please go and checkout https://github.com/photonstorm/phaser-examples

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 250 of them and create new ones to test every new feature added. Inside the examples repo you'll find the current set. If you write a particularly good example then please send it to us.

The examples need to be run through a local web server (in order to avoid file access permission errors from your browser). You can use your own web server, or start the included web server using grunt.

Using a locally installed web server browse to the examples folder:

examples/index.html

Alternatively in order to start the included web server, after you've cloned the repo, run npm install to install all dependencies, then grunt connect to start a local server. After running this command you should be able to access your local webserver at http://127.0.0.1:8000. Then browse to the examples folder: http://127.0.0.1:8000/examples/index.html

There is a new 'Side View' example viewer as well. This loads all the examples into a left-hand frame for faster navigation.

You can also browse all Phaser Examples online.

Features

WebGL & Canvas

Phaser uses both a Canvas and WebGL renderer internally and can automatically swap between them based on browser support. This allows for lightning fast rendering across Desktop and Mobile. When running under WebGL Phaser now supports shaders, allowing for some incredible in-game effects. Phaser uses and contributes towards the excellent Pixi.js library for rendering.

Preloader

We've made the loading of assets as simple as one line of code. Images, Sounds, Sprite Sheets, Tilemaps, JSON data, XML and JavaScript files - all parsed and handled automatically, ready for use in game and stored in a global Cache for Sprites to share.

Physics

Phaser ships with our Arcade Physics system, Ninja Physics and P2.JS - a full body physics system. Arcade Physics is for high-speed AABB collision only. Ninja Physics allows for complex tiles and slopes, perfect for level scenery, and P2.JS is a full-body physics system, with constraints, springs, polygon support and more.

Sprites

Sprites are the life-blood of your game. Position them, tween them, rotate them, scale them, animate them, collide them, paint them onto custom textures and so much more! Sprites also have full Input support: click them, touch them, drag them around, snap them - even pixel perfect click detection if needed.

Groups

Group bundles of Sprites together for easy pooling and recycling, avoiding constant object creation. Groups can also be collided: for example a "Bullets" group checking for collision against the "Aliens" group, with a custom collision callback to handle the outcome.

Animation

Phaser supports classic Sprite Sheets with a fixed frame size, Texture Packer and Flash CS6/CC JSON files (both Hash and Array formats) and Starling XML files. All of these can be used to easily create animation for Sprites.

Particles

An Arcade Particle system is built-in, which allows you to create fun particle effects easily. Create explosions or constant streams for effects like rain or fire. Or attach the Emitter to a Sprite for a jet trail.

Camera

Phaser has a built-in Game World. Objects can be placed anywhere within the world and you've got access to a powerful Camera to look into that world. Pan around and follow Sprites with ease.

Input

Talk to a Phaser.Pointer and it doesn't matter if the input came from a touch-screen or mouse, it can even change mid-game without dropping a beat. Multi-touch, Mouse, Keyboard and lots of useful functions allow you to code custom gesture recognition.

Sound

Phaser supports both Web Audio and legacy HTML Audio. It automatically handles mobile device locking, easy Audio Sprite creation, looping, streaming and volume. We know how much of a pain dealing with audio on mobile is, so we did our best to resolve that!

Tilemaps

Phaser can load, render and collide with a tilemap with just a couple of lines of code. We support CSV and Tiled map data formats with multiple tile layers. There are lots of powerful tile manipulation functions: swap tiles, replace them, delete them, add them and update the map in realtime.

Device Scaling

Phaser has a built-in Scale Manager which allows you to scale your game to fit any size screen. Control aspect ratios, minimum and maximum scales and full-screen support.

Plugin system

We are trying hard to keep the core of Phaser limited to only essential classes, so we built a smart Plugin system to handle everything else. Create your own plugins easily and share them with the community.

Mobile Browser

Phaser was built specifically for Mobile web browsers. Of course it works blazingly fast on Desktop too, but unlike lots of frameworks mobile was our main focus. If it doesn't perform well on mobile then we don't add it into the Core.

Developer Support

We use Phaser every day on our many client projects. As a result it's constantly evolving and improving and we jump on bugs and pull requests quickly. This is a living, breathing framework maintained by a commercial company with custom feature development and support packages available. We live and breathe HTML5 games.

Battle Tested

Phaser has been used to create hundreds of games, which receive millions of plays per month. We're not saying it is 100% bug free, but we use it for our client work every day, so issues get resolved fast and we stay on-top of the changing browser landscape.

Road Map

Beyond version 2.0 here are some of the features planned for the future:

Version 2.1 ("Shienar")

• Enhance the State Management, so you can perform non-destructive State swaps and persistence.
• A more advanced Particle system, one that can render to a single canvas (rather than spawn hundreds of Sprites), more advanced effects, etc.
• Ability to control DOM elements from the core game and layer them into the game.
• Touch Gestures.
• Support for parallel asset loading.

Version 2.2 ("Tarabon")

• Comprehensive testing across Firefox OS devices, CocoonJS and Ejecta.
• Integration with third party services like Google Play Game Services and Amazon JS SDK.
• Flash CC HTML5 export integration.
• Massively enhance the audio side of Phaser. Take more advantage of Web Audio: echo effects, positional sound, etc.

Beyond version 2.2

• Test out packaging with Node-webkit.
• Game parameters stored in Google Docs.
• Look at HiDPI Canvas settings.
• Multiple Camera support.
• DragonBones support.
• Cache to localStorage using If-Modified-Since. See github request
• Allow for complex assets like Bitmap Fonts to be stored within a texture atlas.

Nadion

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.

Contributing

We now have a full Contributors Guide which goes into the process in more detail, but here are the headlines:

• If you find a bug then please report it on GitHub Issues or our Support Forum.

• If you have a feature request, or have written a game or demo that shows Phaser in use, then please get in touch. We'd love to hear from you! Either post to our forum or email: rich@photonstorm.com

• If you issue a Pull Request for Phaser, please only do so againt the dev branch and not against the master branch.

• Before submitting a Pull Request please run your code through JSHint to check for stylistic or formatting errors. To use JSHint, first install it by running npm install jshint, then test your code by running jshint src. This isn't a strict requirement and we are happy to receive Pull Requests that haven't been JSHinted, so don't let it put you off contributing, but do know that we'll reformat your source before going live with it.

Bugs?

Please add them to the Issue Tracker with as much info as possible, especially source code demonstrating the issue.

"Being negative is not how we make progress" - Larry Page, Google

License

Phaser is released under the MIT License.