Skip to content

Latest commit

 

History

History
159 lines (104 loc) · 4.53 KB

README.md

File metadata and controls

159 lines (104 loc) · 4.53 KB

Javascript Capstone Project : Ninja Game

About

This project is part of the Microverse Curriculum projects. The game is meant to be a platform game for the final project of the Javascript curriculum, and was developed using Phaser 3.

Project specifications

The Game

  • The main character is a ninja that run trough a world dominated by an evil AI in the year 2320. The first stage and main scene of this game is where our hero has to collect ninja-stars and kunais(knifes) to get points. The goal is to collect as many weapons as you can to be able to fight enemies in next stages(to be design).

  • Make sure to jump at the right moment because platforms appears at different height and move at different speed.

  • The main characters and items where taken from Open Game Art.

Live Version

How to play

  • You can use the up arrow key to jump over the infinite platforms.
  • Use the left and right arrow keys to move and redirect your jump.
  • The only way to survive is to mantain yourself above the platforms.

Install

You can use the live version or you can install it in your local machine

Clone this repository

$ git clone https://github.com/nriqu322/ninja-game.git

Go to the folder

$ cd ninja-game

Install all dependencies

$ npm install

Run the server

$ node server.js

Open your browser and type

localhost:8080

Hero & Items

Ninja

Ninja

  • Role: Main character

Ninja-Star

star

  • Item : collectible
  • Role : weapon

Kunai

kunai

  • Item : collectible
  • Role : weapon

Scenes

Main Menu : Where you can see three links: Play the Game, Instructions and Leader Board.

Menu

Play : Run for you life and to get the highest score.

Play

GameOver : See your obtained score and type your name.

GameOver

LeaderBoard : Check if you manage to appear in the Leader Board.

Leaderboard

Build with

  • JavaScript
  • Webpack
  • Phaser 3
  • Express
  • Babel
  • Jest
  • Heroku
  • Leaderboard API service
  • ESlint and Stylelint as linters

Available scripts

You can use $ npm run {script here} with the following commands :

  • "test": "jest"
  • "build": "webpack --mode production".
  • "watch": "webpack --mode development --watch"

Testing

Unit tests with Jest. You can run the tests with the following code:

$ npm test

Future Features

  • Ability to throw collected ninja-tars and kunais
  • More stages
  • Add enemies to fight.

Project Design

Project purpuse

Development of a platform game as part of the Microverse curriculum to show technical and soft skills learned through the curriculum. Use of Phaser 3 to develop the game.

Objectives

  1. Design the game, selecting a main theme for the game and characters.
  2. Research for assets and media content: sprite sheets and images.
  3. Write code for the game: Scenes, Characters.
  4. Add a score system
  5. Include a backend API to store a leader board.
  6. Add enemies and game sound.
  7. Add unit test using Jest.

Achievements

  1. Choose a ninja as main character and city as environment. Select a infinite platform game.
  2. Use Open Game Art for platform image and ninja sprite sheet, then use Figma website to create the sprite sheets for ninja actions.
  3. Write code for different scenes: Load Scene, Instructions, Main Menu, Main Scene and GameOver Scene.
  4. Add ninja-star and kunai as collectible items for the score system.
  5. Send request to get the API key and code LeaderBoard Scene
  6. Couldn't be able to add sound and enemies. This is going to be in added future features.
  7. Use axios and jest mocks to add tests.

Author

👤 Luis Saavedra

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

Microverse