Skip to content

Latest commit

 

History

History
169 lines (117 loc) · 5.28 KB

README.md

File metadata and controls

169 lines (117 loc) · 5.28 KB
Raw

Pick Flower 🌼

Top Page Screenshot

About this Project - Javascript Capstone

  • This project is to build a platform game such as the endless runner game , using Phaser framework, and implement scoring system.

Table of Contents

What I have done 👍

  • Planned the game overview and specific mechanic with Game Design Document(GDD)
  • Built platform game with Phaser library
  • Implemented a scoring system using the given API to save the score with a username and display it in a game view
  • Deployed to a server so the game is accessible for anyone
  • Write tests with Jest

Also, these features are added:

  • Three modes: Easy, normal, and hard that is different on the speed of showing enemies and fruits
  • Double jump: The main character can double jump

Built With

Live Demo

Pick Flower

Game Design Document(GDD)

Game Design Document (GDD) Link

Getting Started

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

  1. On the project GitHub page, navigate to the main page of the repository.
  2. Under the repository name, locate and click on a green button named Code.
  3. Copy the project URL as displayed.
  4. If you're running the Windows Operating System, open your command prompt. On Linux, Open your terminal.
  5. Change the current working directory to the location where you want the cloned directory to be made. Leave as it is if the current location is where you want the project to be.
  6. Type git clone, and then paste the URL you copied in Step 3.
    For this project:
git clone https://github.com/AbdumurodovaZulfizar/Pick-Flower.git
  1. Press Enter. Your local copy will be created.

Test

  1. To run the tests
npm test
  1. To test scpesific file
npm test _file_name_

All tests have passed

How to run the game

cd Pick-Flower

npm install

npm run build
  • Then Click Go Live at the right-bottom corner of VSCode, and click dist directory (Or simply click right side of mouse on the index.html and select Open with live server)

What is Pick flowers

Pick Flowers is simple game, a cute girl picks flowers from garden, and when she touches thorn the game ends.

How to play the game

  1. Click the "Click to Start" button
  2. Input a username that will be shown if a player will be a top 5 scorer.
  3. Choose the mode from easy, normal, or hard that is different on the speed of showing spiders(enemy) and fruits
  4. Start the game
  5. In the game-over view,
  • To see the top 5 scorers, click the "Score" button.
  • To start the different username or mode, click the "TOP" button
  • To restart the game in the same mode, click the "Restart" button
  1. In the score view,
  • The top 5 scorers are showing with their username and their score
  • To start the different username or mode, click the "TOP" button
  • To restart the game in the same mode, click the "Restart" button

Rule of the game

  • A player gets a 70 scores when touching a flower
  • The game will be over when a player touches a thorn
  • A player can be operated by using keyboard cursors arrows (←, →, ↑).
  • To run to the left, click ←, to the right, click →, and to jump up, click ↑
  • A player can double jump, to do it, click ↑ again in the air

Author

🏻‍💼 Zulfizar Abdumurodova

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Show your support

Give a ⭐️ if you like this project!

License

This project is MIT licensed.

Acknowledgements