bmad-method 6.0.0-alpha.1 → 6.0.0-alpha.11

package/src/modules/bmm/workflows/2-plan-workflows/gdd/README.md

@@ -1,222 +0,0 @@
-# Game Design Document (GDD) Workflow
-
-This folder contains the GDD workflow for game projects, replacing the traditional PRD approach with game-specific documentation.
-
-## Overview
-
-The GDD workflow creates a comprehensive Game Design Document that captures:
-
-- Core gameplay mechanics and pillars
-- Game type-specific elements (RPG systems, platformer movement, puzzle mechanics, etc.)
-- Level design framework
-- Art and audio direction
-- Technical specifications (platform-agnostic)
-- Development epics
-
-## Architecture
-
-### Universal Template
-
-`gdd-template.md` contains sections common to ALL game types:
-
-- Executive Summary
-- Goals and Context
-- Core Gameplay
-- Win/Loss Conditions
-- Progression and Balance
-- Level Design Framework
-- Art and Audio Direction
-- Technical Specs
-- Development Epics
-- Success Metrics
-
-### Game-Type-Specific Injection
-
-The template includes a `{{GAME_TYPE_SPECIFIC_SECTIONS}}` placeholder that gets replaced with game-type-specific content.
-
-### Game Types Registry
-
-`game-types.csv` defines 24+ game types with:
-
-- **id**: Unique identifier (e.g., `action-platformer`, `rpg`, `roguelike`)
-- **name**: Human-readable name
-- **description**: Brief description of the game type
-- **genre_tags**: Searchable tags
-- **fragment_file**: Path to type-specific template fragment
-
-### Game-Type Fragments
-
-Located in `game-types/` folder, these markdown files contain sections specific to each game type:
-
-**action-platformer.md**:
-
-- Movement System (jump mechanics, air control, special moves)
-- Combat System (attack types, combos, enemy AI)
-- Level Design Patterns (platforming challenges, combat arenas)
-- Player Abilities and Unlocks
-
-**rpg.md**:
-
-- Character System (stats, classes, leveling)
-- Inventory and Equipment
-- Quest System
-- World and Exploration
-- NPC and Dialogue
-- Combat System
-
-**puzzle.md**:
-
-- Core Puzzle Mechanics
-- Puzzle Progression
-- Level Structure
-- Player Assistance
-- Replayability
-
-**roguelike.md**:
-
-- Run Structure
-- Procedural Generation
-- Permadeath and Progression
-- Item and Upgrade System
-- Character Selection
-- Difficulty Modifiers
-
-...and 20+ more game types!
-
-## Workflow Flow
-
-1. **Router Detection** (instructions-router.md):
-   - Step 3 asks for project type
-   - If "Game" selected → sets `workflow_type = "gdd"`
-   - Skips standard level classification
-   - Jumps to GDD-specific assessment
-
-2. **Game Type Selection** (instructions-gdd.md Step 1):
-   - Presents 9 common game types + "Other"
-   - Maps selection to `game-types.csv`
-   - Loads corresponding fragment file
-   - Stores `game_type` for injection
-
-3. **Universal GDD Sections** (Steps 2-5, 7-13):
-   - Platform and target audience
-   - Goals and context
-   - Core gameplay (pillars, loop, win/loss)
-   - Mechanics and controls
-   - Progression and balance
-   - Level design
-   - Art and audio
-   - Technical specs
-   - Epics and metrics
-
-4. **Game-Type Injection** (Step 6):
-   - Loads fragment from `game-types/{game_type}.md`
-   - For each `{{placeholder}}` in fragment, elicits details
-   - Injects completed sections into `{{GAME_TYPE_SPECIFIC_SECTIONS}}`
-
-5. **Solutioning Handoff** (Step 14):
-   - Routes to `3-solutioning` workflow
-   - Platform/engine specifics handled by solutioning registry
-   - Game-\* entries in solutioning `registry.csv` provide engine-specific guidance
-
-## Platform vs. Game Type Separation
-
-**GDD (this workflow)**: Game-type specifics
-
-- What makes an RPG an RPG (stats, quests, inventory)
-- What makes a platformer a platformer (jump mechanics, level design)
-- Genre-defining mechanics and systems
-
-**Solutioning (3-solutioning workflow)**: Platform/engine specifics
-
-- Unity vs. Godot vs. Phaser vs. Unreal
-- 2D vs. 3D rendering
-- Physics engines
-- Input systems
-- Platform constraints (mobile, web, console)
-
-This separation allows:
-
-- Single universal GDD regardless of platform
-- Platform decisions made during architecture phase
-- Easy platform pivots without rewriting GDD
-
-## Output
-
-**GDD.md**: Complete game design document with:
-
-- All universal sections filled
-- Game-type-specific sections injected
-- Ready for solutioning handoff
-
-## Example Game Types
-
-| ID                | Name              | Key Sections                                      |
-| ----------------- | ----------------- | ------------------------------------------------- |
-| action-platformer | Action Platformer | Movement, Combat, Level Patterns, Abilities       |
-| rpg               | RPG               | Character System, Inventory, Quests, World, NPCs  |
-| puzzle            | Puzzle            | Puzzle Mechanics, Progression, Level Structure    |
-| roguelike         | Roguelike         | Run Structure, Procgen, Permadeath, Items         |
-| shooter           | Shooter           | Weapon Systems, Enemy AI, Arena Design            |
-| strategy          | Strategy          | Resources, Units, AI, Victory Conditions          |
-| metroidvania      | Metroidvania      | Interconnected World, Ability Gating, Exploration |
-| visual-novel      | Visual Novel      | Branching Story, Dialogue Trees, Choices          |
-| tower-defense     | Tower Defense     | Waves, Tower Types, Placement, Economy            |
-| card-game         | Card Game         | Deck Building, Card Mechanics, Turn System        |
-
-...and 14+ more!
-
-## Adding New Game Types
-
-1. Add row to `game-types.csv`:
-
-   ```csv
-   new-type,New Type Name,"Description",tags,new-type.md
-   ```
-
-2. Create `game-types/new-type.md`:
-
-   ```markdown
-   ## New Type Specific Elements
-
-   ### System Name
-
-   {{system_placeholder}}
-
-   **Details:**
-
-   - Element 1
-   - Element 2
-   ```
-
-3. The workflow automatically uses it!
-
-## Integration with Solutioning
-
-When a game project completes the GDD and moves to solutioning:
-
-1. Solutioning workflow reads `project_type == "game"`
-2. Loads GDD.md instead of PRD.md
-3. Matches game platforms to solutioning `registry.csv` game-\* entries
-4. Provides engine-specific guidance (Unity, Godot, Phaser, etc.)
-5. Generates architecture.md with platform decisions
-6. Creates per-epic tech specs
-
-Example solutioning registry entries:
-
-- `game-unity-2d`: Unity 2D games
-- `game-godot-3d`: Godot 3D games
-- `game-phaser`: Phaser web games
-- `game-unreal-3d`: Unreal Engine games
-- `game-custom-3d-rust`: Custom Rust game engines
-
-## Philosophy
-
-**Game projects are fundamentally different from software products**:
-
-- Gameplay feel > feature lists
-- Playtesting > user testing
-- Game pillars > product goals
-- Mechanics > requirements
-- Fun > utility
-
-The GDD workflow respects these differences while maintaining BMAD Method rigor.

