Welcome to the Indian City Guessing Game! This is a fun, multiplayer web-based game where players guess a hidden Indian city based on its distances to several major cities. It's an engaging way to test your knowledge of Indian geography!
- Multiplayer Gameplay: Play with friends or other players online.
- City Distances: Guess the hidden city using the distances provided to seven major Indian cities.
- Leaderboard: Track the top players based on their streaks.
- Interactive Map: View city locations on a beautiful map.
- Dark Theme: Enjoy a modern, dark-themed user interface.
To set up the project locally, follow these steps:
- Node.js (v12 or later): Download Node.js
- Git (optional, for cloning the repository): Download Git
-
Clone the Repository
Open your terminal and run the following command:
git clone https://github.com/beachlasagna/IndiGeo.git
-
Navigate to the Project Directory
cd repository
-
Install Dependencies
Run the following command to install the required packages:
npm install
-
Start the Development Server
Launch the game with:
npm start
The game will be accessible at
http://localhost:3000
(or another port, if specified).
- Join a Game: Start or join a multiplayer session.
- Receive Clues: Players will receive clues in the form of distances to major Indian cities.
- Make Guesses: Use the provided distances to guess the hidden city.
- Score Points: Earn points based on correct guesses and how quickly you respond.
- Check the Leaderboard: After each round, check your position against other players.
Contributions are welcome! If you'd like to improve this project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or fix.
- Make your changes and test them thoroughly.
- Submit a pull request explaining your changes.
If you have any questions or need help, feel free to reach out on Discord: sleeezyy.
Happy guessing!
### Key Sections Explained:
- **Project Overview**: A brief introduction to the game and its purpose.
- **Table of Contents**: Helps users navigate through the documentation easily.
- **Features**: Highlights what makes the game unique and engaging.
- **Installation**: Step-by-step guide for setting up the project locally.
- **How to Play**: Clear instructions for new players on how to engage with the game.
- **Contributing**: Encourages community involvement and explains how to contribute.
- **License**: Provides information on the project's licensing.
- **Support**: Offers a direct way for users to seek assistance.