# Mintbean's PhaserJS Template

## Getting Started

1. Mint new [ Project name ]
2. Select `phaser-gh-pages`
3. `mint r -cp`
4. `mint develop`
5. Visit `localhost:1234`

## Deployment

1. `mint deploy`
2. Output files are on gh-pages

## Resources

[OpenGameArt](https://opengameart.org/) - Free game assets for everyone.
[Itch.io](https://itch.io/game-assets/free) - More free game assets.
[Official Phaser webpack template](https://github.com/photonstorm/phaser3-project-template) - Not recently maintained, but an alternative in case you want a different project.

## !Work in progress!

This is currently being developed. Please report any bugs in the issues tab!

## FAQ

### Why are my assets not showing up?

All assets must be imported!

### Where do I get started?

I Recommend starting in src/scenes/game.js, edit the menu screen, and win screen after you complete your game.

## What we're trying to achieve

This starter template is meant to be a kickoff spot for a full-fledged PhaserJS game project.

- Simple template with asset pipeline to help you get started
- Ability to pivot into turn based games, action games, or any other kind of game.
- Good example code for various common game UX patterns.
- Livereload dev server using Parcel Bundler
- Support for `html`, `pug`, `md`, `js`, `jsx`, `ts`, `tsx`, `json`, `css`, `scss`, `postcss`, `less`, and various
  image filetypes, font files, and more. (See [Parcel](https://github.com/parcel-bundler/parcel)'s documentation)
- Yarn for faster package resolution