Files
Tarokka/README.md
Gavin McDonald 24062d1a07 Updated README
2025-04-26 09:39:45 -04:00

37 lines
1.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
````
# 🃏 Tarokka
**Tarokka** is a real-time Tarokka card reading app for _Dungeons & Dragons: Curse of Strahd_. It simulates Madam Evas fortune-telling, revealing a heros fate and Strahds secrets, and is built to deliver an authentic, immersive experience for DMs and players alike.
![screenshot](public/screenshot.png)
You can see it live at:
👉 [https://tarokka.mcmorgans.us](https://tarokka.mcmorgans.us)
---
## ✨ Features
- 🔮 **Faithful to the Tarokka Deck**: Supports all cards and positions used by Madam Eva's reading.
- 💬 Dynamic prophecy rendering based on card and position
- 🎨 Multiple card styles
- 🧙 **Separate DM and Spectator Views**:
- ⚙️ DM can toggle what information is visible to players.
- Every action (flipping cards, settings changes) is broadcast live to connected users.
- 🌐 Fully browser-based — no accounts or installs
- 📱 Mobile-friendly UI
- 🔁 **WebSocket-Powered Real-Time Sync**:
---
## 🚀 Getting Started
### Development
```bash
git clone https://github.com/mcdoh/tarokka.git
cd tarokka
npm install
npm run dev
````