generator-phaser-typescript v0.2.4
generator-phaser-typescript
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-typescript from npm, run:
$ npm install -g generator-phaser-typescript
Finally, initiate the generator:
$ yo phaser-typescript
Yeoman Sub-Generators
The generator includes two sub-generators: one for generating new game states (extending Phaser.State
), and one for generating new prefabs (extending Phaser.Sprite
).
To use the state sub-generator, run:
$ yo phaser-typescript:state StateName
To use the prefab
sub-generator, run:
$ yo phaser-typescript:prefab PrefabName
Grunt Tasks
The default grunt task will build the project and start a server at http://localhost:8080
. The project also uses grunt-contrib-watch and connect-livereload to automatically reload your files when they are modified.
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
Credits
The design of this generator is modeled after the excellent generator-phaser-official by codevinsky.