https://github.com/vladfaust/phaser3-typescript-webpack-boilerplate

👾 Phaser 3 multiplatform Typescript boilerplate
https://github.com/vladfaust/phaser3-typescript-webpack-boilerplate

android es6 game-development phaser phaser-boilerplate phaserjs webpack

Last synced: about 2 months ago
JSON representation

👾 Phaser 3 multiplatform Typescript boilerplate

• Host: GitHub
• URL: https://github.com/vladfaust/phaser3-typescript-webpack-boilerplate
• Owner: vladfaust
• Created: 2018-04-23T22:42:02.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-24T10:35:53.000Z (almost 7 years ago)
• Last Synced: 2024-10-25T01:35:31.161Z (3 months ago)
• Topics: android, es6, game-development, phaser, phaser-boilerplate, phaserjs, webpack
• Language: JavaScript
• Homepage: https://phaser.io
• Size: 588 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Phaser 3 Typescript ES6 Boilerplate

[Phaser 3](https://phaser.io) multiplatform boileplate with Typescript Webpack Core and bare Android application with fullscreen WebView.

## Prerequisites

- [NodeJS with NPM](https://nodejs.org)

- Android Development Environment (e.g. [Android Studio](https://developer.android.com/studio/index.html))

### Recommended NPM packages installed globally:

- [Yarn](https://yarnpkg.com/lang/en/)

- [cross-env](https://www.npmjs.com/package/cross-env)

## Development

1. Clone this boileplate with `git clone https://github.com/vladfaust/phaser3-boilerplate.git`

2. `cd core && yarn`

3. Create `.env` file like `.env.example` - this will will be used *only* for development

4. Run `yarn dev` and open `http://localhost:8080`

5. Develop your game starting from `src/index.ts`

## Building

### HTML5

Build an HTML5 game with `yarn build:web`. See `core/build/web` for output.

### Android

1. Build an HTML5 game optimized for Android with `yarn build:android`. 

2. Copy `core/build/android` to `android/app/src/main/assets` so `index.html` is directly under `assets` folder.

3. Update your Android game with icons etc.

## Contributors

[@vladfaust](https://github.com/vladfaust) - Creator