Skip to content

Latest commit

 

History

History
298 lines (177 loc) · 16.1 KB

README.md

File metadata and controls

298 lines (177 loc) · 16.1 KB
Raw

Phaser CE (Community Edition)

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

Phaser CE is based on Phaser v2.6.2 by Photon Storm. Phaser v3 and Phaser v4 are in active development.

The current Phaser CE release is 2.20.0.

Grab the source and join in the fun!

Contents

Made With Phaser

Thousands of games have been made in Phaser. From game jam entries, to titles by some of the largest entertainment brands in the world. You can find hundreds more on our web site.

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

Requirements

Phaser CE 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 CE 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 polyfills 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 CE 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 CE 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+.

Download Phaser CE

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

NPM

Install via npm:

npm install phaser-ce

Please see additional steps for Browserify/CommonJS and Webpack.

CDN

Phaser CE is on jsDelivr. Include the following in your html:

<script src="https://cdn.jsdelivr.net/npm/phaser-ce@2.20.0/build/phaser.js"></script>

or the minified version:

<script src="https://cdn.jsdelivr.net/npm/phaser-ce@2.20.0"></script>

Custom builds are available too, e.g.,

<script src="https://cdn.jsdelivr.net/npm/phaser-ce@2.20.0/build/custom/phaser-arcade-physics.js"></script>

Getting Started

Our Getting Started Guide will get you up to speed quickly: from setting up a web server to picking an editor/IDE. After that read our Making your first Game tutorial. Please work through this, no matter what your development experience, to learn how Phaser CE approaches things.

Using TypeScript? See Phaser CE's TypeScript definitions and the Using Phaser with TypeScript.

Prefer videos? Zenva have an excellent Phaser video course, with hours of great material.

Source Code Examples

Currently there are over 700 Phaser 2 examples, with the full source code and assets available.

Browse Phaser Examples or clone phaser-examples-mirror and eat your heart out!

Web Templates

If you'd like to try coding in Phaser CE right now, with nothing more than your web browser, open up the Phaser CE Game Template. There are CoffeeScript and ES6 variants too.

http-server

For most development, you'll need to run a local web server. If you already have node, it's as easy as:

npm install -g http-server

Then from your project:

http-server . -c-1 -o

There are many other options that you may already have installed as well.

Browserify / CommonJS

Phaser CE (and Phaser 2, before it) were not 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:

window.PIXI   = require('phaser-ce/build/custom/pixi');
window.p2     = require('phaser-ce/build/custom/p2');
window.Phaser = require('phaser-ce/build/custom/phaser-split');

If you build a custom version of Phaser CE it will split the 3 core libs out into their own files, allowing you to require them as above.

Full module-based development is available in Phaser v3.

Webpack

As with browserify, use the pixi, p2, and phaser-split modules in build/custom. You can then use expose-loader to expose them as PIXI, p2, and Phaser.

See our webpack project template or lean/phaser-es6-webpack for a sample configuration.

Ionic

See Ionic.

Interphase

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.

As well as the book 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 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 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.

Building Phaser CE

Phaser CE 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 CE 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 CE is now just 80KB minified and gzipped.

  1. Run npm install
  2. Run grunt custom to see the module and argument lists (it will error; that's OK)
  3. Run, e.g., grunt custom --exclude=sound,keyboard and then find the built script in dist.

See the Creating a Custom Phaser Build tutorial for details.

Building from source

Should you wish to build Phaser CE 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.

Packaging a new release

Releases of new versions of Phaser CE are under the community's control. If you feel there are sufficient fixes, or important ones that warrant a new version release, then please do the following:

  1. Make sure the version number is increased, in line with semver policies, in the following files:

    • package.json
    • src/Phaser.js

  2. Make sure that you have added details of the new version to CHANGELOG.md. This should include a summary of changes made in the version. You can usually obtain this from the commit / PR history. It's nice to credit who made the changes by linking to their GitHub user ID, but isn't a requirement.

  3. From the root repo folder, run grunt eslint and make sure there are no errors. If there are, please fix them, or request that the original author of the code does so.

  4. Once ESLint passes run grunt release, sit back, and wait. It will build all of the versions of Phaser CE required, update the doc files, TypeScript defs and lots more. When finished, commit all of the new files and make sure to include a clear message in your commit saying you want this release pushed to npm. Be sure to tag me when doing this, i.e. 'Phaser CE Version 2.X.X. Please publish to npm @photonstorm' - I'll see it, and then publish as soon as I can (often the same day).

Support Phaser

Developing Phaser takes a lot of time, effort, and money. There are monthly running costs; such as the forum and site, which we maintain 100% ad-free. As well as countless hours of development time, community support, and assistance resolving issues. We do this out of our love for Phaser of course, 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:

It all helps cover our running costs, and genuinely contributes towards future development.

If you would like to sponsor Phaser then please get in touch. We have sponsorship options available on our GitHub repo, web site, and newsletter. All of which receive tens of thousands of eyeballs per day.

Weekly Newsletter

Every Friday we publish the Phaser World 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. If you want to know what we're working on, this is the newsletter to read!

Previous editions can found on our Back Issues page.

Contributing

The Contributors Guide contains full details on how to help with Phaser CE development. The main points are:

  • Found a bug? Report it on GitHub Issues and include a code sample.
  • Before submitting a Pull Request run npm run test and fix any errors.
  • Before contributing read the code of conduct.

Written something cool in Phaser? Please tell us about it in the forum, or email support@phaser.io

Change Log

See Change Log.

License

Phaser CE is released under the MIT License.

Created by

Phaser is a Photon Storm production.

storm

Created by Richard Davey. 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

Analytics