Skip to content

Commit fc51449

Browse files
authored
Merge pull request phaserjs#3303 from jblang94/revise-readme
Fix and improve README's clarity
2 parents 95d8557 + 69f5bef commit fc51449

1 file changed

Lines changed: 21 additions & 21 deletions

File tree

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
![Phaser Header](https://phaser.io/images/github/300/phaser-header.png "Phaser 3 Header Banner")
44

5-
Phaser is a fast, free, and fun open source HTML5 game framework. It offers WebGL and Canvas rendering across desktop and mobile web browsers. Games can be compiled to iOS, Android and native apps via 3rd party tools. You can use JavaScript or TypeScript for development.
5+
Phaser is a fast, free, and fun open source HTML5 game framework that offers WebGL and Canvas rendering across desktop and mobile web browsers. Games can be compiled to iOS, Android and native apps by using 3rd party tools. You can use JavaScript or TypeScript for development.
66

7-
Phaser is available in two versions: Phaser 3 and [Phaser CE - The Community Edition](https://github.com/photonstorm/phaser-ce). Phaser CE is a community-lead continuation of the Phaser 2 codebase and is hosted on its own repo. Phaser 3 is the next generation of Phaser.
7+
Phaser is available in two versions: Phaser 3 and [Phaser CE - The Community Edition](https://github.com/photonstorm/phaser-ce). Phaser CE is a community-lead continuation of the Phaser 2 codebase and is hosted on a separate repo. Phaser 3 is the next generation of Phaser.
88

99
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/collections/javascript-game-engines) game frameworks on GitHub.
1010

11-
Thousands of developers worldwide use Phaser. From indies and multi-national digital agencies, to schools and Universities. Each creating their own incredible [games](https://phaser.io/games/).
11+
Thousands of developers from indie and multi-national digital agencies, and universities worldwide use Phaser. You can take a look at their incredible [games](https://phaser.io/games/).
1212

1313
**Visit:** The [Phaser website](https://phaser.io) and follow on [Twitter](https://twitter.com/phaser_) (#phaserjs)<br />
1414
**Learn:** [API Docs](https://github.com/photonstorm/phaser3-docs), [Support Forum][forum] and [StackOverflow](https://stackoverflow.com/questions/tagged/phaser-framework)<br />
@@ -18,7 +18,7 @@ Thousands of developers worldwide use Phaser. From indies and multi-national dig
1818
**Extend:** With [Phaser Plugins](https://phaser.io/shop/plugins)<br />
1919
**Be awesome:** [Support](#support) the future of Phaser<br />
2020

21-
Grab the source and join in the fun!
21+
Grab the source and join the fun!
2222

2323
![What's New](https://phaser.io/images/github/div-whats-new.png "What's New")
2424

@@ -68,9 +68,9 @@ Extra special thanks to our top-tier sponsors: [Orange Games](http://orangegames
6868

6969
<div align="center"><img src="https://phaser.io/images/github/phaser-world.png"></div>
7070

71-
Every Monday we publish the [Phaser World](https://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.
71+
Every Monday we publish the [Phaser World](https://phaser.io/community/newsletter) newsletter. It's packed full of the latest Phaser games, tutorials, videos, meet-ups, talks, and more. The newsletter also contains our weekly Development Progress updates which let you know about the new features we're working on.
7272

73-
Over 100 previous editions can found on our [Back Issues](http://phaser.io/community/backissues) page.
73+
Over 100 previous editions can be found on our [Back Issues](http://phaser.io/community/backissues) page.
7474

7575
![Download Phaser](https://phaser.io/images/github/div-download.png "Download Phaser")
7676
<a name="download"></a>
@@ -91,7 +91,7 @@ npm install phaser
9191

9292
### CDN
9393

94-
[Phaser is on jsDelivr](http://www.jsdelivr.com/projects/phaser), a "super-fast CDN for developers". Include the following in your html:
94+
[Phaser is on jsDelivr](http://www.jsdelivr.com/projects/phaser) which is a "super-fast CDN for developers". Include the following in your html:
9595

9696
```html
9797
<script src="//cdn.jsdelivr.net/npm/phaser@3.1.2/dist/phaser.js"></script>
@@ -112,7 +112,7 @@ Phaser is released under the [MIT License](https://opensource.org/licenses/MIT).
112112

113113
<img src="https://phaser.io/images/github/learn.jpg" align="right">
114114

115-
Phaser 3 is so brand new the paint is still wet, but tutorials and guides are starting to come out!
115+
Phaser 3 is so brand new the "paint is still wet", but tutorials and guides are starting to come out!
116116

117117
* [Getting Started with Phaser 3](https://phaser.io/tutorials/getting-started-phaser3) (useful if you are completely new to Phaser)
118118
* [Making your first Phaser 3 Game](https://phaser.io/tutorials/making-your-first-phaser-3-game)
@@ -122,7 +122,7 @@ Also, please subscribe to the [Phaser World](https://phaser.io/community/newslet
122122

123123
### Source Code Examples
124124

125-
During our development of Phaser 3 we created hundreds of examples, with the full source code and assets available. Until those are fully integrated with the Phaser web site, you'll have to browse them in the [Phaser 3 Labs](http://labs.phaser.io), or clone the [examples repo][examples]. Note: Not all examples work, sorry! We're tidying them up as fast as we can.
125+
During our development of Phaser 3, we created hundreds of examples with the full source code and assets. Until these examples are fully integrated into the Phaser website, you can browse them on [Phaser 3 Labs](http://labs.phaser.io), or clone the [examples repo][examples]. Note: Not all examples work, sorry! We're tidying them up as fast as we can.
126126

127127
### Create Your First Phaser 3 Example
128128

@@ -142,7 +142,7 @@ Create an `index.html` page locally and paste the following code into it:
142142
</html>
143143
```
144144

145-
This is a standard empty web page. You'll notice it's pulling in a build of Phaser 3 in the script tag, but otherwise doesn't do anything yet. Now let's set-up the game config. Paste the following between the `<script></script>` tags:
145+
This is a standard empty webpage. You'll notice there's a script tag that is pulling in a build of Phaser 3, but otherwise this webpage doesn't do anything yet. Now let's set-up the game config. Paste the following between the `<script></script>` tags:
146146

147147
```javascript
148148
var config = {
@@ -162,7 +162,7 @@ var config = {
162162
};
163163
```
164164

165-
This is a pretty standard Phaser 3 Game Configuration object. We'll tell it to use the WebGL renderer if it can, set the canvas to a size of 800x600 pixels, enable Arcade Physics and finally call the `preload` and `create` functions. These don't exist yet, so if you run this it will just error. So add the following after the config object:
165+
`config` is a pretty standard Phaser 3 Game Configuration object. We tell `config` to use the WebGL renderer if it can, set the canvas to a size of 800x600 pixels, enable Arcade Physics, and finally call the `preload` and `create` functions. `preload` and `create` have not been implemented yet, so if you run this JavaScript code, you will have an error. Add the following after `config`:
166166

167167
```javascript
168168
var game = new Phaser.Game(config);
@@ -181,9 +181,9 @@ function create ()
181181
}
182182
```
183183

184-
This creates a Phaser Game instance, using our configuration object. It also provides the two functions it needs. The `preload` function is a way to easily load assets into your game. Here we'll set the Base URL to be the Phaser server and grab down 3 PNG files.
184+
`game` is a Phaser Game instance that uses our configuration object `config`. We also add function definitions for `preload` and `create`. The `preload` function helps you easily load assets into your game. In `preload`, we set the Base URL to be the Phaser server and load 3 PNG files.
185185

186-
The create function is empty, so it's time to fill it in:
186+
The `create` function is empty, so it's time to fill it in:
187187

188188
```javascript
189189
function create ()
@@ -208,33 +208,33 @@ function create ()
208208
}
209209
```
210210

211-
Here we're adding the sky image into the game. Over the top of this we have created a Particle Emitter. The `scale` value means the particles will start large and then scale away to nothing over the duration of their lifespan.
211+
Here we add a sky image into the game and create a Particle Emitter. The `scale` value means that the particles will initially be large and will shrink to nothing as their lifespan progresses.
212212

213-
Then we add the logo image. Notice how this is a Physics Image, which means it is given a physics body by default. We set some properties on it: velocity, bounce (or restitution) and collision with the world bounds. This will make our logo bounce around the screen. Finally, we tell the particle emitter to follow the logo - so as it moves, the particles will flow from it.
213+
After creating the `emitter`, we add a logo image called `logo`. Since `logo` is a Physics Image, `logo` is given a physics body by default. We set some properties for `logo`: velocity, bounce (or restitution), and collision with the world bounds. These properties will make our logo bounce around the screen. Finally, we tell the particle emitter to follow the logo - so as the logo moves, the particles will flow from it.
214214

215215
Run it in your browser and you'll see the following:
216216

217217
![Phaser 3 Demo](https://phaser.io/images/github/300/sample1.png "Phaser 3 Demo")
218218

219219
(Got an error? Here's the [full code](https://gist.github.com/photonstorm/46cb8fb4b19fc7717dcad514cdcec064))
220220

221-
It's just a tiny example, and we've hundreds more for you to explore, but hopefully it shows how expressive and quick Phaser is to use. With just a few easily readable lines of code we've got something pretty impressive up on screen!
221+
This is a tiny example, and there are hundreds more for you to explore, but hopefully it shows how expressive and quick Phaser is to use. With just a few easily readable lines of code, we've got something pretty impressive up on screen!
222222

223223
Subscribe to our weekly newsletter for further tutorials and examples.
224224

225225
![Building Phaser](https://phaser.io/images/github/div-building-phaser.png "Building Phaser")
226226

227-
Phaser is provided ready compiled in the `dist` 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.
227+
There are both plain and minified compiled versions of Phaser in the `dist` folder of the repository. The plain version is for use during development, and the minified version is for production use. You can also create your own builds.
228228

229229
### Custom Builds
230230

231-
Phaser 3 has to be built using Webpack. We take advantage of a number of Webpack features and plugins to allow us to properly tailor the build process. You can also elect exactly which features are bundled into your version of Phaser. We will release a tutorial covering the process shortly, but for now please look at our webpack config files to get an idea of the settings required.
231+
Phaser 3 must be built using Webpack. We take advantage of a number of Webpack features and plugins which allow us to properly tailor the build process. You can elect exactly which features are bundled into your version of Phaser. We will release a tutorial covering the process shortly, but for now please look at our webpack config files to get an idea of the required settings.
232232

233-
### Building from source
233+
### Building from Source
234234

235-
Should you wish to build Phaser 3 from source ensure you have the required packages by cloning the repository and then running `npm install`.
235+
If you wish to build Phaser 3 from source, ensure you have the required packages by cloning the repository and then running `npm install`.
236236

237-
You can then run `webpack` to perform a dev build to the `build` folder, including source maps for local testing, or run `npm run dist` to create a minified packaged build into the `dist` folder.
237+
You can then run `webpack` to create a development build in the `build` folder which includes source maps for local testing. You can also run `npm run dist` to create a minified packaged build in the `dist` folder.
238238

239239
![Change Log](https://phaser.io/images/github/div-change-log.png "Change Log")
240240
<a name="changelog"></a>

0 commit comments

Comments
 (0)