sebastianjay / uva-game-design

TypeScript game engine targeting HTML5 canvas

Game Design Engine

Engine for UVA's Game Design course. Written in Typescript for the browser.

Installing

There are a few steps to get going with development using this engine.

1. Download Node.js. The important part is NPM. My version of NPM was 4.1.1, but in theory version differences shouldn't matter.
2. Clone this repo, and with a shell pointed at the root directory, run npm install. This will install all dependencies needed for development.
3. If gulp command line tool is not installed, run npm install -g gulp-cli.
4. Run gulp --lab [number] to compile Typescript into /dist/bundle.js. That appropriate lab code can then be run in browser by opening index.html. Running gulp by itself will compile /src/cakewalk/MainGame.ts for the semester game project. Note: Some labs that use animation may not work on Chrome (either use Firefox or serve the HTML through localhost).
5. To write new code, download an editor or IDE compatible with Typescript. Here is a list. I found Atom with the Typescript plugin to be sufficient.