DaggerDice Documentation¶
Welcome to the DaggerDice documentation! DaggerDice is a 3D dice rolling web application designed specifically for the Daggerheart RPG system, featuring Hope/Fear mechanics and real-time multiplayer collaboration.
๐ฒ Launch DaggerDice ๐ฒ
User Documentation¶
Perfect for players, Game Masters, and content creators who want to use DaggerDice:
๐ Getting Started¶
Complete user guide covering: - Quick start for solo and multiplayer use - Roll types explained (Check, Damage, GM) - Multiplayer session creation and joining - Keyboard shortcuts and tips - Troubleshooting common issues
โจ Features Overview¶
Comprehensive feature documentation: - Core dice system (Hope & Fear mechanics) - 3D physics simulation and themes - Real-time multiplayer features - Mobile optimization and accessibility - Privacy controls and Streamer Mode
Technical Documentation¶
For developers, contributors, and those interested in the technical implementation:
๐ง Development Guide¶
Complete developer documentation: - Project architecture and technology stack - Local development setup - Testing strategy and CI/CD pipeline - Code style and contribution guidelines - Advanced configuration options
๐ Multiplayer Technical Architecture¶
Deep dive into the multiplayer system: - WebSocket connection management - Cloudflare Workers and Durable Objects - Message protocol and data flow - Reconnection strategies and error handling - Performance characteristics and monitoring
Quick Overview¶
DaggerDice is a modern web application that provides:
Daggerheart RPG Features
- ๐ฒ Hope & Fear Dice System: D12-based mechanics from Daggerheart with critical success detection
- ๐ฏ Multiple Roll Types: Check, Damage, and GM rolls with full Daggerheart support
- โก 3D Physics: Realistic dice rolling with WebGL/WASM simulation
Multiplayer & Social
- ๐ Real-time Multiplayer: WebSocket-based sessions with automatic reconnection
- ๐ฑ Mobile Optimized: Responsive design with touch-friendly interfaces
- ๐ฌ Streamer Mode: Privacy controls for content creators
Developer Features
- ๐ง Open Source: MIT licensed with comprehensive documentation
- ๐ Modern Stack: TypeScript, Alpine.js, Cloudflare Workers
- ๐งช Well Tested: Comprehensive test suite with CI/CD
Architecture Overview¶
graph TB
A[Web Browser] -->|HTTPS/WSS| B[Cloudflare Workers]
B --> C[Durable Objects<br/>Session Rooms]
B --> D[Static Assets<br/>3D Dice Themes]
E[Alpine.js Frontend] --> F[3D Dice Physics<br/>@3d-dice/dice-box]
E --> G[WebSocket Client<br/>Real-time Communication]
H[TypeScript] --> I[Vite Build System]
I --> J[Production Bundle]
K[GitHub Actions] --> L[Automated Testing]
L --> M[Cloudflare Deployment]
Getting Help¶
- ๐ Bug Reports: GitHub Issues
- ๐ก Feature Requests: GitHub Discussions
- ๐ Documentation: Browse the guides above
- ๐ป Source Code: View on GitHub
Quick Navigation¶
For Users | For Developers |
---|---|
Getting Started | Development Guide |
Features | Multiplayer Technical |
Troubleshooting | Contributing |
Browser Requirements | Testing |
Ready to start rolling? Launch DaggerDice now! ๐ฒ