Skip to content

Commit

Permalink
Merge pull request #373 from srinidhifd/srinidhi-patch
Browse files Browse the repository at this point in the history
Updated Readme.md file
  • Loading branch information
ayush-t02 authored Jun 18, 2024
2 parents d593d7b + cd407cf commit 236d59e
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 6 deletions.
1 change: 1 addition & 0 deletions .anima/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
cache
78 changes: 72 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,93 @@
# __Dots and Boxes Game__
# __Dots and Boxes Game__ - [Join our Community on Discord](https://discord.gg/V5tc7kTg)
![Community](https://github.com/GameSphere-MultiPlayer/Physi-c-Tech/assets/98798977/e79af9da-814e-487e-8a9a-85947384d3b2)

---
<table align="center">
<thead align="center">
<tr border: 1px;>
<td><b>Stars</b></td>
<td><b>Forks</b></td>
<td><b>Issues</b></td>
<td><b>Open PRs</b></td>
<td><b>Closed PRs</b></td>
</tr>
</thead>
<tbody>
<tr>
<td><img alt="Stars" src="https://img.shields.io/github/stars/ChromeGaming/Dot-Box?style=flat&logo=github"/></td>
<td><img alt="Forks" src="https://img.shields.io/github/forks/ChromeGaming/Dot-Box?style=flat&logo=github"/></td>
<td><img alt="Issues" src="https://img.shields.io/github/issues/ChromeGaming/Dot-Box?style=flat&logo=github"/></td>
<td><img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/ChromeGaming/Dot-Box?style=flat&logo=github"/></td>
<td><img alt="Closed Pull Requests" src="https://img.shields.io/github/issues-pr-closed/ChromeGaming/Dot-Box?style=flat&color=critical&logo=github"/></td>
</tr>
</tbody>
</table>

<br>
## **Tech Stack**
- HTML
- CSS
- Javascript

## **Description 📃**
- It is a multiplayer game.
- Based on the lines connected, the boxes would be coloured.
- The one with maximum number of boxes would be the winner.

<br>

## **Functionalities 🎮**
- It is a multiplayer game.
- The player has to select the lines. The one with the line at the last would fill the connecting boxes.
- The player with the maximum boxes covered would be the winner.
- The size of the board can be adjustable by user.
- Players will switch after every turn. But the player who has filled the last box, will get one extra chance consecutively.

<br>

## **How to play? 🕹️**

- User has to click on edge in such a way that it will maximise the number of boxes based on the lines connected and the number of adjacent boxes.

<br>

## **Setup and Installation**
<p style="font-family:var(--ff-philosopher);">To contribute to the Dot-Box repository, follow these steps:</p>

1. **Fork the Repository:**
Click on the "Fork" button on the repository's GitHub page to create a copy of the repository in your GitHub account.

2. **Clone the repository:**
Clone the forked repository to your local machine using the following command in your terminal.
```bash
git clone https://github.com/<your-github-username>/Dot-Box
```
3. **Add a remote upstream:**
```bash
git remote add upstream https://github.com/ChromeGaming/Dot-Box
```
4. **Create a new branch:**
Create a new branch for your changes. Run the following command in your terminal.
```bash
git checkout -b <your-branch-name>
```
5. **Make the desired changes:**
Make the desired changes to the source code.
6. **Add your changes:**
Add your changes to the staging area. Run the following command in your terminal.
```bash
git add <File1 changed> <File2 changed> ...
```
7. **Commit your changes:**
Commit your changes with a meaningful commit message. Run the following command in your terminal.
```bash
git commit -m "<your-commit-message>"
```
8. **Push your changes:**
Push your changes to your forked repository. Run the following command in your terminal
```bash
git push origin <your-branch-name>
```
9. **Create a Pull Request:**
Go to the GitHub page of your forked repository. You should see a prompt to create a pull request (PR). Click on it, compare the changes, and create the PR.
<br>


## **Screenshots 📸**

![Screenshot](https://github.com/GameSphere-MultiPlayer/GameSphere/assets/114330097/0dbdfbc6-7a84-48e4-ad34-2185f790a146)
Expand All @@ -38,3 +99,8 @@
https://github.com/GameSphere-MultiPlayer/GameSphere/assets/114330097/293120ab-b1f0-48a8-af15-c05d49c65763

<br>

## **Our Contributors**
<a href="https://github.com/ChromeGaming/Dot-Box/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ChromeGaming/Dot-Box" />
</a>

0 comments on commit 236d59e

Please sign in to comment.