bmad-method 4.42.1 → 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 (105) hide show
  1. package/CONTRIBUTING.md +2 -9
  2. package/README.md +0 -98
  3. package/bmad-core/agents/bmad-master.md +6 -6
  4. package/bmad-core/data/bmad-kb.md +1 -0
  5. package/bmad-core/tasks/validate-next-story.md +1 -1
  6. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +5 -5
  7. package/dist/agents/analyst.txt +1 -0
  8. package/dist/agents/architect.txt +5 -5
  9. package/dist/agents/bmad-master.txt +12 -11
  10. package/dist/agents/bmad-orchestrator.txt +1 -0
  11. package/dist/agents/dev.txt +1 -1
  12. package/dist/agents/po.txt +1 -1
  13. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +1 -1
  14. package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +1 -1
  15. package/dist/expansion-packs/bmad-godot-game-dev/agents/bmad-orchestrator.txt +1513 -0
  16. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-analyst.txt +3190 -0
  17. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-architect.txt +4499 -0
  18. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-designer.txt +3925 -0
  19. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-developer.txt +666 -0
  20. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-pm.txt +2381 -0
  21. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-po.txt +1612 -0
  22. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-qa.txt +1745 -0
  23. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-sm.txt +1208 -0
  24. package/dist/expansion-packs/bmad-godot-game-dev/agents/game-ux-expert.txt +958 -0
  25. package/dist/expansion-packs/bmad-godot-game-dev/teams/godot-game-team.txt +27721 -0
  26. package/dist/teams/team-all.txt +7 -6
  27. package/dist/teams/team-fullstack.txt +7 -6
  28. package/dist/teams/team-ide-minimal.txt +2 -1
  29. package/dist/teams/team-no-ui.txt +7 -6
  30. package/docs/GUIDING-PRINCIPLES.md +3 -3
  31. package/docs/expansion-packs.md +3 -83
  32. package/docs/flattener.md +91 -0
  33. package/docs/versions.md +1 -1
  34. package/docs/working-in-the-brownfield.md +15 -6
  35. package/expansion-packs/bmad-godot-game-dev/README.md +244 -0
  36. package/expansion-packs/bmad-godot-game-dev/agent-teams/godot-game-team.yaml +18 -0
  37. package/expansion-packs/bmad-godot-game-dev/agents/bmad-orchestrator.md +147 -0
  38. package/expansion-packs/bmad-godot-game-dev/agents/game-analyst.md +84 -0
  39. package/expansion-packs/bmad-godot-game-dev/agents/game-architect.md +146 -0
  40. package/expansion-packs/bmad-godot-game-dev/agents/game-designer.md +78 -0
  41. package/expansion-packs/bmad-godot-game-dev/agents/game-developer.md +124 -0
  42. package/expansion-packs/bmad-godot-game-dev/agents/game-pm.md +82 -0
  43. package/expansion-packs/bmad-godot-game-dev/agents/game-po.md +115 -0
  44. package/expansion-packs/bmad-godot-game-dev/agents/game-qa.md +160 -0
  45. package/expansion-packs/bmad-godot-game-dev/agents/game-sm.md +66 -0
  46. package/expansion-packs/bmad-godot-game-dev/agents/game-ux-expert.md +75 -0
  47. package/expansion-packs/bmad-godot-game-dev/checklists/game-architect-checklist.md +377 -0
  48. package/expansion-packs/bmad-godot-game-dev/checklists/game-change-checklist.md +250 -0
  49. package/expansion-packs/bmad-godot-game-dev/checklists/game-design-checklist.md +225 -0
  50. package/expansion-packs/bmad-godot-game-dev/checklists/game-po-checklist.md +448 -0
  51. package/expansion-packs/bmad-godot-game-dev/checklists/game-story-dod-checklist.md +202 -0
  52. package/expansion-packs/bmad-godot-game-dev/config.yaml +30 -0
  53. package/expansion-packs/bmad-godot-game-dev/data/bmad-kb.md +811 -0
  54. package/expansion-packs/bmad-godot-game-dev/data/brainstorming-techniques.md +36 -0
  55. package/expansion-packs/bmad-godot-game-dev/data/development-guidelines.md +893 -0
  56. package/expansion-packs/bmad-godot-game-dev/data/elicitation-methods.md +156 -0
  57. package/expansion-packs/bmad-godot-game-dev/data/technical-preferences.md +3 -0
  58. package/expansion-packs/bmad-godot-game-dev/tasks/advanced-elicitation.md +110 -0
  59. package/expansion-packs/bmad-godot-game-dev/tasks/apply-qa-fixes.md +224 -0
  60. package/expansion-packs/bmad-godot-game-dev/tasks/brownfield-create-epic.md +162 -0
  61. package/expansion-packs/bmad-godot-game-dev/tasks/brownfield-create-story.md +149 -0
  62. package/expansion-packs/bmad-godot-game-dev/tasks/correct-course-game.md +159 -0
  63. package/expansion-packs/bmad-godot-game-dev/tasks/create-deep-research-prompt.md +278 -0
  64. package/expansion-packs/bmad-godot-game-dev/tasks/create-doc.md +103 -0
  65. package/expansion-packs/bmad-godot-game-dev/tasks/create-game-story.md +202 -0
  66. package/expansion-packs/bmad-godot-game-dev/tasks/document-project.md +343 -0
  67. package/expansion-packs/bmad-godot-game-dev/tasks/execute-checklist.md +88 -0
  68. package/expansion-packs/bmad-godot-game-dev/tasks/facilitate-brainstorming-session.md +136 -0
  69. package/expansion-packs/bmad-godot-game-dev/tasks/game-brownfield-create-epic.md +160 -0
  70. package/expansion-packs/bmad-godot-game-dev/tasks/game-brownfield-create-story.md +147 -0
  71. package/expansion-packs/bmad-godot-game-dev/tasks/game-design-brainstorming.md +290 -0
  72. package/expansion-packs/bmad-godot-game-dev/tasks/game-risk-profile.md +368 -0
  73. package/expansion-packs/bmad-godot-game-dev/tasks/game-test-design.md +219 -0
  74. package/expansion-packs/bmad-godot-game-dev/tasks/generate-ai-frontend-prompt.md +51 -0
  75. package/expansion-packs/bmad-godot-game-dev/tasks/kb-mode-interaction.md +77 -0
  76. package/expansion-packs/bmad-godot-game-dev/tasks/review-game-story.md +364 -0
  77. package/expansion-packs/bmad-godot-game-dev/tasks/shard-doc.md +187 -0
  78. package/expansion-packs/bmad-godot-game-dev/tasks/validate-game-story.md +208 -0
  79. package/expansion-packs/bmad-godot-game-dev/templates/brainstorming-output-tmpl.yaml +156 -0
  80. package/expansion-packs/bmad-godot-game-dev/templates/brownfield-prd-tmpl.yaml +281 -0
  81. package/expansion-packs/bmad-godot-game-dev/templates/competitor-analysis-tmpl.yaml +306 -0
  82. package/expansion-packs/bmad-godot-game-dev/templates/game-architecture-tmpl.yaml +1111 -0
  83. package/expansion-packs/bmad-godot-game-dev/templates/game-brief-tmpl.yaml +356 -0
  84. package/expansion-packs/bmad-godot-game-dev/templates/game-design-doc-tmpl.yaml +724 -0
  85. package/expansion-packs/bmad-godot-game-dev/templates/game-prd-tmpl.yaml +209 -0
  86. package/expansion-packs/bmad-godot-game-dev/templates/game-qa-gate-tmpl.yaml +186 -0
  87. package/expansion-packs/bmad-godot-game-dev/templates/game-story-tmpl.yaml +406 -0
  88. package/expansion-packs/bmad-godot-game-dev/templates/game-ui-spec-tmpl.yaml +601 -0
  89. package/expansion-packs/bmad-godot-game-dev/templates/level-design-doc-tmpl.yaml +620 -0
  90. package/expansion-packs/bmad-godot-game-dev/templates/market-research-tmpl.yaml +418 -0
  91. package/expansion-packs/bmad-godot-game-dev/utils/bmad-doc-template.md +327 -0
  92. package/expansion-packs/bmad-godot-game-dev/utils/workflow-management.md +71 -0
  93. package/expansion-packs/bmad-godot-game-dev/workflows/game-dev-greenfield.yaml +245 -0
  94. package/expansion-packs/bmad-godot-game-dev/workflows/game-prototype.yaml +213 -0
  95. package/package.json +1 -1
  96. package/release_notes.md +19 -2
  97. package/tools/flattener/ignoreRules.js +2 -0
  98. package/tools/installer/bin/bmad.js +37 -1
  99. package/tools/installer/config/install.config.yaml +35 -7
  100. package/tools/installer/lib/ide-setup.js +285 -80
  101. package/tools/installer/lib/installer.js +6 -1
  102. package/tools/installer/package.json +1 -1
  103. package/tools/upgraders/v3-to-v4-upgrader.js +1 -0
  104. package/test.md +0 -1
  105. /package/{implement-fork-friendly-ci.sh → tools/implement-fork-friendly-ci.sh} +0 -0
