pwright/phaser-3-hygen

A Phaser 3 TypesScript project generator that was built using Hygen.

Phaser-3-Hygen

A Hygen Phaser 3 Project Generator. Currently, this generator only supports TypeScript projects.

Quick Start

This section provides the basic commands needed to generate a project using this generator. For more detailed instructions and more information, please see relevant section of the README.md.

npx @scottwestover/phaser-3-hygen phaser template

TODO: insert image of generator running in cli

You should then be prompted for some additional infomation about your project. Once the project is generated, navigate to that generated project folder and run npm install and then npm run dev to launch the dev server with your Phaser 3 game.

TODO: insert image of Phaser 3 game

Generate a project

In order to run the generator, you will need to use npx to run the generator, or you will need to install the package globally. To install this package, you will need to tell npm how to download this package from the GitHub Package repository. To do this, you can create a .npmrc file in the same directory as your package.json and add the following line to that file:

@scottwestover:registry=https://npm.pkg.github.com

You can also add the same line to your per-user ~/.npmrc file if you plan to use this package in many projects. This is required if you plan to install this package with npx

You can read more about this process here: Installing GitHub Pacakges

Install

To install the package globally:

npm install -g @scottwestover/phaser-3-hygen

Or, you can use npx to install the package:

npx @scottwestover/phaser-3-hygen phaser help

Running the generator

If you installed the package in your project and not globally, you can run the generator by running:

node node_modules/.bin/phaser-hygen phaser help

If you installed the package globally, you can run the generator by running:

phaser-hygen phaser help

If you use npx to install the package, the generator should be ran automatically.

Note: when you run one of the commands above, you should be shown a list of actions that you can run with this template generator.

Available Hygen Actions

Command	Description
phaser-hygen phaser help	Displays the available actions you can take for this generator
phaser-hygen phaser scene	Creates a basic Scene Class that extends the Phaser.Scene class
phaser-hygen phaser template	Creates a basic Phaser 3 TypeScript project

Running the project

Once you have generated your project, you will need to install the required dependencies for that project. To do this just run: npm install. Once everything is installed, you can run one of the following commands:

Command	Description
npm run lint	Lints the project using tslint
npm run dev	Builds project and open web server, but do not watch for changes
npm run build	Builds code bundle with production settings (minification, no source maps, etc..)

Publishing New Version

In order to create a new beta version of this package, you can use the npm version command. This command will also create a git tag with the same version number. Example: npm version 0.0.2

Once you do this, you can run the npm run package-publish script.

Beta

In order to create a new beta version of this package, you can use the same command as above, but you will need to append -beta.0. Example: npm version 0.0.2-beta.0

Once you do this, you can run the npm run package-publish:beta script.