Skip to content

Latest commit

 

History

History
99 lines (57 loc) · 3.55 KB

README.md

File metadata and controls

99 lines (57 loc) · 3.55 KB
Raw

This template is a modified version of this repository: https://github.com/belohlavek/phaser-es6-boilerplate

It has been modified to include the following states:

  • Boot
  • Preload
  • GameTitle
  • Main
  • GameOver

and is set up to auto resize to cover the entire available viewport. It also includes a service worker and manifest file for progressive web app support.

Original documentation below:

Phaser ES6 Boilerplate

This is a non-professional Phaser template for building standard games using the Phaser framework and ES6/2015.

The original idea was to create a small project that contained a robust gulpfile, a basic example and some kind of folder structure.

Codepen example: http://codepen.io/belohlavek/full/aORJVL

Features

✔ Heavily commented, flexible Gulpfile (that means it uses Gulp).

✔ Browserify + Babelify (Yes, it uses Babel).

✔ Browsersync = Livereload + Mobile debugging with Weinre.

✔ Example: Extending Phaser & modular development.

✔ Production (UglifyJS) and Development (Sourcemaps) builds.

✔ Did I say ES6? Well.. some ES7 too! (See Experimental features).

Why?

ES6 is the future!

Anyways, I've been using ES6 for a while in other personal projects, and I currently prefer it over ES5 and Typescript. I found the new Class-based syntax to be a better fit for my developer needs. Unfortunately, the best way to access all the features of the new standard is by using a transpiler. This boilerplate is an attempt to reduce the time spent configurating a project and installing dependencies by providing a template that can work as an scaffold for any Phaser game.

Usage

You need Node.js and npm. You should also have git installed, but it's not mandatory.

Clone the repository (or download the ZIP file)

git clone https://github.com/belohlavek/phaser-es6-boilerplate.git

Install dependencies

npm install

Run a development build...

npm start

...or a production build.

npm run production

Development builds will copy phaser.min.js together with phaser.map and phaser.js Your ES6 code will be transpiled into ES5 and concatenated into a single file. A sourcemap for your code will also be included (by default game.map.js).

Production builds will only copy phaser.min.js. Your ES6 code will be transpiled and minified using UglifyJS.

Any modification to the files inside the ./src and ./static folder will trigger a full page reload.

If you modify the contents of other files, please manually restart the server.

Modifying gulpfile.js

See gulpfile.md

Changelog (1.0.2)

  • Faster builds (no need to copy static files every time).
  • Live reload now works with static files too!

Contributing

Please report any bugs or add requests on Github Issues.

About me

My name is Daniel Belohlavek: I'm from Buenos Aires, Argentina and I love to derp around and code silly snippets. You can follow me on Twitter @dbhvk

License

This project is released under the MIT License.