Phaser 2.0.6-dev

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.6 "Jornhill" - Released: -in development-

By Richard Davey, Photon Storm

• View the Official Website
• Follow on Twitter
• Join the Forum
• StackOverflow tag: phaser-framework
• Source code for 320+ Phaser Examples or browse them online
• View the growing list of Phaser Plugins
• Read the documentation online
• Join our #phaserio IRC channel on freenode
• Subscribe to the Phaser Newsletter and we'll email you when new versions are released.
• Please help support our work via Gittip

Welcome to Phaser and What's new in 2.0.6?

Until then happy coding everyone! And we hope to see you on the forums.

Getting Started Guides

We have a 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.

We wrote a comprehensive How to Learn Phaser guide for GameDevTuts+ which covers finding tutorials, examples and support.

The Game Mechanic Explorer 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.

Finally the list of community authored Phaser Tutorials is growing fast!

Change Log

Version 2.0.6 - "Jornhill" - -in development-

Updates

• Merged Pixi 1.5.4 with Phaser - all of the lovely new Pixi features are in, like complex Graphics objects and masking.
• TypeScript definitions fixes and updates (thanks @clark-stevenson and @Phaiax)
• Documentation fixes (thanks @kay-is #941)
• BitmapData.draw can now also take a Phaser.Sprite, Phaser.Image or BitmapData object as a source type. As a result BitmapData.drawSprite is now depcreated.
• BitmapData.alphaMask can now also take a Phaser.Sprite, Phaser.Image or BitmapData object as a source type.
• BitmapData.alphaMask has 2 new optional parameters: sourceRect and maskRect to give more fine-grained control over where the source and mask are drawn and their size
• BitmapData.alphaMask 'mask' parameter is now optional, if not given it will use itself as the mask.
• BitmapData.alphaMask now calls BitmapData.update after running.
• BitmapData.draw now has two optional parameters: width and height, to let you stretch the image being drawn if needed.
• Group.destroy now removes any set filters (thanks @Jmaharman fix #844)
• RetroFont charsPerRow paramters is now optional. If not given it will take the image width and divide it by the characterWidth value.
• RetroFont now uses Phaser.scaleModes.NEAREST by default for its RenderTexture to preserve scaling.
• Loader.tilemap has renamed the mapURL parameter to url and mapData to data to keep it consistent with the other Loader methods.
• Loader.physics has renamed the dataURL parameter to url and jsonData to data to keep it consistent with the other Loader methods.
• Stage no longer creates the Phaser.Canvas object, but Game itself does in the setupRenderer method.
• Canvas.create has deprecated the noCocoon parameter as it's no longer required. The parameter is still in the signature, but no longer used in the method.
• Time.add allows you to add an existing Phaser.Timer to the timer pool (request #864)
• Emitter.start has a new parameter: forceQuantity which will force the quantity of a flow of particles to be the given value (request #853)
• Sound.pause will no longer fire a Sound.onStop signal, and the pause values are set before the onPause signal is dispatched (thanks @AnderbergE, fix #868)
• Swapped to using escaped Unicode characters for the console output.
• Frame.setTrim no longer modifies the Frame width and height values.
• AnimationParser doesn't populate the Pixi.TextureCache for every frame any longer. Each display object has its own texture property instead.
• Removed the cacheKey parameters from the AnimationParser methods as they're no longer used.
• Loader.isLoading is set to false if the filelist size is zero.

CocoonJS Specific Updates

• Wrapped all touch, keyboard, mouse and fullscreen events that CocoonJS doesn't support in conditional checks to avoid Warnings.
• The SoundManager no longer requires a touch to unlock it, defaults to unlocked.
• Resolved issue where Cocoon won't render a scene in Canvas mode if there is only one Sprite/Image on it.

New Features

• BitmapData.extract has a new parameter that lets you control if the destination BitmapData is resized before the pixels are copied.
• BitmapData.extract has 4 new parameters: r2, g2, b2, a2 which let you re-color the extract pixels as they are drawn to the new BitmapData.
• BitmapData.load will take a game object or string and resize the BitmapData to match it and then draw the pixels in.
• Keyboard.addCallbacks now has a new parameter for keypress event capture.
• Keyboard.pressEvent stores the most recent DOM keypress event.
• Keyboard.processKeyDown now runs the callback after all the objects have been created and/or updated.
• Keyboard.processKeyUp now runs the callback after all the objects have been created and/or updated.
• Phaser.Keyboard.lastChar will return the string value of the last key pressed.
• Phaser.Keyboard.lastKey will return the most recently pressed Key object.
• RetroFont.updateOffset allows you to modify the offsetX/Y values used by the font during rendering.
• ArcadePhysics.Body has a new boolean property enable. If false the body won't be checked for any collision or overlaps, or have its pre or post update methods called. Use this for easy toggling of physics bodies without having to destroy or re-create the Body object itself.
• BitmapData.addToWorld will create a new Phaser.Image object, assign the BitmapData to be its texture, add it to the world then return it.
• BitmapData.copyPixels now accepts a Sprite, Image, BitmapData, HTMLImage or string as its source.
• Loader.pack will allow you to load in a new Phaser Asset Pack JSON file. An Asset Pack is a specially structured file that allows you to define all assets for your game in an external file. The file can be split into sections, allowing you to control loading a specific set of files from it. An example JSON file can be found in the resources\Asset Pack JSON Format folder and examples of use in the Phaser Examples repository.
• Loader.totalQueuedPacks returns the number of Asset Packs in the queue.
• Loader.totalLoadedPacks returns the number of Asset Packs already loaded.
• Emitter.explode is a new short-cut for exploding a fixed quantity of particles at once.
• Emitter.flow is a new short-cut for creating a flow of particles based on the given frequency.
• Sprite.crop (and Image.crop) has been completely overhauled. You can now crop animated sprites (sprite sheet and texture atlas), you can define the x/y crop offset and the crop rectangle is exposed in the Sprite.cropRect property.
• Sprite.updateCrop is available if you wish to update an externally referenced crop rectangle.
• Sprites and Images now have their own textures objects, they are no longer references to those stored in the global Pixi.TextureCache. This allows you to redefine the texture frame dynamically without messing up any other Sprites in your game, such as via cropping. They still share global Base Textures, so image references are kept to a minimum.
• Sprite.resetFrame will revert the Sprites texture frame back to its defaults dimensions. This is called when you call Sprite.crop with no rectangle, to reset the crop effect, but can be userful in other situations so we've left it as a public method.
• TilemapLayers can now be used with an unbounded camera (a camera that can move beyond the world boundaries). Currently, when an unbounded camera moves outside of the world, tilemaps start acting weird because they only render themselves strictly within the world limits. With this change, the tilemap will continue scrolling and show empty space beyond its edge (thanks @jotson #851)
• TilemapLayer.wrap property - if true the map is rendered as if it is on the surface of a toroid (donut) instead of a plane. This allows for games that seamlessly scroll from one edge to the opposite edge of the world without noticing the transition. Note that the World size must match the Map size (thanks @jotson #851)
• Added PlayStation 3 controller button mappings to Phaser.Gamepad (thanks @wayfu)
• GamepadButton.destroy method added. Called automatically by SinglePad when a controller is disconnected.

Bug Fixes

• Sprite.alive property now explicitly defined on the Sprite prototype (thanks @lewster32, #841)
• BitmapData.resize now properly updates the baseTexture and texture dimensions.
• Fixed Gamepad issue that incorrectly checked non-webkit prefix gamepads.
• Phaser.RenderTexture incorrectly passed the scaleMode to Pixi.RenderTexture, causing the renderer to error.
• Sprite animation data wasn't reset when going from a sprite sheet to a single frame in Sprite.loadTexture (thanks @lucbloom, fix #850)
• Timer.ms would report the game time ms value if the Timer hadn't yet been started, instead of 0.
• Timer.seconds would report the game time value if the Timer hadn't yet been started, instead of 0.
• A Canvas style set from a game config object used an incorrect property (thanks @TatumCreative, fix #861)
• Phaser.Line.intersectsPoints fixed for floating point inaccuracy (thanks @woutercommandeur, fix #865 and #937)
• Sound.destroy(true) would call remove on the SoundManager, which in turn would throw a TypeError as it tried to remove the sound events twice (thanks @AnderbergE, fix #874)
• When creating a Sprite or Image using a texture atlas it would set the frame twice, once in loadTexture and once when the initial frame is set. This has been reduced down to just a single setting now.
• BitmapData.getPixel fix for pixels with zero red value (thanks @lstor fix #894)
• If you call ArcadePhysics.collide on a Sprite vs. a Tilemap and provide a custom processCallback, the result was being ignored and the sprite was being separated regardless (thanks @aivins fix #891 #890)
• ArcadePhysics.Body.setSize if you set offset x/y values previously and then passed zero values they would be ignored (thanks @casensiom fix #889)
• InputHandler.checkPointerDown checks and docs updated (thanks @lewster32, fix method #936)

ToDo

When you add an animation it over-rides the default set frame to the first frame of the animation.

Migration Guide

There is an extensive Migration Guide available for those converting from Phaser 1.x to 2.x. In the guide we detail the API breaking changes and approach to our new physics system.

The full Change Log is at https://github.com/photonstorm/phaser/blob/master/CHANGELOG.md

How to Build

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

You will also find custom builds in the build\custom folder, that split phaser up into components.

We also provide a Grunt script that will build Phaser from source.

Run grunt to perform a default build to the dist folder.

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

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.

Koding

You can clone the Phaser repo in Koding 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

Phaser is now available on CDNJS. You can include the following in your html:

http://cdnjs.cloudflare.com/ajax/libs/phaser/2.0.6/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.6/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. But as always be aware of browser limitations. Not all features of Phaser work on all browsers.

IE9

If you need to support IE9 or Android 2.x and want to use P2 physics then you must use the polyfill found in the resources/IE9 Polyfill folder. If you don't require P2 Physics (or don't care about IE9!) then you don't need this polyfill.

JavaScript and TypeScript

Phaser is developed in JavaScript. We've 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. So you won't find it split into require modules or pull in 3rd party npm packages for example. That doesn't mean you can't, it just means we don't force you to do so. If you're a requireJS user you'll find a new template in the resources\Project Templates folder just for you.

If you code with TypeScript you'll find a comprehensive definitions file inside the build folder and tutorials on getting started.

Phaser is 128 KB gzipped (576 KB minified) when including all 3 physics engines. Without the physics engines its 67 KB gzipped (311 KB minified)

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.

Learn By Example

Ever since we started Phaser we've been growing and expanding our extensive set of Examples. Currently over 320 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.

So please checkout https://github.com/photonstorm/phaser-examples

Here you'll find an ever growing suite of Examples. Personally I feel that developers tend to learn better by looking at small refined code examples, so we created hundreds of them, and create new ones to test new features and updates. 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 'Side View' example viewer as well. This loads all the examples into a left-hand frame for faster navigation. And if you've got php installed into your web server you may want to try debug.php, which provides a minimal examples list and debug interface.

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

Here are some of the features planned for future releases:

Version 2.1 ("Shienar")

• Scene Manager - json scene parser.
• Comprehensive testing across Firefox OS devices, CocoonJS and Ejecta.
• Ability to control DOM elements from the core game and layer them into the game.
• Touch Gestures.
• Optimised global Animation manager to cut down on object creation.
• Swapping to using a RenderTexture for the Tilemaps and implementing Tilemap slicing.
• Enhance the State Management, so you can perform non-destructive State swaps and persistence.
• Support for parallel asset loading.
• Optimise the Gamepad._pollGamepads method significantly.

Version 2.2 ("Tarabon")

• Look carefully at the internal structure of Phaser to avoid method repetition (such as Sprite.crop and Image.crop), investigate using mixins to help reduce overall codebase size.
• 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

• A more advanced Particle system, one that can render to a single canvas (rather than spawn hundreds of Sprites), more advanced effects, etc.
• Integration with third party services like Google Play Game Services and Amazon JS SDK.
• 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.
• Look at XDomainRequest for IE9 CORs issues.

MightyEditor - A Visual Phaser Game Editor

MightyEditor 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.

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, run grunt jshint. 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.