/Phoom

Phaser runner game

Primary LanguageJavaScriptMIT LicenseMIT

Phoom a JavaScript Platformer game

Phoom is a Platformer game built with Phaserjs

Table of Contents

Objective

The main goal of this project is to explore and learn the javascript game engine 'phaser', integrating modern technologies (EcmaScript, webpack, npm) for extending the capabilities of the tool (phaser) while testing some code and consuming third party API's.

In this game you could find:

  • A fully functional hero with 3 types of attacks, jumps, and slides
  • A set of enemies moving and attacking automatically
  • A nice level design with tiles, with a paralax background
  • A clock and recolected gems for computing scores
  • A leaderboard that shows up at the end of each level
  • Nice background music
  • Nice User experience
  • Nice set of animations

The following features are under construction:

  • Health and item's manager
  • Combat system between characters
  • Enemies AI
  • Enemies health
  • async testing

Up

Learning process

I decided to integrate a gitBook documentation with this repository for showing step by step how I made this project. The book is still in progress though.

Make phoom step by step

Up

Gameplay

  1. Start Screen

The velocity of the hero is faster for show you the entire map.

When finish the level, it should appear the leaderboard

Up

Languages and technologies used

  • Phaser 3
  • JavaScript
  • Babel
  • ESlint
  • npm
  • Webpack
  • HTML/CSS
  • Nodejs
  • third party API

Up

Install in Your local Machine

To run the scripts npm is required. To get npm you have to install Node.js. Follow the installation instructions for your system Mac, Linux or Windows.

Use your terminal and run the commands after each instruction.

Command Description
git clone https://github.com/nicolasmarino99/Phoom.git Clone the repository to you computer
cd Phoom Navigate to the newly created folder
npm install Install dependencies and launch browser with examples
npm run start Makes the build and starts the development server
Press Ctrl + c to kill http-server process
http://localhost:8080 Visit this link to play the game

Up

Acknowledgements

  • ShwiggityShwag for the main music
  • So many assets that I don't have the names. I used opengameart.org and itch.io Thanks to all the artist.

Up

Author

👨 Nicolás Mariño Parra

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

  1. Fork it (https://github.com/nicolasmarino99/Phoom.git/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Show your support

Give a ⭐️ if you enjoyed this project!

📝 License

This project is MIT licensed.