bmad-method 4.37.0 → 4.39.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 (251) hide show
  1. package/.github/ISSUE_TEMPLATE/bug_report.md +3 -3
  2. package/.github/ISSUE_TEMPLATE/feature_request.md +3 -3
  3. package/.github/workflows/discord.yaml +11 -2
  4. package/.github/workflows/format-check.yaml +42 -0
  5. package/.github/workflows/manual-release.yaml +173 -0
  6. package/.husky/pre-commit +3 -0
  7. package/.vscode/settings.json +26 -1
  8. package/CHANGELOG.md +2 -23
  9. package/README.md +2 -0
  10. package/bmad-core/agent-teams/team-all.yaml +1 -1
  11. package/bmad-core/agents/analyst.md +16 -15
  12. package/bmad-core/agents/architect.md +11 -11
  13. package/bmad-core/agents/bmad-master.md +23 -22
  14. package/bmad-core/agents/bmad-orchestrator.md +13 -17
  15. package/bmad-core/agents/dev.md +14 -11
  16. package/bmad-core/agents/pm.md +15 -14
  17. package/bmad-core/agents/po.md +9 -8
  18. package/bmad-core/agents/qa.md +42 -22
  19. package/bmad-core/agents/sm.md +7 -6
  20. package/bmad-core/agents/ux-expert.md +6 -5
  21. package/bmad-core/core-config.yaml +2 -0
  22. package/bmad-core/data/bmad-kb.md +1 -1
  23. package/bmad-core/data/test-levels-framework.md +146 -0
  24. package/bmad-core/data/test-priorities-matrix.md +172 -0
  25. package/bmad-core/tasks/apply-qa-fixes.md +148 -0
  26. package/bmad-core/tasks/facilitate-brainstorming-session.md +1 -1
  27. package/bmad-core/tasks/nfr-assess.md +343 -0
  28. package/bmad-core/tasks/qa-gate.md +161 -0
  29. package/bmad-core/tasks/review-story.md +234 -74
  30. package/bmad-core/tasks/risk-profile.md +353 -0
  31. package/bmad-core/tasks/test-design.md +174 -0
  32. package/bmad-core/tasks/trace-requirements.md +264 -0
  33. package/bmad-core/templates/architecture-tmpl.yaml +49 -49
  34. package/bmad-core/templates/brainstorming-output-tmpl.yaml +5 -5
  35. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +31 -31
  36. package/bmad-core/templates/brownfield-prd-tmpl.yaml +13 -13
  37. package/bmad-core/templates/competitor-analysis-tmpl.yaml +19 -6
  38. package/bmad-core/templates/front-end-architecture-tmpl.yaml +21 -9
  39. package/bmad-core/templates/front-end-spec-tmpl.yaml +24 -24
  40. package/bmad-core/templates/fullstack-architecture-tmpl.yaml +122 -104
  41. package/bmad-core/templates/market-research-tmpl.yaml +2 -2
  42. package/bmad-core/templates/prd-tmpl.yaml +9 -9
  43. package/bmad-core/templates/project-brief-tmpl.yaml +4 -4
  44. package/bmad-core/templates/qa-gate-tmpl.yaml +102 -0
  45. package/bmad-core/templates/story-tmpl.yaml +12 -12
  46. package/bmad-core/workflows/brownfield-fullstack.yaml +9 -9
  47. package/bmad-core/workflows/brownfield-service.yaml +1 -1
  48. package/bmad-core/workflows/brownfield-ui.yaml +1 -1
  49. package/bmad-core/workflows/greenfield-fullstack.yaml +1 -1
  50. package/bmad-core/workflows/greenfield-service.yaml +1 -1
  51. package/bmad-core/workflows/greenfield-ui.yaml +1 -1
  52. package/common/utils/bmad-doc-template.md +5 -5
  53. package/dist/agents/analyst.txt +1086 -1079
  54. package/dist/agents/architect.txt +1534 -1526
  55. package/dist/agents/bmad-master.txt +646 -632
  56. package/dist/agents/bmad-orchestrator.txt +40 -18
  57. package/dist/agents/dev.txt +158 -19
  58. package/dist/agents/pm.txt +1082 -1107
  59. package/dist/agents/po.txt +314 -332
  60. package/dist/agents/qa.txt +1754 -151
  61. package/dist/agents/sm.txt +88 -98
  62. package/dist/agents/ux-expert.txt +80 -87
  63. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +109 -146
  64. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +75 -86
  65. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +41 -48
  66. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +1903 -1941
  67. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +15 -50
  68. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +149 -195
  69. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +0 -15
  70. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +20 -37
  71. package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +2660 -2752
  72. package/dist/expansion-packs/bmad-creative-writing/agents/beta-reader.txt +871 -0
  73. package/dist/expansion-packs/bmad-creative-writing/agents/book-critic.txt +78 -0
  74. package/dist/expansion-packs/bmad-creative-writing/agents/character-psychologist.txt +839 -0
  75. package/dist/expansion-packs/bmad-creative-writing/agents/cover-designer.txt +85 -0
  76. package/dist/expansion-packs/bmad-creative-writing/agents/dialog-specialist.txt +861 -0
  77. package/dist/expansion-packs/bmad-creative-writing/agents/editor.txt +796 -0
  78. package/dist/expansion-packs/bmad-creative-writing/agents/genre-specialist.txt +927 -0
  79. package/dist/expansion-packs/bmad-creative-writing/agents/narrative-designer.txt +842 -0
  80. package/dist/expansion-packs/bmad-creative-writing/agents/plot-architect.txt +1126 -0
  81. package/dist/expansion-packs/bmad-creative-writing/agents/world-builder.txt +864 -0
  82. package/dist/expansion-packs/bmad-creative-writing/teams/agent-team.txt +5917 -0
  83. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +25 -27
  84. package/dist/teams/team-all.txt +5541 -3768
  85. package/dist/teams/team-fullstack.txt +3014 -2987
  86. package/dist/teams/team-ide-minimal.txt +2219 -469
  87. package/dist/teams/team-no-ui.txt +2993 -2966
  88. package/docs/enhanced-ide-development-workflow.md +220 -15
  89. package/docs/user-guide.md +271 -18
  90. package/docs/versioning-and-releases.md +122 -44
  91. package/docs/working-in-the-brownfield.md +264 -31
  92. package/eslint.config.mjs +119 -0
  93. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +4 -4
  94. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +1 -1
  95. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
  96. package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +26 -28
  97. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +50 -50
  98. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +23 -23
  99. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +24 -24
  100. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +42 -42
  101. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +65 -65
  102. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +5 -5
  103. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +1 -1
  104. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +3 -3
  105. package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +1 -1
  106. package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +1 -1
  107. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +23 -23
  108. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +63 -63
  109. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +20 -20
  110. package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +65 -65
  111. package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-dev-greenfield.yaml +5 -5
  112. package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-prototype.yaml +1 -1
  113. package/expansion-packs/bmad-creative-writing/README.md +132 -0
  114. package/expansion-packs/bmad-creative-writing/agent-teams/agent-team.yaml +19 -0
  115. package/expansion-packs/bmad-creative-writing/agents/beta-reader.md +91 -0
  116. package/expansion-packs/bmad-creative-writing/agents/book-critic.md +35 -0
  117. package/expansion-packs/bmad-creative-writing/agents/character-psychologist.md +90 -0
  118. package/expansion-packs/bmad-creative-writing/agents/cover-designer.md +41 -0
  119. package/expansion-packs/bmad-creative-writing/agents/dialog-specialist.md +89 -0
  120. package/expansion-packs/bmad-creative-writing/agents/editor.md +90 -0
  121. package/expansion-packs/bmad-creative-writing/agents/genre-specialist.md +92 -0
  122. package/expansion-packs/bmad-creative-writing/agents/narrative-designer.md +90 -0
  123. package/expansion-packs/bmad-creative-writing/agents/plot-architect.md +92 -0
  124. package/expansion-packs/bmad-creative-writing/agents/world-builder.md +91 -0
  125. package/expansion-packs/bmad-creative-writing/checklists/beta-feedback-closure-checklist.md +16 -0
  126. package/expansion-packs/bmad-creative-writing/checklists/character-consistency-checklist.md +16 -0
  127. package/expansion-packs/bmad-creative-writing/checklists/comedic-timing-checklist.md +16 -0
  128. package/expansion-packs/bmad-creative-writing/checklists/cyberpunk-aesthetic-checklist.md +16 -0
  129. package/expansion-packs/bmad-creative-writing/checklists/ebook-formatting-checklist.md +15 -0
  130. package/expansion-packs/bmad-creative-writing/checklists/epic-poetry-meter-checklist.md +16 -0
  131. package/expansion-packs/bmad-creative-writing/checklists/fantasy-magic-system-checklist.md +16 -0
  132. package/expansion-packs/bmad-creative-writing/checklists/foreshadowing-payoff-checklist.md +15 -0
  133. package/expansion-packs/bmad-creative-writing/checklists/genre-tropes-checklist.md +15 -0
  134. package/expansion-packs/bmad-creative-writing/checklists/historical-accuracy-checklist.md +16 -0
  135. package/expansion-packs/bmad-creative-writing/checklists/horror-suspense-checklist.md +16 -0
  136. package/expansion-packs/bmad-creative-writing/checklists/kdp-cover-ready-checklist.md +18 -0
  137. package/expansion-packs/bmad-creative-writing/checklists/line-edit-quality-checklist.md +16 -0
  138. package/expansion-packs/bmad-creative-writing/checklists/marketing-copy-checklist.md +16 -0
  139. package/expansion-packs/bmad-creative-writing/checklists/mystery-clue-trail-checklist.md +16 -0
  140. package/expansion-packs/bmad-creative-writing/checklists/orbital-mechanics-checklist.md +16 -0
  141. package/expansion-packs/bmad-creative-writing/checklists/plot-structure-checklist.md +49 -0
  142. package/expansion-packs/bmad-creative-writing/checklists/publication-readiness-checklist.md +16 -0
  143. package/expansion-packs/bmad-creative-writing/checklists/romance-emotional-beats-checklist.md +16 -0
  144. package/expansion-packs/bmad-creative-writing/checklists/scene-quality-checklist.md +16 -0
  145. package/expansion-packs/bmad-creative-writing/checklists/scifi-technology-plausibility-checklist.md +15 -0
  146. package/expansion-packs/bmad-creative-writing/checklists/sensitivity-representation-checklist.md +16 -0
  147. package/expansion-packs/bmad-creative-writing/checklists/steampunk-gadget-checklist.md +16 -0
  148. package/expansion-packs/bmad-creative-writing/checklists/thriller-pacing-stakes-checklist.md +16 -0
  149. package/expansion-packs/bmad-creative-writing/checklists/timeline-continuity-checklist.md +16 -0
  150. package/expansion-packs/bmad-creative-writing/checklists/world-building-continuity-checklist.md +16 -0
  151. package/expansion-packs/bmad-creative-writing/checklists/ya-appropriateness-checklist.md +16 -0
  152. package/expansion-packs/bmad-creative-writing/config.yaml +11 -0
  153. package/expansion-packs/bmad-creative-writing/data/bmad-kb.md +197 -0
  154. package/expansion-packs/bmad-creative-writing/data/story-structures.md +58 -0
  155. package/expansion-packs/bmad-creative-writing/docs/brief.md +183 -0
  156. package/expansion-packs/bmad-creative-writing/tasks/advanced-elicitation.md +117 -0
  157. package/expansion-packs/bmad-creative-writing/tasks/analyze-reader-feedback.md +16 -0
  158. package/expansion-packs/bmad-creative-writing/tasks/analyze-story-structure.md +55 -0
  159. package/expansion-packs/bmad-creative-writing/tasks/assemble-kdp-package.md +22 -0
  160. package/expansion-packs/bmad-creative-writing/tasks/brainstorm-premise.md +16 -0
  161. package/expansion-packs/bmad-creative-writing/tasks/build-world.md +17 -0
  162. package/expansion-packs/bmad-creative-writing/tasks/character-depth-pass.md +15 -0
  163. package/expansion-packs/bmad-creative-writing/tasks/create-doc.md +101 -0
  164. package/expansion-packs/bmad-creative-writing/tasks/create-draft-section.md +19 -0
  165. package/expansion-packs/bmad-creative-writing/tasks/critical-review.md +19 -0
  166. package/expansion-packs/bmad-creative-writing/tasks/develop-character.md +17 -0
  167. package/expansion-packs/bmad-creative-writing/tasks/execute-checklist.md +93 -0
  168. package/expansion-packs/bmad-creative-writing/tasks/expand-premise.md +16 -0
  169. package/expansion-packs/bmad-creative-writing/tasks/expand-synopsis.md +16 -0
  170. package/expansion-packs/bmad-creative-writing/tasks/final-polish.md +16 -0
  171. package/expansion-packs/bmad-creative-writing/tasks/generate-cover-brief.md +18 -0
  172. package/expansion-packs/bmad-creative-writing/tasks/generate-cover-prompts.md +19 -0
  173. package/expansion-packs/bmad-creative-writing/tasks/generate-scene-list.md +16 -0
  174. package/expansion-packs/bmad-creative-writing/tasks/incorporate-feedback.md +18 -0
  175. package/expansion-packs/bmad-creative-writing/tasks/outline-scenes.md +16 -0
  176. package/expansion-packs/bmad-creative-writing/tasks/provide-feedback.md +17 -0
  177. package/expansion-packs/bmad-creative-writing/tasks/publish-chapter.md +16 -0
  178. package/expansion-packs/bmad-creative-writing/tasks/quick-feedback.md +15 -0
  179. package/expansion-packs/bmad-creative-writing/tasks/select-next-arc.md +16 -0
  180. package/expansion-packs/bmad-creative-writing/tasks/workshop-dialog.md +51 -0
  181. package/expansion-packs/bmad-creative-writing/templates/beta-feedback-form.yaml +96 -0
  182. package/expansion-packs/bmad-creative-writing/templates/chapter-draft-tmpl.yaml +81 -0
  183. package/expansion-packs/bmad-creative-writing/templates/character-profile-tmpl.yaml +92 -0
  184. package/expansion-packs/bmad-creative-writing/templates/cover-design-brief-tmpl.yaml +97 -0
  185. package/expansion-packs/bmad-creative-writing/templates/premise-brief-tmpl.yaml +77 -0
  186. package/expansion-packs/bmad-creative-writing/templates/scene-list-tmpl.yaml +54 -0
  187. package/expansion-packs/bmad-creative-writing/templates/story-outline-tmpl.yaml +96 -0
  188. package/expansion-packs/bmad-creative-writing/templates/world-guide-tmpl.yaml +88 -0
  189. package/expansion-packs/bmad-creative-writing/workflows/book-cover-design-workflow.md +176 -0
  190. package/expansion-packs/bmad-creative-writing/workflows/novel-greenfield-workflow.yaml +58 -0
  191. package/expansion-packs/bmad-creative-writing/workflows/novel-serial-workflow.yaml +51 -0
  192. package/expansion-packs/bmad-creative-writing/workflows/novel-snowflake-workflow.yaml +69 -0
  193. package/expansion-packs/bmad-creative-writing/workflows/novel-writing.yaml +92 -0
  194. package/expansion-packs/bmad-creative-writing/workflows/screenplay-development.yaml +86 -0
  195. package/expansion-packs/bmad-creative-writing/workflows/series-planning.yaml +79 -0
  196. package/expansion-packs/bmad-creative-writing/workflows/short-story-creation.yaml +65 -0
  197. package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
  198. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +20 -20
  199. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +7 -7
  200. package/package.json +62 -39
  201. package/prettier.config.mjs +32 -0
  202. package/sync-version.sh +23 -0
  203. package/tools/bmad-npx-wrapper.js +10 -10
  204. package/tools/builders/web-builder.js +124 -130
  205. package/tools/bump-all-versions.js +42 -33
  206. package/tools/bump-expansion-version.js +23 -16
  207. package/tools/cli.js +10 -12
  208. package/tools/flattener/aggregate.js +10 -10
  209. package/tools/flattener/binary.js +44 -17
  210. package/tools/flattener/discovery.js +19 -18
  211. package/tools/flattener/files.js +6 -6
  212. package/tools/flattener/ignoreRules.js +125 -125
  213. package/tools/flattener/main.js +426 -70
  214. package/tools/flattener/projectRoot.js +186 -25
  215. package/tools/flattener/prompts.js +9 -9
  216. package/tools/flattener/stats.helpers.js +395 -0
  217. package/tools/flattener/stats.js +64 -14
  218. package/tools/flattener/test-matrix.js +413 -0
  219. package/tools/flattener/xml.js +33 -31
  220. package/tools/installer/bin/bmad.js +156 -113
  221. package/tools/installer/config/ide-agent-config.yaml +1 -1
  222. package/tools/installer/config/install.config.yaml +13 -3
  223. package/tools/installer/lib/config-loader.js +46 -42
  224. package/tools/installer/lib/file-manager.js +91 -113
  225. package/tools/installer/lib/ide-base-setup.js +57 -56
  226. package/tools/installer/lib/ide-setup.js +545 -399
  227. package/tools/installer/lib/installer.js +875 -714
  228. package/tools/installer/lib/memory-profiler.js +54 -53
  229. package/tools/installer/lib/module-manager.js +19 -15
  230. package/tools/installer/lib/resource-locator.js +26 -28
  231. package/tools/installer/package.json +19 -19
  232. package/tools/lib/dependency-resolver.js +26 -30
  233. package/tools/lib/yaml-utils.js +7 -7
  234. package/tools/preview-release-notes.js +66 -0
  235. package/tools/shared/bannerArt.js +3 -3
  236. package/tools/sync-installer-version.js +7 -9
  237. package/tools/update-expansion-version.js +14 -15
  238. package/tools/upgraders/v3-to-v4-upgrader.js +203 -294
  239. package/tools/version-bump.js +41 -26
  240. package/tools/yaml-format.js +56 -43
  241. package/.github/workflows/release.yaml +0 -60
  242. package/.releaserc.json +0 -21
  243. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/Complete AI Agent System - Flowchart.svg +0 -102
  244. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.1 Google Cloud Project Setup/1.1.1 - Initial Project Configuration - bash copy.txt +0 -13
  245. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.1 Google Cloud Project Setup/1.1.1 - Initial Project Configuration - bash.txt +0 -13
  246. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.2 Agent Development Kit Installation/1.2.2 - Basic Project Structure - txt.txt +0 -25
  247. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.3 Core Configuration Files/1.3.1 - settings.py +0 -34
  248. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.3 Core Configuration Files/1.3.2 - main.py - Base Application.py +0 -70
  249. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.4 Deployment Configuration/1.4.2 - cloudbuild.yaml +0 -26
  250. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/README.md +0 -109
  251. package/tools/semantic-release-sync-installer.js +0 -30
