README

slush-phaser-game

A slush generator for easily starting to make HTML5 games with Phaser.

Features

Phaser
Browserify
Jade
Stylus
ESLint: keep your code clean
BrowserSync: a local web server to test your code
A project structure already established*, making it easier to get started

*Uses separate states files and prefabs for the game objects, as Codevinsky did in his great tutorial. Of course, it's totally up to you to keep or change that behaviour.

Installation

Make sure node, gulp and slush are installed.

Then, install slush-phaser-game globally:

npm install -g slush-phaser-game

Note: you may need to use sudo for this to work.

Usage

Create a new project

Running the following command will create a new folder for your project:

slush phaser-game

You will be prompted to give your game a name, a resolution and the version of Phaser you want to use.

Get started

This will start the local web server and open your game in your browser:

gulp

Once the server is running, each modification will automatically update the page opened in the browser.

A new folder (build) should appear at the root of your project, containing the generated files (HTML, CSS and JS) for your game. That's the content of this folder you'll use when publishing your game.

To list all the available options, you can use gulp -h.

Project structure

awesome-phaser-game/
├── assets                        # Assets folder: images are at the root...
|   ├── audio                     # ... audio and music files are here...
|   └── fonts                     # ... while fonts go there.
├── build                         # Generated folder.
|   ├── assets
|   ├── css
|   └── js
├── dist                          # Were you'll find the version you'll publish.
├── src
|   ├── scripts
|   |   ├── prefabs               # Put all your "prefabs" in that folder...
|   |   ├── states                # ... and your states in this one.
|   |   |   └── boot.js
|   |   |   └── menu.js
|   |   |   └── play.js
|   |   |   └── preloader.js
|   |   └── main.js               # Entry point of your code.
|   ├── stylesheets
|   |   └── style.styl
|   └── index.jade
├── tasks                         # Where the build tasks are. Each file in this
|   ├── build.js                  # directory will be called by gulp.
|   ├── clean.js
|   ├── default.js
|   ├── serve.js
|   └── watch.js
├── .bowerrc
├── .eslintrc
├── .gitignore
├── bower.json
├── config.js                     # A config file for your game.
├── gulpfile.js
└── package.json

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!