Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 1.47 KB

README.md

File metadata and controls

67 lines (43 loc) · 1.47 KB
Raw

This project is indented to help everyone with getting started with Phaser + TypeScript game development, once you download it you are ready to start right away.

Usage

  1. Download the project: https://github.com/wlk/phaser-typescript-boilerplate/archive/master.zip
  2. Install dependencies (more information below)
  3. Write your game, you can start with src/app.ts
  4. Run in development mode (more information below)
  5. Repeat 3-4 until your game is ready
  6. Build in production mode (more information below)

Getting Started

Pre-requisites

You need to have node and npm installed

Dependencies

You need to have typescript installed (globally):

sudo npm install -g typescript
sudo npm install -g tslint

Then inside the project directory run:

npm install

This will install all required local dependencies

Building the project

To build project you can use:

npm build

Or just run:

tsc

the tsconfig.json has is configured for you

Running in dev mode:

npm dev

Known problems

  • tslint doesn't support directory as parameter (you can use what's integrated in your IDE)

IDE support

Intellij IDEA

Intellij has pretty good support for Typescript and this project, you can either used bundled typescript compiler or use the one installed via npm (but make sure you are putting generated *.js files to the build directory)

Contributing

Pull requests and issues with improvements/fixes/suggestions/etc are welcome.