Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ngscheurich/generator-phaser-ts

👾 Provides a handy jumpstart for a Phaser project with a TypeScript codebase.
https://github.com/ngscheurich/generator-phaser-ts

game-development gamedev generator heroku phaser typescript yeoman-generator

Last synced: 3 months ago
JSON representation

👾 Provides a handy jumpstart for a Phaser project with a TypeScript codebase.

Host: GitHub
URL: https://github.com/ngscheurich/generator-phaser-ts
Owner: ngscheurich
License: other
Archived: true
Created: 2016-08-26T23:33:43.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2018-01-17T23:02:39.000Z (almost 7 years ago)
Last Synced: 2024-09-06T03:44:15.720Z (4 months ago)
Topics: game-development, gamedev, generator, heroku, phaser, typescript, yeoman-generator
Language: JavaScript
Homepage: https://www.npmjs.com/package/generator-phaser-ts
Size: 697 KB
Stars: 5
Watchers: 3
Forks: 2
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # 👾 Phaser + TypeScript generator

[![Package version][package-image]][package-url]

[![Build status][build-image]][build-url]

[![Coverage status][coverage-image]][coverage-url]

[![Dependency Status][deps-image]][deps-url]

Provides a handy jumpstart for a [Phaser][phaser] project with a

[TypeScript][typescript] codebase.



In addition to a ready-to-code scaffolding, you get

stuff like:

- A fully-functional Phaser project, complete with TypeScript type definitions

- Automated tasks for compiling, bundling, and deploying

- A demo game to get you going

- A [Heroku][heroku] deployment setup

## Requirements

You’ll need [Node.js][nodejs], [npm][npm], and [Yeoman][yeoman], but you

already knew that, yeah?

## Installation

    $ npm install -g generator-phaser-ts

That’s it.

## Usage

    $ yo phaser-ts

    

This gets a project scaffolded out, installs software requirements, and does

an initial build of the included demo game.

**PRO TIP:** Create a new directory for your game and `cd` to it before running

the generator.

## Development

This project uses [gulp][gulp] to automate various common development tasks. While

you can interact with gulp directly, the generator gives you access to some scripts

that should cover your day-to-day needs.:

- `gulp lint`: Processes all .ts files in the src directory with `tslint` and

  displays the results

- `gulp build`: Compiles all .ts files in the src directory; outputs .js files

  to the build directory

- `gulp bundle`: Concatenates all .js files in the build and lib directories

  into a single file: public/js/bundle.js

- `gulp compress`: Uglifies the bundled .js file; outputs public/js/bundle.min.js

- `gulp watch`: Watches for changes to source files; when a change is detected,

  rebuilds files and reloads the website.

- `gulp deploy`: Deploys to Heroku. See below.

- `gulp`: The default gulp task. Runs the `bundle` task.

For convenience, this project includes a basic Node.js application that serves

up your game courtesy of the [Express][express] framework. To start the Express

server, run `npm start`. You should now be able to see your game running at

[http://localhost:3000](http://localhost:3000).

If you would like to run the server as well as rebuild your files upon save, i.e.,

what you’ll be doing most of the time, run `npm run devel`.

**PRO TIP:** If you want to run the server but *not* rebuild files upon save, set

the `LIVERELOAD` environment variable to `0`: `LIVERELOAD=0 npm run devel`.

## Deployment

Included is a Heroku-compatible [Procfile][heroku-procfile] so—assuming

you have the [Heroku Command Line Interface][heroku-cli] installed and you’re logged

in—getting your game up on them internets should be as simple as:

    $ npm run deploy

**PRO TIP:** You can `npm run production` to locally serve your game using minified code.

## Contributing

Please note that this an opinionated tool based on my particular preferences.

That being said, all pull requests are welcome!

## Licenses

This project is ISC © Nicholas Scheurich.


*Phaser* is MIT © Richard Davey, Photon Storm Ltd.


PC font is CC BY-SA 4.0 from INT10h.org.

[npm]: https://www.npmjs.com/

[phaser]: http://phaser.io/

[typescript]: https://www.typescriptlang.org/

[nodejs]: https://nodejs.org/en/

[typings]: https://github.com/typings/typings

[gulp]: http://gulpjs.com/

[express]: https://expressjs.com/

[heroku]: https://www.heroku.com/

[heroku-procfile]: https://devcenter.heroku.com/articles/procfile

[heroku-cli]: https://devcenter.heroku.com/articles/heroku-command-line

[yeoman]: http://yeoman.io/

[package-image]: https://badge.fury.io/js/generator-phaser-ts.svg

[package-url]: https://npmjs.org/package/generator-phaser-ts

[build-image]: https://travis-ci.org/ngscheurich/generator-phaser-ts.svg?branch=master

[build-url]: https://travis-ci.org/ngscheurich/generator-phaser-ts

[coverage-image]: https://coveralls.io/repos/github/ngscheurich/generator-phaser-ts/badge.svg?branch=master

[coverage-url]: https://coveralls.io/github/ngscheurich/generator-phaser-ts?branch=master

[deps-image]: https://david-dm.org/ngscheurich/generator-phaser-ts.svg?theme=shields.io

[deps-url]: https://david-dm.org/ngscheurich/generator-phaser-ts