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.

Along with the fantastic open source community Phaser is actively developed and maintained by Photon Storm Limited. As a result of rapid support and a developer friendly API Phaser is currently one of the most starred 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 and follow on Twitter (#phaserjs)
• Learn: API Documentation, Support Forum and StackOverflow
• Code: 500+ Source Examples (also available in this git repo)
• Read: Subscribe to the Newsletter and grab our Phaser Books
• Chat: #phaserio IRC channel on freenode
• Extend: With Phaser Plugins
• Be awesome: Support our work via Gratipay

Index

• What's New?
• Download Phaser
• Getting Started
• Using Phaser
• Games made with Phaser
• Requirements
• Road Map
• Change Log
• Contributing

What's new in Phaser 2.3.0

26th March 2015

Phaser 2.3.0 marks the second release in 2015 and easily one of our most significant for a while. In terms of API changes they're actually quite minimal, but under the hood we've taken Phaser for a serious workout.

We've traditionally had something of a 'kitchen sink' issue with Phaser. As we thought of great new features to give you we just added them in. And like too much of a good thing they contributed to an ever growing file size.

So two of the biggest changes 2.3.0 has is an internal shift to using Game Object components, and allowing you to exclude features in your own custom builds. The new build system lets you selectively exclude features from being bundled in: for example if your game doesn't need Gamepad or Keyboard support you can now tell Phaser to skip those parts entirely.

This tutorial explains the process in detail. But the end result is that thanks to these changes we've both managed to remove thousands of lines of code and let you decide what Phaser contains. The minimum build size is now just 83KB minified and gzipped and that's still including both the WebGL and Canvas renderers.

Even though we've been cutting down on size we still managed to pack a whole load of great new features in. For example the new spacial sorting added to Arcade Physics allows for incredible speed increases when dealing with densely populated game worlds. The Loader has received a complete overhaul - now offering full parallel asset loading, sync points and more! The Tilemap system was upgraded to support new Tiled 0.11 editor features. Audio has been also been enhanced, with better marker and loop handling. See the Change Log for all the details.

Your games will run faster, have a smaller footprint and load faster than ever.

But it's not just Phaser that has been updated - we also finally released the new Phaser web site! For the past few years it was a huge "wall of text", with hundreds of links filling up the single page site. Now it's all changed! with a much more attractive layout and structure. We've got a healthy and constantly updating news section, the examples have a great new visual showcase and there's even a Sandbox to play in.

It was a lot of hard work but we're super-happy with the result - and judging by our page hits, which are going off the charts, you are too :) We'll be sure to keep enhancing it over the coming months, especially as Phaser 3 development ramps up.

That's all for now. I hope you enjoy Phaser 2.3.0, the new site, the new features and the New Year. Happy coding everyone! See you on the forums.

Cheers,

Rich - @photonstorm

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 Windows or Mac clients.
• 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

CDN

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

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

or the minified version:

<script src="//cdn.jsdelivr.net/phaser/2.3.0/phaser.min.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. 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? Clone Phaser in Koding and start working right away in their web based development system.

License

Phaser is released under the MIT License.

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 and coding your first game.

Prefer videos to reading? Lynda.com have published a free course: HTML5 Game Development with Phaser

The single biggest Phaser resource is the new Phaser web site. 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 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 or clone the examples repo and eat your heart out!

Phaser Books

We've been busy writing books about Phaser. Available now:

• A Guide to the Phaser Tween Manager Book + Code Bundle
• A Guide to the Phaser Scale Manager

With more on the way. Vote on the next title to be written.

Game Mechanic Explorer

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.

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

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

As of 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 83KB minified and gzipped.

See the Creating a Custom Phaser Build tutorial for details.

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 respectively. These tasks patch their UMD strings so they work properly with Phaser under requireJS.

Games made with Phaser

Thousands of games have been made in Phaser. From game jam entries to titles for some of the largest entertainment brands in the world. This is just a tiny sample.

Artwork copyright their respective owners.

We add new games to the Phaser site regularly, be sure to send us yours when it's finished!

Requirements

Phaser requires a 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. 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 there are comprehensive definition files in the typescript folder. They are for TypeScript 1.4+.

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.

Phaser 3

We're now several months 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 and Phaser 3 repo.

There is still plenty of time to add your suggestions and feedback in this forum 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.

Change Log

Version 2.3.1 - "Katar" - in dev

New Features

Updates

• Added missing resumed method to Phaser.State class template.

Bug Fixes

For changes in previous releases please see the extensive Version History.

Contributing

Please read the Contributors Guide for full details on helping with Phaser, but the main points are:

• Found a bug? Report it on GitHub 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 using our config.

• Before contributing please read the code of conduct.

Written something cool that shows Phaser in use? Please tell us about it in our forum or email: support@phaser.io

Phaser is a Photon Storm production.

Created by Richard Davey. Powered by coffee, anime, pixels and love.

The Phaser logo and characters are © 2015 Photon Storm Limited.

All rights reserved.