@@ -14,7 +14,7 @@ sections:
14
14
  - id: initial-setup
15
15
  instruction: |
16
16
  This template creates a comprehensive game brief that serves as the foundation for all subsequent game development work. The brief should capture the essential vision, scope, and requirements needed to create a detailed Game Design Document.
17
-
17
+
18
18
  This brief is typically created early in the ideation process, often after brainstorming sessions, to crystallize the game concept before moving into detailed design.
19
19
 
20
20
  - id: game-vision
@@ -71,7 +71,7 @@ sections:
71
71
  repeatable: true
72
72
  template: |
73
73
  **Core Mechanic: {{mechanic_name}}**
74
-
74
+
75
75
  - **Description:** {{how_it_works}}
76
76
  - **Player Value:** {{why_its_fun}}
77
77
  - **Implementation Scope:** {{complexity_estimate}}
@@ -98,12 +98,12 @@ sections:
98
98
  title: Technical Constraints
99
99
  template: |
100
100
  **Platform Requirements:**
101
-
101
+
102
102
  - Primary: {{platform_1}} - {{requirements}}
103
103
  - Secondary: {{platform_2}} - {{requirements}}
104
-
104
+
105
105
  **Technical Specifications:**
106
-
106
+
107
107
  - Engine: Phaser 3 + TypeScript
