diff --git a/README.md b/README.md index 8da2a2c20..bef199edd 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,15 @@ ![JSDelivr](https://img.shields.io/jsdelivr/npm/hm/phaser?style=for-the-badge) ![GitHub](https://img.shields.io/github/downloads/phaserjs/phaser/total?style=for-the-badge) -Phaser is a fast, free, and fun open source HTML5 game framework that offers WebGL and Canvas rendering across desktop and mobile web browsers and has been actively developed for over 10 years. Games can be built for the web, YouTube Playables, Discord Activies, Twitch Overlays or compiled to iOS, Android and native apps using 3rd party tools. You can use JavaScript or TypeScript for development. Phaser supports over 40 different front-end frameworks, such as React and Vue. +Phaser is a fast, free, and fun open source HTML5 game framework that offers WebGL and Canvas rendering across desktop and mobile web browsers and has been actively developed for over 10 years. + +Games can be built for the web, or as YouTube Playables, Discord Activies, Twitch Overlays or compiled to iOS, Android, Steam and native apps using 3rd party tools. You can use JavaScript or TypeScript for development. Phaser supports over 40 different front-end frameworks including React and Vue. Phaser is commercially developed and maintained by **Phaser Studio Inc** along with our fantastic open source community. 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. Interested in learning more? Click the image below to watch our intro video. -[![YouTube](http://i.ytimg.com/vi/jHTRu4iNTcA/hqdefault.jpg)](https://www.youtube.com/watch?v=jHTRu4iNTcA) +[![YouTube](http://i.ytimg.com/vi/jHTRu4iNTcA/maxresdefault.jpg)](https://www.youtube.com/watch?v=jHTRu4iNTcA) ## Create Phaser Game App @@ -44,7 +46,7 @@ Most come in both JavaScript and TypeScript versions. ## Installing Phaser from NPM -Install via [npm](https://www.npmjs.com): +Install via [npm](https://www.npmjs.com/package/phaser): ```bash npm install phaser @@ -59,9 +61,16 @@ npm install phaser ``` +It is also available from Cloudflare's [cdnjs](https://cdnjs.com/libraries/phaser): + +```html + + +``` + ## Phaser TypeScript Definitions -Full TypeScript definitions can be found inside the [types folder]((https://github.com/phaserjs/phaser/tree/master/types)). They are also referenced in the `types` entry in `package.json`, meaning modern IDEs such as VSCode will detect them automatically. +Full TypeScript definitions can be found inside the [types folder](https://github.com/phaserjs/phaser/tree/master/types). They are also referenced in the `types` entry in `package.json`, meaning modern editors such as VSCode will detect them automatically. Depending on your project, you may need to add the following to your `tsconfig.json` file: @@ -73,16 +82,20 @@ Depending on your project, you may need to add the following to your `tsconfig.j ## API Documentation -Go to https://newdocs.phaser.io/ to read our API documentation. Use the links at the top of the page to navigate the namespaces, classes, events and Game Objects and also to use the search box. +Read our full API Documentation at https://newdocs.phaser.io/. Use the links at the top of the page to navigate the namespaces, classes, events and Game Objects and also to use the search box. + +We maintain documentation for the 10 most recent versions on this site. ## Getting Started with Phaser -New tutorials are being published every week. We recommend the following to begin your journey: +We recommend the following to begin your journey: * [Getting Started with Phaser 3](https://phaser.io/tutorials/getting-started-phaser3) (useful if you are completely new to Phaser) * [Making your first Phaser 3 Game](https://phaser.io/tutorials/making-your-first-phaser-3-game) * The [Complete Phaser 3 Game Development course](https://academy.zenva.com/product/html5-game-phaser-mini-degree/?a=13) contains over 15 hours of videos covering all kinds of important topics. -* Plus, there are [over 700 Phaser tutorials](https://phaser.io/learn) listed on the official website. +* Plus, there are [over 700 Phaser tutorials](https://phaser.io/learn) listed on our website. + +New tutorials are being published every week, so check our site for more. ## Phaser by Example Book @@ -92,25 +105,27 @@ We have published a brand-new free 500 page book on game development with Phaser Written by long-time prolific Phaser enthusiast Pello Xabier Altadill and Richard Davey, creator of Phaser, it features up-to-date content on building games with Phaser v3.85. -The book takes you through the process of creating a variety of different games. As the title implies, this allows you to learn by working through real-life examples. The games start simple, with an infinite runner game, and then progresses to building a shoot-em-up, a platformer, a puzzle game, a rogue-like, a story game and even 3D and multiplayer games. +Work through the process of creating a variety of games, allowing you to learn from real-life examples. The games start simple, with an infinite runner game, and then progresses to building a shoot-em-up, a platformer, a puzzle game, a rogue-like, a story game and even 3D and multiplayer games. It also contains a large section on the core concepts of Phaser, covering the terminology and conventions used by the framework, as well as a comprehensive deep dive into Game Objects. -Register for a free Phaser account to [Download the book](https://phaser.io/news/2024/04/phaser-by-example-book). +Register for a free Phaser account to [download the book](https://phaser.io/news/2024/04/phaser-by-example-book). ## Source Code Examples -We have created hundreds of examples and they are all available with full source code and assets. Browse the examples on the [Phaser 3 Labs](https://labs.phaser.io) +We have created hundreds of examples and they are all available with full source code and assets. + +Browse the examples on the [Phaser 3 Labs](https://labs.phaser.io) ## Phaser 3 Plugins -Super community member RexRainbow has been publishing Phaser 3 content for years, building up an impressive catalogue that all Phaser developers should be aware of. +Super community member RexRainbow has been publishing Phaser content for years, compiling an impressive catalogue of plugins that all Phaser developers should be aware of. -You'll find [Phaser Plugins](https://rexrainbow.github.io/phaser3-rex-notes/docs/site/index.html#list-of-my-plugins) that extend the framework with features such as UI controls, text input boxes, Firebase support, Finite State Machines and lots more. His set of 'Phaser Notes' are also invaluable reading. Find them at [https://rexrainbow.github.io](https://rexrainbow.github.io/phaser3-rex-notes/docs/site/index.html) +You'll find [Phaser Plugins](https://rexrainbow.github.io/phaser3-rex-notes/docs/site/index.html#list-of-my-plugins) that extend the framework with features such as UI controls, text input boxes, Firebase support, Finite State Machines and lots more. His set of [Phaser Notes](https://rexrainbow.github.io/phaser3-rex-notes/docs/site/index.html) are also invaluable reading. ## Phaser Sandbox -The Phaser Sandbox is a fully-configured online editor, ready to go. It's loaded with all the core versions of Phaser and packed full of handy features. [Register for a free Phaser account](https://phaser.io/register) to create and save your own sandbox entries. Or view one [just like this](https://phaser.io/sandbox/XyqPcjNr). +The Phaser Sandbox is a fully-configured online editor, ready to go direct in your desktop browser. It's loaded with all the core versions of Phaser and packed full of handy features. [Register for a free Phaser account](https://phaser.io/register) to create and save your own sandbox entries. Or view one [just like this](https://phaser.io/sandbox/XyqPcjNr). ## Phaser Compressor @@ -125,12 +140,7 @@ We meticulously keep track of new features, updates and bug fixes in our change * [v3.85 Change Log](changelog/3.85/CHANGELOG-v3.85.md) * [v3.0.0 to v3.80.1. Change Logs](CHANGELOG.md) -**Visit** the [Phaser website](https://phaser.io)
-**Play** some [amazing games](https://phaser.io/games)
-**Learn** By browsing our [API Docs](https://newdocs.phaser.io), [Support Forum][forum] and [StackOverflow](https://stackoverflow.com/questions/tagged/phaser-framework)
-**Code Examples?** We've over 2000 [Examples](https://phaser.io/examples) to learn from
-**Read** the weekly [Phaser World](https://phaser.io/newsletter/2024) Newsletter
-**Be Social:** Join us on [Discord](https://discord.gg/phaser) and [Reddit](https://phaser.io/community/reddit) or follow us on [Twitter](https://twitter.com/phaser_)
+## Have fun! Grab the source and join the fun! @@ -140,11 +150,17 @@ Happy coding everyone! Cheers, -[Rich](mailto:rich@phaser.io) and the whole team at Phaser Studio
-[@photonstorm](https://twitter.com/photonstorm) +[Rich](mailto:rich@phaser.io) and the whole team at Phaser Studio ![boogie](https://www.phaser.io/images/spacedancer.gif) +**Visit** the [Phaser website](https://phaser.io)
+**Play** some [amazing games](https://phaser.io/games)
+**Learn** By browsing our [API Docs](https://newdocs.phaser.io), [Support Forum][forum] and [StackOverflow](https://stackoverflow.com/questions/tagged/phaser-framework)
+**Code Examples?** We've over 2000 [Examples](https://phaser.io/examples) to learn from
+**Read** the weekly [Phaser World](https://phaser.io/newsletter/2024) Newsletter
+**Be Social:** Join us on [Discord](https://discord.gg/phaser) and [Reddit](https://phaser.io/community/reddit) or follow us on [Twitter](https://twitter.com/phaser_)
+ Powered by coffee, anime, pixels and love. The Phaser logo and characters are © 2011 - 2024 Phaser Studio Inc.