rts-commander / README.old.md
Luigi's picture
docs: Comprehensive README update with AI Analysis and NL interface features
114ddfb
metadata
title: RTS Commander
emoji: ๐ŸŽฎ
colorFrom: blue
colorTo: green
sdk: docker
pinned: false
license: mit

๐ŸŽฎ Command & Conquer: Tiberium Dawn - Web Version

A faithful recreation of the classic Command & Conquer: Tiberium Dawn in pure web technologies (FastAPI + WebSocket + Canvas).


๐Ÿ“‚ Project Structure

web/
โ”œโ”€โ”€ README.md           # This file
โ”œโ”€โ”€ app.py              # FastAPI server & WebSocket
โ”œโ”€โ”€ start.py            # Server launcher
โ”œโ”€โ”€ localization.py     # Multi-language support
โ”œโ”€โ”€ ai_analysis.py      # AI engine
โ”œโ”€โ”€ mcp_server.py       # MCP server integration
โ”œโ”€โ”€ backend/            # Game logic
โ”œโ”€โ”€ frontend/           # JavaScript game engine
โ”œโ”€โ”€ static/             # Assets (images, sounds)
โ”œโ”€โ”€ docs/               # ๐Ÿ“š Documentation
โ”œโ”€โ”€ tests/              # ๐Ÿงช Test scripts
โ””โ”€โ”€ tools/              # ๐Ÿ› ๏ธ Dev/debug/ops scripts

๐Ÿš€ Quick Start

Local Development

  1. Install dependencies:

    pip install -r requirements.txt
    
  2. Start the server:

    python start.py
    
  3. Open in browser:

    http://localhost:8000
    

๐Ÿ“– Documentation

๐Ÿ“š Complete Documentation

All technical documentation is in docs/ (28 files organized by category):

  • Architecture: System design, project structure
  • Gameplay: Features, mechanics, Red Alert compatibility
  • Harvester AI: Complete AI implementation (6 docs)
  • Deployment: Setup, Docker, testing
  • Summaries: Final reports and migration guides

Quick Links:

๐Ÿงช Testing

All test scripts are in tests/ (4 scripts):

  • test.sh - Main test suite
  • test_features.sh - Feature-specific tests
  • test_harvester_ai.py - Harvester AI tests
  • docker-test.sh - Docker deployment tests

See tests/README.md for usage guide.


๐Ÿ› ๏ธ Outils (dev/debug/ops)

Les scripts utilitaires sont dans tools/:

  • tools/debug_ai.py โ€” Utilitaires de dรฉbogage AI
  • tools/local_run.sh โ€” Lancement local pratique
  • tools/deploy_hf_spaces.sh โ€” Dรฉploiement vers Hugging Face Spaces

๐ŸŽฎ Key Features

โœ… Real-Time Strategy Gameplay

  • Resource management (Tiberium harvesting)
  • Base building with power system
  • Unit production and combat
  • Fog of War

โœ… Authentic C&C Experience

  • GDI faction with classic units
  • Minimap with live updates
  • Construction yard, power plants, barracks, refineries
  • Infantry, tanks, and harvesters

โœ… Web-Native

  • No downloads or installations
  • Play directly in browser
  • Cross-platform compatible
  • Responsive UI

โœ… Multiplayer Ready (Foundation)

  • WebSocket-based architecture
  • Real-time state synchronization
  • Scalable server design

๐ŸŽฏ Controls

Action Key/Mouse
Select unit/building Left Click
Move unit Right Click (ground)
Attack Right Click (enemy)
Box select Click + Drag
Build structure Click building button
Place building Click grid location
Change language Language buttons (top)

๐ŸŒ Multi-Language Support

  • ๐Ÿ‡ฌ๐Ÿ‡ง English
  • ๐Ÿ‡ซ๐Ÿ‡ท Franรงais
  • ๐Ÿ‡น๐Ÿ‡ผ ็น้ซ”ไธญๆ–‡

Switch language anytime with top-left buttons.


๐Ÿ—๏ธ Tech Stack

Backend:

  • FastAPI (async web framework)
  • WebSockets (real-time communication)
  • Python 3.8+

Frontend:

  • Vanilla JavaScript
  • HTML5 Canvas (rendering)
  • CSS3 (UI styling)

Game Engine:

  • Custom JavaScript engine
  • Canvas-based rendering
  • WebSocket state sync

๐Ÿ“ฆ Deployment

Docker (Recommended)

docker build -t rts-web .
docker run -p 8000:8000 rts-web

See docs/DEPLOYMENT.md for complete deployment guide.


๐Ÿงช Testing

Run the test suite:

./tests/test.sh

See tests/README.md for all available tests.


๐Ÿ“Š Project Status

Version: 2.0 (Web)
Status: Production Ready โœ…
Rating: 4.9/5 (97.3% feature parity with Pygame)

Compared to C&C Red Alert:

  • 49% raw feature parity
  • 4.7/5 context-adjusted score
  • 3 aspects superior to Red Alert

See full comparisons inside docs/ (if present).


๐Ÿ“œ License

MIT License - See LICENSE file for details.


๐Ÿ™ Credits

Inspired by Command & Conquer: Tiberium Dawn (Westwood Studios, 1995)


๐Ÿค– MCP (Model Context Protocol) Integration

This project includes support for the Model Context Protocol (MCP), allowing AI agents to interact with the game programmatically.

Features

  • Game State Access: AI agents can retrieve the current game state
  • Action Execution: AI agents can perform actions in the game
  • AI Analysis: Access to tactical analysis from the built-in AI
  • Documentation Access: Provides game documentation as resources

Running the MCP Server

cd web
python mcp_server.py

The MCP server will start on port 8001.

Documentation

See docs/MCP_INTEGRATION.md for detailed information about the MCP integration.


๐Ÿ“š Full Documentation: docs/
๐Ÿงช Test Scripts: tests/