bmad-method 4.43.0 → 4.43.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (100) hide show
  1. package/CONTRIBUTING.md +2 -9
  2. package/README.md +0 -82
  3. package/bmad-core/agents/bmad-master.md +6 -6
  4. package/bmad-core/tasks/validate-next-story.md +1 -1
  5. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +5 -5
  6. package/dist/agents/architect.txt +5 -5
  7. package/dist/agents/bmad-master.txt +11 -11
  8. package/dist/agents/dev.txt +1 -1
  9. package/dist/agents/po.txt +1 -1
  10. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +1 -1
  11. package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +1 -1
  12. package/dist/expansion-packs/bmad-godot-game-dev/agents/bmad-orchestrator.txt +1513 -0
  13. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-analyst.txt +3190 -0
  14. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-architect.txt +4499 -0
  15. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-designer.txt +3925 -0
  16. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-developer.txt +666 -0
  17. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-pm.txt +2381 -0
  18. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-po.txt +1612 -0
  19. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-qa.txt +1745 -0
  20. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-sm.txt +1208 -0
  21. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-ux-expert.txt +958 -0
  22. package/dist/expansion-packs/bmad-godot-game-dev/teams/godot-game-team.txt +27721 -0
  23. package/dist/teams/team-all.txt +6 -6
  24. package/dist/teams/team-fullstack.txt +6 -6
  25. package/dist/teams/team-ide-minimal.txt +1 -1
  26. package/dist/teams/team-no-ui.txt +6 -6
  27. package/docs/GUIDING-PRINCIPLES.md +3 -3
  28. package/docs/flattener.md +91 -0
  29. package/docs/versions.md +1 -1
  30. package/docs/working-in-the-brownfield.md +15 -6
  31. package/expansion-packs/bmad-godot-game-dev/README.md +244 -0
  32. package/expansion-packs/bmad-godot-game-dev/agent-teams/godot-game-team.yaml +18 -0
  33. package/expansion-packs/bmad-godot-game-dev/agents/bmad-orchestrator.md +147 -0
  34. package/expansion-packs/bmad-godot-game-dev/agents/game-analyst.md +84 -0
  35. package/expansion-packs/bmad-godot-game-dev/agents/game-architect.md +146 -0
  36. package/expansion-packs/bmad-godot-game-dev/agents/game-designer.md +78 -0
  37. package/expansion-packs/bmad-godot-game-dev/agents/game-developer.md +124 -0
  38. package/expansion-packs/bmad-godot-game-dev/agents/game-pm.md +82 -0
  39. package/expansion-packs/bmad-godot-game-dev/agents/game-po.md +115 -0
  40. package/expansion-packs/bmad-godot-game-dev/agents/game-qa.md +160 -0
  41. package/expansion-packs/bmad-godot-game-dev/agents/game-sm.md +66 -0
  42. package/expansion-packs/bmad-godot-game-dev/agents/game-ux-expert.md +75 -0
  43. package/expansion-packs/bmad-godot-game-dev/checklists/game-architect-checklist.md +377 -0
  44. package/expansion-packs/bmad-godot-game-dev/checklists/game-change-checklist.md +250 -0
  45. package/expansion-packs/bmad-godot-game-dev/checklists/game-design-checklist.md +225 -0
  46. package/expansion-packs/bmad-godot-game-dev/checklists/game-po-checklist.md +448 -0
  47. package/expansion-packs/bmad-godot-game-dev/checklists/game-story-dod-checklist.md +202 -0
  48. package/expansion-packs/bmad-godot-game-dev/config.yaml +30 -0
  49. package/expansion-packs/bmad-godot-game-dev/data/bmad-kb.md +811 -0
  50. package/expansion-packs/bmad-godot-game-dev/data/brainstorming-techniques.md +36 -0
  51. package/expansion-packs/bmad-godot-game-dev/data/development-guidelines.md +893 -0
  52. package/expansion-packs/bmad-godot-game-dev/data/elicitation-methods.md +156 -0
  53. package/expansion-packs/bmad-godot-game-dev/data/technical-preferences.md +3 -0
  54. package/expansion-packs/bmad-godot-game-dev/tasks/advanced-elicitation.md +110 -0
  55. package/expansion-packs/bmad-godot-game-dev/tasks/apply-qa-fixes.md +224 -0
  56. package/expansion-packs/bmad-godot-game-dev/tasks/brownfield-create-epic.md +162 -0
  57. package/expansion-packs/bmad-godot-game-dev/tasks/brownfield-create-story.md +149 -0
  58. package/expansion-packs/bmad-godot-game-dev/tasks/correct-course-game.md +159 -0
  59. package/expansion-packs/bmad-godot-game-dev/tasks/create-deep-research-prompt.md +278 -0
  60. package/expansion-packs/bmad-godot-game-dev/tasks/create-doc.md +103 -0
  61. package/expansion-packs/bmad-godot-game-dev/tasks/create-game-story.md +202 -0
  62. package/expansion-packs/bmad-godot-game-dev/tasks/document-project.md +343 -0
  63. package/expansion-packs/bmad-godot-game-dev/tasks/execute-checklist.md +88 -0
  64. package/expansion-packs/bmad-godot-game-dev/tasks/facilitate-brainstorming-session.md +136 -0
  65. package/expansion-packs/bmad-godot-game-dev/tasks/game-brownfield-create-epic.md +160 -0
  66. package/expansion-packs/bmad-godot-game-dev/tasks/game-brownfield-create-story.md +147 -0
  67. package/expansion-packs/bmad-godot-game-dev/tasks/game-design-brainstorming.md +290 -0
  68. package/expansion-packs/bmad-godot-game-dev/tasks/game-risk-profile.md +368 -0
  69. package/expansion-packs/bmad-godot-game-dev/tasks/game-test-design.md +219 -0
  70. package/expansion-packs/bmad-godot-game-dev/tasks/generate-ai-frontend-prompt.md +51 -0
  71. package/expansion-packs/bmad-godot-game-dev/tasks/kb-mode-interaction.md +77 -0
  72. package/expansion-packs/bmad-godot-game-dev/tasks/review-game-story.md +364 -0
  73. package/expansion-packs/bmad-godot-game-dev/tasks/shard-doc.md +187 -0
  74. package/expansion-packs/bmad-godot-game-dev/tasks/validate-game-story.md +208 -0
  75. package/expansion-packs/bmad-godot-game-dev/templates/brainstorming-output-tmpl.yaml +156 -0
  76. package/expansion-packs/bmad-godot-game-dev/templates/brownfield-prd-tmpl.yaml +281 -0
  77. package/expansion-packs/bmad-godot-game-dev/templates/competitor-analysis-tmpl.yaml +306 -0
  78. package/expansion-packs/bmad-godot-game-dev/templates/game-architecture-tmpl.yaml +1111 -0
  79. package/expansion-packs/bmad-godot-game-dev/templates/game-brief-tmpl.yaml +356 -0
  80. package/expansion-packs/bmad-godot-game-dev/templates/game-design-doc-tmpl.yaml +724 -0
  81. package/expansion-packs/bmad-godot-game-dev/templates/game-prd-tmpl.yaml +209 -0
  82. package/expansion-packs/bmad-godot-game-dev/templates/game-qa-gate-tmpl.yaml +186 -0
  83. package/expansion-packs/bmad-godot-game-dev/templates/game-story-tmpl.yaml +406 -0
  84. package/expansion-packs/bmad-godot-game-dev/templates/game-ui-spec-tmpl.yaml +601 -0
  85. package/expansion-packs/bmad-godot-game-dev/templates/level-design-doc-tmpl.yaml +620 -0
  86. package/expansion-packs/bmad-godot-game-dev/templates/market-research-tmpl.yaml +418 -0
  87. package/expansion-packs/bmad-godot-game-dev/utils/bmad-doc-template.md +327 -0
  88. package/expansion-packs/bmad-godot-game-dev/utils/workflow-management.md +71 -0
  89. package/expansion-packs/bmad-godot-game-dev/workflows/game-dev-greenfield.yaml +245 -0
  90. package/expansion-packs/bmad-godot-game-dev/workflows/game-prototype.yaml +213 -0
  91. package/package.json +1 -1
  92. package/release_notes.md +14 -2
  93. package/tools/flattener/ignoreRules.js +2 -0
  94. package/tools/installer/bin/bmad.js +2 -1
  95. package/tools/installer/config/install.config.yaml +16 -7
  96. package/tools/installer/lib/ide-setup.js +192 -80
  97. package/tools/installer/package.json +1 -1
  98. package/tools/upgraders/v3-to-v4-upgrader.js +1 -0
  99. package/test.md +0 -1
  100. /package/{implement-fork-friendly-ci.sh → tools/implement-fork-friendly-ci.sh} +0 -0
