phaser/README.md

Phaser

Phaser is a fast, free and fun open source HTML5 game framework. It uses 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.

It is actively developed and maintained by the company Photon Storm along with the fantastic open source community. As a result of continued support and a friendly API Phaser is currently one of the most starred game frameworks on Github. Thousands of developers worldwide use it. From indies to multi-national digital agencies. Each creating incredible games.

• The official website
• Twitter (feel free to use #phaserjs when tweeting)
• API Documentationn
• Support Forum
• Source Code Examples (also available in this git repo)
• Subscribe to the Phaser Newsletter
• StackOverflow tag: phaser-framework
• Phaser Plugins
• #phaserio IRC channel on freenode
• Please support our work via Gratipay

Index

• What's New?
• Getting Started
• Change Log
• How to Build
• Koding
• Bower / NPM
• jsDelivr
• Requirements
• Build Files
• Learn By Example
• Features
• Road Map
• Mighty Editor
• Contributing
• Bugs?
• License

What's new in 2.2.2?

Content here :)

Happy coding everyone! I hope to see you on the forums.

Change Log

The current stable version of Phaser is 2.2.2 "Alkindar" released: in-dev

New Features

• Phaser.Loader now supports BLOB urls for audio files (thanks @aressler38 #1462)
• Line.reflect will calculate the reflected, or outgoing angle of two lines. This can be used for Body vs. Line collision responses and rebounds.
• Line.normalAngle gets the angle of the line normal in radians.
• Line.normalX and Line.normalY contain the x and y components of the left-hand normal of the line.
• Line.fromAngle will sets this line to start at the given x and y coordinates and for the segment to extend at angle for the given length.
• BitmapData.drawGroup draws the immediate children of a Phaser.Group to a BitmapData. Children are only drawn if they have their exists property set to true. The children will be drawn at their x and y world space coordinates. When drawing it will take into account the child's rotation, scale and alpha values. No iteration takes place. Groups nested inside other Groups will not be iterated through.

Updates

• TypeScript definitions fixes and updates (thanks @clark-stevenson @Schmavery)
• DOM.visualBounds now includes scroll bars (#1429)
• The new fixed time-step code has been more carefully linked to Pixi transform updates. This should finally put a stop to the tunneling issues that were being reported.
• Tween.stop fired a different set of onComplete parameters to Tween.update. Both now dispatch `onComplete(target, tween)`` as the parameters in that order (thanks @P0rnflake #1450)
• Removed redundant tolerance parameter from Rectangle.intersects (thanks @toolness #1463)
• Phaser.Graphics.drawCircle now overrides PIXI.drawCircle which means the docs are now correct re: diameter not radius (thanks @ethankaminski #1454)
• Device.webAudio check inversed to avoid throwing a warning in Chrome.
• Mouse.mouseMoveCallback is flagged as deprecated.
• Remove tw and th init from TilemapLayer (thanks @nextht #1474)
• Particles.Arcade.Emitter.makeParticles now checks the given quantity value against Emitter.maxParticles. If quantity is more than maxParticles then the maxParticles value is reset to the new quantity given (as this is how most devs seem to use it).
• Particles.Arcade.Emitter.emitParticle now returns a boolean depending if a particle was emitted or not.
• Particles.Arcade.Emitter.update only updates _counter if a particle was successfully emitted.
• Phaser.Point.angleSq removed. It didn't work so any code relying on it would be broken, and it's unclear what it was meant for (thanks @nextht #1396)
• BitmapData.copy tx parameter if null and source is a Display Object, it will default to source.x.
• BitmapData.copy ty parameter if null and source is a Display Object, it will default to source.y.

Bug Fixes

• Fix / double-copy for Safari tilemap bug when rendering with delta scrolling. This fixes tilemaps not appearing to update on Safari OS X and iOS specifically (thanks @pnstickne @neurofuzzy @lastnightsparty #1439 #1498)
• Simplified call to updateTransform. This is the unified and verified fix for #1424 #1479 #1490 #1502 and solves issues with physics tunneling and visual glitches under the new time step code.
• Tween.delay, Tween.repeat and Tween.yoyo will no longer throw an error if called before a TweenData object has been created (via Tween.to or Tween.from) (thanks @SomMeri #1419)
• The click trampoline added for IE prevented Chrome for Android from being able to launch Full Screen mode with the default parameters for ScaleManger#startFullScreen (the desktop version of Chrome was not affected.). This is now fixed and additional compatibility settings (clickTrampoline) that can be used to configure when such is used. By default the 'when-not-mouse' mode is only enabled for Desktop browsers, where the primary input is ubiquitously a mouse. There are no known breaking compatibility changes - the Full Screen should be initiatable in Chrome for Android as it was in 2.1.x. The default Android browser does not support Full Screen (thanks @pnstickne)
• TilemapParser now checks for image collections, avoiding crashes. These would arise with maps exported from the new release of Tiled (thanks @paul-reilly #1440)
• Group.replace could still access newChild.parent after it was set to undefined. This unifies the approach (thanks @pnstickne #1410 #1417)
• P2.postBroadphaserHandler updated to avoid skipping final 2 pairs.
• The P2 World constructor wouldn't let you use your own config unless you specified both the gravity and broadphase. Now allows one or both (thanks @englercj #1412)
• The RandomDataGenerator could be seeded with an array of values. However if the array contained a zero it would stop seeding from that point (thanks @jpcloud @pnstickne #1456)
• Added extra checks to Sound.play to stop it throwing DOM Exception Error 11 if the sound.readyState wasn't set or the sound was invalid. Also wrapped stop()`` call in a try catch`.
• Time.reset would incorrectly reset the _started property, now maps it to Time.time (thanks @XekeDeath #1467)
• Fix floating point inaccuracy in Tween easing edge cases (thanks @jounii #1492)
• Phaser.Signal was causing a CSP script-src violations in Cordova and Google Chrome Apps (thanks @elennaro #1494)
• Added Events.onEnterBounds to the destroy method (thanks @legendary-mich #1497)
• AnimationManager.destroy is now more careful about clearing up deep references (thanks @Arturszott #1449)
• Ellipse.right and Ellipse.bottom setters fixed (thanks @nextht #1397)
• Fixed double Ellipse.getBounds definition (thanks @nextht #1397)
• TileSprite.loadTexture crashed when textures were updated in WebGL (thanks @pandavigoureux29 #1495)

Pixi.js 2.2.0 Updates

• The strip class has now three extra properties, canvasPadding, paddingX, and paddingY : @darionco
• Added mipmap option to to textures.
• Added the ability to use GL_TRIANGLES when rendering Strips @darionco
• Added the ability to tint the Graphics.
• Fixed Y-flipped mask issue on render texture.
• Fixed the issue where you could an alpha that is more than one and it would.
• Fixed text issues when using accents.
• Fixed sprite caching not clearing the previous cached texture : @kambing86
• Fixed arcTo issues.
• Vertex buffer and and vertex shader optimisation and reduced memory footprint on the tint and alpha : @bchevalier
• Applied the new generic updateTransform to spritebatch : @kambing86

For changes made in previous versions please see the comprehensive Version History.

Download Phaser

Phaser is hosted on Github. There are a number of ways to download it:

• Clone the git repository via https, ssh or with the Github Desktop client.
• Download as zip or tar.gz
• Download just the build files: phaser.js and phaser.min.js
• Checkout with svn

Bower / npm

Install via bower: bower install phaser

Install via npm: npm install phaser

jsDelivr CDN

jsDelivr is a "super-fast CDN for developers". Include the following in your html:

<script src="//cdn.jsdelivr.net/phaser/2.2.1/phaser.js"></script>

or the minified version:

<script src="//cdn.jsdelivr.net/phaser/2.2.1/phaser.min.js"></script>

More details on the jsDelivr Phaser page.

Koding

Want to try Phaser without downloading anything? Clone Phaser in Koding and start working right away in their web based development system.

Getting Started

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!

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.

This current release of Phaser is 153 KB gzipped and minified. It contains both Arcade Physics and P2 Physics. We also provide streamlined custom builds which are smaller.

Custom Builds

The custom builds of Phaser are in the build\custom folder.

Phaser includes two physics systems: Arcade Physics and P2.js. Arcade Physics is perfect for arcade style games and provides an AABB (bounding box) based collision system. P2 is a full body physics system, complete with springs, materials, constraints and lots more.

If you don't require P2 then use phaser-arcade-physics.js. It will save nearly 200 KB from the minified file size.

If you don't need physics at all, or are implementing your own, there is an even smaller build: phaser-no-physics.js. This doesn't include Tilemaps or Particle Emitter support as both rely on Arcade Physics but is even smaller as a result.

Finally there is phaser-no-libs.js which is Phaser without any physics support or Pixi.js. Phaser requires Pixi.js to work, but this build allows you to use your own version of Pixi instead of using the one Phaser provides.

Create your own custom build by looking at the grunt tasks and manifests in the tasks folder.

Building from source

Should you wish to build Phaser from source you can take advantage of the provided Grunt scripts. Ensure you have the required packages by running npm install first.

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

If you change either Pixi.js or P2 then use the Grunt tasks replace:pixi and replace:p2. These tasks patch their UMD strings so they work properly with Phaser under requireJS.

Requirements

Phaser requires a modern web browser that supports the canvas tag. 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. Especially with regard to memory and GPU limits on mobile, and older 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 there are comprehensive definition files in the typescript folder. They are for TypeScript 1.0+. If using an earlier version of TypeScript (i.e. 0.9.5) you will need to include WebGL definitions into your project first.

Learn By Example

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

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. Not all features are promised to be delivered, and no timescale is put against any of them either.

Version 2.3 ("Tarabon")

• New parallel asset loader (already started in dev branch)
• Enhance the State Management, so you can perform non-destructive State swaps and persistence.
• Updated Text handling
• 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.
• Restore Math.interpolateAngles and Math.nearestAngleBetween
• Scene Manager - json scene parser.
• Touch Gestures.
• Adjust how Pointers and Interactive Objects work. Allow an IO to be flagged as "on click only", so it doesn't ever get processed during normal Pointer move events (unless being dragged)
• Allow multiple drag items - no longer bind just 1 to a Pointer
• Allow Groups to have Priority IDs too and input disable entire Groups and all children (let it flow down the chain)
• Allow Groups to be InputEnabled? Dragging a Group would be really useful.
• Cache to localStorage using If-Modified-Since. See github request
• Allow for complex assets like Bitmap Fonts to be stored within a texture atlas.

Version 2.4

• Ability to control DOM elements from the core game and layer them into the game.
• Game parameters stored in Google Docs.
• Optimised global Animation manager to cut down on object creation.
• Flash CC HTML5 export integration.
• Massively enhance the audio side of Phaser. Take more advantage of Web Audio: echo effects, positional sound, etc.
• DragonBones support.

Phaser 3

Development has now begun on Phaser 3. At the moment it's still in the very early stages. We are asking for suggestions and feedback in this forum thread so be sure to add your voice.

We are currently experimenting with an ES6 based module system and we're keen for Phaser 3 to use as many native ES6 features as possible. It will be a significant refactoring of the code base, but never at the expense of features or ease-of-use. Development will be made public when the time is right.

We don't anticipate a release until Summer 2015. Phaser 2 still has roadmap features left that we'd like to implement, but after 2.3 it will be in maintenance mode as we work on Phaser 3.

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.

Mighty Editor - 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.

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.

• Before contributing, please read the code of conduct.

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.