package/src/modules/bmm/workflows/2-plan-workflows/gdd/workflow.yaml

@@ -1,67 +0,0 @@
-# Game Design Document (GDD) Workflow
-name: gdd
-description: "Game Design Document workflow for all game project levels - from small prototypes to full AAA games. Generates comprehensive GDD with game mechanics, systems, progression, and implementation guidance."
-author: "BMad"
-
-# Critical variables from config
-config_source: "{project-root}/bmad/bmm/config.yaml"
-output_folder: "{config_source}:output_folder"
-user_name: "{config_source}:user_name"
-communication_language: "{config_source}:communication_language"
-document_output_language: "{config_source}:document_output_language"
-user_skill_level: "{config_source}:user_skill_level"
-date: system-generated
-
-# Workflow components
-installed_path: "{project-root}/bmad/bmm/workflows/2-plan-workflows/gdd"
-instructions: "{installed_path}/instructions-gdd.md"
-template: "{installed_path}/gdd-template.md"
-game_types_csv: "{installed_path}/game-types.csv"
-
-# Output configuration
-default_output_file: "{output_folder}/GDD.md"
-
-# Game type references (loaded based on game type selection)
-game_type_guides: "{installed_path}/game-types/"
-
-# Recommended input documents
-recommended_inputs:
-  - game_brief: "{output_folder}/game-brief.md"
-  - narrative_design: "{output_folder}/narrative-design.md"
-  - market_research: "{output_folder}/market-research.md"
-
-standalone: true
-
-web_bundle:
-  name: "gdd"
-  description: "Game Design Document workflow for all game project levels - from small prototypes to full AAA games. Generates comprehensive GDD with game mechanics, systems, progression, and implementation guidance."
-  author: "BMad"
-  instructions: "bmad/bmm/workflows/2-plan-workflows/gdd/instructions-gdd.md"
-  web_bundle_files:
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/instructions-gdd.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/gdd-template.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types.csv"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/action-platformer.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/adventure.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/card-game.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/fighting.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/horror.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/idle-incremental.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/metroidvania.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/moba.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/party-game.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/puzzle.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/racing.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/rhythm.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/roguelike.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/rpg.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/sandbox.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/shooter.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/simulation.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/sports.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/strategy.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/survival.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/text-based.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/tower-defense.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/turn-based-tactics.md"
-    - "bmad/bmm/workflows/2-plan-workflows/gdd/game-types/visual-novel.md"

