rts-commander / docs /README.md
Luigi's picture
Initial commit: Complete RTS project with MCP evaluation
551ad28
# ๐Ÿ“š Web Version Documentation
This directory contains all technical documentation for the RTS Web version.
---
## ๐Ÿ“– Core Documentation
### Architecture & Design
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - Complete system architecture (FastAPI + WebSocket)
- **[PROJECT_SUMMARY.md](PROJECT_SUMMARY.md)** - Project overview and structure
- **[MIGRATION.md](MIGRATION.md)** - Pygame to Web migration guide
### Quick Start
- **[QUICKSTART.md](QUICKSTART.md)** - Fast setup guide
- **[QUICK_SUMMARY.txt](QUICK_SUMMARY.txt)** - Brief project summary
---
## ๐ŸŽฎ Gameplay Documentation
### Features & Mechanics
- **[FEATURES_RESTORED.md](FEATURES_RESTORED.md)** - All restored features from Pygame
- **[GAMEPLAY_ISSUES.md](GAMEPLAY_ISSUES.md)** - Gameplay analysis
- **[GAMEPLAY_UPDATE_SUMMARY.md](GAMEPLAY_UPDATE_SUMMARY.md)** - Gameplay improvements
- **[UNIT_VISUAL_SHAPES.md](UNIT_VISUAL_SHAPES.md)** - Unit visual design
### Red Alert Compatibility
- **[RED_ALERT_FIXES.md](RED_ALERT_FIXES.md)** - Red Alert-style fixes
- **[RED_ALERT_CORRECTIONS_COMPLETE.md](RED_ALERT_CORRECTIONS_COMPLETE.md)** - Corrections summary
---
## ๐Ÿค– AI & Integration Documentation
### Model Context Protocol (MCP)
- **[MCP_INTEGRATION.md](MCP_INTEGRATION.md)** - MCP server integration guide
### Harvester AI System
- **[HARVESTER_AI_FIX.md](HARVESTER_AI_FIX.md)** - Complete Harvester AI implementation
- **[HARVESTER_AI_MOVEMENT_FIX.md](HARVESTER_AI_MOVEMENT_FIX.md)** - Movement improvements
- **[HARVESTER_AI_VISUAL_COMPARISON.txt](HARVESTER_AI_VISUAL_COMPARISON.txt)** - Visual behavior analysis
- **[HARVESTER_COMPLETE_SUMMARY.txt](HARVESTER_COMPLETE_SUMMARY.txt)** - Full implementation summary
- **[HARVESTER_LOGIC_EXPLAINED.md](HARVESTER_LOGIC_EXPLAINED.md)** - Logic explanation
- **[HARVESTER_MANUAL_CONTROL_FIX.md](HARVESTER_MANUAL_CONTROL_FIX.md)** - Manual control improvements
---
## ๐Ÿ”ง Technical Implementation
### Harvester AI System
- **[HARVESTER_LOGIC_EXPLAINED.md](HARVESTER_LOGIC_EXPLAINED.md)** - Harvester AI logic
- **[HARVESTER_AI_FIX.md](HARVESTER_AI_FIX.md)** - AI fixes applied
- **[HARVESTER_AI_MOVEMENT_FIX.md](HARVESTER_AI_MOVEMENT_FIX.md)** - Movement improvements
- **[HARVESTER_MANUAL_CONTROL_FIX.md](HARVESTER_MANUAL_CONTROL_FIX.md)** - Manual control
- **[HARVESTER_AI_VISUAL_COMPARISON.txt](HARVESTER_AI_VISUAL_COMPARISON.txt)** - Visual comparison
- **[HARVESTER_COMPLETE_SUMMARY.txt](HARVESTER_COMPLETE_SUMMARY.txt)** - Complete summary
### Bug Fixes & Corrections
- **[FIXES_IMPLEMENTATION.md](FIXES_IMPLEMENTATION.md)** - Implemented fixes
- **[CORRECTIONS_APPLIED.txt](CORRECTIONS_APPLIED.txt)** - Applied corrections
- **[CORRECTIONS_SUMMARY.txt](CORRECTIONS_SUMMARY.txt)** - Corrections summary
---
## ๐Ÿš€ Deployment & Testing
### Deployment
- **[DEPLOYMENT.md](DEPLOYMENT.md)** - Deployment guide
- **[DEPLOYMENT_CHECKLIST.md](DEPLOYMENT_CHECKLIST.md)** - Pre-deployment checklist
- **[DOCKER_TESTING.md](DOCKER_TESTING.md)** - Docker testing procedures
---
## ๐Ÿ“Š Summaries & Reports
### Final Reports
- **[FINAL_SUMMARY.txt](FINAL_SUMMARY.txt)** - English summary
- **[FINAL_SUMMARY_FR.txt](FINAL_SUMMARY_FR.txt)** - French summary
- **[RESTORATION_COMPLETE.txt](RESTORATION_COMPLETE.txt)** - Feature restoration report
- **[VISUAL_GUIDE.txt](VISUAL_GUIDE.txt)** - Visual documentation guide
### Project Files
- **[PROJECT_FILES_INDEX.txt](PROJECT_FILES_INDEX.txt)** - Complete file index
---
## ๐Ÿ“‚ Documentation by Category
### ๐Ÿ—๏ธ Architecture (3 docs)
1. ARCHITECTURE.md
2. PROJECT_SUMMARY.md
3. MIGRATION.md
### ๐ŸŽฎ Gameplay (5 docs)
1. FEATURES_RESTORED.md
2. GAMEPLAY_ISSUES.md
3. GAMEPLAY_UPDATE_SUMMARY.md
4. UNIT_VISUAL_SHAPES.md
5. RED ALERT docs (2)
### ๐Ÿค– Harvester AI (6 docs)
Complete documentation of harvester AI implementation
### ๐Ÿ”ง Technical (3 docs)
1. FIXES_IMPLEMENTATION.md
2. CORRECTIONS docs (2)
### ๐Ÿš€ Deployment (3 docs)
1. DEPLOYMENT.md
2. DEPLOYMENT_CHECKLIST.md
3. DOCKER_TESTING.md
### ๐Ÿ“Š Summaries (5 docs)
Final reports and summaries
---
## ๐Ÿ” Quick Search
Looking for something specific?
- **Setup & Installation** โ†’ QUICKSTART.md, DEPLOYMENT.md
- **Architecture** โ†’ ARCHITECTURE.md, PROJECT_SUMMARY.md
- **Features** โ†’ FEATURES_RESTORED.md
- **Gameplay** โ†’ GAMEPLAY_*.md
- **Harvester AI** โ†’ HARVESTER_*.md
- **Bug Fixes** โ†’ FIXES_IMPLEMENTATION.md, CORRECTIONS_*.txt
- **Docker** โ†’ DOCKER_TESTING.md
- **Migration** โ†’ MIGRATION.md
- **Red Alert** โ†’ RED_ALERT_*.md
---
## ๐Ÿ“ˆ Documentation Stats
- **Total Documents:** 28 files
- **Categories:** 6 major categories
- **Languages:** English + French summaries
- **Coverage:** Architecture, gameplay, deployment, testing
---
## ๐Ÿ†• Latest Updates
- โœ… All documentation organized in dedicated directory
- โœ… Clear categorization by topic
- โœ… Complete index for easy navigation
- โœ… Test scripts separated in `../tests/`
---
**For main project README:** See `../README.md`
**For test scripts:** See `../tests/`