Go to file
StillHammer bb92e9dc93 Add comprehensive engine-focused documentation structure
📚 Complete documentation reorganization:

🗂️ Structure:
- docs/global/ → Complete project documentation (all original files)
- docs/engines/ → 10 engine-specific docs with focused responsibilities
- docs/serveur/ → Server coordinator and inter-engine communication
- docs/client/ → Smart Client interface and user experience

🔧 Engine Documentation:
- Designer: Vehicle design with AI assistance (1-2 designs/tick)
- Economy: Market simulation and dynamic pricing
- Event: Breakthrough system and global events
- Factory: Factorio-like production with belts/assemblers
- Intelligence: Metrics collection (3.1GB adaptive) + reconnaissance
- Logistic: Supply chains and convoy management
- MacroEntity: Companies, diplomacy, administration (1000 pts/day)
- Map: Procedural generation (218+ elements) + chunk streaming
- Operation: Military strategy and adaptive AI generals
- War: Multi-chunk combat and persistent frontlines

📋 Each engine doc includes:
- Core responsibilities and system overview
- Key mechanics from relevant design documents
- Communication patterns with other engines
- Implementation notes and architecture details

🎯 Navigation optimized for:
- Engine developers (focused system details)
- System architects (coordination patterns)
- Game designers (mechanics integration)

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-09-19 14:41:03 +08:00
client Add complete C++ structure for all 10 engines 2025-09-19 02:07:17 +08:00
cmake Complete 10-engine architecture with CMake build system 2025-09-19 14:19:25 +08:00
core Add project structure with engines, core, client 2025-09-19 01:40:53 +08:00
docs Add comprehensive engine-focused documentation structure 2025-09-19 14:41:03 +08:00
engines Complete 10-engine architecture with CMake build system 2025-09-19 14:19:25 +08:00
examples Complete 10-engine architecture with CMake build system 2025-09-19 14:19:25 +08:00
helpers Add comprehensive test structure for all engines 2025-09-19 02:12:44 +08:00
include/warfactory Complete 10-engine architecture with CMake build system 2025-09-19 14:19:25 +08:00
scripts Complete 10-engine architecture with CMake build system 2025-09-19 14:19:25 +08:00
server Add complete C++ structure for all 10 engines 2025-09-19 02:07:17 +08:00
shared Add complete C++ structure for all 10 engines 2025-09-19 02:07:17 +08:00
tests Add comprehensive test structure for all engines 2025-09-19 02:12:44 +08:00
.gitignore Complete 10-engine architecture with CMake build system 2025-09-19 14:19:25 +08:00
ADVANCED_TESTING.md Complete 10-engine architecture with CMake build system 2025-09-19 14:19:25 +08:00
AUTOMATION_GUIDE.md Complete 10-engine architecture with CMake build system 2025-09-19 14:19:25 +08:00
CLAUDE.md Update CLAUDE.md with complete implementation status 2025-09-19 14:25:57 +08:00
CMakeLists.txt Complete 10-engine architecture with CMake build system 2025-09-19 14:19:25 +08:00
cppcheck-suppressions.txt Complete 10-engine architecture with CMake build system 2025-09-19 14:19:25 +08:00

Warfactory Documentation Index

Documentation Structure

This documentation is organized by component type to provide focused information for each part of the Warfactory system.

📁 Global Documentation (/global/)

Complete project documentation with all design documents:

  • vue-ensemble.md - Project vision and philosophy
  • architecture-technique.md - Complete technical architecture
  • map-system.md - Multi-scale map system (218+ elements)
  • systeme-militaire.md - Combat and vehicle design systems
  • economie-logistique.md - Economic simulation and supply chains
  • gameplay-industriel.md - Factory management (Factorio-like)
  • mecaniques-jeu.md - Research, breakthrough, and progression
  • arbre-technologique.md - 3000+ technology tree
  • metriques-joueur.md - Analytics system (3.1GB adaptive)
  • coherence-problem.md - Resolved design challenges
  • questions-ouvertes.md - Open questions and future considerations

🔧 Engine Documentation (/engines/)

Focused documentation for each of the 10 autonomous engines:

Core Engines

  • Designer - Vehicle design with AI assistance (1-2 designs/tick)
  • Economy - Market simulation and dynamic pricing
  • Factory - Factorio-like production with belts and assemblers
  • War - Multi-chunk combat and persistent frontlines

Specialized Engines

  • Intelligence - Metrics collection (3.1GB adaptive) and reconnaissance
  • Logistic - Supply chains and convoy management
  • Map - Procedural generation (218+ elements) and chunk streaming
  • Operation - Military strategy and adaptive AI generals

Support Engines

  • Event - Breakthrough system and global events
  • MacroEntity - Companies, diplomacy, administration (1000 pts/day)

🖥️ Server Documentation (/serveur/)

Server coordinator system:

  • Engine communication and coordination
  • Smart Client request/response handling
  • Performance monitoring and load balancing
  • Inter-engine message routing

💻 Client Documentation (/client/)

Smart Client interface system:

  • Multi-scale user interface (World → Regional → Local → Detail)
  • Factory management interface (Factorio-like)
  • Vehicle design interface (grid-based component placement)
  • Strategic command and diplomatic interfaces

Quick Navigation

For Engine Developers

Each engine folder contains:

  • Core responsibilities and system overview
  • Key mechanics from relevant design documents
  • Communication patterns with other engines
  • Implementation notes and architecture details

For System Architects

For Game Designers

Implementation Status

Complete: Documentation structure with engine-specific focus Complete: 10 engine implementations with CMake build system Complete: Fast/full build presets for development efficiency 🔄 In Progress: Engine logic expansion and inter-engine communication 📋 Next: Gameplay feature implementation and testing

Build Commands Quick Reference

# Fast development build (minimal sanitizers)
cmake -DFAST_BUILD=ON .. && make claude-workflow-fast

# Full validation build (all sanitizers)
cmake -DCMAKE_BUILD_TYPE=Debug .. && make

# Single engine development
make economy-engine && ./bin/economy-engine

For complete build system documentation, see CLAUDE.md in the project root.