Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SandunLB authored Aug 12, 2024
1 parent 8eed46e commit 43e862f
Showing 1 changed file with 69 additions and 7 deletions.
76 changes: 69 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,72 @@
# Pig Dice Game
# Pig Dice Game ๐ŸŽฒ

A simple Pig Dice game implemented in JavaScript.
Welcome to the Pig Dice Game! ๐ŸŽ‰ This classic dice game brings a fun twist to your browser with engaging animations, adjustable AI difficulty, and a cosmic background. Ready to test your luck?

## How to Play
๐Ÿ”— [Play the Game](https://sandunlb.github.io/PIG-DICE-JS/)

1. Roll the dice by clicking the "Roll Dice" button.
2. Accumulate points or lose them if a 1 is rolled.
3. Hold to save points to your total.
4. First to reach Wining points wins!
---

## ๐ŸŒŸ Features

- **๐ŸŽฎ Game Modes**: Play against an AI or another player.
- **๐Ÿค– AI Difficulty Levels**: Customize the AIโ€™s difficulty for a greater challenge.
- **โœจ Animations**: Experience smooth and captivating dice roll animations.
- **๐Ÿ”Š Sound Effects & Music**: Toggle background music and sound effects on or off.
- **๐Ÿ“ฑ Responsive Design**: Optimized for both desktop and mobile devices.

---

## ๐Ÿš€ Installation & Setup

1. **Clone the Repository**
- Open your terminal or command prompt.
- Clone the repository using:
```sh
git clone https://github.com/SandunLB/PIG-DICE-JS.git
```

2. **Navigate to the Project Directory**
- Change your directory to the project folder:
```sh
cd PIG-DICE-JS
```

3. **Open `index.html` in Your Browser**
- Open the `index.html` file in your preferred web browser to start playing.

4. **Optional Customization**
- Edit the `styles.css` file to customize the game's appearance.
---
## ๐ŸŽฎ Usage Instructions
### Game Modes
- **Single-Player**: Compete against an AI with adjustable difficulty.
- **Multiplayer**: Play against another human player.
### Controls
- **๐ŸŽฒ Roll Dice**: Click the "Roll" button to roll the dice.
- **โœ‹ Hold**: Click the "Hold" button to end your turn and save your score.
- **๐Ÿ”„ New Game**: Click the "New Game" button to start a fresh game.
- **๐Ÿ† Set Winning Score**: Enter your desired winning score in the provided input field.
---
## ๐Ÿค Development & Contribution
- **Languages Used**: HTML, CSS, JavaScript
- **Frameworks & Libraries**: No specific frameworks; custom code.
- **Contributions**: Feel free to fork the repository, make improvements, and create a pull request.
For any issues or suggestions, please open an issue on the [GitHub repository](https://github.com/SandunLB/PIG-DICE-JS).
---
## ๐Ÿ“œ License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
Thank you for checking out the Pig Dice Game! ๐ŸŽ‰ Have fun rolling the dice! ๐ŸŽฒ

0 comments on commit 43e862f

Please sign in to comment.