Files
dwroller/docs/user-guide.md
alex a4cabbd2b8 Clean rules database and add documentation
- Remove OCR noise, credits, and duplicates from rules-database.json (288→255 rules)
- Add clean_rules.py script for rule cleanup
- Add CLAUDE.md, docs/, and update README with documentation links

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-04-22 17:35:36 +02:00

119 lines
2.3 KiB
Markdown

# User Guide
## Introduction
Deathwatch Roller helps you manage your tabletop RPG sessions, track player progress, and access game resources.
## Main Features
### Dashboard
The main page provides quick access to all features:
- Shop for items
- Browse bestiary
- View rules database
- Access GM tools (if authorized)
### Shop
Browse and purchase equipment:
1. Click **"Shop"** in the navigation
2. Filter by item type (weapons, armor, vehicles)
3. Check RP cost and stats
4. Click **"Purchase"** to buy items
5. Items are added to your requisition
### Bestiary
Look up monsters and enemies:
1. Click **"Bestiary"** in navigation
2. Search by name or type
3. View monster stats and weaknesses
4. Use in combat preparation
### Rules Database
Access game rules:
1. Click **"Rules"** in navigation
2. Search for specific rules
3. View quick reference cards
4. Print rulesheets for reference
### Player Management (GM Only)
Game Masters can manage players:
1. Click **"Players"** in navigation (GM only)
2. Create new player accounts
3. Edit player stats and RP
4. Reset passwords
5. Bulk modify XP/RP
### Session Tracking
Track your game sessions:
1. Click **"Sessions"** in navigation
2. Create a new session
3. Add player notes
4. Track accomplishments
5. Export session data
## Tips and Tricks
### Quick Reference
Print quick reference cards for your next session:
- Click **"Print"** in navigation
- Download PDF reference sheets
- Keep handy for quick lookup
### GM Kit
Game Masters have access to special tools:
- Character generator
- Scenario templates
- Combat generator
- Utility scripts
### Session Organization
Organize your sessions:
- Add notes after each game
- Track player progression
- Maintain a campaign log
- Export data for backups
## Keyboard Shortcuts
| Shortcut | Action |
|----------|--------|
| `Ctrl+K` | Quick search |
| `Ctrl+S` | Save current view |
| `Ctrl+P` | Print current page |
## Accessibility
The application supports:
- Screen readers
- Keyboard navigation
- High contrast mode
- Adjustable text size
## Privacy
- Player data is stored locally
- No external data collection
- Session data is encrypted
- GM tools require secret key
## Support
For issues or questions:
- Check the [Developer Guide](./developer-guide.md)
- Review the [API documentation](./api.md)
- See open issues on GitHub