@@ -0,0 +1,811 @@
1
+ # BMad Knowledge Base - Godot Game Development
2
+
3
+ ## Overview
4
+
5
+ This is the game development expansion of BMad-Method (Breakthrough Method of Agile AI-driven Development), specializing in creating 2D and 3D games using Godot Engine with GDScript and C#. The system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments, specifically optimized for Godot game development workflows.
6
+
7
+ ### Key Features for Game Development
8
+
9
+ - **Game-Specialized Agent System**: AI agents for each game development role (Designer, Developer, Scrum Master, QA)
10
+ - **Godot-Optimized Build System**: Automated dependency resolution for game assets and scenes
11
+ - **Dual Environment Support**: Optimized for both web UIs and game development IDEs
12
+ - **Game Development Resources**: Specialized templates, tasks, and checklists for Godot games
13
+ - **Performance-First Approach**: Built-in optimization patterns for cross-platform game deployment (60+ FPS target)
14
+ - **TDD Enforcement**: Test-driven development with GUT (GDScript) and GoDotTest (C#)
15
+
16
+ ### Game Development Focus
17
+
18
+ - **Target Engine**: Godot 4.x (or 3.x LTS) with GDScript and C#/.NET support
19
+ - **Platform Strategy**: Cross-platform (Desktop, Mobile, Web, Console) with 2D/3D support
20
+ - **Development Approach**: Agile story-driven development with TDD and performance focus
21
+ - **Performance Target**: 60+ FPS minimum on target devices (following Carmack's principles)
22
+ - **Architecture**: Node-based architecture using Godot's scene system and signals
23
+ - **Language Strategy**: GDScript for rapid iteration, C# for performance-critical systems
24
+
25
+ ### When to Use BMad for Game Development
26
+
27
+ - **New Game Projects (Greenfield)**: Complete end-to-end game development from concept to deployment
28
+ - **Existing Game Projects (Brownfield)**: Feature additions, level expansions, and gameplay enhancements
29
+ - **Game Team Collaboration**: Multiple specialized roles working together on game features
30
+ - **Game Quality Assurance**: Structured testing with TDD, performance validation, and gameplay balance
31
+ - **Game Documentation**: Professional Game Design Documents, technical architecture, user stories
32
+
33
+ ## How BMad Works for Game Development
34
+
35
+ ### The Core Method
36
+
37
+ BMad transforms you into a "Player Experience CEO" - directing a team of specialized game development AI agents through structured workflows. Here's how:
38
+
39
+ 1. **You Direct, AI Executes**: You provide game vision and creative decisions; agents handle implementation details
40
+ 2. **Specialized Game Agents**: Each agent masters one game development role (Designer, Developer, Scrum Master, QA)
41
+ 3. **Game-Focused Workflows**: Proven patterns guide you from game concept to deployed Godot game
42
+ 4. **Clean Handoffs**: Fresh context windows ensure agents stay focused and effective for game development
43
+
44
+ ### The Two-Phase Game Development Approach
45
+
46
+ #### Phase 1: Game Design & Planning (Web UI - Cost Effective)
47
+
48
+ - Use large context windows for comprehensive game design
49
+ - Generate complete Game Design Documents and technical architecture
50
+ - Leverage multiple agents for creative brainstorming and mechanics refinement
51
+ - Create once, use throughout game development
52
+
53
+ #### Phase 2: Game Development (IDE - Implementation)
54
+
55
+ - Shard game design documents into manageable pieces
56
+ - Execute focused SM → Dev cycles for game features
57
+ - One game story at a time, sequential progress
58
+ - Real-time Godot operations, GDScript/C# coding, and game testing
59
+
60
+ ### The Game Development Loop
61
+
62
+ ```text
63
+ 1. Game SM Agent (New Chat) → Creates next game story from sharded docs
64
+ 2. You → Review and approve game story
65
+ 3. Game Dev Agent (New Chat) → Implements approved game feature in Godot (TDD-first)
66
+ 4. QA Agent (New Chat) → Reviews code, enforces TDD, validates performance
67
+ 5. You → Verify game feature completion and 60+ FPS
68
+ 6. Repeat until game epic complete
69
+ ```
70
+
71
+ ### Why This Works for Games
72
+
73
+ - **Context Optimization**: Clean chats = better AI performance for complex game logic
74
+ - **Role Clarity**: Agents don't context-switch = higher quality game features
75
+ - **Incremental Progress**: Small game stories = manageable complexity
76
+ - **Player-Focused Oversight**: You validate each game feature = quality control
77
+ - **Design-Driven**: Game specs guide everything = consistent player experience
78
+ - **Performance-First**: Every decision validated against 60+ FPS target
79
+
80
+ ### Core Game Development Philosophy
81
+
82
+ #### Player-First Development
83
+
84
+ You are developing games as a "Player Experience CEO" - thinking like a game director with unlimited creative resources and a singular vision for player enjoyment.
85
+
86
+ #### Game Development Principles
87
+
88
+ 1. **MAXIMIZE_PLAYER_ENGAGEMENT**: Push the AI to create compelling gameplay. Challenge mechanics and iterate.
89
+ 2. **PERFORMANCE_IS_KING**: 60+ FPS is the minimum, not the target. Profile everything.
90
+ 3. **TDD_MANDATORY**: Tests written first, no exceptions. GUT for GDScript, GoDotTest for C#.
91
+ 4. **GAMEPLAY_QUALITY_CONTROL**: You are the ultimate arbiter of fun. Review all game features.
92
+ 5. **CREATIVE_OVERSIGHT**: Maintain the high-level game vision and ensure design alignment.
93
+ 6. **ITERATIVE_REFINEMENT**: Expect to revisit game mechanics. Game development is not linear.
94
+ 7. **CLEAR_GAME_INSTRUCTIONS**: Precise game requirements lead to better implementations.
95
+ 8. **DOCUMENTATION_IS_KEY**: Good game design docs lead to good game features.
96
+ 9. **START_SMALL_SCALE_FAST**: Test core mechanics, then expand and polish.
97
+ 10. **EMBRACE_CREATIVE_CHAOS**: Adapt and overcome game development challenges.
98
+
99
+ ## Getting Started with Game Development
100
+
101
+ ### Quick Start Options for Game Development
102
+
103
+ #### Option 1: Web UI for Game Design
104
+
105
+ **Best for**: Game designers who want to start with comprehensive planning
106
+
107
+ 1. Navigate to `dist/teams/` (after building)
108
+ 2. Copy `godot-game-team.txt` content
109
+ 3. Create new Gemini Gem or CustomGPT
110
+ 4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
111
+ 5. Type `/help` to see available game development commands
112
+
113
+ #### Option 2: IDE Integration for Game Development
114
+
115
+ **Best for**: Godot developers using Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot
116
+
117
+ ```bash
118
+ # Interactive installation (recommended)
119
+ npx bmad-method install
120
+ # Select the bmad-godot-game-dev expansion pack when prompted
121
+ ```
122
+
123
+ **Installation Steps for Game Development**:
124
+
125
+ - Choose "Install expansion pack" when prompted
126
+ - Select "bmad-godot-game-dev" from the list
127
+ - Select your IDE from supported options:
128
+ - **Cursor**: Native AI integration with Godot support
129
+ - **Claude Code**: Anthropic's official IDE
130
+ - **Windsurf**: Built-in AI capabilities
131
+ - **Trae**: Built-in AI capabilities
132
+ - **Cline**: VS Code extension with AI features
133
+ - **Roo Code**: Web-based IDE with agent support
134
+ - **GitHub Copilot**: VS Code extension with AI peer programming assistant
135
+
136
+ **Verify Game Development Installation**:
137
+
138
+ - `.bmad-core/` folder created with all core agents
139
+ - `.bmad-godot-game-dev/` folder with game development agents
140
+ - IDE-specific integration files created
141
+ - Game development agents available with `/BmadG` prefix
142
+
143
+ ### Environment Selection Guide for Game Development
144
+
145
+ **Use Web UI for**:
146
+
147
+ - Game design document creation and brainstorming
148
+ - Cost-effective comprehensive game planning (especially with Gemini)
149
+ - Multi-agent game design consultation
150
+ - Creative ideation and mechanics refinement
151
+
152
+ **Use IDE for**:
153
+
154
+ - Godot project development and GDScript/C# coding
155
+ - Scene operations and node hierarchy management
156
+ - Game story management and implementation workflow
157
+ - Godot testing with GUT/GoDotTest, profiling, and debugging
158
+
159
+ **Cost-Saving Tip for Game Development**: Create large game design documents in web UI, then copy to `docs/game-design-doc.md` and `docs/architecture.md` in your Godot project before switching to IDE for development.
160
+
161
+ ### IDE-Only Game Development Workflow Considerations
162
+
163
+ **Can you do everything in IDE?** Yes, but understand the game development tradeoffs:
164
+
165
+ **Pros of IDE-Only Game Development**:
166
+
167
+ - Single environment workflow from design to Godot deployment
168
+ - Direct Godot project operations from start
169
+ - No copy/paste between environments
170
+ - Immediate Godot project integration
171
+
172
+ **Cons of IDE-Only Game Development**:
173
+
174
+ - Higher token costs for large game design document creation
175
+ - Smaller context windows for comprehensive game planning
176
+ - May hit limits during creative brainstorming phases
177
+ - Less cost-effective for extensive game design iteration
178
+ - **Note**: Gemini CLI with Gemini Pro's 1m context window, for the planning phase, makes IDE-Only Game Development feasible
179
+
180
+ **CRITICAL RULE for Game Development**:
181
+
182
+ - **ALWAYS use Game SM agent for story creation** - Never use bmad-master or bmad-orchestrator
183
+ - **ALWAYS use Game Dev agent for Godot implementation** - Never use bmad-master or bmad-orchestrator
184
+ - **Why this matters**: Game SM and Game Dev agents are specifically optimized for Godot workflows
185
+ - **No exceptions**: Even if using bmad-master for design, switch to Game SM → Game Dev for implementation
186
+
187
+ ## Core Configuration for Game Development (core-config.yaml)
188
+
189
+ **New in V4**: The `expansion-packs/bmad-godot-game-dev/core-config.yaml` file enables BMad to work seamlessly with any Godot project structure, providing maximum flexibility for game development.
190
+
191
+ ### Game Development Configuration
192
+
193
+ The expansion pack follows the standard BMad configuration patterns. Copy your core-config.yaml file to expansion-packs/bmad-godot-game-dev/ and add Game-specific configurations to your project's `core-config.yaml`:
194
+
195
+ ```yaml
196
+ markdownExploder: true
197
+ prd:
198
+ prdFile: docs/prd.md
199
+ prdVersion: v4
200
+ prdSharded: true
201
+ prdShardedLocation: docs/prd
202
+ epicFilePattern: epic-{n}*.md
203
+ architecture:
204
+ architectureFile: docs/architecture.md
205
+ architectureVersion: v4
206
+ architectureSharded: true
207
+ architectureShardedLocation: docs/architecture
208
+ gdd:
209
+ gddVersion: v4
210
+ gddSharded: true
211
+ gddLocation: docs/game-design-doc.md
212
+ gddShardedLocation: docs/gdd
213
+ epicFilePattern: epic-{n}*.md
214
+ gamearchitecture:
215
+ gamearchitectureFile: docs/architecture.md
216
+ gamearchitectureVersion: v3
217
+ gamearchitectureLocation: docs/architecture.md
218
+ gamearchitectureSharded: true
219
+ gamearchitectureShardedLocation: docs/architecture
220
+ gamebriefdocLocation: docs/game-brief.md
221
+ levelDesignLocation: docs/level-design.md
222
+ # Specify Godot executable location if needed
223
+ godotExecutablePath: /Applications/Godot.app/Contents/MacOS/Godot
224
+ customTechnicalDocuments: null
225
+ devDebugLog: .ai/debug-log.md
226
+ devStoryLocation: docs/stories
227
+ slashPrefix: BmadG
228
+ # Sharded architecture files for developer reference
229
+ devLoadAlwaysFiles:
230
+ - docs/architecture/9-coding-standards.md
231
+ - docs/architecture/3-tech-stack.md
232
+ - docs/architecture/8-godot-project-structure.md
233
+ ```
234
+
235
+ ## Complete Game Development Workflow
236
+
237
+ ### Planning Phase (Web UI Recommended - Especially Gemini for Game Design!)
238
+
239
+ **Ideal for cost efficiency with Gemini's massive context for game brainstorming:**
240
+
241
+ **For All Game Projects**:
242
+
243
+ 1. **Game Concept Brainstorming**: `/bmadg/game-designer` - Use `*game-design-brainstorming` task
244
+ 2. **Game Brief**: Create foundation game document using `game-brief-tmpl`
245
+ 3. **Game Design Document Creation**: `/bmadg/game-designer` - Use `game-design-doc-tmpl` for comprehensive game requirements
246
+ 4. **Game Architecture Design**: `/bmadg/game-architect` - Use `game-architecture-tmpl` for Godot technical foundation
247
+ 5. **Level Design Framework**: `/bmadg/game-designer` - Use `level-design-doc-tmpl` for level structure planning
248
+ 6. **Document Preparation**: Copy final documents to Godot project as `docs/game-design-doc.md`, `docs/game-brief.md`, `docs/level-design.md` and `docs/architecture.md`
249
+
250
+ #### Example Game Planning Prompts
251
+
252
+ **For Game Design Document Creation**:
253
+
254
+ ```text
255
+ "I want to build a [genre] 2D game in Godot that [core gameplay].
256
+ Help me brainstorm mechanics and create a comprehensive Game Design Document."
257
+ ```
258
+
259
+ **For Game Architecture Design**:
260
+
261
+ ```text
262
+ "Based on this Game Design Document, design a scalable Godot architecture
263
+ that can handle [specific game requirements] with 60+ FPS performance.
264
+ Consider both GDScript and C# for appropriate systems."
265
+ ```
266
+
267
+ ### Critical Transition: Web UI to Godot IDE
268
+
269
+ **Once game planning is complete, you MUST switch to IDE for Godot development:**
270
+
271
+ - **Why**: Godot development workflow requires scene operations, GDScript/C# coding, and real-time testing
272
+ - **Cost Benefit**: Web UI is more cost-effective for large game design creation; IDE is optimized for Godot development
273
+ - **Required Files**: Ensure `docs/game-design-doc.md` and `docs/architecture.md` exist in your Godot project
274
+
275
+ ### Godot IDE Development Workflow
276
+
277
+ **Prerequisites**: Game planning documents must exist in `docs/` folder of Godot project
278
+
279
+ 1. **Document Sharding** (CRITICAL STEP for Game Development):
280
+ - Documents created by Game Designer/Architect (in Web or IDE) MUST be sharded for development
281
+ - Use core BMad agents or tools to shard:
282
+ a) **Manual**: Use core BMad `shard-doc` task if available
283
+ b) **Agent**: Ask core `@bmad-master` agent to shard documents
284
+ - Shards `docs/game-design-doc.md` → `docs/game-design/` folder
285
+ - Shards `docs/architecture.md` → `docs/architecture/` folder
286
+ - **WARNING**: Do NOT shard in Web UI - copying many small files to Godot is painful!
287
+
288
+ 2. **Verify Sharded Game Content**:
289
+ - At least one `feature-n.md` file in `docs/game-design/` with game stories in development order
290
+ - Godot system documents and coding standards for game dev agent reference
291
+ - Sharded docs for Game SM agent story creation
292
+
293
+ Resulting Godot Project Folder Structure:
294
+
295
+ - `docs/game-design/` - Broken down game design sections
296
+ - `docs/architecture/` - Broken down Godot architecture sections
297
+ - `docs/game-stories/` - Generated game development stories
298
+
299
+ 3. **Game Development Cycle** (Sequential, one game story at a time):
300
+
301
+ **CRITICAL CONTEXT MANAGEMENT for Godot Development**:
302
+ - **Context windows matter!** Always use fresh, clean context windows
303
+ - **Model selection matters!** Use most powerful thinking model for Game SM story creation
304
+ - **ALWAYS start new chat between Game SM, Game Dev, and QA work**
305
+
306
+ **Step 1 - Game Story Creation**:
307
+ - **NEW CLEAN CHAT** → Select powerful model → `/bmadgd/game-sm` → `*draft`
308
+ - Game SM executes create-game-story task using `game-story-tmpl`
309
+ - Review generated story in `docs/game-stories/`
310
+ - _Optional_ - Use `/bmadg/game-po` -> `*validate-story-draft (story)` to confirm alignment
311
+ - Update status from "Draft" to "Approved"
312
+
313
+ **Step 2 - Godot Game Story Implementation (TDD)**:
314
+ - **NEW CLEAN CHAT** → `/bmadg/game-developer`
315
+ - Agent asks which game story to implement
316
+ - Include story file content to save game dev agent lookup time
317
+ - **CRITICAL**: Game Dev writes tests FIRST (GUT/GoDotTest)
318
+ - Game Dev implements to make tests pass
319
+ - Game Dev maintains File List of all Godot/GDScript/C# changes
320
+ - Game Dev validates 60+ FPS performance
321
+ - Game Dev marks story as "Ready for Review" when complete with all tests passing
322
+
323
+ **Step 3 - Game QA Review**:
324
+ - **NEW CLEAN CHAT** → `/bmadg/game-qa` → execute review-story task
325
+ - QA enforces TDD compliance (tests written first)
326
+ - QA validates 60+ FPS performance
327
+ - QA can refactor and improve Godot code directly
328
+ - QA appends results to story's QA Results section
329
+ - If approved: Status → "Done"
330
+ - If changes needed: Status stays "Review" with unchecked items for game dev
331
+
332
+ **Step 4 - Repeat**: Continue Game SM → Game Dev → QA cycle until all game feature stories complete
333
+
334
+ **Important**: Only 1 game story in progress at a time, worked sequentially until all game feature stories complete.
335
+
336
+ ### Game Story Status Tracking Workflow
337
+
338
+ Game stories progress through defined statuses:
339
+
340
+ - **Draft** → **Approved** → **InProgress** → **Ready for Review** → **Done**
341
+
342
+ Each status change requires user verification and approval before proceeding.
343
+
344
+ ### Game Development Workflow Types
345
+
346
+ #### Greenfield Game Development
347
+
348
+ - Game concept brainstorming and mechanics design
349
+ - Game design requirements and feature definition
350
+ - Godot system architecture and technical design
351
+ - Game development execution with TDD
352
+ - Game testing, performance optimization (60+ FPS), and deployment
353
+
354
+ #### Brownfield Game Enhancement (Existing Godot Projects)
355
+
356
+ **Key Concept**: Brownfield game development requires comprehensive documentation of your existing Godot project for AI agents to understand game mechanics, node patterns, and technical constraints.
357
+
358
+ **Brownfield Game Enhancement Workflow**:
359
+
360
+ 1. **Upload Godot project to Web UI** (GitHub URL, files, or zip)
361
+ 2. **Create adapted Game Design Document**: `/bmadg/game-designer` - Modify `game-design-doc-tmpl` to include:
362
+ - Analysis of existing scene structure
363
+ - Integration points for new features
364
+ - Save game compatibility requirements
365
+ - Risk assessment for changes
366
+
367
+ 3. **Game Architecture Planning**:
368
+ - Use `/bmadg/game-architect` with `game-architecture-tmpl`
369
+ - Focus on how new features integrate with existing Godot systems
370
+ - Plan for gradual rollout and testing
371
+
372
+ 4. **Story Creation for Enhancements**:
373
+ - Use `/bmadg/game-sm` with `*create-game-story`
374
+ - Stories should explicitly reference existing scenes/scripts to modify
375
+ - Include integration testing requirements
376
+
377
+ **Critical Success Factors for Game Development**:
378
+
379
+ 1. **Game Documentation First**: Always document existing code thoroughly before making changes
380
+ 2. **Godot Context Matters**: Provide agents access to relevant scenes and scripts
381
+ 3. **Gameplay Integration Focus**: Emphasize compatibility and non-breaking changes to game mechanics
382
+ 4. **Incremental Approach**: Plan for gradual rollout and extensive game testing
383
+ 5. **Performance Validation**: Every change must maintain 60+ FPS
384
+
385
+ ## Document Creation Best Practices for Game Development
386
+
387
+ ### Required File Naming for Game Framework Integration
388
+
389
+ - `docs/game-design-doc.md` - Game Design Document
390
+ - `docs/architecture.md` - Godot System Architecture Document
391
+
392
+ **Why These Names Matter for Game Development**:
393
+
394
+ - Game agents automatically reference these files during Godot development
395
+ - Game sharding tasks expect these specific filenames
396
+ - Game workflow automation depends on standard naming
397
+
398
+ ### Cost-Effective Game Document Creation Workflow
399
+
400
+ **Recommended for Large Game Documents (Game Design Document, Game Architecture):**
401
+
402
+ 1. **Use Web UI**: Create game documents in web interface for cost efficiency
403
+ 2. **Copy Final Output**: Save complete markdown to your Godot project
404
+ 3. **Standard Names**: Save as `docs/game-design-doc.md` and `docs/architecture.md`
405
+ 4. **Switch to Godot IDE**: Use IDE agents for Godot development and smaller game documents
406
+
407
+ ### Game Document Sharding
408
+
409
+ Game templates with Level 2 headings (`##`) can be automatically sharded:
410
+
411
+ **Original Game Design Document**:
412
+
413
+ ```markdown
414
+ ## Core Gameplay Mechanics
415
+
416
+ ## Player Progression System
417
+
418
+ ## Level Design Framework
419
+
420
+ ## Technical Requirements
421
+ ```
422
+
423
+ **After Sharding**:
424
+
425
+ - `docs/game-design/core-gameplay-mechanics.md`
426
+ - `docs/game-design/player-progression-system.md`
427
+ - `docs/game-design/level-design-framework.md`
428
+ - `docs/game-design/technical-requirements.md`
429
+
430
+ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic game document sharding.
431
+
432
+ ## Game Agent System
433
+
434
+ ### Core Game Development Team
435
+
436
+ | Agent | Role | Primary Functions | When to Use |
437
+ | ---------------- | ---------------------- | ------------------------------------------------ | -------------------------------------------- |
438
+ | `game-designer` | Game Designer | Game mechanics, creative design, GDD | Game concept, mechanics, creative direction |
439
+ | `game-developer` | Godot Developer | GDScript/C# implementation, TDD, optimization | All Godot development tasks (tests first!) |
440
+ | `game-sm` | Game Scrum Master | Game story creation, sprint planning | Game project management, workflow |
441
+ | `game-architect` | Game Architect | Godot system design, performance architecture | Complex Godot systems, 60+ FPS planning |
442
+ | `game-qa` | Game QA & TDD Enforcer | TDD enforcement, performance validation, testing | Code review, test verification, optimization |
443
+
444
+ ### Game Agent Interaction Commands
445
+
446
+ #### IDE-Specific Syntax for Game Development
447
+
448
+ **Game Agent Loading by IDE**:
449
+
450
+ - **Claude Code**: `/bmadg/game-designer`, `/bmadg/game-developer`, `/bmadg/game-sm`, `/bmadg/game-architect`, `/bmadg/game-qa`
451
+ - **Cursor**: `@bmadg/game-designer`, `@bmadg/game-developer`, `@bmadg/game-sm`, `@bmadg/game-architect`, `@bmadg/game-qa`
452
+ - **Windsurf**: `/bmadg/game-designer`, `/bmadg/game-developer`, `/bmadg/game-sm`, `/bmadg/game-architect`, `/bmadg/game-qa`
453
+ - **Trae**: `@bmadg/game-designer`, `@bmadg/game-developer`, `@bmadg/game-sm`, `@bmadg/game-architect`, `@bmadg/game-qa`
454
+ - **Roo Code**: Select mode from mode selector with bmadg prefix
455
+ - **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select the appropriate game agent
456
+
457
+ **Common Game Development Task Commands**:
458
+
459
+ - `*help` - Show available game development commands
460
+ - `*status` - Show current game development context/progress
461
+ - `*exit` - Exit the game agent mode
462
+ - `*game-design-brainstorming` - Brainstorm game concepts and mechanics (Game Designer)
463
+ - `*draft` - Create next game development story (Game SM agent)
464
+ - `*review {story}` - Review story with TDD enforcement (Game QA agent)
465
+ - `*enforce-tdd {story}` - Verify tests written first (Game QA agent)
466
+ - `*correct-course-game` - Course correction for game development issues
467
+ - `*advanced-elicitation` - Deep dive into game requirements
468
+
469
+ ## Game-Specific Development Guidelines
470
+
471
+ ### Godot + GDScript/C# Standards
472
+
473
+ **Project Structure**:
474
+
475
+ ```text
476
+ GodotProject/
477
+ ├── .godot/ # Godot cache (gitignore)
478
+ ├── scenes/ # Game scenes
479
+ │ ├── main/ # Main game scenes
480
+ │ ├── ui/ # UI scenes
481
+ │ ├── levels/ # Level scenes
482
+ │ └── components/ # Reusable scene components
483
+ ├── scripts/ # GDScript and C# scripts
484
+ │ ├── player/ # Player-related scripts
485
+ │ ├── enemies/ # Enemy scripts
486
+ │ ├── systems/ # Game systems
487
+ │ ├── ui/ # UI scripts
488
+ │ └── utils/ # Utility scripts
489
+ ├── resources/ # Custom Resources
490
+ │ ├── items/ # Item definitions
491
+ │ ├── stats/ # Stat Resources
492
+ │ └── settings/ # Game settings
493
+ ├── assets/ # Art and audio assets
494
+ │ ├── sprites/ # 2D sprites
495
+ │ ├── models/ # 3D models (if 3D)
496
+ │ ├── audio/ # Sound effects and music
497
+ │ └── fonts/ # Font files
498
+ ├── tests/ # Test suites
499
+ │ ├── unit/ # GUT unit tests
500
+ │ └── integration/ # Integration tests
501
+ ├── addons/ # Godot plugins
502
+ │ ├── gut/ # GUT testing framework
503
+ │ └── godottest/ # GoDotTest for C#
504
+ ├── export_presets.cfg # Export configurations
505
+ └── project.godot # Project settings
506
+ ```
507
+
508
+ **Performance Requirements**:
509
+
510
+ - Maintain 60+ FPS minimum on target devices (Carmack's principle)
511
+ - Frame time under 16.67ms consistently
512
+ - Memory usage under platform-specific limits
513
+ - Loading times under 3 seconds for scenes
514
+ - Input latency under 50ms
515
+
516
+ **Code Quality**:
517
+
518
+ - GDScript with static typing enforced
519
+ - C# for performance-critical systems
520
+ - Node-based architecture (composition over inheritance)
521
+ - Signal-based communication between systems
522
+ - Resource-driven data management
523
+ - TDD with 80% minimum test coverage
524
+
525
+ ### Game Development Story Structure
526
+
527
+ **Story Requirements**:
528
+
529
+ - Clear reference to Game Design Document section
530
+ - Specific acceptance criteria for game functionality
531
+ - Technical implementation details for Godot
532
+ - Performance requirements (60+ FPS validation)
533
+ - Testing requirements (tests written FIRST)
534
+ - Language selection justification (GDScript vs C#)
535
+
536
+ **Story Categories**:
537
+
538
+ - **Core Mechanics**: Fundamental gameplay systems
539
+ - **Scene Content**: Individual scenes and level implementation
540
+ - **UI/UX**: Control nodes and player experience features
541
+ - **Performance**: Optimization and technical improvements
542
+ - **Polish**: Visual effects, audio, and game feel enhancements
543
+
544
+ ### Quality Assurance for Games
545
+
546
+ **Testing Approach (TDD Mandatory)**:
547
+
548
+ - Unit tests written FIRST (GUT for GDScript)
549
+ - Integration tests for scene interactions (GoDotTest for C#)
550
+ - Performance benchmarking with Godot profiler
551
+ - Gameplay testing and balance validation
552
+ - Cross-platform compatibility testing
553
+ - 80% minimum test coverage
554
+
555
+ **Performance Monitoring**:
556
+
557
+ - Frame rate consistency tracking (60+ FPS)
558
+ - Draw call optimization
559
+ - Memory usage monitoring
560
+ - Scene loading performance
561
+ - Input responsiveness validation
562
+ - Battery usage optimization (mobile)
563
+
564
+ ## Usage Patterns and Best Practices for Game Development
565
+
566
+ ### Environment-Specific Usage for Games
567
+
568
+ **Web UI Best For Game Development**:
569
+
570
+ - Initial game design and creative brainstorming phases
571
+ - Cost-effective large game document creation
572
+ - Game agent consultation and mechanics refinement
573
+ - Multi-agent game workflows with orchestrator
574
+
575
+ **Godot IDE Best For Game Development**:
576
+
577
+ - Active Godot development with TDD
578
+ - Scene and node hierarchy management
579
+ - Game story management and development cycles
580
+ - Performance profiling and optimization
581
+ - GUT/GoDotTest execution
582
+
583
+ ### Quality Assurance for Game Development
584
+
585
+ - Use appropriate game agents for specialized tasks
586
+ - Follow Agile ceremonies and game review processes
587
+ - Use game-specific checklists:
588
+ - `game-architect-checklist` for architecture reviews
589
+ - `game-change-checklist` for change validation
590
+ - `game-design-checklist` for design reviews
591
+ - `game-story-dod-checklist` for story quality (TDD compliance)
592
+ - `game-po-checklist` for product owner validation
593
+ - Regular validation with game templates
594
+
595
+ ### Performance Optimization for Game Development
596
+
597
+ - Use specific game agents vs. `bmad-master` for focused Godot tasks
598
+ - Choose appropriate game team size for project needs
599
+ - Leverage game-specific technical preferences for consistency
600
+ - Regular context management and cache clearing for Godot workflows
601
+ - Profile everything, optimize based on data (Carmack's philosophy)
602
+
603
+ ## Game Development Team Roles
604
+
605
+ ### Game Designer
606
+
607
+ - **Primary Focus**: Game mechanics, player experience, design documentation
608
+ - **Key Outputs**: Game Brief, Game Design Document, Level Design Framework
609
+ - **Specialties**: Brainstorming, game balance, player psychology, creative direction
610
+
611
+ ### Game Developer
612
+
613
+ - **Primary Focus**: Godot implementation with TDD, GDScript/C# excellence, 60+ FPS optimization
614
+ - **Key Outputs**: Working game features with tests, optimized Godot code, performance validation
615
+ - **Specialties**: TDD practices, GDScript/C#, node architecture, cross-platform development
616
+
617
+ ### Game Scrum Master
618
+
619
+ - **Primary Focus**: Game story creation, development planning, agile process
620
+ - **Key Outputs**: Detailed implementation stories, sprint planning, quality assurance
621
+ - **Specialties**: Story breakdown, developer handoffs, process optimization
622
+
623
+ ### Game Architect
624
+
625
+ - **Primary Focus**: Godot system design, performance architecture, language strategy
626
+ - **Key Outputs**: Technical architecture, performance budgets, optimization strategies
627
+ - **Specialties**: Node patterns, signal architecture, GDScript vs C# decisions, 60+ FPS planning
628
+
629
+ ### Game QA
630
+
631
+ - **Primary Focus**: TDD enforcement, test verification, performance validation
632
+ - **Key Outputs**: Test coverage reports, performance metrics, code quality assessment
633
+ - **Specialties**: GUT/GoDotTest frameworks, profiling, optimization validation
634
+
635
+ ## Platform-Specific Considerations
636
+
637
+ ### Cross-Platform Development
638
+
639
+ - Use InputMap for platform-agnostic input
640
+ - Export templates for each target platform
641
+ - Test on all target platforms regularly
642
+ - Optimize for different screen resolutions and aspect ratios
643
+ - Platform-specific performance targets
644
+
645
+ ### Mobile Optimization
646
+
647
+ - Touch input with TouchScreenButton nodes
648
+ - Battery usage optimization
649
+ - Performance scaling for different device capabilities
650
+ - App store compliance and export settings
651
+ - Reduced draw calls and texture memory
652
+
653
+ ### Performance Targets
654
+
655
+ - **Desktop**: 60+ FPS at native resolution (144 FPS for high-refresh displays)
656
+ - **Mobile**: 60 FPS on mid-range devices minimum
657
+ - **Web**: 60 FPS with optimized export settings
658
+ - **Loading**: Scene transitions under 2 seconds
659
+ - **Memory**: Within platform-specific limits
660
+
661
+ ## Success Metrics for Game Development
662
+
663
+ ### Technical Metrics
664
+
665
+ - Frame rate consistency (>95% of time at 60+ FPS)
666
+ - Frame time variance (<2ms variation)
667
+ - Memory usage within budgets
668
+ - Loading time targets met
669
+ - Zero critical bugs in core gameplay systems
670
+ - 80%+ test coverage (TDD compliance)
671
+
672
+ ### Player Experience Metrics
673
+
674
+ - Input latency under 50ms
675
+ - Tutorial completion rate >80%
676
+ - Level completion rates appropriate for difficulty curve
677
+ - Average session length meets design targets
678
+ - Player retention and engagement metrics
679
+
680
+ ### Development Process Metrics
681
+
682
+ - All stories have tests written FIRST
683
+ - Story completion within estimated timeframes
684
+ - Code quality metrics (test coverage, static analysis)
685
+ - Documentation completeness and accuracy
686
+ - Team velocity and delivery consistency
687
+
688
+ ## Common Godot Development Patterns
689
+
690
+ ### Scene Management
691
+
692
+ - Use scene inheritance for variant levels
693
+ - Autoload singletons for persistent systems
694
+ - Scene transitions with loading screens
695
+ - Resource preloading for smooth gameplay
696
+
697
+ ### Node Architecture
698
+
699
+ - Composition over inheritance with scene instances
700
+ - Signal-based communication between nodes
701
+ - Node groups for efficient queries
702
+ - Tool scripts for editor enhancement
703
+
704
+ ### Performance Patterns
705
+
706
+ - Object pooling for frequently spawned nodes
707
+ - MultiMesh for many identical objects
708
+ - LOD systems with visibility ranges
709
+ - Occlusion culling for complex scenes
710
+ - Static typing in GDScript for 10-20% performance gain
711
+
712
+ ### Language Strategy
713
+
714
+ - GDScript for:
715
+ - Rapid prototyping
716
+ - UI and menu systems
717
+ - Simple game logic
718
+ - Editor tools
719
+ - C# for:
720
+ - Complex algorithms
721
+ - Performance-critical systems
722
+ - Heavy computation
723
+ - External library integration
724
+
725
+ ## Success Tips for Game Development
726
+
727
+ - **Use Gemini for game design planning** - The team-game-dev bundle provides collaborative game expertise
728
+ - **Enforce TDD religiously** - Tests first, implementation second, no exceptions
729
+ - **Profile constantly** - Measure don't guess (Carmack's philosophy)
730
+ - **Follow the Game SM → Game Dev → QA cycle** - This ensures systematic game progress
731
+ - **Keep conversations focused** - One game agent, one Godot task per conversation
732
+ - **Review everything** - Always verify 60+ FPS before marking features complete
733
+ - **Use appropriate language** - GDScript for iteration, C# for performance
734
+
735
+ ## Contributing to BMad-Method Game Development
736
+
737
+ ### Game Development Contribution Guidelines
738
+
739
+ For full details, see `CONTRIBUTING.md`. Key points for game development:
740
+
741
+ **Fork Workflow for Game Development**:
742
+
743
+ 1. Fork the repository
744
+ 2. Create game development feature branches
745
+ 3. Submit PRs to `next` branch (default) or `main` for critical game development fixes only
746
+ 4. Keep PRs small: 200-400 lines ideal, 800 lines maximum
747
+ 5. One game feature/fix per PR
748
+
749
+ **Game Development PR Requirements**:
750
+
751
+ - Clear descriptions (max 200 words) with What/Why/How/Testing for game features
752
+ - Use conventional commits (feat:, fix:, docs:) with game context
753
+ - Atomic commits - one logical game change per commit
754
+ - Must align with game development guiding principles
755
+ - Include performance impact assessment
756
+
757
+ **Game Development Core Principles**:
758
+
759
+ - **Game Dev Agents Must Be Lean**: Minimize dependencies, save context for Godot code
760
+ - **Natural Language First**: Everything in markdown, no code in game development core
761
+ - **Core vs Game Expansion Packs**: Core for universal needs, game packs for Godot specialization
762
+ - **Game Design Philosophy**: "Game dev agents code Godot, game planning agents plan gameplay"
763
+ - **Performance First**: Every change validated against 60+ FPS target
764
+ - **TDD Mandatory**: Tests before implementation, always
765
+
766
+ ## Game Development Expansion Pack System
767
+
768
+ ### This Game Development Expansion Pack
769
+
770
+ This Godot Game Development expansion pack extends BMad-Method beyond traditional software development into professional game development. It provides specialized game agent teams, Godot templates, and game workflows while keeping the core framework lean and focused on general development.
771
+
772
+ ### Why Use This Game Development Expansion Pack?
773
+
774
+ 1. **Keep Core Lean**: Game dev agents maintain maximum context for Godot coding
775
+ 2. **Game Domain Expertise**: Deep, specialized Godot and game development knowledge
776
+ 3. **Community Game Innovation**: Game developers can contribute and share Godot patterns
777
+ 4. **Modular Game Design**: Install only game development capabilities you need
778
+ 5. **Performance Focus**: Built-in 60+ FPS validation and optimization patterns
779
+ 6. **TDD Enforcement**: Mandatory test-first development practices
780
+
781
+ ### Using This Game Development Expansion Pack
782
+
783
+ 1. **Install via CLI**:
784
+
785
+ ```bash
786
+ npx bmad-method install
787
+ # Select "Install game development expansion pack" option
788
+ ```
789
+
790
+ 2. **Use in Your Game Workflow**: Installed game agents integrate seamlessly with existing BMad agents
791
+
792
+ ### Creating Custom Game Development Extensions
793
+
794
+ Use the **expansion-creator** pack to build your own game development extensions:
795
+
796
+ 1. **Define Game Domain**: What game development expertise are you capturing?
797
+ 2. **Design Game Agents**: Create specialized game roles with clear Godot boundaries
798
+ 3. **Build Game Resources**: Tasks, templates, checklists for your game domain
799
+ 4. **Test & Share**: Validate with real Godot use cases, share with game development community
800
+
801
+ **Key Principle**: Game development expansion packs democratize game development expertise by making specialized Godot and game design knowledge accessible through AI agents.
802
+
803
+ ## Getting Help with Game Development
804
+
805
+ - **Commands**: Use `*/*help` in any environment to see available game development commands
806
+ - **Game Agent Switching**: Use `*/*switch game-agent-name` with orchestrator for role changes
807
+ - **Game Documentation**: Check `docs/` folder for Godot project-specific context
808
+ - **Game Community**: Discord and GitHub resources available for game development support
809
+ - **Game Contributing**: See `CONTRIBUTING.md` for full game development guidelines
810
+
811
+ This knowledge base provides the foundation for effective game development using the BMad-Method framework with specialized focus on Godot game creation using GDScript and C# with mandatory TDD practices and 60+ FPS performance targets.