Running

KO | EN

gitlite — search

#javascript #hacktoberfest #llm #golang #deep-learning #linux #macos #awesome #cli #kubernetes #awesome-list #vue #pytorch #security

(★ 3)

Platform game developed using Phaser 3 library. The character is a robot that has to escape from the factory it was created, jumping through platforms with different widths and positioned in different heights, collect coins, and evading robots and spikes.

Running Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Robot Runner

This is a platform game developed using Phaser 3 library. the character is a robot that has to escape from the factory it was created, jumping through platforms with different widths and positioned in different heights, collect coins, and evading robots and spikes.

The score is increased, for each platform and robot completely hidden in the right and for each coin collected. Once the score passes some limits the difficulty will be increased, and spikes are going to appear.

You can submit your player name, and once the player dye, your score will be submitted to leaderboard API.

You will see your position if your score is higher than the player in the #10 position.

## Live Version

[Play me](https://thirsty-mcnulty-d6efb3.netlify.app/)

## Video Description

[video](https://www.loom.com/share/63cfd2c941624e33ba7dac0db22fb777)
## How to play

TO play you can use, click, or the space key.
 With a max 2, your goal is to collect as many coins as possible without fall.

## Assets

### Main Character - Robot Man

![Screenshot](https://raw.githubusercontent.com/gasb150/Running/developer/src/assets/images/player.png)

### Enemy Character - Robot Enemy
![Screenshot](https://raw.githubusercontent.com/gasb150/Running/developer/src/assets/images/robotEnemy.png)

### Platforms

![Screenshot](https://raw.githubusercontent.com/gasb150/Running/developer/src/assets/images/platform.png)

### Spike

![Screenshot](https://raw.githubusercontent.com/gasb150/Running/developer/src/assets/images/Spike.png)

### Coins

![Screenshot](https://raw.githubusercontent.com/gasb150/Running/developer/src/assets/images/coin.png)

## Main Scenes

### Enter Name
 This Scene has a text box where the user should enter with a username. The user should press enter and wait for the submission.

![Screenshot](https://raw.githubusercontent.com/gasb150/Running/developer/src/assets/images/entername.jpeg)

### Menu

> Menu Scene - Where you can navigate through the options: Play, Options, Instructions, and Credits

![Screenshot](https://raw.githubusercontent.com/gasb150/Running/developer/src/assets/images/menu.jpeg)

### Game Scene

> Game Scene - Where the game starts. Platforms of different sizes are generated and also random amounts of coins. The user can make the character jump through the platforms using the 'SPACE' key or clicking with the left mouse button. Character is allowed to double jump, but no more than two jumps are allowed. Every time the character collects a coin (overlapping the coin) the Score is increased by 10 units and that should be displayed.

![Screenshot](https://raw.githubusercontent.com/gasb150/Running/developer/src/assets/images/game.jpeg)

> Submit Scene - When the character finally falls the "Submit Scene" is generated. Where the app will submit his score,

### Leaderboard

> Leaderboard Scene - After the score submission a leaderboard is displayed and if the last submission is at the top 6, it should be included. This scene contains 2 buttons where the user can choose between play again and come back to the main menu.

![Screenshot](https://raw.githubusercontent.com/gasb150/Running/developer/src/assets/images/leaderboard.jpeg)

### Instructions

> Instructions - The page contains instructions about how to control the character and also the game goal.

![Screenshot](https://raw.githubusercontent.com/gasb150/Running/developer/src/assets/images/instrutctions.jpeg)

### Credits

> Credits - The scene to acknowledge the developer responsible for the game development.

![Screenshot](https://raw.githubusercontent.com/gasb150/Running/developer/src/assets/images/credits.jpeg)

## Built With

- Javascript
- Webpack
- HTML5
- CSS3
- Jest
- Phaser

## Deployed with Netlify

## Prerequisites

- Using NPM package and JavaScript knowledge to build and test the game.
- You should install Node.js to run the server with the dependency used. If you don't have Node you can follow this tutorial to set it on your local machine: [HERE](https://www.w3schools.com/nodejs/default.asp)

## Getting Started

To get a local copy of this project running follow these simple steps.

- Clone this repository
 > `git clone <repo>`

- To set Webpack and the dependencies run the command
> `npm install`
- Use your favorite browser to open the index.html file (located at the dist page)

- If you have node.js installed and all the dependencies were installed successfully, you can run the following command to start the server where the project will run.

> `yarn start`

- Open the following path in your browser.

> `http://localhost:8000/`

## Running tests

This project contains Built tests using jest. To run the tests on your local machine you can run the following command on the project folder:
 > `yarn test`

If you want to build customized tests, you should create new files or edit the files inside the tests/ folder.
 The tests files should be always named with the extension .test.js
 To set the watch mode and keep tracking the tests continuously while you build it you can run
> `yarn test-watch`

## Authors

:bird: **Gustavo Sanmartin**

- Github: [gasb150](https://github.com/gasb150)
- Twitter: [@7aves](https://twitter.com/7aves)
- Linkedin: [gustavsanmartin](https://www.linkedin.com/in/gustavsanmartin/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](issues/).

## Show your support

Show your support with a star if you like this project!

## Acknowledgments

- Microverse

- opengameart.org

- Gameart2d

## 📝 License

<p>This project is <a href="LICENSE">MIT</a> licensed.</p>

Running

Running Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Running

Running Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README