egee-irl/jumper

# jumper ![example workflow](https://github.com/egeexyz/jumper/actions/workflows/nodejs-ci.yaml/badge.svg)

[![Maintainability](https://api.codeclimate.com/v1/badges/04601514cd7b18f394a8/maintainability)](https://codeclimate.com/github/egee-irl/jumper/maintainability)
[![Discord](https://discordapp.com/api/guilds/183740337976508416/widget.png?style=shield)](https://discord.gg/tVyBHAU)

A basic platformer game written with [PhaserJS](https://phaser.io/) **2.0** to demonstrate basic game functions. It is a spirtual fork of the original PhaserJS 2.0 tutorial when it was first released. Watch how I built it on [YouTube](https://youtu.be/88DS3Z8nOdY).

## Getting Started

This repository is configured to be as simple as possible; build, deploy, and play with all with **npm**! The game's [code](https://github.com/egeexyz/jumper/blob/master/public/src/game.js) is neatly written and annotated to help you figure out how it all works.

First, clone or download this repository and run `npm install`.

There are a few ways to run Jumper:

- Run `npm start` and the game window should appear.
- Run `npm start` and go to `localhost:8080` in a web browser.
- Run `docker-compose` and go to `localhost:8080` in a web browser. (requires Docker & Docker-Compose to be installed.)