README.md

Phaser 3 Game Examples written in TypeScript.

                 

_{Examples made with ❤︎ by digitsensitive
Framework created by Photonstorm}

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!

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/digitsensitive/phaser3-typescript.git

Install the dependencies with this command-line:

npm install

If you use yarn just replace npm with yarn

Building and Running

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

npm run dev

If you use yarn just replace npm with yarn

Game Examples

• If you have any suggestion for a next game example, let me know!

Cheat Sheets

• Browse through the Cheat Sheets

Tutorials

• Learn to create a HTML5 Game in 5 Minutes

External Resources

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

Helpful tools

• Leshy SpriteSheet Tool
• Tiled
• Littera
• Tile Extruder

TypeScript Configuration

tsconfig.json

The following Compiler Options have been set in the tsconfig.json file:

Option	Value
target	ES2016
module	CommonJS
sourceMap	true
noImplicitAny	true [WIP]
strict	true [WIP]

You can see the complete list of the available options at here. Interesting read about setting up a nodejs-project.

Changelog

Learn about the latest improvements

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.