Phaser 3 boilerplate written in TypeScript.

                 

_{Framework created by Photonstorm
Repository adapted from phaser3-typescript}

Phaser 3 and TypeScript

Phaser is a wonderful, fast and free open source HTML5 game framework. Here you will find everything you need to develop games with Phaser 3 in TypeScript. Have fun discovering, developing and playing! Ideas and corrections are highly desirable to constantly improve this repository!

Acknowledgement

This repository is a simplified version of digitsensitive's phaser3-typescript repository, which was adapted to suit my needs. Check out his awesome work and Phaser examples ! This repository was created for my own personal use, but feel free to use it as you wish !

Getting started

Prerequisites

Download and install npm with Node.js @ https://nodejs.org/en

Installing

Select a folder, navigate to it, and clone this repository with this command-line:

git clone https://github.com/jlepasquier/phaser3-typescript-boilerplate.git

Install the dependencies with this command-line:

npm install

Building and Running

Perform a quick build (bundle.js) and start server:

npm run dev

Cheat Sheets

• Phaser.Game
• Phaser.Scene
• Phaser.GameObject.Image
• Phaser.GameObject.Sprite
• Phaser.GameObject.Group
• Phaser.GameObject.Mesh

External Resources

• Phaser 3 Framework
• Phaser 3 Docs with TypeScript Definition File
• Phaser 3 Online Docs
• Phaser 3 Official Examples
• Phaser Labs

Helpful tools

• Leshy SpriteSheet Tool
• Tiled
• Littera

Contributing

Want to correct a bug, contribute some code, or improve the codes? Excellent! Let me know! Please read CONTRIBUTING.md for details on our code of conduct.

License

This project is licensed under the MIT License - see the LICENSE.md file for details