108
108
  - Performance Target: {{fps_target}} FPS on {{target_device}}
109
109
  - Memory Budget: <{{memory_limit}}MB
@@ -141,10 +141,10 @@ sections:
141
141
  title: Competitive Analysis
142
142
  template: |
143
143
  **Direct Competitors:**
144
-
144
+
145
145
  - {{competitor_1}}: {{strengths_and_weaknesses}}
146
146
  - {{competitor_2}}: {{strengths_and_weaknesses}}
147
-
147
+
148
148
  **Differentiation Strategy:**
149
149
  {{how_we_differ_and_why_thats_valuable}}
150
150
  - id: market-opportunity
@@ -168,16 +168,16 @@ sections:
168
168
  title: Content Categories
169
169
  template: |
170
170
  **Core Content:**
171
-
171
+
172
172
  - {{content_type_1}}: {{quantity_and_description}}
173
173
  - {{content_type_2}}: {{quantity_and_description}}
174
-
174
+
175
175
  **Optional Content:**
176
-
176
+
177
177
  - {{optional_content_type}}: {{quantity_and_description}}
178
-
178
+
179
179
  **Replay Elements:**
180
-
180
+
181
181
  - {{replayability_features}}
182
182
  - id: difficulty-accessibility
183
183
  title: Difficulty and Accessibility
