Spaces:
Sleeping
Sleeping
Delete README.md
Browse files
README.md
DELETED
|
@@ -1,88 +0,0 @@
|
|
| 1 |
-
# 🎨 Drawable
|
| 2 |
-
|
| 3 |
-
> The ultimate Draw & Guess game — skribbl.io clone with superpowers.
|
| 4 |
-
|
| 5 |
-
## 🚀 Features (beyond skribbl.io)
|
| 6 |
-
|
| 7 |
-
| Feature | Drawable | skribbl.io |
|
| 8 |
-
|---|---|---|
|
| 9 |
-
| Power-ups (Reveal, Time Warp, Bomb) | ✅ | ❌ |
|
| 10 |
-
| Emoji reactions (floating) | ✅ | ❌ |
|
| 11 |
-
| Drawing replay after each round | ✅ | ❌ |
|
| 12 |
-
| Live score graph timeline | ✅ | ❌ |
|
| 13 |
-
| Team mode (Red vs Blue) | ✅ | ❌ |
|
| 14 |
-
| Sudden Death (wrong = lose points) | ✅ | ❌ |
|
| 15 |
-
| Quick Draw mode (20s) | ✅ | ❌ |
|
| 16 |
-
| 10 word categories | ✅ | ❌ |
|
| 17 |
-
| Custom words | ✅ | ✅ |
|
| 18 |
-
| Achievements system | ✅ | ❌ |
|
| 19 |
-
| Streak bonuses | ✅ | ❌ |
|
| 20 |
-
| Host kick player | ✅ | ✅ |
|
| 21 |
-
| Spectator mode | ✅ | ❌ |
|
| 22 |
-
| Undo stroke | ✅ | ❌ |
|
| 23 |
-
| Shape tools (line, rect, circle) | ✅ | ❌ |
|
| 24 |
-
| Bucket fill tool | ✅ | ✅ |
|
| 25 |
-
| Close-guess detection | ✅ | ❌ |
|
| 26 |
-
|
| 27 |
-
## 📁 File Structure
|
| 28 |
-
|
| 29 |
-
```
|
| 30 |
-
drawable/
|
| 31 |
-
├── server.js # Node.js + Socket.IO backend
|
| 32 |
-
├── words.js # 300+ words across 10 categories
|
| 33 |
-
├── package.json
|
| 34 |
-
├── Dockerfile
|
| 35 |
-
├── .dockerignore
|
| 36 |
-
└── public/
|
| 37 |
-
├── index.html # Lobby
|
| 38 |
-
├── game.html # Game screen
|
| 39 |
-
├── css/style.css
|
| 40 |
-
└── js/
|
| 41 |
-
├── lobby.js
|
| 42 |
-
└── game.js
|
| 43 |
-
```
|
| 44 |
-
|
| 45 |
-
## 🏠 Run Locally
|
| 46 |
-
|
| 47 |
-
```bash
|
| 48 |
-
npm install
|
| 49 |
-
npm start
|
| 50 |
-
# Open http://localhost:7860
|
| 51 |
-
```
|
| 52 |
-
|
| 53 |
-
## 🤗 Deploy to Hugging Face Spaces
|
| 54 |
-
|
| 55 |
-
1. Go to https://huggingface.co/new-space
|
| 56 |
-
2. Name: `drawable` | SDK: **Docker** | Visibility: Public
|
| 57 |
-
3. Clone the Space repo:
|
| 58 |
-
```bash
|
| 59 |
-
git clone https://huggingface.co/spaces/YOUR_USERNAME/drawable
|
| 60 |
-
```
|
| 61 |
-
4. Copy all project files into the cloned folder
|
| 62 |
-
5. Push:
|
| 63 |
-
```bash
|
| 64 |
-
git add . && git commit -m "init" && git push
|
| 65 |
-
```
|
| 66 |
-
6. Wait ~2 min for build. Your game is live! 🎉
|
| 67 |
-
|
| 68 |
-
> **Note:** Hugging Face Spaces expose port 7860 automatically — no config needed.
|
| 69 |
-
|
| 70 |
-
## ❓ Do I need a database?
|
| 71 |
-
|
| 72 |
-
**No!** All game state is stored in-memory on the server.
|
| 73 |
-
- Rooms exist while players are connected
|
| 74 |
-
- Scores reset each game
|
| 75 |
-
- No user accounts needed — just pick a name and play
|
| 76 |
-
|
| 77 |
-
If you want persistent leaderboards later, add Supabase (free tier) and a `/leaderboard` endpoint.
|
| 78 |
-
|
| 79 |
-
## 🎮 How Rooms Work
|
| 80 |
-
|
| 81 |
-
```
|
| 82 |
-
Player → click "Quick Play"
|
| 83 |
-
Server: any open room? → YES → join it
|
| 84 |
-
→ NO → create new room, wait for others
|
| 85 |
-
|
| 86 |
-
Player → click "Create Room" → get 6-char code → share with friends
|
| 87 |
-
Player → click "Join Room" → enter code → join instantly
|
| 88 |
-
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|