@@ -4628,8 +4628,8 @@ sections:
4628
4628
  - **UI/UX Consistency:** {{ui_compatibility}}
4629
4629
  - **Performance Impact:** {{performance_constraints}}
4630
4630
 
4631
- - id: tech-stack-alignment
4632
- title: Tech Stack Alignment
4631
+ - id: tech-stack
4632
+ title: Tech Stack
4633
4633
  instruction: |
4634
4634
  Ensure new components align with existing technology choices:
4635
4635
 
@@ -4791,8 +4791,8 @@ sections:
4791
4791
 
4792
4792
  **Error Handling:** {{error_handling_strategy}}
4793
4793
 
4794
- - id: source-tree-integration
4795
- title: Source Tree Integration
4794
+ - id: source-tree
4795
+ title: Source Tree
4796
4796
  instruction: |
4797
4797
  Define how new code will integrate with existing project structure:
4798
4798
 
@@ -4861,7 +4861,7 @@ sections:
4861
4861
  **Monitoring:** {{monitoring_approach}}
4862
4862
 
4863
4863
  - id: coding-standards
4864
- title: Coding Standards and Conventions
4864
+ title: Coding Standards
4865
4865
  instruction: |
4866
4866
  Ensure new code follows existing project conventions:
4867
4867
 