@@ -244,13 +244,13 @@ sections:
244
244
  title: Player Experience Metrics
245
245
  template: |
246
246
  **Engagement Goals:**
247
-
247
+
248
248
  - Tutorial completion rate: >{{percentage}}%
249
249
  - Average session length: {{duration}} minutes
250
250
  - Player retention: D1 {{d1}}%, D7 {{d7}}%, D30 {{d30}}%
251
-
251
+
252
252
  **Quality Benchmarks:**
253
-
253
+
254
254
  - Player satisfaction: >{{rating}}/10
255
255
  - Completion rate: >{{percentage}}%
256
256
  - Technical performance: {{fps_target}} FPS consistent
@@ -258,13 +258,13 @@ sections:
258
258
  title: Development Metrics
259
259
  template: |
260
260
  **Technical Targets:**
261
-
261
+
262
262
  - Zero critical bugs at launch
263
263
  - Performance targets met on all platforms
264
264
  - Load times under {{seconds}}s
265
-
265
+
266
266
  **Process Goals:**
267
-
267
+
268
268
  - Development timeline adherence
269
269
  - Feature scope completion
270
270
  - Quality assurance standards
@@ -273,7 +273,7 @@ sections:
273
273
  condition: has_business_goals
274
274
  template: |
275
275
  **Commercial Goals:**