package/src/modules/bmm/workflows/2-plan-workflows/prd/epics-template.md

@@ -1,63 +0,0 @@
-# {{project_name}} - Epic Breakdown
-
-**Author:** {{user_name}}
-**Date:** {{date}}
-**Project Level:** {{project_level}}
-**Target Scale:** {{target_scale}}
-
----
-
-## Overview
-
-This document provides the detailed epic breakdown for {{project_name}}, expanding on the high-level epic list in the [PRD](./PRD.md).
-
-Each epic includes:
-
-- Expanded goal and value proposition
-- Complete story breakdown with user stories
-- Acceptance criteria for each story
-- Story sequencing and dependencies
-
-**Epic Sequencing Principles:**
-
-- Epic 1 establishes foundational infrastructure and initial functionality
-- Subsequent epics build progressively, each delivering significant end-to-end value
-- Stories within epics are vertically sliced and sequentially ordered
-- No forward dependencies - each story builds only on previous work
-
----
-
-{{epic_details}}
-
----
-
-## Story Guidelines Reference
-
-**Story Format:**
-
-```
-**Story [EPIC.N]: [Story Title]**
-
-As a [user type],
-I want [goal/desire],
-So that [benefit/value].
-
-**Acceptance Criteria:**
-1. [Specific testable criterion]
-2. [Another specific criterion]
-3. [etc.]
-
-**Prerequisites:** [Dependencies on previous stories, if any]
-```
-
-**Story Requirements:**
-
-- **Vertical slices** - Complete, testable functionality delivery
-- **Sequential ordering** - Logical progression within epic
-- **No forward dependencies** - Only depend on previous work
-- **AI-agent sized** - Completable in 2-4 hour focused session
-- **Value-focused** - Integrate technical enablers into value-delivering stories
-
----
-
-**For implementation:** Use the `create-story` workflow to generate individual story implementation plans from this epic breakdown.

package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions-level0-story.md

