Skip to content

Commit

Permalink
Update README to include changes for Phaser 3.50
Browse files Browse the repository at this point in the history
  • Loading branch information
josephmbustamante authored Dec 17, 2020
1 parent 0e4ffd3 commit 5603f73
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ This repository contains all the code necessary to start making a game in Phaser
The code contained here is an expansion of what is created in [this blog post that I wrote.](https://spin.atomicobject.com/2019/07/13/phaser-3-typescript-tutorial/)
This repository contains all the code that I go through in that tutorial, plus some additional things to help get your game off the ground. Notably, besides a loading screen and main menu screen, an example sprite is included that can be moved around with the arrow keys.

**Update:** The starter kit has been updated to work with Phaser 3.23 and TypeScript 3.7.
#### Latest Changes

The starter kit has been updated to work with Phaser 3.50 and TypeScript 4.1. Additionally, the webpack config has been changed to look at the `NODE_ENV` environment variable, and either do a production or development build depending on what is provided. You can use `yarn dev` to run the server in dev mode, whcih gives better debugging assistance and faster compile times, or `yarn prod` to run in production, which gives much smaller bundles but takes longer to compile.

## How to Use

Expand All @@ -15,6 +17,8 @@ Once you're done installing, simply run `yarn dev` and the game should begin to

The game opens up to a main menu. Only the "Start Game" button does anything - the other two are placeholders. If you click "Start Game", you'll be taken to a black screen with a small sprite. You can move the sprite with the arrow keys. This starter kit is far from feature complete, but it's meant to take away the boilerplate that can come with getting a Phaser 3 + TypeScript project up-and-running.

Running `yarn dev` runs the game in development mode, which produces larger bundle sizes but compiles faster and provides better debug support. If you desire a smaller game bundle or to host your game on a server, you can use `yarn build:prod` to compile the project into an optimized bundle. You can use `yarn prod` to run your game locally with production compilation, but this will cause your hot reloading to take longer.

## Extensions

You can edit this code with any text editor. VS Code is recommended, though. If you download the Prettier and ESLint extensions, you can get automatic code formatting to work.
Expand Down

0 comments on commit 5603f73

Please sign in to comment.