276
-
276
+
277
277
  - {{revenue_target}} in first {{time_period}}
278
278
  - {{user_acquisition_target}} players in first {{time_period}}
279
279
  - {{retention_target}} monthly active users
@@ -326,12 +326,12 @@ sections:
326
326
  title: Validation Plan
327
327
  template: |
328
328
  **Concept Testing:**
329
-
329
+
330
330
  - {{validation_method_1}} - {{timeline}}
331
331
  - {{validation_method_2}} - {{timeline}}
332
-
332
+
333
333
  **Prototype Testing:**
334
-
334
+
335
335
  - {{testing_approach}} - {{timeline}}
336
336
  - {{feedback_collection_method}} - {{timeline}}
337
337
 
@@ -353,4 +353,4 @@ sections:
353
353
  type: table
354
354
  template: |
355
355
  | Date | Version | Description | Author |
356
- | :--- | :------ | :---------- | :----- |
356
+ | :--- | :------ | :---------- | :----- |
@@ -14,7 +14,7 @@ sections:
14
14
  - id: initial-setup
15
15
  instruction: |
16
16
  This template creates a comprehensive Game Design Document that will serve as the foundation for all game development work. The GDD should be detailed enough that developers can create user stories and epics from it. Focus on gameplay systems, mechanics, and technical requirements that can be broken down into implementable features.