@@ -6673,7 +6673,7 @@ To comprehensively validate a story draft before implementation begins, ensuring
6673
6673
 
6674
6674
  ### 1. Template Completeness Validation
6675
6675
 
6676
- - Load `bmad-core/templates/story-tmpl.md` and extract all section headings from the template
6676
+ - Load `.bmad-core/templates/story-tmpl.yaml` and extract all section headings from the template
6677
6677
  - **Missing sections check**: Compare story sections against template sections to verify all required sections are present
6678
6678
  - **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
6679
6679
  - **Agent section verification**: Confirm all sections from template exist for future agent use
@@ -6513,8 +6513,8 @@ sections:
6513
6513
  - **UI/UX Consistency:** {{ui_compatibility}}
6514
6514
  - **Performance Impact:** {{performance_constraints}}
6515
6515
 
6516
- - id: tech-stack-alignment
6517
- title: Tech Stack Alignment
6516
+ - id: tech-stack
6517
+ title: Tech Stack
6518
6518
  instruction: |
6519
6519
  Ensure new components align with existing technology choices:
6520
6520
 
@@ -6676,8 +6676,8 @@ sections:
6676
6676
 
6677
6677
  **Error Handling:** {{error_handling_strategy}}
6678
6678
 
6679
- - id: source-tree-integration
6680
- title: Source Tree Integration
6679
+ - id: source-tree
6680
+ title: Source Tree
6681
6681
  instruction: |
6682
6682
  Define how new code will integrate with existing project structure:
6683
6683
 
@@ -6746,7 +6746,7 @@ sections:
6746
6746
  **Monitoring:** {{monitoring_approach}}
6747
6747
 
6748
6748
  - id: coding-standards
6749
- title: Coding Standards and Conventions
6749
+ title: Coding Standards
6750
6750
  instruction: |
6751
6751
  Ensure new code follows existing project conventions:
6752
6752
 
@@ -8397,7 +8397,7 @@ To comprehensively validate a story draft before implementation begins, ensuring
8397
8397
 
8398
8398
  ### 1. Template Completeness Validation
8399
8399
 
8400
- - Load `bmad-core/templates/story-tmpl.md` and extract all section headings from the template
8400
+ - Load `.bmad-core/templates/story-tmpl.yaml` and extract all section headings from the template
8401
8401
  - **Missing sections check**: Compare story sections against template sections to verify all required sections are present
8402
8402
  - **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
8403
8403
  - **Agent section verification**: Confirm all sections from template exist for future agent use
@@ -2142,7 +2142,7 @@ To comprehensively validate a story draft before implementation begins, ensuring
2142
2142
 
2143
2143
  ### 1. Template Completeness Validation
2144
2144
 
2145
- - Load `bmad-core/templates/story-tmpl.md` and extract all section headings from the template
2145
+ - Load `.bmad-core/templates/story-tmpl.yaml` and extract all section headings from the template
2146
2146
  - **Missing sections check**: Compare story sections against template sections to verify all required sections are present
2147
2147
  - **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
2148
2148
  - **Agent section verification**: Confirm all sections from template exist for future agent use
@@ -6050,8 +6050,8 @@ sections:
6050
6050
  - **UI/UX Consistency:** {{ui_compatibility}}
6051
6051
  - **Performance Impact:** {{performance_constraints}}
6052
6052
 
6053
- - id: tech-stack-alignment
6054
- title: Tech Stack Alignment
6053
+ - id: tech-stack
6054
+ title: Tech Stack
6055
6055
  instruction: |
6056
6056
  Ensure new components align with existing technology choices:
6057
6057
 
@@ -6213,8 +6213,8 @@ sections:
6213
6213
 
6214
6214
  **Error Handling:** {{error_handling_strategy}}
6215
6215
 
6216
- - id: source-tree-integration
6217
- title: Source Tree Integration
6216
+ - id: source-tree
6217
+ title: Source Tree
6218
6218
  instruction: |
6219
6219
  Define how new code will integrate with existing project structure:
6220
6220
 
@@ -6283,7 +6283,7 @@ sections:
6283
6283
  **Monitoring:** {{monitoring_approach}}
6284
6284
 
6285
6285
  - id: coding-standards
