bmad-method 6.0.0-alpha.2 → 6.0.0-alpha.20

package/src/modules/bmgd/workflows/2-design/gdd/steps/step-14-complete.md

@@ -0,0 +1,335 @@
+---
+name: 'step-14-complete'
+description: 'Document out of scope items, capture assumptions, and provide handoff guidance'
+
+# Path Definitions
+workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd'
+
+# File References
+thisStepFile: '{workflow_path}/steps/step-14-complete.md'
+workflowFile: '{workflow_path}/workflow.md'
+outputFile: '{output_folder}/gdd.md'
+epicsFile: '{output_folder}/epics.md'
+
+# Workflow References
+narrativeWorkflow: '{project-root}/_bmad/bmgd/workflows/2-design/narrative/workflow.yaml'
+architectureWorkflow: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture/workflow.yaml'
+---
+
+# Step 14: Complete & Handoff
+
+**Progress: Step 14 of 14** - GDD Complete!
+
+## STEP GOAL:
+
+Document what is explicitly out of scope, capture key assumptions and dependencies, and provide clear next steps for the game development process.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- NEVER generate content without user input
+- CRITICAL: Read the complete step file before taking any action
+- YOU ARE A FACILITATOR, not a content generator
+
+### Role Reinforcement:
+
+- You are a veteran game designer facilitator collaborating with a creative peer
+- This is the final step - ensure completeness
+- Provide clear actionable next steps
+
+### Step-Specific Rules:
+
+- Focus on scope boundaries and assumptions
+- Check if narrative workflow is recommended
+- Provide concrete next steps based on workflow status
+
+## EXECUTION PROTOCOLS:
+
+- Show your analysis before taking any action
+- Generate final sections without A/P/C menu (just confirmation)
+- Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]`
+- Present completion summary and next steps
+
+## CONTEXT BOUNDARIES:
+
+- All GDD content from previous steps available
+- Check for `needs_narrative` flag from step 7
+- Reference workflow-status if integrated with BMM
+
+## Sequence of Instructions (Do not deviate, skip, or optimize)
+
+### 1. Out of Scope Discovery
+
+**Guide user through scope boundaries:**
+
+"Let's document what is explicitly NOT in scope for {{game_name}} v1.0.
+
+**Out of Scope Categories:**
+
+| Category         | Examples                               |
+| ---------------- | -------------------------------------- |
+| **Features**     | Multiplayer, level editor, mod support |
+| **Content**      | Additional game modes, DLC areas       |
+| **Platforms**    | Console ports, VR version              |
+| **Polish**       | Full voice acting, orchestral score    |
+| **Localization** | Additional languages                   |
+
+**Questions to consider:**
+
+1. What features have you intentionally cut for v1.0?
+2. What platforms are NOT in initial scope?
+3. What post-launch content are you deferring?
+4. What's 'nice to have' vs 'required for launch'?
+
+What's explicitly out of scope for {{game_name}} v1.0?"
+
+### 2. Assumptions and Dependencies Discovery
+
+**Guide user through assumptions:**
+
+"Now let's document key assumptions and dependencies.
+
+**Assumption Categories:**
+
+| Category      | Examples                                                          |
+| ------------- | ----------------------------------------------------------------- |
+| **Technical** | 'Unity LTS will remain stable', 'Players have controllers'        |
+| **Team**      | 'Art contractor available Q2', 'Solo developer capacity'          |
+| **External**  | 'Steam review approval in 2 weeks', 'Asset store assets licensed' |
+| **Market**    | 'Genre remains popular', 'Pricing assumptions'                    |
+
+**Dependency Categories:**
+
+| Category        | Examples                                  |
+| --------------- | ----------------------------------------- |
+| **Third-party** | Middleware, plugins, asset licenses       |
+| **Services**    | Backend providers, analytics, multiplayer |
+| **Content**     | External art, music, voice acting         |
+| **Platform**    | SDK versions, certification requirements  |
+
+What assumptions is {{game_name}} built on? What external dependencies exist?"
+
+### 3. Check Narrative Workflow Recommendation
+
+**Check if game type suggested narrative:**
+
+If `needs_narrative` flag is true (from step 7):
+
+"**Narrative Recommendation:**
+
+Based on your game type ({{game_type}}), a dedicated Narrative Design Document would benefit {{game_name}}. This covers:
+
+- Story structure and arcs
+- Character development
+- World lore and history
+- Dialogue framework
+- Environmental storytelling
+
+Would you like to create a Narrative Design Document as your next step?"
+
+Store user response for next steps.
+
+### 4. Generate Completion Content
+
+Based on the conversation, prepare the content:
+
+```markdown
+## Out of Scope
+
+{{out_of_scope_items}}
+
+### Deferred to Post-Launch
+
+{{post_launch_items}}
+
+---
+
+## Assumptions and Dependencies
+
+### Key Assumptions
+
+{{assumptions_list}}
+
+### External Dependencies
+
+{{dependencies_list}}
+
+### Risk Factors
+
+{{risks_based_on_assumptions}}
+
+---
+
+## Document Information
+
+**Document:** {{game_name}} - Game Design Document
+**Version:** 1.0
+**Created:** {{date}}
+**Author:** {{user_name}}
+**Status:** Complete
+
+### Change Log
+
+| Version | Date     | Changes              |
+| ------- | -------- | -------------------- |
+| 1.0     | {{date}} | Initial GDD complete |
+```
+
+### 5. Present Completion Summary
+
+"**GDD Complete!**
+
+{{user_name}}, the Game Design Document for **{{game_name}}** is now complete!
+
+**Document Summary:**
+
+- **Game Type:** {{game_type}}
+- **Platform:** {{platform}}
+- **Epics:** {{epic_count}} development epics
+- **Estimated Stories:** {{story_estimate}}
+
+**Files Created:**
+
+- `gdd.md` - Full Game Design Document
+- `epics.md` - Detailed epic and story breakdown
+
+**GDD Sections Completed:**
+
+1. Executive Summary & Game Type
+2. Platforms & Target Audience
+3. Goals & Unique Selling Points
+4. Core Gameplay (Pillars, Loop, Win/Loss)
+5. Game Mechanics & Controls
+6. {{game_type}} Specific Design
+7. Progression & Balance
+8. Level Design Framework
+9. Art & Audio Direction
+10. Technical Specifications
+11. Development Epics
+12. Success Metrics
+13. Out of Scope & Assumptions
+
+Do you want me to add or modify anything before we finalize?"
+
+### 6. Present Next Steps
+
+**After user confirms completion:**
+
+"**Next Steps for {{game_name}}:**
+
+{{if needs_narrative and user_wants_narrative}}
+**Immediate Next Step:**
+
+1. **Narrative Design Document** - Create story, characters, and world lore
+   - Command: `narrative` (Game Designer agent)
+   - Input: This GDD
+   - Output: narrative-design.md
+     {{/if}}
+
+**Required Next Steps:**
+
+1. **Game Architecture** - Define engine, tech stack, and system design
+   - Command: `create-architecture` (Game Architect agent)
+   - Input: This GDD
+   - Output: architecture.md
+
+2. **Sprint Planning** - Set up your first development sprint
+   - Command: `sprint-planning` (Scrum Master agent)
+   - Input: GDD + epics.md
+   - Output: sprint-status.yaml
+
+**Recommended Actions:**
+
+- [ ] Review GDD with any team members or stakeholders
+- [ ] Create a prototype for core gameplay validation
+- [ ] Set up project repository and dev environment
+- [ ] Gather reference materials for art direction
+
+**Which would you like to do next?**
+
+1. {{if needs_narrative}}Create Narrative Design Document{{else}}Create Game Architecture{{/if}}
+2. Start Sprint Planning
+3. Review the completed GDD
+4. Exit workflow"
+
+### 7. Handle User Selection
+
+Based on user choice:
+
+**If 1 (Narrative or Architecture):**
+
+- Update frontmatter with final `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]`
+- Provide handoff guidance for next workflow
+
+**If 2 (Sprint Planning):**
+
+- Update frontmatter with final stepsCompleted
+- Provide handoff guidance for sprint planning
+
+**If 3 (Review):**
+
+- Present document summary
+- Offer to highlight any sections
+- Return to next steps menu
+
+**If 4 (Exit):**
+
+- Update frontmatter with final stepsCompleted
+- Confirm GDD is saved
+- Exit workflow gracefully
+
+## CRITICAL STEP COMPLETION NOTE
+
+This is the final step. Ensure:
+
+- All content is saved to gdd.md
+- Frontmatter shows all 14 steps completed
+- User has clear actionable next steps
+- Handoff to next workflow is smooth
+
+---
+
+## SYSTEM SUCCESS/FAILURE METRICS
+
+### SUCCESS:
+
+- Out of scope clearly documented
+- Assumptions and dependencies captured
+- Narrative workflow recommendation handled
+- Final document status updated
+- Clear next steps provided
+- Smooth handoff to next workflow
+
+### SYSTEM FAILURE:
+
+- Missing out of scope documentation
+- Not checking for narrative flag
+- No clear next steps provided
+- Frontmatter not updated to show completion
+- User left without actionable guidance
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
+
+---
+
+## GDD Workflow Complete
+
+The GDD workflow transforms a game concept into a comprehensive design document through 14 collaborative steps:
+
+1. **Initialize** - Set up workflow and discover input documents
+2. **Context** - Determine game type and load relevant guide
+3. **Platforms** - Define target platforms and audience
+4. **Vision** - Establish goals, context, and USPs
+5. **Core Gameplay** - Define pillars, loop, and win/loss
+6. **Mechanics** - Detail player actions and controls
+7. **Game Type** - Process genre-specific sections
+8. **Progression** - Design player growth and balance
+9. **Levels** - Structure playable content
+10. **Art & Audio** - Establish aesthetic direction
+11. **Technical** - Define performance requirements
+12. **Epics** - Organize features into development units
+13. **Metrics** - Define success criteria
+14. **Complete** - Document scope and hand off
+
+This step-file architecture ensures consistent, thorough GDD creation with user collaboration at every step.

package/src/modules/bmgd/workflows/2-design/gdd/workflow.md

@@ -0,0 +1,61 @@
+---
+name: create-gdd
+description: Creates a comprehensive Game Design Document through collaborative step-by-step discovery between game designer and user.
+main_config: '{project-root}/_bmad/bmgd/config.yaml'
+web_bundle: true
+---
+
+# GDD Workflow
+
+**Goal:** Create comprehensive Game Design Documents through collaborative step-by-step discovery between game designer and user.
+
+**Your Role:** You are a veteran game designer facilitator collaborating with a creative peer. This is a partnership, not a client-vendor relationship. You bring structured game design thinking and facilitation skills, while the user brings their game vision and domain expertise. Work together as equals. You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
+
+---
+
+## WORKFLOW ARCHITECTURE
+
+This uses **step-file architecture** for disciplined execution:
+
+### Core Principles
+
+- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
+- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
+- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
+- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
+- **Append-Only Building**: Build documents by appending content as directed to the output file
+
+### Step Processing Rules
+
+1. **READ COMPLETELY**: Always read the entire step file before taking any action
+2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
+3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
+4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
+5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
+6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
+
+### Critical Rules (NO EXCEPTIONS)
+
+- NEVER load multiple step files simultaneously
+- ALWAYS read entire step file before execution
+- NEVER skip steps or optimize the sequence
+- ALWAYS update frontmatter of output files when writing the final output for a specific step
+- ALWAYS follow the exact instructions in the step file
+- ALWAYS halt at menus and wait for user input
+- NEVER create mental todo lists from future steps
+
+---
+
+## INITIALIZATION SEQUENCE
+
+### 1. Configuration Loading
+
+Load and read full config from {main_config} and resolve:
+
+- `project_name`, `output_folder`, `user_name`
+- `communication_language`, `document_output_language`, `user_skill_level`
+- `date` as system-generated current datetime
+
+### 2. First Step EXECUTION
+
+Load, read the full file and then execute `steps/step-01-init.md` to begin the workflow.

package/src/modules/bmgd/workflows/2-design/gdd/workflow.yaml

@@ -0,0 +1,101 @@
+# 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/bmgd/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"
+game_dev_experience: "{config_source}:game_dev_experience"
+date: system-generated
+
+# Workflow components - Step-file architecture
+installed_path: "{project-root}/_bmad/bmgd/workflows/2-design/gdd"
+instructions: "{installed_path}/workflow.md"
+template: "{installed_path}/templates/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/"
+
+# Smart input file references - handles both whole docs and sharded docs
+# Priority: Whole document first, then sharded version
+input_file_patterns:
+  game_brief:
+    description: "Game vision and core concept (optional)"
+    whole: "{output_folder}/*game-brief*.md"
+    sharded: "{output_folder}/*game-brief*/index.md"
+    load_strategy: "INDEX_GUIDED"
+
+  research:
+    description: "Market or domain research (optional)"
+    whole: "{output_folder}/*research*.md"
+    sharded: "{output_folder}/*research*/index.md"
+    load_strategy: "FULL_LOAD"
+
+  document_project:
+    description: "Brownfield project documentation (optional)"
+    sharded: "{output_folder}/index.md"
+    load_strategy: "INDEX_GUIDED"
+
+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/bmgd/workflows/2-design/gdd/workflow.md"
+  web_bundle_files:
+    # Main workflow file
+    - "_bmad/bmgd/workflows/2-design/gdd/workflow.md"
+    # Step files
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-01-init.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-01b-continue.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-02-context.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-03-platforms.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-04-vision.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-05-core-gameplay.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-06-mechanics.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-07-game-type.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-08-progression.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-09-levels.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-10-art-audio.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-11-technical.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-12-epics.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-13-metrics.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/steps/step-14-complete.md"
+    # Template
+    - "_bmad/bmgd/workflows/2-design/gdd/templates/gdd-template.md"
+    # Data files
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types.csv"
+    # Game type guides
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/action-platformer.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/adventure.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/card-game.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/fighting.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/horror.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/idle-incremental.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/metroidvania.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/moba.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/party-game.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/puzzle.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/racing.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/rhythm.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/roguelike.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/rpg.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/sandbox.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/shooter.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/simulation.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/sports.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/strategy.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/survival.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/text-based.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/tower-defense.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/turn-based-tactics.md"
+    - "_bmad/bmgd/workflows/2-design/gdd/game-types/visual-novel.md"