17
-
17
+
18
18
  If available, review any provided documents or ask if any are optionally available: Project Brief, Market Research, Competitive Analysis
19
19
 
20
20
  - id: executive-summary
@@ -59,7 +59,7 @@ sections:
59
59
  instruction: Define the 30-60 second loop that players will repeat. Be specific about timing and player actions.
60
60
  template: |
61
61
  **Primary Loop ({{duration}} seconds):**
62
-
62
+
63
63
  1. {{action_1}} ({{time_1}}s)
64
64
  2. {{action_2}} ({{time_2}}s)
65
65
  3. {{action_3}} ({{time_3}}s)
@@ -69,12 +69,12 @@ sections:
69
69
  instruction: Clearly define success and failure states
70
70
  template: |
71
71
  **Victory Conditions:**
72
-
72
+
73
73
  - {{win_condition_1}}
74
74
  - {{win_condition_2}}
75
-
75
+
76
76
  **Failure States:**
77
-
77
+
78
78
  - {{loss_condition_1}}
79
79
  - {{loss_condition_2}}
80
80
 
@@ -90,17 +90,17 @@ sections:
90
90
  title: "{{mechanic_name}}"
91
91
  template: |
92
92
  **Description:** {{detailed_description}}
93
-
93
+
94
94
  **Player Input:** {{input_method}}
95
-
95
+
96
96
  **System Response:** {{game_response}}
97
-
97
+
98
98
  **Implementation Notes:**
99
-
99
+
100
100
  - {{tech_requirement_1}}
101
101
  - {{tech_requirement_2}}
102
102
  - {{performance_consideration}}
103
-
103
+
104
104
  **Dependencies:** {{other_mechanics_needed}}
105
105
  - id: controls
106
106
  title: Controls
@@ -119,9 +119,9 @@ sections:
119
119
  title: Player Progression
120
120
  template: |
121
121
  **Progression Type:** {{linear|branching|metroidvania}}
122
-
122
+
123
123
  **Key Milestones:**
124
-
124
+
125
125
  1. **{{milestone_1}}** - {{unlock_description}}
126
126
  2. **{{milestone_2}}** - {{unlock_description}}
127
127
  3. **{{milestone_3}}** - {{unlock_description}}
@@ -158,9 +158,9 @@ sections:
158
158
  **Duration:** {{target_time}}
159
159
  **Key Elements:** {{required_mechanics}}
160
160
  **Difficulty:** {{relative_difficulty}}
161
-
161
+
162
162
  **Structure Template:**
163
-
163
+
164
164
  - Introduction: {{intro_description}}
165
165
  - Challenge: {{main_challenge}}
166
166
  - Resolution: {{completion_requirement}}
