mirror of
https://github.com/photonstorm/phaser
synced 2024-11-16 17:58:23 +00:00
359 lines
20 KiB
Markdown
359 lines
20 KiB
Markdown
# Phaser - HTML5 Game Framework
|
|
|
|
<img src="http://phaser.io/images/github/arcade-cab.png" align="right">
|
|
|
|
Phaser is a fast, free, and fun open source HTML5 game framework. It uses a custom build of [Pixi.js](https://github.com/GoodBoyDigital/pixi.js/) for WebGL and Canvas rendering, and supports desktop and mobile web browsers. Games can be compiled to iOS, Android and native desktop apps via 3rd party tools. You can use JavaScript or TypeScript for development.
|
|
|
|
Along with the fantastic open source community, Phaser is actively developed and maintained by [Photon Storm](http://www.photonstorm.com). As a result of rapid support, and a developer friendly API, Phaser is currently one of the [most starred](https://github.com/showcases/javascript-game-engines) game frameworks on GitHub.
|
|
|
|
Thousands of developers worldwide use Phaser. From indies and multi-national digital agencies, to schools and Universities. Each creating their own incredible [games](http://phaser.io/games/).
|
|
|
|
**Visit:** The [Phaser website](http://phaser.io) and follow on [Twitter](https://twitter.com/photonstorm) (#phaserjs)<br />
|
|
**Learn:** [API Docs](http://phaser.io/docs), [Support Forum][forum] and [StackOverflow](http://stackoverflow.com/questions/tagged/phaser-framework)<br />
|
|
**Code:** 700+ [Examples](http://phaser.io/examples) (source available in this [repo][examples])<br />
|
|
**Read:** Weekly [Phaser World](#newsletter) Newsletter<br />
|
|
**Chat:** [Slack](http://phaser.io/community/slack) and [Discord](http://phaser.io/community/discord)<br />
|
|
**Extend:** With [Phaser Plugins](http://phaser.io/shop/plugins)<br />
|
|
**Be awesome:** [Support](#support) the future of Phaser<br />
|
|
|
|
Grab the source and join in the fun!
|
|
|
|
## Contents
|
|
|
|
- [What's New?](#whats-new)
|
|
- [Support Phaser](#support)
|
|
- [Phaser World Newsletter](#newsletter)
|
|
- [Download Phaser](#download)
|
|
- [Getting Started](#getting-started)
|
|
- [Building Phaser](#building-phaser)
|
|
- [Games made with Phaser](#games)
|
|
- [Requirements](#requirements)
|
|
- [Road Map](#road-map)
|
|
- [Change Log](#change-log)
|
|
- [Contributing](#contributing)
|
|
|
|
<a name="whats-new"></a>
|
|
|
|
|
|
<div align="center"><img src="http://phaser.io/images/github/news.jpg"></div>
|
|
|
|
> 31st July 2017
|
|
|
|
Welcome!
|
|
|
|
Phaser has been split into 3 major versions:
|
|
|
|
**[Phaser 2.6.2](https://github.com/photonstorm/phaser/blob/master/v2/)**
|
|
|
|
This is the last official release of Phaser 2. If you're here for the first time then we would recommend you start here.
|
|
|
|
**[Phaser CE (Community Edition)](https://github.com/photonstorm/phaser-ce)**
|
|
|
|
In November 2016 we handed ownership of Phaser 2 over to the open source community so we could work freely on Phaser 3. Since then the community has added many enhancements, new features and fixed loads of bugs. This build is called Phaser CE (Community Edition) and at the time of writing is at version 2.8.3.
|
|
|
|
**[Phaser 3](http://phaser.io/phaser3/)**
|
|
|
|
Phaser 3 is the next generation of the Phaser game framework. We have been working hard on it all year and have a development roadmap in place and regular dev logs. We've recently released the first Alpha build, so if you've time to help us test that would be appreciated! It is not yet production ready, but gets closer with every build.
|
|
|
|
For the latest information visit the Phaser web site, where we cover all three versions. Subscribe to [Phaser World](#newsletter), our weekly newsletter, for the latest news, tutorials and development updates on both Phaser 3 and Phaser CE.
|
|
|
|
Want something more social? Then you can follow us on [Twitter](https://twitter.com/photonstorm) and chat with fellow Phaser developers in our [Slack](http://phaser.io/community/slack) and [Discord](http://phaser.io/community/discord) channels.
|
|
|
|
There are now more ways than ever to help [support](#support) development of Phaser. The uptake so far has been fantastic, but this is an on-going mission. Thank you to everyone who supports our development, who shares our belief in the future of HTML5 gaming, and Phasers role in that.
|
|
|
|
Happy coding everyone!
|
|
|
|
Cheers,
|
|
|
|
Rich - [@photonstorm](https://twitter.com/photonstorm)
|
|
|
|
|
|
|
|
<a name="support"></a>
|
|
|
|
|
|
Developing Phaser takes a lot of time, effort and money. There are monthly running costs; such as hosting and services. As well as countless hours of development time, community support, and assistance resolving issues. We do this out of our love for Phaser, but at the end of the day there are real tangible costs involved.
|
|
|
|
If you have found Phaser useful in your development life. Or have made income as a result of using it, and are in a position to support us financially, without causing any detriment to yourself, then please do. There are a number of ways:
|
|
|
|
* A monthly contribution via [Patreon](https://www.patreon.com/photonstorm).
|
|
* A [one-off donation](http://phaser.io/community/donate) via PayPal.
|
|
* Purchase any of our [plugins or books](http://phaser.io/shop).
|
|
* Companies can sponsor a release of Phaser, or an issue of our newsletter.
|
|
|
|
It all helps cover our running costs, and genuinely contributes towards future development.
|
|
|
|
Extra special thanks to our top-tier sponsors: [Orange Games](http://orangegames.com), [Zenva Academy](http://zenva.com) and [CrossInstall](http://crossinstall.com).
|
|
|
|
|
|
|
|
If you would like to sponsor Phaser then please [get in touch](mailto:support@phaser.io). We have sponsorship options available on our GitHub repo, web site, and newsletter. All of which receive tens of thousands of eyeballs per day.
|
|
|
|
|
|
<a name="newsletter"></a>
|
|
|
|
<div align="center"><img src="http://phaser.io/images/github/phaser-world.png"></div>
|
|
|
|
Every Monday we publish the [Phaser World](http://phaser.io/community/newsletter) newsletter. It's packed full of the latest Phaser games, tutorials, videos, meet-ups, talks, and more. It also contains our weekly Development Progress updates, where you can read about what new features we've been working on.
|
|
|
|
Previous editions can found on our [Back Issues](http://phaser.io/community/backissues) page.
|
|
|
|
|
|
<a name="download"></a>
|
|
|
|
All Phaser versions are [hosted on Github][phaser]. You can:
|
|
|
|
* 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]
|
|
|
|
You can also get Phaser via Bower, npm and CDN. Please see the README files for the version you need for further details:
|
|
|
|
* [Phaser 2 README](https://github.com/photonstorm/phaser/blob/master/v2/README.md)
|
|
* [Phaser Community Edition README](https://github.com/photonstorm/phaser-ce/blob/master/README.md)
|
|
* [Phaser 3 README](https://github.com/photonstorm/phaser/blob/master/v3/README.md)
|
|
|
|
### Phaser Sandbox
|
|
|
|
If you'd like to try coding in Phaser right now, with nothing more than your web browser, then head over to the [Phaser Sandbox](http://phaser.io/sandbox). You'll find Quick Start templates, and a user-friendly editor filled with handy code-completion features.
|
|
|
|
### License
|
|
|
|
Phaser is released under the [MIT License](http://opensource.org/licenses/MIT).
|
|
|
|
|
|
<a name="getting-started"></a>
|
|
|
|
<img src="http://phaser.io/images/github/learn.jpg" align="right">
|
|
|
|
Our [Getting Started Guide](http://phaser.io/tutorials/getting-started) will get you up to speed quickly. From setting up a web server, to picking an IDE. After which read our [Making your first Game](http://phaser.io/tutorials/making-your-first-phaser-game) tutorial. Please work through this, no matter what your development experience, to learn how Phaser approaches things.
|
|
|
|
The single biggest Phaser resource is the [Phaser web site](http://phaser.io/news). You'll find hundreds of tutorials, with new ones added every week. Subscribe to the [Phaser World](http://phaser.io/community/newsletter) newsletter for a weekly links round-up.
|
|
|
|
Using **TypeScript**? [Game From Scratch](http://www.gamefromscratch.com/page/Adventures-in-Phaser-with-TypeScript-tutorial-series.aspx) has a great series of tutorials covering that.
|
|
|
|
Prefer **videos**? Zenva have an excellent [Phaser video course](https://academy.zenva.com/product/the-complete-mobile-game-development-course-platinum-edition/?a=13), with hours of great material.
|
|
|
|
### Source Code Examples
|
|
|
|
Ever since we started Phaser we've been growing and expanding our extensive set of examples. Currently there are over 700 of them, with the full source code and assets available.
|
|
|
|
Browse the [Phaser Examples](http://phaser.io/examples), or clone the [examples repo][examples], and eat your heart out!
|
|
|
|
### Interphase
|
|
|
|
<div align="center"><img src="http://phaser.io/content/interphase/1/images/editorial/pages.jpg"></div>
|
|
|
|
[Interphase](http://phaser.io/interphase) is a programming book for Phaser developers of all skill levels.
|
|
|
|
With 400 pages of content you'll find detailed articles, game development "Making Of" guides and tutorials. All were written using the latest version of Phaser, so you won't be learning any out-dated tricks.
|
|
|
|
As well as the [book](http://phaser.io/interphase) you get all the source code, graphics and assets to go with it, and lots of extras too.
|
|
|
|
### Phaser Editor - A complete Phaser Editor
|
|
|
|
[Phaser Editor](http://phaser.io/shop/apps/phaser-editor) is a brand new Eclipse based editor that offers lots of built-in tools specifically for Phaser developers. Handy features include Smart code auto-completion, built-in web server, documentation search, asset management, texture atlas creator, audio sprite creator, asset previews and lots more.
|
|
|
|
### 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.
|
|
|
|
### Mighty Editor - Visual 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.
|
|
|
|
|
|
<a name="building-phaser"></a>
|
|
|
|
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. You can also create your own builds.
|
|
|
|
### Custom Builds
|
|
|
|
Phaser 2 includes a grunt based build system, which allows you to strip out features you may not require, saving hundreds of KB in the process. Don't use any Sound in your game? Then exclude the entire sound system. Don't need Keyboard support? That can be excluded 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](http://phaser.io/tutorials/creating-custom-phaser-builds) tutorial for details.
|
|
|
|
<a name="browserify"></a>
|
|
### Browserify / CJS
|
|
|
|
Phaser 2 was never written to be modular. Everything exists under one single global namespace, and you cannot `require` selected parts of it into your builds. It expects 3 global vars to exist in order to work properly: `Phaser`, `PIXI` and `p2`. The following is one way of doing this:
|
|
|
|
```javascript
|
|
window.PIXI = require('phaser/build/custom/pixi')
|
|
window.p2 = require('phaser/build/custom/p2')
|
|
window.Phaser = require('phaser/build/custom/phaser-split')
|
|
```
|
|
|
|
If you build a custom version of Phaser 1 it will split the 3 core libs out into their own files, allowing you to require them as above.
|
|
|
|
We appreciate this is just a band-aid, and not a proper use of modules, but please understand it was never built to be used this way. You're trying to fit a square peg in a round browserify-shaped hole, so compromises have to be made. Please don't open GitHub issues about it as we've no intention of changing Phaser at this stage of its life. Full module based development is supported in Phaser 3.
|
|
|
|
### Webpack
|
|
|
|
Starting from Phaser 2.4.5 we included a custom build for Webpack.
|
|
|
|
You need to add `p2` as a dependency.
|
|
|
|
##### Webpack Config
|
|
|
|
```javascript
|
|
var path = require('path');
|
|
var webpack = require('webpack');
|
|
|
|
var phaserModule = path.join(__dirname, '/node_modules/phaser/');
|
|
var phaser = path.join(phaserModule, 'build/custom/phaser-split.js'),
|
|
pixi = path.join(phaserModule, 'build/custom/pixi.js'),
|
|
p2 = path.join(phaserModule, 'build/custom/p2.js');
|
|
|
|
module.exports = {
|
|
...
|
|
module: {
|
|
loaders: [
|
|
{ test: /pixi.js/, loader: "script" },
|
|
]
|
|
},
|
|
resolve: {
|
|
alias: {
|
|
'phaser': phaser,
|
|
'pixi.js': pixi,
|
|
'p2': p2,
|
|
}
|
|
}
|
|
...
|
|
}
|
|
```
|
|
|
|
##### Main js file
|
|
|
|
```javascript
|
|
require('pixi.js');
|
|
require('p2');
|
|
require('phaser');
|
|
```
|
|
|
|
### Building from source
|
|
|
|
Should you wish to build Phaser 2 from source you can take advantage of the provided [Grunt](http://gruntjs.com/) scripts. Ensure you have the required packages by changing to the `v2` or `v2-community` folder, and running `npm install` first.
|
|
|
|
Run `grunt` to perform a default build to the `dist` folder.
|
|
|
|
|
|
<a name="games"></a>
|
|
|
|
Thousands of [games](http://phaser.io/news/category/game) have been made in Phaser. From game jam entries, to titles by some of the largest entertainment brands in the world. Here is a tiny sample. You can find hundreds more on our web site.
|
|
|
|
[][game10]
|
|
[][game11]
|
|
[][game12]
|
|
[][game13]
|
|
[][game14]
|
|
[][game15]
|
|
[][game16]
|
|
[][game17]
|
|
[][game18]
|
|
[][game1]
|
|
[][game2]
|
|
[][game3]
|
|
[][game4]
|
|
[][game5]
|
|
[][game6]
|
|
[][game7]
|
|
[][game8]
|
|
[][game9]
|
|
|
|
Artwork copyright their respective owners.
|
|
|
|
We add [new games](http://phaser.io/news/category/game) to the Phaser site weekly, so be sure to send us yours when it's finished!
|
|
|
|
|
|
<a name="requirements"></a>
|
|
|
|
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. This is especially important with 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 ES5 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](http://www.typescriptlang.org/) there are comprehensive definition files in the `typescript` folder. They are for TypeScript 1.4+.
|
|
|
|
|
|
<a name="change-log"></a>
|
|
|
|
We have always been meticulous in recording changes to the Phaser code base, and where relevant, giving attribution to those in the community who helped with the change. You can find comprehensive Change Logs for all versions:
|
|
|
|
* [Phaser 2 Change Log](https://github.com/photonstorm/phaser/blob/master/v2/CHANGELOG.md).
|
|
* [Phaser Community Edition Change Log](https://github.com/photonstorm/phaser-ce/CHANGELOG.md).
|
|
|
|
|
|
<a name="contributing"></a>
|
|
|
|
The [Contributors Guide][contribute] contains full details on how to help with Phaser development. The main points are:
|
|
|
|
- Found a bug? Report it on [GitHub Issues][issues] and include a code sample. Please state which version of Phaser you are using! This is vitally important.
|
|
|
|
- Pull Requests can now be made against the `master` branch (for years we only accepted PRs against the `dev` branch, but with the release of Phaser CE we've relaxed this policy)
|
|
|
|
- Before submitting a Pull Request run your code through [JSHint](http://www.jshint.com/) using our [config](https://github.com/photonstorm/phaser/blob/master/v2-community/.jshintrc).
|
|
|
|
- Before contributing read the [code of conduct](https://github.com/photonstorm/phaser-ce/blob/master/CODE_OF_CONDUCT.md).
|
|
|
|
Written something cool in Phaser? Please tell us about it in the [forum][forum], or email support@phaser.io
|
|
|
|
|
|
|
|
Phaser is a [Photon Storm](http://www.photonstorm.com) production.
|
|
|
|
|
|
|
|
Created by [Richard Davey](mailto:rich@photonstorm.com). Powered by coffee, anime, pixels and love.
|
|
|
|
The Phaser logo and characters are © 2017 Photon Storm Limited.
|
|
|
|
All rights reserved.
|
|
|
|
"Above all, video games are meant to be just one thing: fun. Fun for everyone." - Satoru Iwata
|
|
|
|
[](https://github.com/igrigorik/ga-beacon)
|
|
|
|
[get-js]: https://github.com/photonstorm/phaser/releases/download/v2.6.2/phaser.js
|
|
[get-minjs]: https://github.com/photonstorm/phaser/releases/download/v2.6.2/phaser.min.js
|
|
[get-zip]: https://github.com/photonstorm/phaser/archive/v2.6.2.zip
|
|
[get-tgz]: https://github.com/photonstorm/phaser/archive/v2.6.2.tar.gz
|
|
[clone-http]: https://github.com/photonstorm/phaser.git
|
|
[clone-ssh]: git@github.com:photonstorm/phaser.git
|
|
[clone-svn]: https://github.com/photonstorm/phaser
|
|
[clone-ghwin]: github-windows://openRepo/https://github.com/photonstorm/phaser
|
|
[clone-ghmac]: github-mac://openRepo/https://github.com/photonstorm/phaser
|
|
[phaser]: https://github.com/photonstorm/phaser
|
|
[issues]: https://github.com/photonstorm/phaser/issues
|
|
[examples]: https://github.com/photonstorm/phaser-examples
|
|
[contribute]: https://github.com/photonstorm/phaser/blob/master/.github/CONTRIBUTING.md
|
|
[forum]: http://www.html5gamedevs.com/forum/14-phaser/
|
|
|
|
[game1]: https://www.prodigygame.com/Fun-Math-Games/
|
|
[game2]: http://www.bbc.co.uk/cbbc/games/deadly-defenders-game
|
|
[game3]: http://www.defiantfew.com/
|
|
[game4]: http://www.pawpatrol.com/fun.php
|
|
[game5]: http://www.fyretale.com/
|
|
[game6]: http://www.pocoyo.com/juegos-ninos/caramelos
|
|
[game7]: http://www.html5gamedevs.com/topic/11179-phaser-cocoonjs-tap-tap-submarine/
|
|
[game8]: http://www.gamepix.com/project/footchinko/
|
|
[game9]: http://orcattack.thehobbit.com
|
|
[game10]: http://phaser.io/news/2015/06/bubble-academy
|
|
[game11]: http://phaser.io/news/2015/07/woodventure
|
|
[game12]: http://phaser.io/news/2015/04/hopsop-journey-to-the-top
|
|
[game13]: http://phaser.io/news/2015/05/banana-mania
|
|
[game14]: http://phaser.io/news/2015/06/salazar-the-alchemist
|
|
[game15]: http://phaser.io/news/2015/05/phaser-shmup
|
|
[game16]: http://phaser.io/news/2015/05/trappy-trap
|
|
[game17]: http://phaser.io/news/2015/04/runaway-ruins
|
|
[game18]: http://phaser.io/news/2015/04/ananias
|