From 89999bc27a32c2c7106b6b036f6e28d1469fd00c Mon Sep 17 00:00:00 2001 From: jduranigles Date: Wed, 14 Feb 2024 18:37:50 -0500 Subject: [PATCH] Improvements to README file --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 19f6b84..380c7e5 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,30 @@ Example Solution: https://coach-stephanie.github.io/pokebattle/ (Screenshot Coming Soon) +## Installation +Before running the PokeAPI Battle project, ensure you have the following installed: + - Node.js: visit the official website (https://nodejs.org/en) to install +Once Node.js is installed, follow these steps to setup the project locally: + +1. Fork the repository to your Github account +2. Clone the repository to your local machine using this command: +``` +git clone https://github.com/username/PokeAPIBattle.git +``` +3. Navigate to the project directory: +``` +cd PokeApiBattle +``` +4. Install the necessary dependencies using npm: +``` +npm install +``` +5. After installing the dependencies, start the development server by running: +``` +npm start +``` ## Lesson @@ -69,6 +91,16 @@ for (var key in objectName) { - The page is quite basic looking… customize your page by adding your flair to the CSS! - We will be working on the “Battle” mechanics and general win/lose game design algorithms next week. If you feel that you want to start this now, feel free to do so :) +## Game Mechanics +* **Random Pokemon:** + - You must get a random pokemon on each battle side using the PokeAPI and put them to battle to determine the winner + + +* **Battle Mechanics:** + - There is the possibility for a winner, loser, or a tie. The battle mechanics are up to you but there must be these three possibilities. In the example solution above, the battle is based solely on which Pokemon's attack stat is higher. Other battle mechanics may include summing up all base stats and determining which total is higher or finding the higher difference between the opponent's health stat and the attack stat of the other Pokemon. + + - There are several possibilities for battle mechanics but these are some suggestions for starting out, it can go much more in-depth such as to add moves, health bar, etc. +