Starter templates for Phaser game framework.

gitlab-pages html5-game-development javascript phaser phaser-ce phaserjs phaser-starter-templates typescript vscode

Go to file

James Skemp a4a21a09bb Fix npm audit issues		2022-07-23 20:02:08 -05:00
.github/ISSUE_TEMPLATE	Add feature request project template	2018-10-22 20:36:24 -05:00
v2-ce	Fix npm audit issues	2022-07-23 20:02:08 -05:00
v2-official	Add READMEs for all versions and update main with version suggestion	2019-01-21 20:58:22 -06:00
.gitignore	Add GitLab CI from PhaserTutorials and blank gitignore	2018-02-11 12:40:01 -06:00
.gitlab-ci.yml	Add GitLab CI from PhaserTutorials and blank gitignore	2018-02-11 12:40:01 -06:00
CODE_OF_CONDUCT.md	Create very basic code of conduct	2019-01-21 21:26:37 -06:00
LICENSE	Initial commit	2018-02-11 12:30:25 -06:00
README.md	Delete Phaser 3 starter template and link to new repo	2019-06-09 21:45:10 -05:00

README.md

Phaser Starter Templates

This repository includes a number of starter templates for Phaser game framework, and was originally part of my Phaser Tutorials collection.

Templates

All templates use Visual Studio Code, but do not require that it be used. However, Visual Studio Code is a great, free, cross-platform application, and is highly recommended.

TypeScript is used, and required, for all templates. Some templates use Node.js and Webpack.

To use one of these templates you can download a copy of, or clone, this repository, and then copy the directory containing the template you want to get started with.

See each individual project for specific requirements and setup instructions.

Which Version Should I Use?

If you're not sure what version to use, I would recommend starting with Phaser 3.

While not as stable or mature as Phaser 2.x, and there aren't as many tutorials yet (but it is getting there), Phaser 3 is where the future is at.

If you're new to JavaScript and/or game development, using Phaser Community Edition is also an option. Phaser 2 tutorials will generally work fine, requiring minor changes, if any.

Phaser 3

Phaser 3 (previously named Lazer) is the latest official version of Phaser.

These starter templates are setup in GitHub as templates that can be used to easily create new projects.

Starter Project for Phaser with Visual Studio Code, TypeScript, and Node.js: Recommended for new development, uses Node.js for pulling Phaser 3, and Webpack for compilation.

Phaser Community Edition (CE)

As of this writing, Phaser Community Edition (CE) is the active branch of Phaser v2. New features and bug fixes are being made to this code, so it's recommended to use this over the last official release of Phaser 2.

Starter Project for Phaser CE with Visual Studio Code, TypeScript, and Node.js: Uses Node.js for pulling Phaser CE, and Webpack for compilation.
Starter Project for Phaser CE with Visual Studio Code and TypeScript: The same as the above project, but Phaser CE must be manually updated by grabbing the code from the Phaser site. Use this if you don't want the Node.js dependency.

Phaser 2.6.2

Version 2.6.2 was the last official/non-community edition of Phaser. While this version can be used, it is no longer actively supported.

Starter Project for Phaser with Visual Studio Code and TypeScript: Uses the last official release of Phaser 2.

Phaser Logo Usage

The Phaser logo (Phaser-Logo-Small.png) is a trademark of Photon Storm, and is meant to be used in a manner consistent with their usage guidelines.