generator-phaser-official

Yeoman generator

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

$ npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-phaser from npm, run:

$ npm install -g generator-phaser-official

Create your folder where you want your game to be located and finally, initiate the generator inside that folder:

$ yo phaser-official

Subgenerators

This generator also comes with two sub-generators:

$ yo phaser-official:state "stateName"

$ yo phaser-official:prefab "prefabName"

Built in server

Once you've run the generator, all you have to do is:

$ grunt

This will start a server, build the index and bootstrapper files, and watch for any changes to javascript files in the game/ directory

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

License

MIT