You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+41-51Lines changed: 41 additions & 51 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,22 +4,22 @@
4
4
5
5
Phaser CE 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.
6
6
7
-
Phaser CE is based on Phaser v2.6.2 by [Photon Storm](http://www.photonstorm.com).[Phaser v3](http://phaser.io/) is the current and fully maintained version.
7
+
Phaser CE is based on Phaser v2.6.2 by Photon Storm.[Phaser](http://phaser.io/) is the current and fully maintained version.
8
8
9
-
The [current Phaser CE release is 2.20.1](https://github.com/phaserjs/phaser-ce/releases/tag/v2.20.1).
9
+
The [current Phaser CE release is 2.20.2](https://github.com/phaserjs/phaser-ce/releases/tag/v2.20.2).
10
10
11
-
-**Visit:** The [Phaser website](https://phaser.io) and follow on [Twitter](https://twitter.com/phaser_) (#[phaserjs](https://twitter.com/hashtag/phaserjs))
12
-
-**Learn:**[API Docs](https://phaserjs.github.io/phaser-ce/), [Support Forum][forum] and [StackOverflow](https://stackoverflow.com/questions/tagged/phaser-framework)
13
-
-**Code:** 700+ [Examples](https://samme.github.io/phaser-examples-mirror/"Phaser CE Examples") ([source][examples]), new [Phaser CE examples](https://codepen.io/collection/AMbZgY/)
-[New Phaser CE examples](https://codepen.io/collection/AMbZgY/)
14
+
-[Phaser 2/CE Forum][forum]
15
+
-[Phaser on Discord](http://phaser.io/community/discord)
16
+
-[Phaser plugins on GitHub](https://github.com/search?q=topic%3Aphaser-plugin&type=Repositories)
17
+
-[Phaser plugins on NPM](https://www.npmjs.com/browse/keyword/phaser-plugin)
17
18
18
-
Grab the source and join in the fun!
19
+
If you need API documentation for a [previous version](https://github.com/phaserjs/phaser-ce/releases), download the source code, e.g., <https://github.com/phaserjs/phaser-ce/releases/tag/v2.6.2>, unzip, and open `docs/index.html`.
19
20
20
21
## Contents
21
22
22
-
-[Games made with Phaser](#games)
23
23
-[Requirements](#requirements)
24
24
-[Download Phaser](#download)
25
25
-[Getting Started](#getting-started)
@@ -28,14 +28,6 @@ Grab the source and join in the fun!
28
28
-[Contributing](#contributing)
29
29
-[Change Log](#change-log)
30
30
31
-
<aname="games"></a>
32
-
33
-
## Made With Phaser
34
-
35
-
Thousands of [games](https://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. You can find [hundreds more on our web site](https://phaser.io/games).
36
-
37
-
We add [new games](https://phaser.io/news/category/game) to the Phaser site weekly, so be sure to send us yours when it's finished!
38
-
39
31
<aname="requirements"></a>
40
32
41
33
## Requirements
@@ -80,52 +72,48 @@ Please see additional steps for [Browserify/CommonJS](#browserify) and [Webpack]
80
72
[Phaser CE is on jsDelivr](http://www.jsdelivr.com/projects/phaser-ce). Include the following in your html:
Our [Getting Started Guide](https://phaser.io/tutorials/getting-started) will get you up to speed quickly: from [setting up a web server](https://phaser.io/tutorials/getting-started/part2) to picking an editor/IDE. After that read our [Making your first Game](https://phaser.io/tutorials/making-your-first-phaser-2-game/) tutorial. Please work through this, **no matter what your development experience**, to learn how Phaser CE approaches things.
94
+
Our [Getting Started Guide](https://phaser.io/tutorials/getting-started-phaser2/) will get you up to speed quickly: from [setting up a web server](https://phaser.io/tutorials/getting-started/part2) to picking an editor/IDE. After that read our [Making your first Game](https://phaser.io/tutorials/making-your-first-phaser-2-game/) tutorial. Please work through this, **no matter what your development experience**, to learn how Phaser CE approaches things.
103
95
104
96
Using **TypeScript**? See Phaser CE's [TypeScript definitions](https://github.com/photonstorm/phaser-ce/tree/master/typescript) and the [Using Phaser with TypeScript](https://phaser.io/tutorials/how-to-use-phaser-with-typescript).
105
97
106
-
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.
107
-
108
98
### Source Code Examples
109
99
110
-
Currently there are over 700 Phaser 2 examples, with the full source code and assets available.
111
-
112
-
Browse [Phaser Examples Mirror](https://github.com/samme/phaser-examples-mirror) and eat your heart out!
100
+
Currently there are over [700 Phaser 2 examples](https://github.com/samme/phaser-examples-mirror), with the full source code and assets available.
113
101
114
102
### Web Templates
115
103
116
-
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](https://codepen.io/pen?template=vyKJvw). There are [CoffeeScript](https://codepen.io/pen?template=OWxELE) and [ES6](https://codepen.io/pen?template=pRGPKG) variants too.
104
+
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](https://codepen.io/pen?template=vyKJvw) or [ES6 Template](https://codepen.io/pen?template=pRGPKG).
117
105
118
106
### http-server
119
107
120
108
For most development, you'll need to run a local web server. If you already have [node](https://nodejs.org), it's as easy as:
121
109
122
-
```bash
110
+
```sh
123
111
npm install -g http-server
124
112
```
125
113
126
114
Then from your project:
127
115
128
-
```bash
116
+
```sh
129
117
http-server . -c-1 -o
130
118
```
131
119
@@ -195,17 +183,25 @@ Releases of new versions of Phaser CE are under the community's control. If you
195
183
-`package.json`
196
184
-`src/Phaser.js`
197
185
198
-
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.
186
+
2.Add 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.
199
187
200
-
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.
188
+
3.Update any relevant version numbers in `README.md`.
201
189
202
-
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).
190
+
4. Run `npm run check-version`. Verify all the version numbers match except in `build/phaser.js`, which isn't rebuilt yet.
191
+
192
+
5. 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.
193
+
194
+
6. 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.
195
+
196
+
7. Run `npm run check-version` and verify all the version numbers match.
197
+
198
+
8. When finished, commit all of the new files and include a clear message in your commit saying you want this release pushed to npm: _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).
203
199
204
200
<aname="newsletter"></a>
205
201
206
202
## Weekly Newsletter
207
203
208
-
Every Monday we publish the [Phaser World](https://phaser.io/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. If you want to know what we're working on, this is the newsletter to read!
204
+
Every Monday we publish the [Phaser World](https://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!
209
205
210
206
<aname="contributing"></a>
211
207
@@ -215,7 +211,7 @@ The [Contributors Guide][contribute] contains full details on how to help with P
215
211
216
212
- Found a bug? Report it on [GitHub Issues][issues] and include a code sample.
217
213
- Before submitting a Pull Request run `npm run test` and fix any errors.
218
-
- Before contributing read the [code of conduct](https://github.com/photonstorm/phaser-ce/blob/master/CODE_OF_CONDUCT.md).
214
+
- Before contributing read the [code of conduct](https://github.com/phaserjs/phaser-ce/blob/master/CODE_OF_CONDUCT.md).
219
215
220
216
Written something cool in Phaser? Please tell us about it in the [forum][forum], or email [email protected]
221
217
@@ -235,27 +231,21 @@ Phaser 2 was originally a [Photon Storm](http://www.photonstorm.com) production,
if (this.usingWebAudio && this.context.state !== 'running')
67582
+
{
67583
+
var _this = this;
67584
+
67585
+
// Needed to handle resuming audio on iOS17/iOS18+ if you hide the browser, press the home button, etc. <https://github.com/phaserjs/phaser/issues/6829>
if (this.usingWebAudio && this.context.state !== 'running')
59848
+
{
59849
+
var _this = this;
59850
+
59851
+
// Needed to handle resuming audio on iOS17/iOS18+ if you hide the browser, press the home button, etc. <https://github.com/phaserjs/phaser/issues/6829>
0 commit comments