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 the future of Phaser on Patreon or by buying our books and plugins
- What's New?
- Support Phaser
- Download Phaser
- Getting Started
- Using Phaser
- Games made with Phaser
- Requirements
- Road Map
- Change Log
- Contributing
29th July 2015
Phaser 2.4 is another huge update. We had to bump the version number from 2.3 directly to 2.4 because of some API adjustments, all of which are fully detailed in the Change Log. While it's true we could have released it over a few smaller point releases, that just isn't how the cookie crumbled this time. Be sure to pay attention to the previous deprecated API calls that have been removed in 2.4.
So although you had to wait for it a couple months more than usual, Phaser 2.4 is quite simply an epic release - there is no two ways about it! Brand new video component? Check. Support for fully boned Creature animations? Check. Brand new Cache and Loader updates? Check. Dynamic sprite and gradient generator? Check. Literally hundreds of updates, enhancements and fixes across the entire codebase? Yup, those too! The Change Log seems to scroll on forever, yet the overall package size continues to come down as we optimise and streamline our code too (this release actually builds smaller than 2.3 did, just 80KB min + gz)
Make sure you check out the Phaser web site. We are going to be adding in stacks of new examples and features in the coming weeks.
Also we'd be extremely grateful if you could get involved with our Patreon campaign. We've got some really ambitious plans for how we'd like to see Phaser evolve in the future. Hopefully together we can reach that goal faster.
But that's all for now. I hope you enjoy Phaser 2.4.
Happy coding everyone! See you on the forums.
Cheers,
Rich - @photonstorm
Please help support the future development of Phaser through our Patreon campaign. 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 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
Install via bower
bower install phaser
Install via npm
npm install phaser
jsDelivr is a "super-fast CDN for developers". Include the following in your html:
<script src="//cdn.jsdelivr.net/phaser/2.4.2/phaser.js"></script>
or the minified version:
<script src="//cdn.jsdelivr.net/phaser/2.4.2/phaser.min.js"></script>
cdnjs.com 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.2/phaser.js"></script>
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.
Want to try Phaser without downloading anything? Clone Phaser in Koding and start working right away in their web based development system.
Phaser is released under the MIT License.
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.
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!
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.
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.
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.
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.
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 tutorial for details.
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.
Thousands of games have been made in Phaser. From game jam entries to titles by 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!
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.
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.
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+.
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.
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 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.
- TypeScript definitions fixes and updates (thanks @clark-stevenson @shivinsky)
- JSDoc typo fixes (thanks @DrkSephy)
- TilemapLayer - Fixed unmatched
context.saveandcontext.restorecalls (thanks @MortimerGoro #1934) - Cache.getFrame has a new
cacheparameter (that defaults to the Image cache, but can be changed to any other) - Cache.getFrameCount has a new
cacheparameter (that defaults to the Image cache, but can be changed to any other) - Cache.getFrameData has a new
cacheparameter (that defaults to the Image cache, but can be changed to any other) - Cache.hasFrameData has a new
cacheparameter (that defaults to the Image cache, but can be changed to any other) - Cache.getFrameByIndex has a new
cacheparameter (that defaults to the Image cache, but can be changed to any other) - Cache.getFrameByName has a new
cacheparameter (that defaults to the Image cache, but can be changed to any other) - Device.canPlayVideo now checks for
ogvas a valid file extension for OGG video files (thanks @JB-Tellez #1928) - Phaser.Sound will now automatically check the Cache to see if the audio file it is using is still there or not. If not then it will automatically called
Sound.destroyon itself. If you do not desire this result then you should ensure that you undertake all house-keeping yourself, and properly destroy Sound objects before callingCache.removeSound(#1946)
- DeviceButton would try to set
altKey,shiftKeyandctrlKeyeven for Joypads (thanks @zatch #1939) - Pointer.move would accidentally reset the
isDownstatus of the Pointer on touch devices, which broke things like Sprite input events when built to native apps or run locally (#1932 #1943) - Pointer.onDown (and input enabled items like Buttons) would fail on FireFox / Linux and CocoonJS (#1944 #1945)
For changes in previous releases please see the extensive Version History.
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
devbranch. Never againstmaster. -
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.
"Above all, video games are meant to be just one thing: fun. Fun for everyone." - Satoru Iwata