Phaser 3 Template

A quick-start Phaser 3 template used by the Bodging Bear team

View Demo · Report Bug · Request Feature

About The Project

In this repo you can find a template that is being used by the Bodging Bear team when starting new project.

Even though this template includes Bodging Bear specific code (like intro or credits) feel free to use it in your own project.

Table of Contents

• About the Project
  • Features
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Available Commands
• License
• Contact

Features

• Bodging Bear intro while loading
• Simple main menu
• Credits scene
• How to play scene
• Game scene
• Custom made utilities for quicker Phaser 3 development

Built With

• Phaser 3
• TypeScript
• Webpack 4
• Electron
• Love ❤️

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You'll need to have the following programmes installed to run use template

Node.js

Download and install appropriate version from https://nodejs.org/en/download

Installation

1. Create a new repo from a template
2. Clone the newly created repo

git clone https://github.com/bodgingbear/new-game

3. Install NPM packages

npm install

4. Run game locally

npm start

Available Commands

Command	Description
npm run start	Build project and watch for changes, starts server on http://localhost:8080
npm run build	Builds project in production mode (enables minification, outputs files to public folder)
npm run lint:eslint	Runs eslint on the codebase checking for code style errors
npm run lint:tsc	Runs TypeScript checks
npm run lint	Combines lint:eslint and lint:tsc
npm run electron:dev	Runs Electron in the development mode
npm run electron:dist	Builds the Electron version of the app. Outputs builds for MacOS and Windows

License

Distributed under the Creative Commons Attribution-NonCommercial 4.0 International License.
See https://creativecommons.org/licenses/by-nc/4.0 for a human-readable summary of it and LICENSE.md for full license text.

If you wish to commercially use your game that was created using this template, drop us a message at [email protected].

Contact

Bartek (@bibix1999) and Kacper (@pietrzakacper) – [email protected]

Project Link: https://github.com/bodgingbear/phaser3-template