This is a text based multiplayer puzzle game with real-time chat that allows users to connect and communicate with each other through web sockets. It uses the Express framework, Mongoose, Socket.IO, and other libraries to set up a server that handles incoming connections and stores user and chat room information in a MongoDB database.
To install and run GuessWho on your local machine, follow these steps:
- Clone this repository to your local machine using
git clone https://github.com/mshubham0403/KnowWhere.git
. - Navigate to the root directory of the project using ๐
cd KnowWhere
. - Install the project dependencies using ๐ ๏ธ
npm install
. - Start the server using ๐
npm start
.
Note: You will need to have Node.js and npm installed on your machine in order to run this project.
Once you have installed and started GuessWho, you can access it by navigating to ๐ http://localhost:3000
in your web browser. From there, you can create an account or log in if you already have one.
To create a new account on GuessWho:
- Click the ๐ค "Sign Up" button on the home page.
- Enter your desired username and password.
- Click "Create Account".
To sign in to an existing account on GuessWho:
- Click the ๐ "Sign In" button on the home page.
- Enter your username and password.
- Click "Sign In".
Once you are logged in, you can join or create chat rooms by clicking on the ๐ฌ "Chat Rooms" tab at the top of the page.
To join an existing chat room:
- Choose to be a guesser on choice page.
- Click on the name of the room you want to join.
- you ill be dorected to a room ith puzzler present.
- ait for the riddler to pose the question and try to guess the ansWer.
To create a new chat room:
- Confirm that your role is set to "Riddler" by choosing "Be a puzzler" on choice page.
- Click on "Create Room".
- A room Will be created With you username as its name Wait for a guesser to join the room.
- Pose the question and give hints using send image file option.
To delete a chat room:
- Click on the "Delete Room" button on the room list page.
- If you are the creater of that room ,the room is deleted.
- Room list is updated.
As a Riddler, you can send image files as hints to help the Guessers solve the puzzle. To send an image file:
- Click on the "Upload Image" button in the chat window.
- Select the image file you want to upload.
- The image will be sent to the server and displayed in the chat window for all users to see.
If you would like to contribute to GuessWho, please follow these guidelines:
- Fork this repository.
- Create a new branch for your changes using ๐ฑ
git checkout -b [branch-name]
. - Make your changes and commit them using โ๏ธ
git commit -m "[commit-message]"
. - Push your changes to your forked repository using โฌ๏ธ
git push origin [branch-name]
. - Submit a pull request from your forked repository to this repository.