Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Edge Craft - Phase Requirement Proposals (PRPs)

📚 Consolidated Phase Documentation

This directory contains the complete, consolidated documentation for all Edge Craft development phases. Each phase is documented in a single source-of-truth file with complete Definition of Ready (DoR) and Definition of Done (DoD).


🗂️ Phase Structure

Status: ✅ COMPLETE (100% - 99.5% DoD compliance) Duration: 6 weeks | Budget: $30,000 | Team: 2 developers Completion Date: 2025-10-10

What Was Delivered:

  • ✅ Babylon.js rendering engine @ 60 FPS (58 FPS avg, 55 FPS min)
  • ✅ Advanced terrain system (multi-texture, 4-level LOD, quadtree chunking)
  • ✅ GPU instancing for 500+ units (99% draw call reduction)
  • ✅ Cascaded shadow maps (3 cascades, <6ms per frame)
  • ✅ W3X/SCM map loading pipeline (95% compatibility)
  • ✅ Rendering optimization (187 draw calls, 1842 MB memory)
  • ✅ Automated legal compliance pipeline (100% detection)

Sub-PRPs: 1.1-1.7 (all complete) Performance: 187 draw calls, 58 FPS, 1842 MB memory, <6ms shadows Documentation: Phase 1 README


Status: 📋 Planned (Scope Validated - 8.5/10 Confidence) Duration: 2-3 weeks | Budget: $20,000 | Team: 2 developers

What It Delivers:

  • Post-processing pipeline (FXAA, bloom, color grading)
  • Advanced lighting system (8 dynamic lights)
  • GPU particles (5,000 @ 60 FPS)
  • Weather effects (rain, snow, fog)
  • PBR material system
  • Custom shader framework
  • Decal system (50 texture decals)
  • Render target system (minimap)
  • Quality preset system (LOW/MEDIUM/HIGH/ULTRA)

Key Revisions (Evidence-Based):

  • Particles: 50,000 → 5,000 (10x reduction)
  • RTTs: 3 → 1 minimap only
  • SSAO/DoF: Deferred to Phase 10
  • Quality presets: Now MANDATORY

Status: 📋 Planned (Post-Phase 2) Duration: 2-3 weeks | Budget: $25,000 | Team: 2-3 developers

What It Delivers:

  • Unit selection & control system
  • Command & movement system
  • A* pathfinding system
  • Resource gathering & economy
  • Building placement & construction
  • Unit training & production
  • Combat system prototype
  • Fog of war & vision system
  • Minimap system
  • Basic AI opponent
  • Deterministic game simulation loop

Milestone: First playable RTS prototype (gather → build → fight)


📊 Phase Progress Overview

Phase Status Progress Start Date End Date Budget
Phase 1 ✅ Complete 100% Completed 2025-10-10 $30,000
Phase 2 ⏸️ Planned 0% Ready to Start TBD $20,000
Phase 3 ⏸️ Planned 0% Post-Phase 2 TBD $25,000

🎯 How to Use This Documentation

For Developers

  1. Read the Phase Overview - Understand strategic context and goals
  2. Check the DoR - Ensure all prerequisites are met before starting
  3. Review the DoD - Know exactly what needs to be delivered
  4. Follow Implementation Breakdown - Detailed architecture and code examples
  5. Run Validation Tests - Ensure success criteria are met

For Project Managers

  1. Track Progress - Use DoD checkboxes to measure completion
  2. Monitor Budget - Each phase has cost estimates
  3. Validate Quality - Success metrics define phase exit criteria
  4. Plan Next Phase - DoD of current phase = DoR of next phase

For Stakeholders

  1. Understand Scope - What each phase delivers
  2. Review Timeline - Duration estimates for planning
  3. Check Risks - Known risks and mitigation strategies
  4. Validate Milestones - Clear exit criteria for each phase

📁 Directory Structure

PRPs/
├── README.md (this file)
├── phase1-foundation/
│   ├── 1-mvp-launch-functions.md        # Consolidated Phase 1 PRP
│   ├── 1.1-babylon-integration.md       # Legacy individual PRP
│   ├── 1.2-advanced-terrain-system.md   # Legacy individual PRP
│   ├── 1.3-gpu-instancing-animation.md  # Legacy individual PRP
│   ├── 1.4-cascaded-shadow-system.md    # Legacy individual PRP
│   ├── 1.5-map-loading-architecture.md  # Legacy individual PRP
│   ├── 1.6-rendering-optimization.md    # Legacy individual PRP
│   ├── 1.7-legal-compliance-pipeline.md # Legacy individual PRP
│   ├── PHASE1_COMPREHENSIVE_BREAKDOWN.md # Legacy overview
│   └── README.md                         # Phase 1 navigation
├── phase2-rendering/
│   ├── 2-advanced-rendering-visual-effects.md  # Consolidated Phase 2 PRP ⭐
│   ├── PHASE2_COMPREHENSIVE_SPECIFICATION.md   # Legacy detailed spec
│   ├── EXECUTIVE_SUMMARY.md                    # Legacy summary
│   └── README.md                               # Phase 2 navigation
└── phase3-gameplay/
    └── 3-gameplay-mechanics.md           # Consolidated Phase 3 PRP ⭐

⭐ = Primary source of truth (use these files)


🔄 Documentation Standards

Each Consolidated Phase PRP Contains:

  1. Phase Overview - Strategic context and objectives
  2. Definition of Ready (DoR) - Prerequisites to start
  3. Definition of Done (DoD) - Exit criteria and deliverables
  4. Implementation Breakdown - Architecture and code examples
  5. Timeline - Week-by-week rollout plan
  6. Testing & Validation - Benchmarks and quality checks
  7. Success Metrics - Quantifiable targets
  8. Risk Assessment - Known risks and mitigation
  9. Exit Criteria - Phase completion checklist

Quality Standards:

  • ✅ Complete DoR/DoD checklists
  • ✅ Evidence-based scope decisions
  • ✅ Performance targets with validation methods
  • ✅ Test coverage requirements (>80%)
  • ✅ Browser compatibility matrix
  • ✅ Budget and timeline estimates

🚀 Development Workflow

Starting a New Phase

  1. Verify DoR - All prerequisites from previous phase complete
  2. 📖 Read Consolidated PRP - Understand full scope
  3. 🗓️ Plan Sprint - Break down into 1-week sprints
  4. 👥 Assign Tasks - Allocate work to team members
  5. 🔨 Implement - Follow architecture and code examples
  6. 🧪 Test Continuously - Run benchmarks and validation tests
  7. Validate DoD - Check all deliverables complete

Completing a Phase

  1. DoD Checklist 100% - All items checked off
  2. 📊 Benchmarks Pass - Performance targets met
  3. 🧪 Tests Pass - >80% coverage, all green
  4. 📝 Documentation Updated - APIs and guides complete
  5. 🎯 Stakeholder Review - Demo and approval
  6. 🚀 Merge to Main - Production-ready code
  7. 📋 Next Phase DoR - Ready to start next phase

📞 Support

Questions or Issues?

  • Architecture Questions: Review consolidated PRP for detailed explanations
  • Performance Issues: Check benchmarks and optimization sections
  • Scope Changes: Propose via GitHub issue with justification
  • Legal Compliance: Refer to Phase 1 PRP 1.7 for pipeline details

Contributing

See CONTRIBUTING.md for contribution guidelines.


All phase documentation is now consolidated and aligned with strategic objectives!