@@ -1,167 +0,0 @@
-# Level 0 - Minimal User Story Generation
-
-<workflow>
-
-<critical>This generates a single user story for Level 0 atomic changes</critical>
-<critical>Level 0 = single file change, bug fix, or small isolated task</critical>
-<critical>This workflow runs AFTER tech-spec.md has been completed</critical>
-<critical>Output format MUST match create-story template for compatibility with story-context and dev-story workflows</critical>
-
-<step n="1" goal="Load tech spec and extract the change">
-
-<action>Read the completed tech-spec.md file from {output_folder}/tech-spec.md</action>
-<action>Load bmm-workflow-status.md from {output_folder}/bmm-workflow-status.md</action>
-<action>Extract dev_story_location from config (where stories are stored)</action>
-<action>Extract the problem statement from "Technical Approach" section</action>
-<action>Extract the scope from "Source Tree Structure" section</action>
-<action>Extract time estimate from "Implementation Guide" or technical details</action>
-<action>Extract acceptance criteria from "Testing Approach" section</action>
-
-</step>
-
-<step n="2" goal="Generate story slug and filename">
-
-<action>Derive a short URL-friendly slug from the feature/change name</action>
-<action>Max slug length: 3-5 words, kebab-case format</action>
-
-<example>
-- "Migrate JS Library Icons" → "icon-migration"
-- "Fix Login Validation Bug" → "login-fix"
-- "Add OAuth Integration" → "oauth-integration"
-</example>
-
-<action>Set story_filename = "story-{slug}.md"</action>
-<action>Set story_path = "{dev_story_location}/story-{slug}.md"</action>
-
-</step>
-
-<step n="3" goal="Create user story in standard format">
-
-<action>Create 1 story that describes the technical change as a deliverable</action>
-<action>Story MUST use create-story template format for compatibility</action>
-
-<guidelines>
-**Story Point Estimation:**
-- 1 point = < 1 day (2-4 hours)
-- 2 points = 1-2 days
-- 3 points = 2-3 days
-- 5 points = 3-5 days (if this high, question if truly Level 0)
-
-**Story Title Best Practices:**
-
-- Use active, user-focused language
-- Describe WHAT is delivered, not HOW
-- Good: "Icon Migration to Internal CDN"
-- Bad: "Run curl commands to download PNGs"
-
-**Story Description Format:**
-
-- As a [role] (developer, user, admin, etc.)
-- I want [capability/change]
-- So that [benefit/value]
-
-**Acceptance Criteria:**
-
-- Extract from tech-spec "Testing Approach" section
-- Must be specific, measurable, and testable
-- Include performance criteria if specified
-
-**Tasks/Subtasks:**
-
-- Map directly to tech-spec "Implementation Guide" tasks
-- Use checkboxes for tracking
-- Reference AC numbers: (AC: #1), (AC: #2)
-- Include explicit testing subtasks
-
-**Dev Notes:**
-
-- Extract technical constraints from tech-spec
-- Include file paths from "Source Tree Structure"
-- Reference architecture patterns if applicable
-- Cite tech-spec sections for implementation details
-  </guidelines>
-
-<action>Initialize story file using user_story_template</action>
-
-<template-output file="{story_path}">story_title</template-output>
-<template-output file="{story_path}">role</template-output>
-<template-output file="{story_path}">capability</template-output>
-<template-output file="{story_path}">benefit</template-output>
-<template-output file="{story_path}">acceptance_criteria</template-output>
-<template-output file="{story_path}">tasks_subtasks</template-output>
-<template-output file="{story_path}">technical_summary</template-output>
-<template-output file="{story_path}">files_to_modify</template-output>
-<template-output file="{story_path}">test_locations</template-output>
-<template-output file="{story_path}">story_points</template-output>
-<template-output file="{story_path}">time_estimate</template-output>
-<template-output file="{story_path}">architecture_references</template-output>
-
-</step>
-
-<step n="4" goal="Update status - Level 0 single story">
-
-<invoke-workflow path="{project-root}/bmad/bmm/workflows/workflow-status">
-  <param>mode: update</param>
-  <param>action: complete_workflow</param>
-  <param>workflow_name: tech-spec</param>
-</invoke-workflow>
-
-<check if="success == true">
-  <output>✅ Tech-spec complete! Next: {{next_workflow}}</output>
-</check>
-
-<action>Load {{status_file_path}}</action>
-<action>Set STORIES_SEQUENCE: [{slug}]</action>
-<action>Set TODO_STORY: {slug}</action>
-<action>Set TODO_TITLE: {{story_title}}</action>
-<action>Set IN_PROGRESS_STORY: (empty)</action>
-<action>Set STORIES_DONE: []</action>
-<action>Save {{status_file_path}}</action>
-
-<output>Story queue initialized with single story: {slug}</output>
-
-</step>
-
-<step n="5" goal="Provide user guidance for next steps">
-
-<action>Display completion summary</action>
-
-**Level 0 Planning Complete!**
-
-**Generated Artifacts:**
-
-- `tech-spec.md` → Technical source of truth
-- `story-{slug}.md` → User story ready for implementation
-
-**Story Location:** `{story_path}`
-
-**Next Steps (choose one path):**
-
-**Option A - Full Context (Recommended for complex changes):**
-
-1. Load SM agent: `{project-root}/bmad/bmm/agents/sm.md`
-2. Run story-context workflow
-3. Then load DEV agent and run dev-story workflow
-
-**Option B - Direct to Dev (For simple, well-understood changes):**
-
-1. Load DEV agent: `{project-root}/bmad/bmm/agents/dev.md`
-2. Run dev-story workflow (will auto-discover story)
-3. Begin implementation
-
-**Progress Tracking:**
-
-- All decisions logged in: `bmm-workflow-status.md`
-- Next action clearly identified
-
-<ask>Ready to proceed? Choose your path:
-
-1. Generate story context (Option A - recommended)
-2. Go directly to dev-story implementation (Option B - faster)
-3. Exit for now
-
-Select option (1-3):</ask>
-
-</step>
-
-</workflow>