@@ -186,13 +186,13 @@ sections:
186
186
  title: Platform Specific
187
187
  template: |
188
188
  **Desktop:**
189
-
189
+
190
190
  - Resolution: {{min_resolution}} - {{max_resolution}}
191
191
  - Input: Keyboard, Mouse, Gamepad
192
192
  - Browser: Chrome 80+, Firefox 75+, Safari 13+
193
-
193
+
194
194
  **Mobile:**
195
-
195
+
196
196
  - Resolution: {{mobile_min}} - {{mobile_max}}
197
197
  - Input: Touch, Tilt (optional)
198
198
  - OS: iOS 13+, Android 8+
@@ -201,14 +201,14 @@ sections:
201
201
  instruction: Define asset specifications for the art and audio teams
202
202
  template: |
203
203
  **Visual Assets:**
204
-
204
+
205
205
  - Art Style: {{style_description}}
206
206
  - Color Palette: {{color_specification}}
207
207
  - Animation: {{animation_requirements}}
208
208
  - UI Resolution: {{ui_specs}}
209
-
209
+
210
210
  **Audio Assets:**
211
-
211
+
212
212
  - Music Style: {{music_genre}}
213
213
  - Sound Effects: {{sfx_requirements}}
214
214
  - Voice Acting: {{voice_needs}}
@@ -221,7 +221,7 @@ sections:
221
221
  title: Engine Configuration
222
222
  template: |
223
223
  **Phaser 3 Setup:**
224
-
224
+
225
225
  - TypeScript: Strict mode enabled
226
226
  - Physics: {{physics_system}} (Arcade/Matter)
227
227
  - Renderer: WebGL with Canvas fallback
@@ -230,7 +230,7 @@ sections:
230
230
  title: Code Architecture
231
231
  template: |
232
232
  **Required Systems:**
233
-
233
+
234
234
  - Scene Management
235
235
  - State Management
236
236
  - Asset Loading
@@ -242,7 +242,7 @@ sections:
242
242
  title: Data Management
243
243
  template: |
244
244
  **Save Data:**
245
-
245
+
246
246
  - Progress tracking
247
247
  - Settings persistence
248
248
  - Statistics collection
@@ -340,4 +340,4 @@ sections:
340
340
  title: References
341
341
  instruction: List any competitive analysis, inspiration, or research sources
342
342
  type: bullet-list
343
- template: "{{reference}}"
343
+ template: "{{reference}}"
@@ -14,13 +14,13 @@ sections:
14
14
  - id: initial-setup
15
15
  instruction: |
16
16
  This template creates detailed game development stories that are immediately actionable by game developers. Each story should focus on a single, implementable feature that contributes to the overall game functionality.
17
-
17
+
18
18
  Before starting, ensure you have access to:
19
-
19
+
20
20
  - Game Design Document (GDD)
21
21
  - Game Architecture Document
22
22
  - Any existing stories in this epic
23
-
23
+
24
24
  The story should be specific enough that a developer can implement it without requiring additional design decisions.
25
25
 
26
26
  - id: story-header
@@ -69,12 +69,12 @@ sections:
69
69
  title: Files to Create/Modify
70
70
  template: |
71
71
  **New Files:**
72
-
72
+
73
73
  - `{{file_path_1}}` - {{purpose}}
74
74
  - `{{file_path_2}}` - {{purpose}}
75
-
75
+
76
76
  **Modified Files:**
77
-
77
+
78
78
  - `{{existing_file_1}}` - {{changes_needed}}
79
79
  - `{{existing_file_2}}` - {{changes_needed}}
80
80
  - id: class-interface-definitions
@@ -89,15 +89,15 @@ sections:
89
89
  {{property_2}}: {{type}};
90
90
  {{method_1}}({{params}}): {{return_type}};
91
91
  }
92
-
92
+
93
93
  // {{class_name}}