6286
- title: Coding Standards and Conventions
6286
+ title: Coding Standards
6287
6287
  instruction: |
6288
6288
  Ensure new code follows existing project conventions:
6289
6289
 
@@ -7934,7 +7934,7 @@ To comprehensively validate a story draft before implementation begins, ensuring
7934
7934
 
7935
7935
  ### 1. Template Completeness Validation
7936
7936
 
7937
- - Load `bmad-core/templates/story-tmpl.md` and extract all section headings from the template
7937
+ - Load `.bmad-core/templates/story-tmpl.yaml` and extract all section headings from the template
7938
7938
  - **Missing sections check**: Compare story sections against template sections to verify all required sections are present
7939
7939
  - **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
7940
7940
  - **Agent section verification**: Confirm all sections from template exist for future agent use
@@ -1,6 +1,6 @@
1
1
  # BMad Method Guiding Principles
2
2
 
3
- The BMad Method is a natural language framework for AI-assisted software development. These principles ensure contributions maintain the method's effectiveness.
3
+ The BMad Core and Method is a natural language framework for AI-assisted workflow with human in the loop processing along with software development. These principles ensure contributions maintain the method's effectiveness.
4
4
 
5
5
  ## Core Principles
6
6
 
@@ -8,7 +8,7 @@ The BMad Method is a natural language framework for AI-assisted software develop
8
8
 
9
9
  - **Minimize dev agent dependencies**: Development agents that work in IDEs must have minimal context overhead
10
10
  - **Save context for code**: Every line counts - dev agents should focus on coding, not documentation
11
- - **Web agents can be larger**: Planning agents (PRD Writer, Architect) used in web UI can have more complex tasks and dependencies
11
+ - **Planning agents can be larger**: Planning agents (PM, Architect) used in web UI can have more complex tasks and dependencies
12
12
  - **Small files, loaded on demand**: Multiple small, focused files are better than large files with many branches
13
13
 
14
14
  ### 2. Natural Language First
