Skip to content

Commit fda10b1

Browse files
committed
added detailed documentation
1 parent 813c95e commit fda10b1

File tree

1 file changed

+106
-1
lines changed

1 file changed

+106
-1
lines changed

README.md

Lines changed: 106 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,106 @@
1-
# Fate-of-Three
1+
# 🎮 Fate of Three – Rock Paper Scissors Game
2+
3+
A stylish and interactive **Rock–Paper–Scissors** game against the computer featuring animated buttons, score tracking, background music, sound effects, and confetti celebrations! Designed using **HTML, CSS, and JavaScript**.
4+
5+
---
6+
7+
## 📌 Features
8+
9+
* 🪨 **Rock–Paper–Scissors Gameplay**
10+
* 👨‍💻 **Play vs Computer (Randomized)**
11+
* 🔊 **Background Music + Sound Effects** (Win & Lose)
12+
* 🎉 **Confetti Animation** on Winning
13+
***Button Entry Animations**
14+
* 📱 **Responsive UI for Mobile Screens**
15+
* 🎨 Custom fonts and modern UI
16+
17+
---
18+
19+
## 📁 Project Structure
20+
21+
```
22+
docs/
23+
24+
├── index.html # Main HTML structure
25+
├── styles.css # Styling and animations
26+
├── index.js # Game logic & event handling
27+
28+
├── assets/ # Images & audio files
29+
│ ├── 6729598.png # Favicon
30+
│ ├── bg_audio.mp3 # Background music
31+
│ ├── victory.mp3 # Victory sound
32+
│ └── lose.mp3 # Losing sound
33+
34+
└── README.md # Project documentation
35+
```
36+
37+
---
38+
39+
## 🛠️ Technologies Used
40+
41+
* **HTML5** – UI structure
42+
* **CSS3** – Styling, animations, responsiveness
43+
* **JavaScript** – Game functionality
44+
* **Google Fonts** – Custom typography
45+
* **Canvas Confetti JS (CDN)** – Win animation
46+
47+
---
48+
49+
## ▶️ How to Run the Project
50+
51+
1. Download or clone the repository:
52+
53+
```bash
54+
git clone https://github.com/your-username/fate-of-three.git
55+
```
56+
57+
2. Open the project folder.
58+
59+
3. Double-click **index.html** to open it in your browser.
60+
61+
4. Start playing! 🎮
62+
63+
---
64+
65+
## 🎯 Game Rules
66+
67+
* **Rock** beats **Scissors**
68+
* **Scissors** beats **Paper**
69+
* **Paper** beats **Rock**
70+
* Same choices → **Tie**
71+
72+
---
73+
74+
## 👥 Contributors
75+
76+
| Name |
77+
| ------------------- |
78+
| **Injora Injora** |
79+
| **Kartik Tripathi** |
80+
| **Ashwin Alwa** |
81+
82+
---
83+
84+
## 🚀 Future Improvements
85+
86+
* Add multiplayer mode
87+
* Add advanced animations
88+
* Add multiple themes (dark/light)
89+
90+
---
91+
92+
## 📄 License
93+
94+
This project is open-source. Feel free to modify and improve.
95+
96+
---
97+
98+
## ❤️ Acknowledgements
99+
100+
* Google Fonts
101+
* Canvas Confetti library
102+
* Emojis for Rock, Paper, Scissors
103+
104+
---
105+
106+
**Enjoy the Game!** 🎉🪨📃✂️

0 commit comments

Comments
 (0)