Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-10 07:04:31 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added game screen shots.

Browse source
This commit is contained in:
photonstorm 2015-01-06 04:19:19 +00:00
parent 8620f20dec
commit a57d2e5cb2
1 changed files with 113 additions and 162 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

275
README.md
View file

@ -1,4 +1,4 @@
![div](http://www.phaser.io/images/github/welcome-div.png)
![div](http://www.phaser.io/images/github/welcome-div2.png)
# Phaser
@ -12,53 +12,53 @@ It is actively developed and maintained by the company [Photon Storm](http://www
* [Twitter](https://twitter.com/photonstorm) (feel free to use #phaserjs when tweeting)
* [API Documentation](http://docs.phaser.io)
* [Support Forum][forum]
* [Source Code Examples](http://examples.phaser.io) (also available in this [git repo][examples])
* [400+ Code Examples](http://examples.phaser.io) (also available in this [git repo][examples])
* Subscribe to the [Phaser Newsletter](https://confirmsubscription.com/h/r/369DE48E3E86AF1E)
* StackOverflow tag: [phaser-framework](http://stackoverflow.com/questions/tagged/phaser-framework)
* [Phaser Plugins](https://github.com/photonstorm/phaser-plugins)
* [#phaserio IRC channel](http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/) on freenode
* Please support our work via [Gratipay](https://gratipay.com/photonstorm/)
![div](http://www.phaser.io/images/github-hr.png)
![div](http://www.phaser.io/images/github/div.png)
# Index
## Index
- [What's New?](#whats-new)
- [Getting Started](#getting-started)
- [Change Log](#change-log)
- [How to Build](#how-to-build)
- [Koding](#koding)
- [Bower / NPM](#bower)
- [jsDelivr](#jsdelivr)
- [Download Phaser](#download)
- [Getting Started](#getting-started)
- [Using Phaser](#using-phaser)
- [Phaser made Games](#games)
- [Requirements](#requirements)
- [Build Files](#build-files)
- [Learn By Example](#example)
- [Features](#features)
- [Road Map](#road-map)
- [Mighty Editor](#mighty-editor)
- [Phaser 3](#phaser3)
- [Contributing](#contributing)
- [Bugs?](#bugs)
- [License](#license)
![div](http://www.phaser.io/images/github-hr.png)
![div](http://www.phaser.io/images/github/div.png)
<a name="whats-new"></a>
## What's new in 2.2.2?
<div align="center"><img src="http://phaser.io/images/github/news.jpg"></div>
Content here :)
Happy New Year and to the first release of Phaser in 2015!
After the runaway success Phaser enjoyed in 2014 we're really excited to see what this year will bring. So we're starting out strong with the 2.2.2 release. This is mostly a maintenance release and fixes a few crucial issues such as tilemap rendering in Safari and physics performance. But a few small but super-useful features sneaked in too, my favourite being that the Loader now supports BLOB urls for audio files.
If you take a peek at the [milestones](https://github.com/photonstorm/phaser/milestones/2.3.0) you'll see we've got some great features about to merge into dev for the 2.3 release. Included is a refactoring of all the Game Object classes, a new parallel asset loader and more consistent Text style handling.
As well as this we're also hard at work on Phaser 3. Development on the brand new renderer began in earnest last year and we're already seeing exceptional results from it. You can follow along in the forum and public repo.
Happy coding everyone! I hope to see you on the forums.
![boogie](http://www.phaser.io/images/spacedancer.gif)
![div](http://www.phaser.io/images/github/change-log-div.png)
![div](http://www.phaser.io/images/github/div.png)
<a name="change-log"></a>
## Change Log
The current stable version of Phaser is 2.2.2 "Alkindar" released: in-dev
Version 2.2.2 - "Alkindar" - 6th January 2015
### New Features
@ -126,78 +126,103 @@ primary input is ubiquitously a mouse. There are no known breaking compatibility
* 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](https://github.com/photonstorm/phaser/blob/master/CHANGELOG.md).
For changes made in previous versions please see the [Version History](https://github.com/photonstorm/phaser/blob/master/CHANGELOG.md).
![Phaser Logo](http://www.photonstorm.com/wp-content/uploads/2013/09/phaser_10_release.jpg)
![div](http://www.phaser.io/images/github-hr.png)
![div](http://www.phaser.io/images/github/div.png)
<a name="download"></a>
## Download Phaser
Phaser is [hosted on Github][phaser]. There are a number of ways to download it:
* Clone the git repository via [https][clone-http], [ssh][clone-ssh] or with the Github Desktop [Windows][clone-ghwin] or [Mac][clone-ghmac] client.
* Clone the git repository via [https][clone-http], [ssh][clone-ssh] or with the Github [Windows][clone-ghwin] or [Mac][clone-ghmac] clients.
* Download as [zip][get-zip] or [tar.gz][get-tgz]
* Download just the build files: [phaser.js][get-js] and [phaser.min.js][get-minjs]
* Checkout with [svn][clone-svn]
### Bower / npm
Install via [bower](http://bower.io): `bower install phaser`
Install via [bower](http://bower.io)
Install via [npm](https://www.npmjs.com): `npm install phaser`
`bower install phaser`
### jsDelivr CDN
Install via [npm](https://www.npmjs.com)
[jsDelivr](http://jsdelivr.com) is a "super-fast CDN for developers". Include the following in your html:
`npm install phaser`
`<script src="//cdn.jsdelivr.net/phaser/2.2.1/phaser.js"></script>`
### CDN
[jsDelivr](http://www.jsdelivr.com/#!phaser) is a "super-fast CDN for developers". Include the following in your html:
`<script src="//cdn.jsdelivr.net/phaser/2.2.2/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](http://www.jsdelivr.com/#!phaser).
`<script src="//cdn.jsdelivr.net/phaser/2.2.2/phaser.min.js"></script>`
### Koding
Want to try Phaser without downloading anything? [Clone Phaser in Koding](https://koding.com/Teamwork?import=https://github.com/photonstorm/phaser/archive/master.zip&c=git1) and start working right away in their web based development system.
![div](http://www.phaser.io/images/github-hr.png)
### License
Phaser is released under the [MIT License](http://opensource.org/licenses/MIT).
![div](http://www.phaser.io/images/github/div.png)
<a name="getting-started"></a>
## Getting Started
We have a [Getting Started Guide](http://phaser.io/getting-started-js.php) 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 have a [Getting Started Guide](http://phaser.io/getting-started-js.php) which covers all you need to begin developing games with Phaser. From setting up a web server to picking an IDE to coding your first game.
Lynda.com have published a free video course: [HTML5 Game Development with Phaser](http://www.lynda.com/Phaser-tutorials/HTML5-Game-Development-Phaser/163641-2.html)
We wrote a comprehensive [How to Learn Phaser](http://gamedevelopment.tutsplus.com/articles/how-to-learn-the-phaser-html5-game-engine--gamedev-13643) guide for GameDevTuts+ which covers finding tutorials, examples and support.
Although it's currently a bit of a wall of text we urge you to check out the "News" section of the [Phaser web site][http://phaser.io]. You'll find fresh links *daily* including loads of tutorials.
### Learn by Example
Ever since we started Phaser we've been growing and expanding our extensive set of source code examples. Currently there are over 400 of them!
Browse the [Phaser Examples](http://examples.phaser.io) or clone the [examples repo][examples] and eat your heart out!
### Phaser Books
<div align="center"><img src="http://phaser.io/images/github/news.jpg"></div>
Available now: [A Guide to the Phaser Tween Manager](https://leanpub.com/phasertweenmanager) Book + Code Bundle! and [A Guide to the Phaser Scale Manager](https://leanpub.com/phaserscalemanager) with more on the way.
### Game Mechanic Explorer
The [Game Mechanic Explorer](http://gamemechanicexplorer.com) 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](http://www.lessmilk.com/phaser-tutorial/) is growing fast!
### Mighty Editor - A Visual Phaser Game Editor
![div](http://www.phaser.io/images/github-hr.png)
[MightyEditor](http://mightyfingers.com/) 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.
![div](http://www.phaser.io/images/github/div.png)
<a name="using-phaser"></a>
## 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.
This current release of Phaser is 153 KB *gzipped and minified* with both **Arcade Physics** and **P2 Physics** included. We also provide streamlined custom builds.
### Custom Builds
The custom builds of Phaser are in the `build\custom` folder.
Phaser includes two physics systems: Arcade Physics and [P2.js](https://schteppe.github.io/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.
Phaser comes with two physics systems: Arcade Physics and [P2.js](https://schteppe.github.io/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 require P2 then use the custom build: `phaser-arcade-physics.js`. This 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.
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 either, 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.
See the manifests files in the `tasks` folder to create your own custom builds.
### Building from source
@ -205,16 +230,31 @@ Should you wish to build Phaser from source you can take advantage of the provid
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.
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.
![div](http://www.phaser.io/images/github-hr.png)
![div](http://www.phaser.io/images/github/div.png)
<a name="games"></a>
## Phaser made Games
*Thousands* of games have been made in Phaser. This is just a tiny sample.
[![Game Title](http://phaser.io/images/github/shot1.jpg)][game1]
[![Game Title](http://phaser.io/images/github/shot2.jpg)][game2]
[![Game Title](http://phaser.io/images/github/shot3.jpg)][game3]
[![Game Title](http://phaser.io/images/github/shot4.jpg)][game4]
[![Game Title](http://phaser.io/images/github/shot5.jpg)][game5]
[![Game Title](http://phaser.io/images/github/shot6.jpg)][game6]
[![Game Title](http://phaser.io/images/github/shot7.jpg)][game7]
![div](http://www.phaser.io/images/github/div.png)
<a name="requirements"></a>
## Requirements
Phaser requires a modern web browser that supports the [canvas tag](http://caniuse.com/#feat=canvas). This includes Internet Explorer 9+, Firefox, Chrome, Safari and Opera on desktop. iOS Safari, Android Browser and Chrome for Android are supported on mobile.
Phaser requires a web browser that supports the [canvas tag](http://caniuse.com/#feat=canvas). 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.
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
@ -226,92 +266,7 @@ Phaser is developed in JavaScript. We've made no assumptions about how you like
If you code with [TypeScript](http://www.typescriptlang.org/) 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](https://github.com/piersh/WebGL.ts) into your project first.
![div](http://www.phaser.io/images/github-hr.png)
<a name="example"></a>
## 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](http://examples.phaser.io) online.
![div](http://www.phaser.io/images/github-hr.png)
<a name="features"></a>
## Features
**WebGL &amp; 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 <em>fast</em> and we stay on-top of the changing browser landscape.
![FruitParty](http://www.photonstorm.com/wp-content/uploads/2013/10/phaser_fruit_particles-640x480.png)
![div](http://www.phaser.io/images/github-hr.png)
![div](http://www.phaser.io/images/github/div.png)
<a name="road-map"></a>
## Road Map
@ -343,9 +298,12 @@ Here are some of the features planned for future releases. Not all features are
* Massively enhance the audio side of Phaser. Take more advantage of Web Audio: echo effects, positional sound, etc.
* DragonBones support.
### Phaser 3
![div](http://www.phaser.io/images/github/div.png)
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](http://www.html5gamedevs.com/topic/7949-the-phaser-3-wishlist-thread/) so be sure to add your voice.
<a name="phaser3"></a>
## Phaser 3
Development has 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](http://www.html5gamedevs.com/topic/7949-the-phaser-3-wishlist-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.
@ -353,49 +311,34 @@ We don't anticipate a release until Summer 2015. Phaser 2 still has roadmap feat
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.
![div](http://www.phaser.io/images/github-hr.png)
<a name="mighty-editor"></a>
## Mighty Editor - A Visual Phaser Game Editor
[MightyEditor](http://mightyfingers.com/) 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.
![div](http://www.phaser.io/images/github-hr.png)
![div](http://www.phaser.io/images/github/div.png)
<a name="contributing"></a>
## Contributing
We now have a full [Contributors Guide][contribute] which goes into the process in more detail, but here are the headlines:
Please read the [Contributors Guide][contribute] for full details on helping with Phaser, but the main points are:
- If you find a bug then please report it on [GitHub Issues][issues] or our [Support Forum][forum].
- If you find a bug then report it on [GitHub Issues][issues] or our [Support Forum][forum], ideally with a code example.
- 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][forum] or email: rich@photonstorm.com
- If you issue a Pull Request only do so against the `dev` branch. *Never* against `master`.
- 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](http://www.jshint.com/) 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 submitting a Pull Request run your code through [JSHint](http://www.jshint.com/) to check for stylistic or formatting errors. To use JSHint, run `grunt jshint`.
- Before contributing, please read the [code of conduct](https://github.com/photonstorm/phaser/blob/master/CODE_OF_CONDUCT.md).
[![Build Status](https://travis-ci.org/photonstorm/phaser.png?branch=dev)](https://travis-ci.org/photonstorm/phaser)
![div](http://www.phaser.io/images/github-hr.png)
<a name="bugs"></a>
## Bugs?
Please add them to the [Issue Tracker][issues] with as much info as possible, especially source code demonstrating the issue.
![Phaser Tilemap](http://www.photonstorm.com/wp-content/uploads/2013/04/phaser_tilemap_collision.png)
"Being negative is not how we make progress" - Larry Page, Google
![div](http://www.phaser.io/images/github-hr.png)
Written something cool that shows Phaser in use? Then we'd love to hear from you! Post it to our [forum][forum] or email: rich@photonstorm.com
<a name="license"></a>
## License
[![Build Status](https://travis-ci.org/photonstorm/phaser.png?branch=dev)](https://travis-ci.org/photonstorm/phaser)
Phaser is released under the [MIT License](http://opensource.org/licenses/MIT).
![div](http://www.phaser.io/images/github/div.png)
Phaser is a Photon Storm production.
![storm](http://www.phaser.io/images/github/photonstorm.png)
The Phaser logo and characters are &copy; Copyright 2012 - 2015 Photon Storm Limited. All rights reserved.
[![Analytics](https://ga-beacon.appspot.com/UA-44006568-2/phaser/index)](https://github.com/igrigorik/ga-beacon)
@ -413,3 +356,11 @@ Phaser is released under the [MIT License](http://opensource.org/licenses/MIT).
[examples]: https://github.com/photonstorm/phaser-examples
[contribute]: https://github.com/photonstorm/phaser/blob/master/CONTRIBUTING.md
[forum]: http://www.html5gamedevs.com/forum/14-phaser/
[game1]: http://phaser.io
[game2]: http://phaser.io
[game3]: http://phaser.io
[game4]: http://phaser.io
[game5]: http://phaser.io
[game6]: http://phaser.io
[game7]: http://phaser.io