phaser-starter-templates/v2-official/_starter-v2-vsc-ts
James Skemp 449f456dd2 Add existing non-simple templates for Phaser 2.x versions 2018-02-11 13:56:28 -06:00
..
.vscode Add existing non-simple templates for Phaser 2.x versions 2018-02-11 13:56:28 -06:00
assets Add existing non-simple templates for Phaser 2.x versions 2018-02-11 13:56:28 -06:00
lib Add existing non-simple templates for Phaser 2.x versions 2018-02-11 13:56:28 -06:00
plugins Add existing non-simple templates for Phaser 2.x versions 2018-02-11 13:56:28 -06:00
src Add existing non-simple templates for Phaser 2.x versions 2018-02-11 13:56:28 -06:00
.gitignore Add existing non-simple templates for Phaser 2.x versions 2018-02-11 13:56:28 -06:00
README.md Add existing non-simple templates for Phaser 2.x versions 2018-02-11 13:56:28 -06:00
app.css Add existing non-simple templates for Phaser 2.x versions 2018-02-11 13:56:28 -06:00
favicon.ico Add existing non-simple templates for Phaser 2.x versions 2018-02-11 13:56:28 -06:00
index.html Add existing non-simple templates for Phaser 2.x versions 2018-02-11 13:56:28 -06:00
tsconfig.json Add existing non-simple templates for Phaser 2.x versions 2018-02-11 13:56:28 -06:00

README.md

Starter Project for Phaser with Visual Studio Code and TypeScript

The following is a starter project to get started with a new game in Phaser and Visual Studio Code, using TypeScript.

What This Provides

  • assets
    • This directory can be used to store any assets (images, audio, etcetera) that your game will use.
  • lib
    • This directory includes Phaser 2.6.2, and the necessary TypeScript definitions.
  • plugins
    • This directory is intended to store any plugins that are used by your game.
    • A collection of plugins can be found in the Phaser Plugins repository.
  • src
    • This directory is intended to store your TypeScript files, and includes a .gitignore so that any JavaScript files that are built aren't committed.
    • A possible directory structure, as well as a few starter states, have been added for ease, but can be removed without issue.
  • app.css can include any styling necessary for your application.
  • favicon.ico
  • index.html
    • The title and h1 elements should be updated to match the needs of your game.
    • Includes a reference to the minified Phaser library.
    • Also includes a reference to a JavaScript file, which the Visual Studio project is setup to output TypeScript files to, and which should be updated to match your needs.
  • README.md is this file, and should be replaced with whatever content is needed for your game.
  • tsconfig.json
    • This file determines how TypeScript will compile the project.
    • By default all TypeScript files will be compiled into a single app.js file in the root of the project.
  • .vscode/tasks.json
    • Used by Visual Studio code when running the build task.