94
94
  class {{class_name}} extends {{phaser_class}} {
95
95
  private {{property}}: {{type}};
96
-
96
+
97
97
  constructor({{params}}) {
98
98
  // Implementation requirements
99
99
  }
100
-
100
+
101
101
  public {{method}}({{params}}): {{return_type}} {
102
102
  // Method requirements
103
103
  }
@@ -107,15 +107,15 @@ sections:
107
107
  instruction: Specify how this feature integrates with existing systems
108
108
  template: |
109
109
  **Scene Integration:**
110
-
110
+
111
111
  - {{scene_name}}: {{integration_details}}
112
-
112
+
113
113
  **System Dependencies:**
114
-
114
+
115
115
  - {{system_name}}: {{dependency_description}}
116
-
116
+
117
117
  **Event Communication:**
118
-
118
+
119
119
  - Emits: `{{event_name}}` when {{condition}}
120
120
  - Listens: `{{event_name}}` to {{response}}
121
121
 
@@ -127,7 +127,7 @@ sections:
127
127
  title: Dev Agent Record
128
128
  template: |
129
129
  **Tasks:**
130
-
130
+
131
131
  - [ ] {{task_1_description}}
132
132
  - [ ] {{task_2_description}}
133
133
  - [ ] {{task_3_description}}
@@ -135,18 +135,18 @@ sections:
135
135
  - [ ] Write unit tests for {{component}}
136
136
  - [ ] Integration testing with {{related_system}}
137
137
  - [ ] Performance testing and optimization
138
-
138
+
139
139
  **Debug Log:**
140
140
  | Task | File | Change | Reverted? |
141
141
  |------|------|--------|-----------|
142
142
  | | | | |
143
-
143
+
144
144
  **Completion Notes:**
145
-
145
+
146
146
  <!-- Only note deviations from requirements, keep under 50 words -->
147
-
147
+
148
148
  **Change Log:**
149
-
149
+
150
150
  <!-- Only requirement changes during implementation -->
151
151
 
152
152
  - id: game-design-context
@@ -154,13 +154,13 @@ sections:
154
154
  instruction: Reference the specific sections of the GDD that this story implements
155
155
  template: |
156
156
  **GDD Reference:** {{section_name}} ({{page_or_section_number}})
157
-
157
+
158
158
  **Game Mechanic:** {{mechanic_name}}
159
-
159
+
160
160
  **Player Experience Goal:** {{experience_description}}
161
-
161
+
162
162
  **Balance Parameters:**
163
-
163
+
164
164
  - {{parameter_1}}: {{value_or_range}}
165
165
  - {{parameter_2}}: {{value_or_range}}
166
166
 
@@ -172,11 +172,11 @@ sections:
172
172
  title: Unit Tests
173
173
  template: |
174
174
  **Test Files:**
175
-
175
+
176
176
  - `tests/{{component_name}}.test.ts`
177
-
177
+
178
178
  **Test Scenarios:**
179
-
179
+
180
180
  - {{test_scenario_1}}
181
181
  - {{test_scenario_2}}
182
182
  - {{edge_case_test}}
@@ -184,12 +184,12 @@ sections:
184
184
  title: Game Testing
185
185
  template: |
186
186
  **Manual Test Cases:**
187
-
187
+
188
188
  1. {{test_case_1_description}}
189
-
189
+
190
190
  - Expected: {{expected_behavior}}
191
191
  - Performance: {{performance_expectation}}
192
-
192
+
193
193
  2. {{test_case_2_description}}
194
194
  - Expected: {{expected_behavior}}
195
195
  - Edge Case: {{edge_case_handling}}
@@ -197,7 +197,7 @@ sections:
197
197
  title: Performance Tests
198
198
  template: |
199
199
  **Metrics to Verify:**
200
-
200
+
201
201
  - Frame rate maintains {{fps_target}} FPS
202
202
  - Memory usage stays under {{memory_limit}}MB
203
203
  - {{feature_specific_performance_metric}}
@@ -207,15 +207,15 @@ sections:
207
207
  instruction: List any dependencies that must be completed before this story can be implemented
208
208
  template: |
209
209
  **Story Dependencies:**
210
-
210
+
211
211
  - {{story_id}}: {{dependency_description}}
212
-
212
+
213
213
  **Technical Dependencies:**
214
-
214
+
215
215
  - {{system_or_file}}: {{requirement}}
216
-
216
+
217
217
  **Asset Dependencies:**
218
-
218
+
219
219
  - {{asset_type}}: {{asset_description}}
220
220
  - Location: `{{asset_path}}`
221
221
 
@@ -238,16 +238,16 @@ sections:
238
238
  instruction: Any additional context, design decisions, or implementation notes
239
239
  template: |
240
240
  **Implementation Notes:**
241
-
241
+
242
242
  - {{note_1}}
243
243
  - {{note_2}}
244
-
244
+
245
245
  **Design Decisions:**
246
-
246
+
247
247
  - {{decision_1}}: {{rationale}}
248
248
  - {{decision_2}}: {{rationale}}
249
-
249
+
250
250
  **Future Considerations:**
251
-
251
+
252
252
  - {{future_enhancement_1}}
253
- - {{future_optimization_1}}
253
+ - {{future_optimization_1}}