/phaser-starter

phaser 3 starter project, typescript, webpack, babel, ava, service workers, spine

Primary LanguageJavaScriptMIT LicenseMIT

Phaser 3 TS Starter

dependencies status License: Mit Phaser Version

Starter template for Phaser 3, using Typescript, Babel and Webpack.

Provides support for:

  • webworker loading in webpack
  • AVA unit tests
  • Creating a zip files for Itch.io releases
  • Spine plugin for Phaser

Requirements

SSL

Make sure you have local certificates that are trusted. Use mkcert for example. Put certificate files in ./ssl/ and make sure filenames in package.json script match

How to use

# Clone this repository
$ git clone --depth 1 https://github.com/pinkkis/phaser-starter.git phaser-starter

# Go into the repository
$ cd phaser-starter

# Install dependencies
$ npm install

# Start the local development server (on port 8080)
$ npm start

# Local dev server with ssl (for service worker)
$ npm start:https

# Build a production version into /dist
$ npm run build

# Bundle an Itch.io release zip
# Creates a release-version.zip in /build
$ npm run itchio

3rd party licenses

This template uses the Phaser 3 Spine plugin. The Spine Runtimes require you to have your own license if you wish to use them in your own project outside of evaluation

See the 3rd party license file for a list of other software used.