This project is an online endless platformer game built with Phaser 3 Library
-
HTML5
-
CSS3
-
Javascript
Run Buddy Run is a simple endless-runner platformer game that is all about collecting coins and bringing down missiles.
The game starts off with the player character already running forward, and your objective is to help her collect as many coins as possible before the health bar is completely depleted.
- Click on the Instructions button on the game's Main Menu to read about the rules and objectives of the game, as well as the controls for moving the game's player character.
-
During the planning phase of the game, I was faced with the conundrum of recognizing that there are plenty of platformer runner games out there most of which share the same ideas. Therefore I decided to proceed with the Idea of creating a runner game that not only relys on one's skills to hit a good score, but also a little bit of luck -- Meaning one's probability of not hitting a high score each session of play is slightly higher than most games due to the luck factor involved.
-
This phase was such a pivotal part of the development process. In it, despite the project being a simple 2D platformer game, I desired for it to capture one's eye by creating quite decent visuals and graphics hence the decision of building a faintly deep Parallax of upto 3 layers of scrolling background images, which images along with other assets were obtained from good sources which are mentioned in the
AcknowledgementssectionThe challenge in this was to create an infinite scrolling parallax without consuming extra memory because memory is finite (Which i managed to achieve).
-
Working with Phaser 3 was very interesting and after some time, you learn to appreciate the work put into it.
I listed the main features I wanted in my game and designed them following the Phaser 3 documentation.
Breifly, below are the steps I followed in development:
-
Install Phaser using Node Package Manager(npm) and set up the game configuration.
-
Design the Game scene by implementing the following:
- Create a game background with associated parallax and optimise it.
- Add the player character and associated functionality/features
- Add the enemies and other characters with associated features
- Add a scoring system
-
Design other supplimentary scenes.
-
Add sound to the game.
-
Add and implement the Leader Board functionality using the scoring api.
-
Finalise.
-
-
First the game was deployed on githack.com, and later it will be deployed on Netlify.
- Node Package Manager (npm)
- A local server such as Live Server
-
Clone the repository to your local machine by running
git clone git@github.com:RNtaate/Endless-Runner.gitin your terminal -
On your local machine, navigate to the game folder using
cd Endless-Runnerin your terminal -
Run
npm installto install Phaser, and all the necessary dependencies. -
Run
npm run build -
Open index.html using a local server such as
Live Server
- In your terminal, run
npm test
There are two ways of contributing to this project:
-
If you see something wrong or not working, please check the issue tracker section, if that problem you met is not in already opened issues then open the issue by clicking on
new issuebutton. -
If you have a solution to that, and you are willing to work on it, follow the below steps to contribute:
-
Fork this repository
-
Clone it on your local computer by running
git clone git@github.com:RNtaate/Endless-Runner.gitReplace RNtaate with the username you use on github -
Open the cloned repository which appears as a folder on your local computer with your favorite code editor
-
Create a separate branch off the master branch,
-
Write your codes which fix the issue you found
-
Commit and push the branch you created
-
Raise a pull request, comparing your new created branch with our original master branch here
-
👤 Roy Ntaate
- Github: @RNtaate
- Twitter: @RNtaate
- Linkedin: roy-ntaate
Give a ⭐️ if you like this project!