Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elijahscriptdev/runner
Runner is a single player based game. The game is intended to determine how fast a player can collect enough stars. The game has infinite levels and the player is expected to collect 6000 stars to escape.
https://github.com/elijahscriptdev/runner
javascript phaser3 webpack
Last synced: 7 days ago
JSON representation
Runner is a single player based game. The game is intended to determine how fast a player can collect enough stars. The game has infinite levels and the player is expected to collect 6000 stars to escape.
- Host: GitHub
- URL: https://github.com/elijahscriptdev/runner
- Owner: Elijahscriptdev
- License: mit
- Created: 2020-08-03T13:24:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T13:42:08.000Z (about 2 years ago)
- Last Synced: 2023-03-07T22:39:13.135Z (almost 2 years ago)
- Topics: javascript, phaser3, webpack
- Language: JavaScript
- Homepage: https://runner-rgp-game.netlify.app/
- Size: 41.9 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Video Game: Runner
Runner is an RPG video game built with [Phaser 3](https://phaser.io), an open source framework for Canvas and WebGL powered games. This game was inspired by [Phaser 3 tutorial: Endless Runner](http://phaser.io/tutorials/making-your-first-phaser-3-game/part1). The main objective was to create a custom role play game.
Assignment [link](https://www.notion.so/Platform-game-4a55a7d1fcc245bcb012c76814764712).
## Overview
Runner is a single player based game. The game is intended to determine how fast a player can collect enough stars. The game has infinite levels and the player is expected to collect 6000 stars to escape.
### Live [link](https://runner-rgp-game.netlify.app/)
## Gameplay
###### Player
Player (Runner) uses the direction keys( up: to jump and move to upper blocks, down: to move down in a faster way, left: to move left, right: to move right). He continues on in quest to collect stars
###### Enemy
Bombs are released from vertically into game. They will continue bounce.
## Design and Thinking
In the first day I read alot on the Phaserjs library and I got started with the documentation from the [official docs](https://photonstorm.github.io/phaser3-docs/). It took me a couple of days understanding the concepts.
On the fifth day, I came up with my game mechanics, including the game name, players, enemy and scoring system. The day after, I starting coding based on my own plan.
## Assets
All sprites, images and sounds used in this game are from [Open Game Art](https://opengameart.org).
## Technologies used
* HTML5 and CSS
* JavaScript
* Phaser 3
* Webpack
* Eslint
* Babel
* Jest
* Github
* [Netlify](https://app.netlify.com/) for the deployment
* [Leaderboard API service](https://www.notion.so/Leaderboard-API-service-24c0c3c116974ac49488d4eb0267ade3) for the leaderboard
## Future work
- Adding more levels
- Defence mechanisms
## Project Setup
Use the [git](https://git-scm.com/downloads) to clone the project to your local machine.
```sh
$ git clone https://github.com/Elijahscriptdev/Runner.git
```
Navigate to the extracted folder
```sh
cd Runner
```
Install the dependencies and modules
```sh
$ npm install
```
### Usage
```sh
$ npm run start
```
This will open the app at port-8080. If it doesn't open, visit ```http://localhost:8080```
### Testing
```sh
$ npm run test
```
## Author
👤 **Elijah Obominuru**
[Github](https://github.com/Elijahscriptdev) | [Twitter](https://twitter.com/ElijahObominuru) | [LinkedIn](https://www.linkedin.com/in/elijah-obominuru-0b730b143/)
- Email: [email protected]
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
You can open a new issue on the [issues page](https://github.com/Elijahscriptdev/Runner/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgements
- [Microverse](https://www.microverse.org/)
- [The Odin Project](https://www.theodinproject.com/)
- [Freecodecamp](http://freecodecamp.org/)
- [Phaser](https://phaser.io)
- [Open Game Art](https://opengameart.org)
## 📝 License
This project is licensed under MIT license - see [LICENSE](/LICENSE) for more details.