@@ -85,7 +85,7 @@ Templates follow the [BMad Document Template](../common/utils/bmad-doc-template.
85
85
 
86
86
  ## Remember
87
87
 
88
- - The power is in natural language orchestration, not code
88
+ - The power is in natural language orchestration and human agent collaboration, not code
89
89
  - Dev agents code, planning agents plan
90
90
  - Keep dev agents lean for maximum coding efficiency
91
91
  - Expansion packs handle specialized domains
@@ -0,0 +1,91 @@
1
+ # Codebase Flattener Tool
2
+
3
+ The BMAD-METHOD™ includes a powerful codebase flattener tool designed to prepare your project files for AI model consumption when uploading to web AI tools. This tool aggregates your entire codebase into a single XML file, making it easy to share your project context with AI assistants for analysis, debugging, or development assistance.
4
+
5
+ ## Features
6
+
7
+ - **AI-Optimized Output**: Generates clean XML format specifically designed for AI model consumption
8
+ - **Smart Filtering**: Automatically respects `.gitignore` patterns to exclude unnecessary files, plus optional project-level `.bmad-flattenignore` for additional exclusions if planning to flatten an existing repository for external update and analysis
9
+ - **Binary File Detection**: Intelligently identifies and excludes binary files, focusing on source code
10
+ - **Progress Tracking**: Real-time progress indicators and comprehensive completion statistics
11
+ - **Flexible Output**: Customizable output file location and naming
12
+
13
+ ## Usage
14
+
15
+ ```bash
16
+ # Basic usage - creates flattened-codebase.xml in current directory
17
+ npx bmad-method flatten
18
+
19
+ # Specify custom input directory
20
+ npx bmad-method flatten --input /path/to/source/directory
21
+ npx bmad-method flatten -i /path/to/source/directory
22
+
23
+ # Specify custom output file
24
+ npx bmad-method flatten --output my-project.xml
25
+ npx bmad-method flatten -o /path/to/output/codebase.xml
26
+
27
+ # Combine input and output options
28
+ npx bmad-method flatten --input /path/to/source --output /path/to/output/codebase.xml
29
+ ```
30
+
31
+ ## Example Output
32
+
33
+ The tool will display progress and provide a comprehensive summary:
34
+
35
+ ```text
36
+ 📊 Completion Summary:
37
+ ✅ Successfully processed 156 files into flattened-codebase.xml
38
+ 📁 Output file: /path/to/your/project/flattened-codebase.xml
39
+ 📏 Total source size: 2.3 MB
40
+ 📄 Generated XML size: 2.1 MB
41
+ 📝 Total lines of code: 15,847
42
+ 🔢 Estimated tokens: 542,891
43
+ 📊 File breakdown: 142 text, 14 binary, 0 errors
44
+ ```
45
+
46
+ The generated XML file contains your project's text-based source files in a structured format that AI models can easily parse and understand, making it perfect for code reviews, architecture discussions, or getting AI assistance with your BMAD-METHOD™ projects.
47
+
48
+ ## Advanced Usage & Options
49
+
50
+ - CLI options
51
+ - `-i, --input <path>`: Directory to flatten. Default: current working directory or auto-detected project root when run interactively.
52
+ - `-o, --output <path>`: Output file path. Default: `flattened-codebase.xml` in the chosen directory.
53
+ - Interactive mode
54
+ - If you do not pass `--input` and `--output` and the terminal is interactive (TTY), the tool will attempt to detect your project root (by looking for markers like `.git`, `package.json`, etc.) and prompt you to confirm or override the paths.
55
+ - In non-interactive contexts (e.g., CI), it will prefer the detected root silently; otherwise it falls back to the current directory and default filename.
56
+ - File discovery and ignoring
57
+ - Uses `git ls-files` when inside a git repository for speed and correctness; otherwise falls back to a glob-based scan.
58
+ - Applies your `.gitignore` plus a curated set of default ignore patterns (e.g., `node_modules`, build outputs, caches, logs, IDE folders, lockfiles, large media/binaries, `.env*`, and previously generated XML outputs).
59
+ - Supports an optional `.bmad-flattenignore` file at the project root for additional ignore patterns (gitignore-style). If present, its rules are applied after `.gitignore` and the defaults.
60
+
61
+ ## `.bmad-flattenignore` example
62
+
63
+ Create a `.bmad-flattenignore` file in the root of your project to exclude files that must remain in git but should not be included in the flattened XML:
64
+
65
+ ```text
66
+ seeds/**
67
+ scripts/private/**
68
+ **/*.snap
69
+ ```
70
+
71
+ - Binary handling
72
+ - Binary files are detected and excluded from the XML content. They are counted in the final summary but not embedded in the output.
73
+ - XML format and safety
74
+ - UTF-8 encoded file with root element `<files>`.
75
+ - Each text file is emitted as a `<file path="relative/path">` element whose content is wrapped in `<![CDATA[ ... ]]>`.
76
+ - The tool safely handles occurrences of `]]>` inside content by splitting the CDATA to preserve correctness.
77
+ - File contents are preserved as-is and indented for readability inside the XML.
78
+ - Performance
79
+ - Concurrency is selected automatically based on your CPU and workload size. No configuration required.
80
+ - Running inside a git repo improves discovery performance.
81
+
82
+ ## Minimal XML example
83
+
84
+ ```xml
85
+ <?xml version="1.0" encoding="UTF-8"?>
86
+ <files>
87
+ <file path="src/index.js"><![CDATA[
88
+ // your source content
89
+ ]]></file>
90
+ </files>
91
+ ```
package/docs/versions.md CHANGED
@@ -6,7 +6,7 @@
6
6
  - [Version 2](https://github.com/bmadcode/BMad-Method/tree/V2)
7
7
  - [Version 1](https://github.com/bmadcode/BMad-Method/tree/V1)
8
8
 
9
- ## Current Version: V4 - Alpha
9
+ ## Current Version: V4
10
10
 
11
11
  Guiding Principles of V4:
12
12
 
@@ -1,11 +1,14 @@
1
1
  # Working in the Brownfield: A Complete Guide
2
2
 
3
- > **HIGHLY RECOMMENDED: Use Gemini Web or Gemini CLI for Brownfield Documentation Generation!**
4
- >
5
- > Gemini Web's 1M+ token context window or Gemini CLI (when it's working) can analyze your ENTIRE codebase, or critical sections of it, all at once (obviously within reason):
6
- >
7
- > - Upload via GitHub URL or use gemini cli in the project folder
8
- > - If working in the web: use `npx bmad-method flatten` to flatten your project into a single file, then upload that file to your web agent.
3
+ ## Critical Tip
4
+
5
+ Regardless of what you plan for your existing project you want to start agentic coding with, producing contextual artifacts for agents is of the highest importance.
6
+
7
+ If using Claude Code - it is recommended to use the document-project task with the architect to systematically produce important key artifacts for your codebase.
8
+
9
+ Optionally you can product context information and understanding for your repo utilizing web agents like Gemini. If its already in github, you can provide the project URL in gemini and use the agents to help analyze or document the project with the team fullstack or the architect specific gem.
10
+
11
+ If your project is too large, you can also flatten your codebase - which can make it easier to upload or use with some tools. You can read more about the optional tool in the [Flattener Guide](./flattener.md)
9
12
 
10
13
  ## What is Brownfield Development?
11
14
 
@@ -26,9 +29,15 @@ If you have just completed an MVP with BMad, and you want to continue with post-
26
29
 
27
30
  ## The Complete Brownfield Workflow
28
31
 
32
+ Starting in the Web Option (potentially save some cost but a potentially more frustrating experience):
33
+
29
34
  1. **Follow the [<ins>User Guide - Installation</ins>](user-guide.md#installation) steps to setup your agent in the web.**
30
35
  2. **Generate a 'flattened' single file of your entire codebase** run: `npx bmad-method flatten`
31
36
 
37
+ Starting in an IDE with large context and good models (Its important to use quality models for this process for the best results)
38
+
39
+ 1. In Claude Code or a similar IDE, select the architect agent and then use the \*document-project task. You will want to ensure you are validating and directing the agent to produce the best possible documents for LLMs to understand your code base, and not include any misleading or unnecessary info.
40
+
32
41
  ### Choose Your Approach
33
42
 
34
43
  #### Approach A: PRD-First (Recommended if adding very large and complex new features, single or multiple epics or massive changes)
@@ -0,0 +1,244 @@
1
+ # BMAD-Method BMAD Godot Expansion User Guide
2
+
3
+ This guide will help you understand and effectively use the BMad Method Godot Expansion Pack for agile ai driven planning and development.
4
+
5
+ ## The BMad Plan and Execute Workflow
6
+
7
+ **We will be following the user-guide in most cases, and modifications will be made for expansion pack specific usage**
8
+ First, here is the full standard Greenfield Planning + Execution Workflow.
9
+
10
+ ### The Planning Workflow (Web UI or Powerful IDE Agents)
11
+
12
+ Before development begins, BMad follows a structured planning workflow that's ideally done in web UI for cost efficiency:
13
+
14
+ ```mermaid
15
+ graph TD
16
+ A["Start: Project Idea"] --> B{"Optional: Analyst Research"}
17
+ B -->|Yes| C["Analyst: Brainstorming (Optional)"]
18
+ B -->|No| G{"Project Brief Available?"}
19
+ C --> C2["Analyst: Market Research (Optional)"]
20
+ C2 --> C3["Analyst: Competitor Analysis (Optional)"]
21
+ C3 --> D["Game-Designer: Create Game Brief"]
22
+ D --> G
23
+ G -->|Yes| E["Game-Designer: Create GDD from Brief (Fast Track)"]
24
+ G -->|No| E2["Game-Designer: Interactive GDD Creation (More Questions)"]
25
+ E --> F["GDD Created with FRs, NFRs, Epics & Stories"]
26
+ E2 --> F
27
+ F --> F2["Game-PM: Create PRD from GDD"]
28
+ F2 --> F3["Game-Architect: Create Game Architecture from GDD and PRD"]
29
+ F3 --> I["PO: Run game-po-validation-checklist"]
30
+ I --> J{"Documents Aligned?"}
31
+ J -->|Yes| K["Planning Complete"]
32
+ J -->|No| L["Game-Designer: Update Epics & Stories"]
33
+ L --> M["Update GDD/Game Architecture as needed"]
34
+ M --> I
35
+ K --> N["📁 Switch to IDE (If in a Web Agent Platform)"]
36
+ N --> O["Game-PO: Shard Documents"]
37
+ O --> P["Ready for SM/Dev Cycle"]
38
+
39
+ style A fill:#f5f5f5,color:#000
40
+ style B fill:#e3f2fd,color:#000
41
+ style C fill:#e8f5e9,color:#000
42
+ style C2 fill:#e8f5e9,color:#000
43
+ style C3 fill:#e8f5e9,color:#000
44
+ style D fill:#e8f5e9,color:#000
45
+ style E fill:#fff3e0,color:#000
46
+ style E2 fill:#fff3e0,color:#000
47
+ style F fill:#fff3e0,color:#000
48
+ style F2 fill:#e3f2fd,color:#000
49
+ style F3 fill:#f3e5f5,color:#000
50
+ style G fill:#e3f2fd,color:#000
51
+ style H fill:#f3e5f5,color:#000
52
+ style H2 fill:#f3e5f5,color:#000
53
+ style I fill:#f9ab00,color:#fff
54
+ style J fill:#e3f2fd,color:#000
55
+ style K fill:#34a853,color:#fff
56
+ style L fill:#f9ab00,color:#fff
57
+ style M fill:#fff3e0,color:#000
58
+ style N fill:#1a73e8,color:#fff
59
+ style O fill:#f9ab00,color:#fff
60
+ style P fill:#34a853,color:#fff
61
+ ```
62
+
63
+ #### Web UI to IDE Transition
64
+
65
+ **Critical Transition Point**: Once the PO confirms document alignment, you must switch from web UI to IDE to begin the development workflow:
66
+
67
+ 1. **Copy Documents to Project**: Ensure `docs/gdd.md` and `docs/gamearchitecture.md` are in your project's docs folder (or a custom location you can specify during installation)
68
+ 2. **Switch to IDE**: Open your project in your preferred Agentic IDE
69
+ 3. **Document Sharding**: Use the Game-Designer to shard the GDD and then the game-architecht to shard the gamearchitecture
70
+ 4. **Begin Development**: Start the Core Development Cycle that follows
71
+
72
+ ### The Core Development Cycle (IDE)
73
+
74
+ Once planning is complete and documents are sharded, BMad follows a structured development workflow:
75
+
76
+ ```mermaid
77
+ graph TD
78
+ A["Development Phase Start"] --> B["Game-SM: Reviews Previous Story Dev/QA Notes"]
79
+ B --> B2["Game-SM: Drafts Next Story from Sharded Epic + Architecture"]
80
+ B2 --> B3{"Game-PO: Review Story Draft - Optional"}
81
+ B3 -->|Review Requested| B4["Game-QA: Review Story Against Artifacts"]
82
+ B3 -->|Skip Review| C{"User Approval"}
83
+ B4 --> C
84
+ C -->|Approved| D["Game-Dev: Sequential Task Execution"]
85
+ C -->|Needs Changes| B2
86
+ D --> E["Game-Dev: Implement Tasks + Tests"]
87
+ E --> F["Game-Dev: Run All Validations"]
88
+ F --> G["Game-Dev: Mark Ready for Review + Add Notes"]
89
+ G --> H{"User Verification"}
90
+ H -->|Request QA Review| I["Game-QA: Senior Dev Review + Active Refactoring"]
91
+ H -->|Approve Without QA| M["IMPORTANT: Verify All Regression Tests and Linting are Passing"]
92
+ I --> J["Game-QA: Review, Refactor Code, Add Tests, Document Notes"]
93
+ J --> L{"Game-QA Decision"}
94
+ L -->|Needs Dev Work| D
95
+ L -->|Approved| M
96
+ H -->|Needs Fixes| D
97
+ M --> N["IMPORTANT: COMMIT YOUR CHANGES BEFORE PROCEEDING!"]
98
+ N --> K["Mark Story as Done"]
99
+ K --> B
100
+
101
+ style A fill:#f5f5f5,color:#000
102
+ style B fill:#e8f5e9,color:#000
103
+ style B2 fill:#e8f5e9,color:#000
104
+ style B3 fill:#e3f2fd,color:#000
105
+ style B4 fill:#fce4ec,color:#000
106
+ style C fill:#e3f2fd,color:#000
107
+ style D fill:#e3f2fd,color:#000
108
+ style E fill:#e3f2fd,color:#000
109
+ style F fill:#e3f2fd,color:#000
110
+ style G fill:#e3f2fd,color:#000
111
+ style H fill:#e3f2fd,color:#000
112
+ style I fill:#f9ab00,color:#fff
113
+ style J fill:#ffd54f,color:#000
114
+ style K fill:#34a853,color:#fff
115
+ style L fill:#e3f2fd,color:#000
116
+ style M fill:#ff5722,color:#fff
117
+ style N fill:#d32f2f,color:#fff
118
+ ```
119
+
120
+ ## Installation
121
+
122
+ ### Optional
123
+
124
+ If you want to do the planning in the Web with Claude (Sonnet 4 or Opus), Gemini Gem (2.5 Pro), or Custom GPT's:
125
+
126
+ 1. Navigate to `dist/expansion-packs/bmad-godot-game-dev/teams`
127
+ 2. Copy `godot-game-dev.txt` content
128
+ 3. Create new Gemini Gem or CustomGPT
129
+ 4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
130
+ 5. Type `/help` to see available commands
131
+
132
+ ### IDE Project Setup
133
+
134
+ ```bash
135
+ # Interactive installation (recommended)
136
+ npx bmad-method install
137
+ ```
138
+
139
+ ## Special Agents
140
+
141
+ There are two bmad agents - in the future they will be consolidated into the single bmad-master.
142
+
143
+ ### BMad-Master
144
+
145
+ This agent can do any task or command that all other agents can do, aside from actual story implementation. Additionally, this agent can help explain the BMad Method when in the web by accessing the knowledge base and explaining anything to you about the process.
146
+
147
+ If you dont want to bother switching between different agents aside from the dev, this is the agent for you.
148
+
149
+ ### BMad-Orchestrator
150
+
151
+ This agent should NOT be used within the IDE, it is a heavy weight special purpose agent that utilizes a lot of context and can morph into any other agent. This exists solely to facilitate the team's within the web bundles. If you use a web bundle you will be greeted by the BMad Orchestrator.
152
+
153
+ ### How Agents Work
154
+
155
+ #### Dependencies System
156
+
157
+ Each agent has a YAML section that defines its dependencies:
158
+
159
+ ```yaml
160
+ dependencies:
161
+ templates:
162
+ - prd-template.md
163
+ - user-story-template.md
164
+ tasks:
165
+ - create-doc.md
166
+ - shard-doc.md
167
+ data:
168
+ - bmad-kb.md
169
+ ```
170
+
171
+ **Key Points:**
172
+
173
+ - Agents only load resources they need (lean context)
174
+ - Dependencies are automatically resolved during bundling
175
+ - Resources are shared across agents to maintain consistency
176
+
177
+ #### Agent Interaction
178
+
179
+ **In IDE:**
180
+
181
+ ```bash
182
+ # Some Ide's, like Cursor or Windsurf for example, utilize manual rules so interaction is done with the '@' symbol
183
+ @game-designer Create a GDD for a task management app
184
+ @game-architect Design the game architecture
185
+ @game-developer Implement the user authentication
186
+
187
+ # Some, like Claude Code use slash commands instead
188
+ /game-sm Create user stories
189
+ /game-developer Fix the login bug
190
+ ```
191
+
192
+ #### Interactive Modes
193
+
194
+ - **Incremental Mode**: Step-by-step with user input
195
+ - **YOLO Mode**: Rapid generation with minimal interaction
196
+
197
+ ## IDE Integration
198
+
199
+ ### IDE Best Practices
200
+
201
+ - **Context Management**: Keep relevant files only in context, keep files as lean and focused as necessary
202
+ - **Agent Selection**: Use appropriate agent for task
203
+ - **Iterative Development**: Work in small, focused tasks
204
+ - **File Organization**: Maintain clean project structure
205
+
206
+ ## Technical Preferences System
207
+
208
+ BMad includes a personalization system through the `technical-preferences.md` file located in `.bmad-godot-game-dev/data/` - this can help bias the PM and Architect to recommend your preferences for design patterns, technology selection, or anything else you would like to put in here.
209
+
210
+ ### Using with Web Bundles
211
+
212
+ When creating custom web bundles or uploading to AI platforms, include your `technical-preferences.md` content to ensure agents have your preferences from the start of any conversation.
213
+
214
+ ## Core Configuration
215
+
216
+ The `.bmad-core/core-config.yaml` and for this expansion-pack the `.bmad-godot-game-dev/config.yaml` files are a critical config that enables BMad to work seamlessly with differing project structures, more options will be made available in the future. Currently the most important is the devLoadAlwaysFiles list section in the yaml.
217
+
218
+ For the expansion pack ensure you either copy the core-config.yaml.example from the expansion pack directory to replace your .bmad-core/core-config.yaml and copy it to the .bmad-unit-game-dev/ expansion pack as core-config.yaml and at the very least update the gameDimension variable to the dimension your game will be in.
219
+
220
+ ### Developer Context Files
221
+
222
+ Define which files the dev agent should always load:
223
+
224
+ ```yaml
225
+ devLoadAlwaysFiles:
226
+ - docs/architecture/##-coding-standards.md
227
+ - docs/architecture/##-tech-stack.md
228
+ - docs/architecture/##-godot-project-structure.md
229
+ ```
230
+
231
+ You will want to verify from sharding your architecture that these documents exist (replace ## with the prefix generated in sharding), that they are as lean as possible, and contain exactly the information you want your dev agent to ALWAYS load into it's context. These are the rules the agent will follow.
232
+
233
+ As your project grows and the code starts to build consistent patterns, coding standards should be reduced to just the items that the agent makes mistakes at still - must with the better models, they will look at surrounding code in files and not need a rule from that file to guide them.
234
+
235
+ ## Getting Help
236
+
237
+ - **Discord Community**: [Join Discord](https://discord.gg/gk8jAdXWmj)
238
+ - **GitHub Issues**: [Report bugs](https://github.com/bmadcode/bmad-method/issues)
239
+ - **Documentation**: [Browse docs](https://github.com/bmadcode/bmad-method/docs)
240
+ - **YouTube**: [BMadCode Channel](https://www.youtube.com/@BMadCode)
241
+
242
+ ## Conclusion
243
+
244
+ Remember: BMad is designed to enhance your development process, not replace your expertise. Use it as a powerful tool to accelerate your projects while maintaining control over design decisions and implementation details.
@@ -0,0 +1,18 @@
1
+ bundle:
2
+ name: Godot Game Team
3
+ icon: 🎮
4
+ description: Game Development team specialized in games using Godot Engine, GDScript and C#.
5
+ agents:
6
+ - game-analyst
7
+ - bmad-orchestrator
8
+ - game-designer
9
+ - game-architect
10
+ - game-developer
11
+ - game-qa
12
+ - game-sm
13
+ - game-po
14
+ - game-pm
15
+ - game-ux-expert
16
+ workflows:
17
+ - game-dev-greenfield.md
18
+ - game-prototype.md