mkc188 / many-cars

drift-runners

INSTRUCTIONS

• Clone this repo:

git clone https://github.com/mkc188/drift-runners.git && cd drift-runners

• Install Node.js

• Install the required npm modules and phaser.js by issuing these commands:

npm install

bower install

You can optionally install Gulp globally npm install -g gulp but you don't have to.

• Run a local development server (livereload enabled) with this command:

npm start

If you have Gulp installed globally you can also use: gulp

• Package your game (i.e. minify css, html and js) with:

npm run build

If you have Gulp installed globally you can also use: gulp build

• To add new Phaser states (optional, generator creates basic initial states):

  npm install -g yo generator-phaser

  yo phaser:state

  You will be asked for a new state name.

HOW TO USE

• The game data is appended to the window object, on a key that corresponds to your game's name (e.g window['game']).

• Each game state is a constructor whose declaration is wrapped in a self-executing function in order to not pollute the global scope.

• These constructor functions will be sent to Phaser via game.state.add() (in main.js) and become a State object. There will be a state object for the boot, preloading, menu and one for the game itself.

• Inside these state objects, you can use the this keyword to access several properties. To learn more about the properties you can access, please check the documentation page linked on the previous point.

CREDITS

• This game is using julien/generator-phaser

• @photonstorm for creating phaser.

• The guys behind yeoman.

• Gulp.js

• Ben Alman for Grunt