Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jpdf00/phaser3-plataformer

This is Cat Jump, a small game made with JavaScript using the Phaser 3 Library. It is an endless runner platform game, it has a double jump mechanic, a score that can be saved, and a Leaderboard that shows the top 10 scores.
https://github.com/jpdf00/phaser3-plataformer

Last synced: about 16 hours ago
JSON representation

Host: GitHub
URL: https://github.com/jpdf00/phaser3-plataformer
Owner: jpdf00
License: mit
Created: 2021-05-07T13:16:37.000Z (over 3 years ago)
Default Branch: develop
Last Pushed: 2021-05-27T18:13:58.000Z (over 3 years ago)
Last Synced: 2025-01-18T16:52:39.855Z (2 days ago)
Language: JavaScript
Homepage: https://cat-jump-jpdf00.netlify.app/
Size: 2.51 MB
Stars: 7
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

![](https://img.shields.io/badge/Microverse-blueviolet)

# Cat Jump

> A small platformer game built wiht Javascript and Phaser 3.

![screenshot](./screenshots/app_screenshot.png)

## Game instructions

- This game is an endless runner platformer. The plataforms appear infinitly until the game ends and the game character (a cat) has to jump from building to building.
- If the cat falls below the edge of the screen the game ends.
- Your progress (score) is measured in seconds. The longer the cat stays "alive" higher the score.
- To jump you have to simply click on the screen with the left mouse button.
- The cat can jump twice. After the second jump, the cat has to touch a platform to be able to jump again.
- On the game over screen you can input your name and click on the "Save Score" button, to save your score in a leaderbord.
- If no name is given, the name "Default User" will be attributed.
- If you access the leaderboard (by clicking on the "Leaderboard" button) without saving your score, the score for that run WILL BE LOST!
- If you chose to return to the title screen (by clicking on the "Title Screen" button) without saving your score, the score for that run WILL BE LOST!
- By clicking on the "Leaderboard" button, on the Title screen or on the game over screen, You will be shown a Leaderboard with the top 10 scores.

[Click Here to read the Game Design Document](./game-instructions)

## Built With

- JavaScript, CSS, HTML.
- Phaser 3
- Webpack, Jest, Babel, eslint, stylelint, webhint.

## Live Demo

[Play Cat Jump](https://cat-jump-jpdf00.netlify.app/)

## Getting Started

To get a local copy up and running follow these simple example steps.

- On the top of the page there is a green button name "Code"
![Code Button](./screenshots/code-button.png)
- Click on the "Code" button.
- A Menu will appear click in "Download Zip"
![Download Zip](./screenshots/download-zip.png)
- Save the "phaser3-plataformer-feature-full-game.zip" file on your computer.
- Extract the contents of the "phaser3-plataformer-feature-full-game.zip" you just downloaded in a folder.

### Prerequisites

- nodeJS.
- A browser.

### Setup

- Open your comand prompt.
- Go inside the folder "phaser3-plataformer-feature-full-game" (The one you extracted from the "phaser3-plataformer-feature-full-game.zip" file).
- Type `npm install`.

### Usage

- Open your comand prompt.
- Go inside the folder "phaser3-plataformer-feature-full-game" (The one you extracted from the "phaser3-plataformer-feature-full-game.zip" file).
- Type `npm run start` (this should open a page in your default browser and the game should load).

### Run tests

- Open your comand prompt.
- Go inside the folder "phaser3-plataformer-feature-full-game" (The one you extracted from the "phaser3-plataformer-feature-full-game.zip" file).
- Type `npm run test`.

## Authors

👤 **João Paulo Dias França**

- GitHub: [@jpdf00](https://github.com/jpdf00)
- Twitter: [@jpdf00](https://twitter.com/jpdf00)
- LinkedIn: [João Paulo Dias França](https://www.linkedin.com/in/jpdf00/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/jpdf00/phaser3-plataformer/issues).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

Thanks to:

- Cat Asset by [[LPC] Cats and Dogs" Artist: bluecarrot16 License: CC-BY 3.0 / GPL 3.0 / GPL 2.0 / OGA-BY 3.0](http://opengameart.org/content/lpc-cats-and-dogs).
- Building Asset by [Pedro Neves](https://opengameart.org/content/plataform-building).
- Sky Asset by [Paulina Riva](https://opengameart.org/content/sky-background).
- Phaser 3 template tutorial by [Bill Reed](https://snowbillr.github.io/blog/2018-04-09-a-modern-web-development-setup-for-phaser-3/)
- Phaser 3 Endless Runner tutorial by [Emanuele Feronato](https://www.emanueleferonato.com/tag/endless-runner/)

## 📝 License

This project is [MIT](./LICENSE) licensed.