Skip to content

bodgingbear/ggj-2024

Repository files navigation

Bodging Bear

Phaser 3 Template

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

View Demo · Report Bug · Request Feature

About The Project

Template showcase

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

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

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. Latest tested version is v20.5.0

Installation

  1. Create a new repo from a template
  2. Clone the newly created repo
git clone https://github.com/bodgingbear/new-game
  1. Install NPM packages
yarn install
  1. Run game locally
yarn dev

Available Commands

Command Description
yarn run dev Build project and watch for changes, starts server on http://localhost:5173
yarn run build Builds project in production mode (enables minification, outputs files to dist folder)
yarn run lint Runs eslint on the codebase checking for code style errors
yarn run type-check Runs TypeScript checks

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 team@bodgingbear.dev.

Contact

Bartek (@bibix1999) and Kacper (@pietrzakacper) – team@bodgingbear.dev

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages