Skip to content
/ phaser-game-template Public template

⚠️ WIP. Template for creating a game on Phaser.js engine

License

Notifications You must be signed in to change notification settings

hywax/phaser-game-template

Repository files navigation

Phaser Game Template

Phaser Game Template is a template for creating Phaser games with TypeScript.

Phaser Game Template

Table of Contents

Features

  • 🪄️ All the code is written in TypeScript
  • ✨ Fully customized eslint configuration based on the config by Antfu
  • 🧪 Write tests quickly and conveniently with vitest
  • 🤝 Supports conventional commits
  • 💅 Generate beautiful changelogs with changelogen
  • ♾️ GitHub CI for your build
  • 📢 Issue templates
  • 📝 Pull request template
  • 🤖 Ready configuration for renovatebot with renovate-config
  • 🚀 Action releases with just one command

Get started

GitHub Template

This is a template repo. Click the green Use this template button to get started.

Git Clone

git clone https://github.com/hywax/phaser-game-template.git
cd phaser-game-template
pnpm install

Usage

The template contains the following scripts:

  • build - Build for production
  • preview - Preview the production build
  • dev - Start the development server
  • lint - Checks your code for any linting errors
  • lint:fix - Checks your code for any linting errors and fix them
  • test - Run all tests with code coverage report
  • test:watch - Run all tests with watch mode
  • release - Generate changelog and git tag push
  • prepare - Script for setting up husky hooks

Used by

If you are using this template, feel free to open a PR to add your project to the list.

License

This template was created under the MIT License.