📚 Storyteller RPG Documentation
Welcome to the Storyteller RPG documentation hub. All project documentation is organized here for easy navigation.
📂 Documentation Structure
✨ Features
Comprehensive feature documentation with examples and guides.
- Features Overview - Complete feature catalog
- Demo Session Guide - Using the pre-configured test session
- Context-Aware Responses - Multi-character AI generation
- Prompt Engineering - LLM prompt techniques
- Bug Fixes - Recent fixes and improvements
🚀 Setup Guides
Get started quickly with installation and configuration guides.
- Quickstart Guide - Step-by-step setup instructions
- Quick Reference - Common commands and workflows
📋 Planning & Roadmap
Project vision, milestones, and future plans.
- Project Plan - Overall project structure and goals
- MVP Roadmap - Minimum viable product phases
- Next Steps - Immediate priorities and tasks
🔧 Development
Technical implementation details and testing.
- MVP Progress - Current status and achievements
- Testing Guide - How to test the application
- Test Results - Latest test results
📖 Reference
Technical guides and comprehensive references.
- LLM Guide - Working with different AI models
- Project Files Reference - Complete file structure
🔗 Quick Links
For New Users
- ⚡ Start with Quickstart Guide
- 🎮 Try the Demo Session (pre-configured!)
- 📖 Review Features Overview to see what's possible
- 🤖 Check LLM Guide for model selection
For Developers
- 🔧 Read MVP Progress for current state
- 🧪 Check Testing Guide
- 📁 Review Project Files Reference
- 🚀 Follow Next Steps for contribution areas
For Storytellers
- 🎭 See Features Guide for all tools
- 🧠 Learn about Context-Aware Responses
- 💡 Use Quick Reference for common tasks
- 🎲 Start with Demo Session for practice
📊 Current Status (v0.2.0)
✅ Completed Features
- Private/public/mixed messaging system
- Context-aware AI response generator
- Demo session with pre-configured characters
- Real-time WebSocket communication
- Multi-LLM support (GPT-4o, Claude, Llama, etc.)
- AI-assisted storyteller suggestions
- Session ID quick copy
- Full conversation history
🚧 Coming Soon
- Database persistence
- Character sheets & stats
- Dice rolling mechanics
- Combat system
- Image generation
- Voice messages
See MVP Roadmap for the complete timeline.
📝 Documentation Principles
This documentation follows these principles:
- Progressive Disclosure: Start simple, dive deeper as needed
- Always Current: Updated with each feature implementation
- Example-Driven: Real code examples and use cases
- Clear Structure: Logical organization for easy navigation
- Feature-Focused: Detailed guides for every feature
🎯 Documentation Map
docs/
├── features/ ← Feature guides & examples
│ ├── README.md
│ ├── DEMO_SESSION.md
│ ├── CONTEXTUAL_RESPONSE_FEATURE.md
│ ├── PROMPT_IMPROVEMENTS.md
│ └── FIXES_SUMMARY.md
├── setup/ ← Installation & quick start
│ ├── QUICKSTART.md
│ └── QUICK_REFERENCE.md
├── planning/ ← Roadmap & future plans
│ ├── PROJECT_PLAN.md
│ ├── MVP_ROADMAP.md
│ └── NEXT_STEPS.md
├── development/ ← Technical & testing docs
│ ├── MVP_PROGRESS.md
│ ├── TESTING_GUIDE.md
│ └── TEST_RESULTS.md
└── reference/ ← Technical references
├── LLM_GUIDE.md
└── PROJECT_FILES_REFERENCE.md
🤝 Contributing to Documentation
Found a typo or want to improve the docs? Contributions are welcome!
- Documentation lives in the
docs/folder - Use clear, concise language
- Include examples where helpful
- Keep formatting consistent
- Update relevant indexes when adding new docs
Need help? Start with the Quickstart Guide or check the main README.
Last updated: October 11, 2025