beachlasagna / IndiGeo

IndiGeo is a web based game for geography nerds
1 stars 9 forks source link
hacktoberfest hacktoberfest-accepted

Indian City Guessing Game

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!

Table of Contents

Features

Installation

To set up the project locally, follow these steps:

Prerequisites

Steps

  1. Clone the Repository

    Open your terminal and run the following command:

    git clone https://github.com/beachlasagna/IndiGeo.git
  2. Navigate to the Project Directory

    cd repository
  3. Install Dependencies

    Run the following command to install the required packages:

    npm install
  4. Start the Development Server

    Launch the game with:

    npm start

    The game will be accessible at http://localhost:3000 (or another port, if specified).

How to Play

  1. Join a Game: Start or join a multiplayer session.
  2. Receive Clues: Players will receive clues in the form of distances to major Indian cities.
  3. Make Guesses: Use the provided distances to guess the hidden city.
  4. Score Points: Earn points based on correct guesses and how quickly you respond.
  5. Check the Leaderboard: After each round, check your position against other players.

Contributing

Contributions are welcome! If you'd like to improve this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or fix.
  3. Make your changes and test them thoroughly.
  4. Submit a pull request explaining your changes.

Support

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.