bmad-method 5.1.2 → 6.0.0-alpha.0

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 (579) hide show
  1. package/.github/FUNDING.yaml +2 -2
  2. package/.github/ISSUE_TEMPLATE/config.yaml +1 -0
  3. package/.github/ISSUE_TEMPLATE/idea_submission.md +109 -0
  4. package/.github/workflows/discord.yaml +1 -10
  5. package/.github/workflows/format-check.yaml +3 -2
  6. package/.github/workflows/manual-release.yaml +2 -2
  7. package/.nvmrc +1 -0
  8. package/.vscode/settings.json +34 -9
  9. package/CHANGELOG.md +211 -577
  10. package/CONTRIBUTING.md +130 -60
  11. package/LICENSE +6 -1
  12. package/docs/codebase-flattener.md +19 -0
  13. package/docs/ide-info/auggie.md +31 -0
  14. package/docs/ide-info/claude-code.md +25 -0
  15. package/docs/ide-info/cline.md +31 -0
  16. package/docs/ide-info/codex.md +32 -0
  17. package/docs/ide-info/crush.md +30 -0
  18. package/docs/ide-info/cursor.md +25 -0
  19. package/docs/ide-info/gemini.md +25 -0
  20. package/docs/ide-info/github-copilot.md +26 -0
  21. package/docs/ide-info/iflow.md +33 -0
  22. package/docs/ide-info/kilo.md +24 -0
  23. package/docs/ide-info/qwen.md +25 -0
  24. package/docs/ide-info/roo.md +27 -0
  25. package/docs/ide-info/trae.md +25 -0
  26. package/docs/ide-info/windsurf.md +22 -0
  27. package/docs/installers-bundlers/ide-injections.md +196 -0
  28. package/docs/installers-bundlers/installers-modules-platforms-reference.md +355 -0
  29. package/docs/installers-bundlers/web-bundler-usage.md +54 -0
  30. package/eslint.config.mjs +17 -7
  31. package/package.json +26 -35
  32. package/prettier.config.mjs +1 -1
  33. package/readme.md +216 -0
  34. package/src/core/_module-installer/install-menu-config.yaml +24 -0
  35. package/src/core/_module-installer/installer.js +68 -0
  36. package/src/core/agents/bmad-master.md +27 -0
  37. package/src/core/agents/bmad-web-orchestrator.md +71 -0
  38. package/src/core/tasks/adv-elicit-methods.csv +39 -0
  39. package/src/core/tasks/adv-elicit.md +109 -0
  40. package/src/core/tasks/index-docs.md +69 -0
  41. package/src/core/tasks/shard-doc.md +57 -0
  42. package/src/core/tasks/validate-workflow.md +92 -0
  43. package/src/core/tasks/workflow.md +141 -0
  44. package/src/core/workflows/bmad-init/instructions.md +79 -0
  45. package/src/core/workflows/bmad-init/workflow.yaml +24 -0
  46. package/src/core/workflows/party-mode/instructions.md +181 -0
  47. package/src/core/workflows/party-mode/workflow.yaml +24 -0
  48. package/src/modules/bmb/_module-installer/install-menu-config.yaml +16 -0
  49. package/src/modules/bmb/agents/bmad-builder.md +30 -0
  50. package/src/modules/bmb/workflows/convert-legacy/README.md +262 -0
  51. package/src/modules/bmb/workflows/convert-legacy/checklist.md +204 -0
  52. package/src/modules/bmb/workflows/convert-legacy/instructions.md +328 -0
  53. package/src/modules/bmb/workflows/convert-legacy/workflow.yaml +35 -0
  54. package/src/modules/bmb/workflows/create-agent/README.md +268 -0
  55. package/src/modules/bmb/workflows/create-agent/agent-architecture.md +412 -0
  56. package/src/modules/bmb/workflows/create-agent/agent-command-patterns.md +757 -0
  57. package/src/modules/bmb/workflows/create-agent/agent-types.md +177 -0
  58. package/src/modules/bmb/workflows/create-agent/brainstorm-context.md +174 -0
  59. package/src/modules/bmb/workflows/create-agent/checklist.md +134 -0
  60. package/src/modules/bmb/workflows/create-agent/communication-styles.md +240 -0
  61. package/src/modules/bmb/workflows/create-agent/instructions.md +340 -0
  62. package/src/modules/bmb/workflows/create-agent/workflow.yaml +39 -0
  63. package/src/modules/bmb/workflows/create-module/README.md +218 -0
  64. package/src/modules/bmb/workflows/create-module/brainstorm-context.md +137 -0
  65. package/src/modules/bmb/workflows/create-module/checklist.md +245 -0
  66. package/src/modules/bmb/workflows/create-module/installer-templates/install-module-config.yaml +132 -0
  67. package/src/modules/bmb/workflows/create-module/installer-templates/installer.js +231 -0
  68. package/src/modules/bmb/workflows/create-module/instructions.md +509 -0
  69. package/src/modules/bmb/workflows/create-module/module-structure.md +310 -0
  70. package/src/modules/bmb/workflows/create-module/workflow.yaml +47 -0
  71. package/src/modules/bmb/workflows/create-workflow/README.md +216 -0
  72. package/src/modules/bmb/workflows/create-workflow/brainstorm-context.md +197 -0
  73. package/src/modules/bmb/workflows/create-workflow/checklist.md +72 -0
  74. package/src/modules/bmb/workflows/create-workflow/instructions.md +267 -0
  75. package/src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md +456 -0
  76. package/src/modules/bmb/workflows/create-workflow/workflow-template/checklist.md +24 -0
  77. package/src/modules/bmb/workflows/create-workflow/workflow-template/instructions.md +12 -0
  78. package/src/modules/bmb/workflows/create-workflow/workflow-template/template.md +9 -0
  79. package/src/modules/bmb/workflows/create-workflow/workflow-template/workflow.yaml +35 -0
  80. package/src/modules/bmb/workflows/create-workflow/workflow.yaml +42 -0
  81. package/src/modules/bmb/workflows/edit-workflow/README.md +63 -0
  82. package/src/modules/bmb/workflows/edit-workflow/checklist.md +70 -0
  83. package/src/modules/bmb/workflows/edit-workflow/instructions.md +170 -0
  84. package/src/modules/bmb/workflows/edit-workflow/workflow.yaml +34 -0
  85. package/src/modules/bmb/workflows/module-brief/README.md +264 -0
  86. package/src/modules/bmb/workflows/module-brief/checklist.md +116 -0
  87. package/src/modules/bmb/workflows/module-brief/instructions.md +265 -0
  88. package/src/modules/bmb/workflows/module-brief/template.md +275 -0
  89. package/src/modules/bmb/workflows/module-brief/workflow.yaml +30 -0
  90. package/src/modules/bmb/workflows/redoc/README.md +87 -0
  91. package/src/modules/bmb/workflows/redoc/checklist.md +99 -0
  92. package/src/modules/bmb/workflows/redoc/instructions.md +255 -0
  93. package/src/modules/bmb/workflows/redoc/workflow.yaml +33 -0
  94. package/src/modules/bmm/_module-installer/assets/bmm-kb.md +1 -0
  95. package/src/modules/bmm/_module-installer/assets/technical-decisions-template.md +30 -0
  96. package/src/modules/bmm/_module-installer/install-menu-config.yaml +49 -0
  97. package/src/modules/bmm/_module-installer/installer.js +131 -0
  98. package/src/modules/bmm/_module-installer/platform-specifics/claude-code.js +35 -0
  99. package/src/modules/bmm/_module-installer/platform-specifics/windsurf.js +32 -0
  100. package/src/modules/bmm/agents/analyst.md +26 -0
  101. package/src/modules/bmm/agents/architect.md +29 -0
  102. package/src/modules/bmm/agents/dev.md +61 -0
  103. package/src/modules/bmm/agents/game-architect.md +26 -0
  104. package/src/modules/bmm/agents/game-designer.md +27 -0
  105. package/src/modules/bmm/agents/game-dev.md +28 -0
  106. package/src/modules/bmm/agents/pm.md +26 -0
  107. package/src/modules/bmm/agents/po.md +25 -0
  108. package/src/modules/bmm/agents/sm.md +29 -0
  109. package/src/modules/bmm/agents/tea.md +32 -0
  110. package/src/modules/bmm/agents/ux-expert.md +24 -0
  111. package/src/modules/bmm/sub-modules/claude-code/config.yaml +5 -0
  112. package/src/modules/bmm/sub-modules/claude-code/injections.yaml +242 -0
  113. package/src/modules/bmm/sub-modules/claude-code/readme.md +87 -0
  114. package/src/modules/bmm/sub-modules/claude-code/sub-agents/api-documenter.md +85 -0
  115. package/src/modules/bmm/sub-modules/claude-code/sub-agents/codebase-analyzer.md +64 -0
  116. package/src/modules/bmm/sub-modules/claude-code/sub-agents/data-analyst.md +84 -0
  117. package/src/modules/bmm/sub-modules/claude-code/sub-agents/dependency-mapper.md +67 -0
  118. package/src/modules/bmm/sub-modules/claude-code/sub-agents/document-reviewer.md +85 -0
  119. package/src/modules/bmm/sub-modules/claude-code/sub-agents/epic-optimizer.md +66 -0
  120. package/src/modules/bmm/sub-modules/claude-code/sub-agents/market-researcher.md +34 -0
  121. package/src/modules/bmm/sub-modules/claude-code/sub-agents/pattern-detector.md +67 -0
  122. package/src/modules/bmm/sub-modules/claude-code/sub-agents/requirements-analyst.md +61 -0
  123. package/src/modules/bmm/sub-modules/claude-code/sub-agents/tech-debt-auditor.md +89 -0
  124. package/src/modules/bmm/sub-modules/claude-code/sub-agents/technical-decisions-curator.md +146 -0
  125. package/src/modules/bmm/sub-modules/claude-code/sub-agents/technical-evaluator.md +51 -0
  126. package/src/modules/bmm/sub-modules/claude-code/sub-agents/test-coverage-analyzer.md +91 -0
  127. package/src/modules/bmm/sub-modules/claude-code/sub-agents/trend-spotter.md +99 -0
  128. package/src/modules/bmm/sub-modules/claude-code/sub-agents/user-journey-mapper.md +101 -0
  129. package/src/modules/bmm/sub-modules/claude-code/sub-agents/user-researcher.md +56 -0
  130. package/src/modules/bmm/tasks/daily-standup.md +91 -0
  131. package/src/modules/bmm/tasks/retrospective.md +110 -0
  132. package/src/modules/bmm/teams/team-all.yaml +7 -0
  133. package/src/modules/bmm/teams/team-dev.yaml +14 -0
  134. package/src/modules/bmm/teams/team-gamedev.yaml +9 -0
  135. package/src/modules/bmm/testarch/atdd.md +40 -0
  136. package/src/modules/bmm/testarch/automate.md +38 -0
  137. package/src/modules/bmm/testarch/ci.md +39 -0
  138. package/src/modules/bmm/testarch/framework.md +41 -0
  139. package/src/modules/bmm/testarch/nfr-assess.md +38 -0
  140. package/src/modules/bmm/testarch/risk-profile.md +38 -0
  141. package/src/modules/bmm/testarch/tea-commands.csv +11 -0
  142. package/src/modules/bmm/testarch/tea-gate.md +38 -0
  143. package/src/modules/bmm/testarch/tea-knowledge.md +275 -0
  144. package/src/modules/bmm/testarch/test-design.md +39 -0
  145. package/{bmad-core/data → src/modules/bmm/testarch}/test-levels-framework.md +2 -0
  146. package/{bmad-core/data → src/modules/bmm/testarch}/test-priorities-matrix.md +2 -0
  147. package/src/modules/bmm/testarch/trace-requirements.md +38 -0
  148. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/game-brain-methods.csv +26 -0
  149. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/game-context.md +115 -0
  150. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/instructions.md +47 -0
  151. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/workflow.yaml +22 -0
  152. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/instructions.md +38 -0
  153. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/project-context.md +25 -0
  154. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml +21 -0
  155. package/src/modules/bmm/workflows/1-analysis/game-brief/README.md +221 -0
  156. package/src/modules/bmm/workflows/1-analysis/game-brief/checklist.md +128 -0
  157. package/src/modules/bmm/workflows/1-analysis/game-brief/instructions.md +517 -0
  158. package/src/modules/bmm/workflows/1-analysis/game-brief/template.md +205 -0
  159. package/src/modules/bmm/workflows/1-analysis/game-brief/workflow.yaml +34 -0
  160. package/src/modules/bmm/workflows/1-analysis/product-brief/README.md +180 -0
  161. package/src/modules/bmm/workflows/1-analysis/product-brief/checklist.md +115 -0
  162. package/src/modules/bmm/workflows/1-analysis/product-brief/instructions.md +353 -0
  163. package/src/modules/bmm/workflows/1-analysis/product-brief/template.md +165 -0
  164. package/src/modules/bmm/workflows/1-analysis/product-brief/workflow.yaml +33 -0
  165. package/src/modules/bmm/workflows/1-analysis/research/README.md +454 -0
  166. package/src/modules/bmm/workflows/1-analysis/research/checklist.md +202 -0
  167. package/src/modules/bmm/workflows/1-analysis/research/claude-code/injections.yaml +114 -0
  168. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-competitor-analyzer.md +259 -0
  169. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-data-analyst.md +190 -0
  170. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-market-researcher.md +337 -0
  171. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-trend-spotter.md +107 -0
  172. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-user-researcher.md +329 -0
  173. package/src/modules/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +370 -0
  174. package/src/modules/bmm/workflows/1-analysis/research/instructions-market.md +553 -0
  175. package/src/modules/bmm/workflows/1-analysis/research/instructions-router.md +91 -0
  176. package/src/modules/bmm/workflows/1-analysis/research/instructions-technical.md +442 -0
  177. package/src/modules/bmm/workflows/1-analysis/research/template-deep-prompt.md +94 -0
  178. package/src/modules/bmm/workflows/1-analysis/research/template-market.md +311 -0
  179. package/src/modules/bmm/workflows/1-analysis/research/template-technical.md +210 -0
  180. package/src/modules/bmm/workflows/1-analysis/research/workflow.yaml +149 -0
  181. package/src/modules/bmm/workflows/2-plan/README.md +203 -0
  182. package/src/modules/bmm/workflows/2-plan/checklist.md +369 -0
  183. package/src/modules/bmm/workflows/2-plan/gdd/README.md +222 -0
  184. package/src/modules/bmm/workflows/2-plan/gdd/game-types/action-platformer.md +45 -0
  185. package/src/modules/bmm/workflows/2-plan/gdd/game-types/adventure.md +84 -0
  186. package/src/modules/bmm/workflows/2-plan/gdd/game-types/card-game.md +76 -0
  187. package/src/modules/bmm/workflows/2-plan/gdd/game-types/fighting.md +89 -0
  188. package/src/modules/bmm/workflows/2-plan/gdd/game-types/horror.md +86 -0
  189. package/src/modules/bmm/workflows/2-plan/gdd/game-types/idle-incremental.md +78 -0
  190. package/src/modules/bmm/workflows/2-plan/gdd/game-types/metroidvania.md +87 -0
  191. package/src/modules/bmm/workflows/2-plan/gdd/game-types/moba.md +74 -0
  192. package/src/modules/bmm/workflows/2-plan/gdd/game-types/party-game.md +79 -0
  193. package/src/modules/bmm/workflows/2-plan/gdd/game-types/puzzle.md +58 -0
  194. package/src/modules/bmm/workflows/2-plan/gdd/game-types/racing.md +88 -0
  195. package/src/modules/bmm/workflows/2-plan/gdd/game-types/rhythm.md +79 -0
  196. package/src/modules/bmm/workflows/2-plan/gdd/game-types/roguelike.md +69 -0
  197. package/src/modules/bmm/workflows/2-plan/gdd/game-types/rpg.md +70 -0
  198. package/src/modules/bmm/workflows/2-plan/gdd/game-types/sandbox.md +79 -0
  199. package/src/modules/bmm/workflows/2-plan/gdd/game-types/shooter.md +62 -0
  200. package/src/modules/bmm/workflows/2-plan/gdd/game-types/simulation.md +73 -0
  201. package/src/modules/bmm/workflows/2-plan/gdd/game-types/sports.md +75 -0
  202. package/src/modules/bmm/workflows/2-plan/gdd/game-types/strategy.md +71 -0
  203. package/src/modules/bmm/workflows/2-plan/gdd/game-types/survival.md +79 -0
  204. package/src/modules/bmm/workflows/2-plan/gdd/game-types/text-based.md +91 -0
  205. package/src/modules/bmm/workflows/2-plan/gdd/game-types/tower-defense.md +79 -0
  206. package/src/modules/bmm/workflows/2-plan/gdd/game-types/turn-based-tactics.md +88 -0
  207. package/src/modules/bmm/workflows/2-plan/gdd/game-types/visual-novel.md +89 -0
  208. package/src/modules/bmm/workflows/2-plan/gdd/game-types.csv +25 -0
  209. package/src/modules/bmm/workflows/2-plan/gdd/gdd-template.md +159 -0
  210. package/src/modules/bmm/workflows/2-plan/gdd/instructions-gdd.md +480 -0
  211. package/src/modules/bmm/workflows/2-plan/instructions-router.md +222 -0
  212. package/src/modules/bmm/workflows/2-plan/narrative/instructions-narrative.md +517 -0
  213. package/src/modules/bmm/workflows/2-plan/narrative/narrative-template.md +195 -0
  214. package/src/modules/bmm/workflows/2-plan/prd/analysis-template.md +53 -0
  215. package/src/modules/bmm/workflows/2-plan/prd/epics-template.md +18 -0
  216. package/src/modules/bmm/workflows/2-plan/prd/instructions-lg.md +267 -0
  217. package/src/modules/bmm/workflows/2-plan/prd/instructions-med.md +251 -0
  218. package/src/modules/bmm/workflows/2-plan/prd/prd-template.md +73 -0
  219. package/src/modules/bmm/workflows/2-plan/tech-spec/instructions-sm.md +137 -0
  220. package/src/modules/bmm/workflows/2-plan/tech-spec/tech-spec-template.md +59 -0
  221. package/src/modules/bmm/workflows/2-plan/ux/instructions-ux.md +360 -0
  222. package/src/modules/bmm/workflows/2-plan/ux/ux-spec-template.md +162 -0
  223. package/src/modules/bmm/workflows/2-plan/workflow.yaml +60 -0
  224. package/src/modules/bmm/workflows/3-solutioning/ADR-template.md +74 -0
  225. package/src/modules/bmm/workflows/3-solutioning/README.md +565 -0
  226. package/src/modules/bmm/workflows/3-solutioning/checklist.md +170 -0
  227. package/src/modules/bmm/workflows/3-solutioning/instructions.md +661 -0
  228. package/src/modules/bmm/workflows/3-solutioning/project-types/backend-questions.md +490 -0
  229. package/src/modules/bmm/workflows/3-solutioning/project-types/cli-questions.md +337 -0
  230. package/src/modules/bmm/workflows/3-solutioning/project-types/data-questions.md +472 -0
  231. package/src/modules/bmm/workflows/3-solutioning/project-types/desktop-questions.md +299 -0
  232. package/src/modules/bmm/workflows/3-solutioning/project-types/embedded-questions.md +118 -0
  233. package/src/modules/bmm/workflows/3-solutioning/project-types/extension-questions.md +374 -0
  234. package/src/modules/bmm/workflows/3-solutioning/project-types/game-questions.md +133 -0
  235. package/src/modules/bmm/workflows/3-solutioning/project-types/infra-questions.md +484 -0
  236. package/src/modules/bmm/workflows/3-solutioning/project-types/library-questions.md +146 -0
  237. package/src/modules/bmm/workflows/3-solutioning/project-types/mobile-questions.md +110 -0
  238. package/src/modules/bmm/workflows/3-solutioning/project-types/project-types.csv +12 -0
  239. package/src/modules/bmm/workflows/3-solutioning/project-types/web-questions.md +136 -0
  240. package/src/modules/bmm/workflows/3-solutioning/tech-spec/README.md +195 -0
  241. package/src/modules/bmm/workflows/3-solutioning/tech-spec/checklist.md +17 -0
  242. package/src/modules/bmm/workflows/3-solutioning/tech-spec/instructions.md +73 -0
  243. package/src/modules/bmm/workflows/3-solutioning/tech-spec/template.md +76 -0
  244. package/src/modules/bmm/workflows/3-solutioning/tech-spec/workflow.yaml +51 -0
  245. package/src/modules/bmm/workflows/3-solutioning/templates/backend-service-architecture.md +66 -0
  246. package/src/modules/bmm/workflows/3-solutioning/templates/cli-tool-architecture.md +66 -0
  247. package/src/modules/bmm/workflows/3-solutioning/templates/data-pipeline-architecture.md +66 -0
  248. package/src/modules/bmm/workflows/3-solutioning/templates/desktop-app-architecture.md +66 -0
  249. package/src/modules/bmm/workflows/3-solutioning/templates/embedded-firmware-architecture.md +66 -0
  250. package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-architecture.md +244 -0
  251. package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-godot-guide.md +428 -0
  252. package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-unity-guide.md +333 -0
  253. package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-web-guide.md +528 -0
  254. package/src/modules/bmm/workflows/3-solutioning/templates/infrastructure-architecture.md +66 -0
  255. package/src/modules/bmm/workflows/3-solutioning/templates/library-package-architecture.md +66 -0
  256. package/src/modules/bmm/workflows/3-solutioning/templates/mobile-app-architecture.md +66 -0
  257. package/src/modules/bmm/workflows/3-solutioning/templates/registry.csv +172 -0
  258. package/src/modules/bmm/workflows/3-solutioning/templates/web-api-architecture.md +66 -0
  259. package/src/modules/bmm/workflows/3-solutioning/templates/web-fullstack-architecture.md +277 -0
  260. package/src/modules/bmm/workflows/3-solutioning/workflow.yaml +65 -0
  261. package/src/modules/bmm/workflows/4-implementation/correct-course/checklist.md +279 -0
  262. package/src/modules/bmm/workflows/4-implementation/correct-course/instructions.md +190 -0
  263. package/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml +35 -0
  264. package/src/modules/bmm/workflows/4-implementation/create-story/README.md +42 -0
  265. package/src/modules/bmm/workflows/4-implementation/create-story/checklist.md +39 -0
  266. package/src/modules/bmm/workflows/4-implementation/create-story/instructions.md +81 -0
  267. package/src/modules/bmm/workflows/4-implementation/create-story/template.md +57 -0
  268. package/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml +72 -0
  269. package/src/modules/bmm/workflows/4-implementation/dev-story/README.md +84 -0
  270. package/src/modules/bmm/workflows/4-implementation/dev-story/checklist.md +38 -0
  271. package/src/modules/bmm/workflows/4-implementation/dev-story/instructions.md +87 -0
  272. package/src/modules/bmm/workflows/4-implementation/dev-story/workflow.yaml +53 -0
  273. package/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +391 -0
  274. package/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml +41 -0
  275. package/src/modules/bmm/workflows/4-implementation/review-story/README.md +72 -0
  276. package/src/modules/bmm/workflows/4-implementation/review-story/backlog_template.md +12 -0
  277. package/src/modules/bmm/workflows/4-implementation/review-story/checklist.md +22 -0
  278. package/src/modules/bmm/workflows/4-implementation/review-story/instructions.md +176 -0
  279. package/src/modules/bmm/workflows/4-implementation/review-story/workflow.yaml +99 -0
  280. package/src/modules/bmm/workflows/4-implementation/story-context/README.md +234 -0
  281. package/src/modules/bmm/workflows/4-implementation/story-context/checklist.md +16 -0
  282. package/src/modules/bmm/workflows/4-implementation/story-context/context-template.xml +34 -0
  283. package/src/modules/bmm/workflows/4-implementation/story-context/instructions.md +76 -0
  284. package/src/modules/bmm/workflows/4-implementation/story-context/workflow.yaml +56 -0
  285. package/src/modules/cis/_module-installer/install-menu-config.yaml +14 -0
  286. package/src/modules/cis/_module-installer/installer.js +92 -0
  287. package/src/modules/cis/agents/README.md +104 -0
  288. package/src/modules/cis/agents/brainstorming-coach.md +24 -0
  289. package/src/modules/cis/agents/creative-problem-solver.md +24 -0
  290. package/src/modules/cis/agents/design-thinking-coach.md +24 -0
  291. package/src/modules/cis/agents/innovation-strategist.md +24 -0
  292. package/src/modules/cis/agents/storyteller.md +24 -0
  293. package/src/modules/cis/readme.md +86 -0
  294. package/src/modules/cis/teams/creative-squad.yaml +6 -0
  295. package/src/modules/cis/workflows/README.md +67 -0
  296. package/src/modules/cis/workflows/brainstorming/README.md +271 -0
  297. package/src/modules/cis/workflows/brainstorming/brain-methods.csv +36 -0
  298. package/src/modules/cis/workflows/brainstorming/instructions.md +310 -0
  299. package/src/modules/cis/workflows/brainstorming/template.md +102 -0
  300. package/src/modules/cis/workflows/brainstorming/workflow.yaml +30 -0
  301. package/src/modules/cis/workflows/design-thinking/README.md +56 -0
  302. package/src/modules/cis/workflows/design-thinking/design-methods.csv +31 -0
  303. package/src/modules/cis/workflows/design-thinking/instructions.md +200 -0
  304. package/src/modules/cis/workflows/design-thinking/template.md +111 -0
  305. package/src/modules/cis/workflows/design-thinking/workflow.yaml +29 -0
  306. package/src/modules/cis/workflows/innovation-strategy/README.md +56 -0
  307. package/src/modules/cis/workflows/innovation-strategy/innovation-frameworks.csv +31 -0
  308. package/src/modules/cis/workflows/innovation-strategy/instructions.md +274 -0
  309. package/src/modules/cis/workflows/innovation-strategy/template.md +189 -0
  310. package/src/modules/cis/workflows/innovation-strategy/workflow.yaml +29 -0
  311. package/src/modules/cis/workflows/problem-solving/README.md +56 -0
  312. package/src/modules/cis/workflows/problem-solving/instructions.md +250 -0
  313. package/src/modules/cis/workflows/problem-solving/solving-methods.csv +31 -0
  314. package/src/modules/cis/workflows/problem-solving/template.md +165 -0
  315. package/src/modules/cis/workflows/problem-solving/workflow.yaml +29 -0
  316. package/src/modules/cis/workflows/storytelling/README.md +58 -0
  317. package/src/modules/cis/workflows/storytelling/instructions.md +275 -0
  318. package/src/modules/cis/workflows/storytelling/story-types.csv +26 -0
  319. package/src/modules/cis/workflows/storytelling/template.md +113 -0
  320. package/src/modules/cis/workflows/storytelling/workflow.yaml +29 -0
  321. package/src/utility/models/agent-activation-ide.xml +51 -0
  322. package/src/utility/models/agent-config-template.md +23 -0
  323. package/tools/cli/bmad-cli.js +42 -0
  324. package/tools/cli/bundlers/bundle-web.js +157 -0
  325. package/tools/cli/bundlers/test-analyst.js +28 -0
  326. package/tools/cli/bundlers/test-bundler.js +118 -0
  327. package/tools/cli/bundlers/web-bundler.js +880 -0
  328. package/tools/cli/commands/install.js +41 -0
  329. package/tools/cli/commands/list.js +28 -0
  330. package/tools/cli/commands/status.js +47 -0
  331. package/tools/cli/commands/uninstall.js +44 -0
  332. package/tools/cli/commands/update.js +28 -0
  333. package/tools/cli/installers/lib/core/config-collector.js +383 -0
  334. package/tools/cli/installers/lib/core/dependency-resolver.js +721 -0
  335. package/tools/cli/installers/lib/core/detector.js +208 -0
  336. package/tools/cli/installers/lib/core/installer.js +1070 -0
  337. package/tools/cli/installers/lib/core/manifest-generator.js +385 -0
  338. package/tools/cli/installers/lib/core/manifest.js +484 -0
  339. package/tools/cli/installers/lib/ide/_base-ide.js +281 -0
  340. package/tools/cli/installers/lib/ide/auggie.js +271 -0
  341. package/tools/cli/installers/lib/ide/claude-code.js +625 -0
  342. package/tools/cli/installers/lib/ide/cline.js +301 -0
  343. package/tools/cli/installers/lib/ide/codex.js +267 -0
  344. package/tools/cli/installers/lib/ide/crush.js +204 -0
  345. package/tools/cli/installers/lib/ide/cursor.js +224 -0
  346. package/tools/cli/installers/lib/ide/gemini.js +160 -0
  347. package/tools/cli/installers/lib/ide/github-copilot.js +289 -0
  348. package/tools/cli/installers/lib/ide/iflow.js +142 -0
  349. package/tools/cli/installers/lib/ide/kilo.js +171 -0
  350. package/tools/cli/installers/lib/ide/manager.js +203 -0
  351. package/tools/cli/installers/lib/ide/qwen.js +188 -0
  352. package/tools/cli/installers/lib/ide/roo.js +288 -0
  353. package/tools/cli/installers/lib/ide/trae.js +182 -0
  354. package/tools/cli/installers/lib/ide/windsurf.js +149 -0
  355. package/tools/cli/installers/lib/ide/workflow-command-generator.js +162 -0
  356. package/tools/cli/installers/lib/ide/workflow-command-template.md +11 -0
  357. package/tools/cli/installers/lib/modules/manager.js +452 -0
  358. package/tools/cli/lib/agent-party-generator.js +206 -0
  359. package/tools/cli/lib/cli-utils.js +208 -0
  360. package/tools/cli/lib/config.js +210 -0
  361. package/tools/cli/lib/file-ops.js +204 -0
  362. package/tools/cli/lib/platform-codes.js +116 -0
  363. package/tools/cli/lib/project-root.js +71 -0
  364. package/tools/cli/lib/replace-project-root.js +239 -0
  365. package/tools/cli/lib/ui.js +516 -0
  366. package/tools/cli/lib/xml-handler.js +183 -0
  367. package/tools/cli/lib/xml-to-markdown.js +82 -0
  368. package/tools/{yaml-format.js → cli/lib/yaml-format.js} +3 -10
  369. package/tools/cli/regenerate-manifests.js +28 -0
  370. package/tools/flattener/ignoreRules.js +2 -6
  371. package/tools/flattener/main.js +31 -121
  372. package/tools/flattener/projectRoot.js +3 -8
  373. package/tools/flattener/stats.helpers.js +8 -35
  374. package/tools/flattener/stats.js +1 -6
  375. package/tools/flattener/test-matrix.js +1 -5
  376. package/tools/platform-codes.yaml +127 -0
  377. package/tools/test-agents/captain-kirk-commander.md +110 -0
  378. package/tools/test-agents/data-operations-android.md +123 -0
  379. package/tools/test-agents/geordi-chief-engineer.md +135 -0
  380. package/tools/test-agents/isabella-martinez-ethicist.md +109 -0
  381. package/tools/test-agents/marcus-thompson-security.md +109 -0
  382. package/tools/test-agents/maya-patel-pragmatist.md +82 -0
  383. package/tools/test-agents/picard-diplomat-captain.md +134 -0
  384. package/tools/test-agents/spock-science-officer.md +124 -0
  385. package/tools/test-agents/william-smithers-technocrat.md +71 -0
  386. package/tools/test-agents/zara-chen-designer.md +94 -0
  387. package/tools/validate-bundles.js +87 -0
  388. package/.github/ISSUE_TEMPLATE/feature_request.md +0 -22
  389. package/README.md +0 -221
  390. package/bmad-core/agent-teams/team-all.yaml +0 -14
  391. package/bmad-core/agent-teams/team-fullstack.yaml +0 -18
  392. package/bmad-core/agent-teams/team-ide-minimal.yaml +0 -10
  393. package/bmad-core/agent-teams/team-no-ui.yaml +0 -13
  394. package/bmad-core/agents/analyst.md +0 -81
  395. package/bmad-core/agents/architect.md +0 -83
  396. package/bmad-core/agents/bmad-master.md +0 -107
  397. package/bmad-core/agents/bmad-orchestrator.md +0 -149
  398. package/bmad-core/agents/dev.md +0 -75
  399. package/bmad-core/agents/pm.md +0 -81
  400. package/bmad-core/agents/po.md +0 -76
  401. package/bmad-core/agents/qa.md +0 -88
  402. package/bmad-core/agents/sm.md +0 -62
  403. package/bmad-core/agents/ux-expert.md +0 -66
  404. package/bmad-core/checklists/architect-checklist.md +0 -438
  405. package/bmad-core/checklists/change-checklist.md +0 -182
  406. package/bmad-core/checklists/pm-checklist.md +0 -370
  407. package/bmad-core/checklists/po-master-checklist.md +0 -432
  408. package/bmad-core/checklists/story-dod-checklist.md +0 -94
  409. package/bmad-core/checklists/story-draft-checklist.md +0 -153
  410. package/bmad-core/core-config.yaml +0 -20
  411. package/bmad-core/data/bmad-kb.md +0 -806
  412. package/bmad-core/data/brainstorming-techniques.md +0 -36
  413. package/bmad-core/data/elicitation-methods.md +0 -154
  414. package/bmad-core/data/technical-preferences.md +0 -3
  415. package/bmad-core/tasks/advanced-elicitation.md +0 -117
  416. package/bmad-core/tasks/brownfield-create-epic.md +0 -160
  417. package/bmad-core/tasks/brownfield-create-story.md +0 -147
  418. package/bmad-core/tasks/correct-course.md +0 -70
  419. package/bmad-core/tasks/create-brownfield-story.md +0 -312
  420. package/bmad-core/tasks/create-deep-research-prompt.md +0 -278
  421. package/bmad-core/tasks/create-next-story.md +0 -112
  422. package/bmad-core/tasks/document-project.md +0 -343
  423. package/bmad-core/tasks/facilitate-brainstorming-session.md +0 -136
  424. package/bmad-core/tasks/generate-ai-frontend-prompt.md +0 -51
  425. package/bmad-core/tasks/index-docs.md +0 -173
  426. package/bmad-core/tasks/kb-mode-interaction.md +0 -75
  427. package/bmad-core/tasks/nfr-assess.md +0 -343
  428. package/bmad-core/tasks/qa-gate.md +0 -159
  429. package/bmad-core/tasks/review-story.md +0 -314
  430. package/bmad-core/tasks/risk-profile.md +0 -353
  431. package/bmad-core/tasks/shard-doc.md +0 -185
  432. package/bmad-core/tasks/test-design.md +0 -174
  433. package/bmad-core/tasks/trace-requirements.md +0 -264
  434. package/bmad-core/tasks/validate-next-story.md +0 -134
  435. package/bmad-core/templates/architecture-tmpl.yaml +0 -650
  436. package/bmad-core/templates/brainstorming-output-tmpl.yaml +0 -156
  437. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +0 -476
  438. package/bmad-core/templates/brownfield-prd-tmpl.yaml +0 -280
  439. package/bmad-core/templates/competitor-analysis-tmpl.yaml +0 -306
  440. package/bmad-core/templates/front-end-architecture-tmpl.yaml +0 -218
  441. package/bmad-core/templates/front-end-spec-tmpl.yaml +0 -349
  442. package/bmad-core/templates/fullstack-architecture-tmpl.yaml +0 -823
  443. package/bmad-core/templates/market-research-tmpl.yaml +0 -252
  444. package/bmad-core/templates/prd-tmpl.yaml +0 -202
  445. package/bmad-core/templates/project-brief-tmpl.yaml +0 -221
  446. package/bmad-core/templates/qa-gate-tmpl.yaml +0 -102
  447. package/bmad-core/templates/story-tmpl.yaml +0 -137
  448. package/bmad-core/workflows/brownfield-fullstack.yaml +0 -297
  449. package/bmad-core/workflows/brownfield-service.yaml +0 -187
  450. package/bmad-core/workflows/brownfield-ui.yaml +0 -197
  451. package/bmad-core/workflows/greenfield-fullstack.yaml +0 -240
  452. package/bmad-core/workflows/greenfield-service.yaml +0 -206
  453. package/bmad-core/workflows/greenfield-ui.yaml +0 -235
  454. package/common/tasks/create-doc.md +0 -101
  455. package/common/tasks/execute-checklist.md +0 -86
  456. package/common/utils/bmad-doc-template.md +0 -325
  457. package/common/utils/workflow-management.md +0 -69
  458. package/dist/agents/analyst.txt +0 -2889
  459. package/dist/agents/architect.txt +0 -3552
  460. package/dist/agents/bmad-master.txt +0 -8769
  461. package/dist/agents/bmad-orchestrator.txt +0 -1513
  462. package/dist/agents/dev.txt +0 -414
  463. package/dist/agents/pm.txt +0 -2204
  464. package/dist/agents/po.txt +0 -1346
  465. package/dist/agents/qa.txt +0 -1987
  466. package/dist/agents/sm.txt +0 -658
  467. package/dist/agents/ux-expert.txt +0 -694
  468. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +0 -2371
  469. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +0 -1620
  470. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +0 -815
  471. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +0 -10952
  472. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +0 -4012
  473. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +0 -3698
  474. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +0 -450
  475. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +0 -973
  476. package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +0 -15376
  477. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +0 -2075
  478. package/dist/teams/team-all.txt +0 -12682
  479. package/dist/teams/team-fullstack.txt +0 -10421
  480. package/dist/teams/team-ide-minimal.txt +0 -5103
  481. package/dist/teams/team-no-ui.txt +0 -8980
  482. package/docs/GUIDING-PRINCIPLES.md +0 -91
  483. package/docs/core-architecture.md +0 -219
  484. package/docs/enhanced-ide-development-workflow.md +0 -248
  485. package/docs/expansion-packs.md +0 -280
  486. package/docs/how-to-contribute-with-pull-requests.md +0 -158
  487. package/docs/user-guide.md +0 -504
  488. package/docs/versioning-and-releases.md +0 -147
  489. package/docs/versions.md +0 -48
  490. package/docs/working-in-the-brownfield.md +0 -597
  491. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/Complete AI Agent System - Flowchart.svg +0 -102
  492. 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
  493. 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
  494. 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
  495. 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
  496. 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
  497. 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
  498. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/README.md +0 -109
  499. package/expansion-packs/README.md +0 -3
  500. package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +0 -13
  501. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +0 -71
  502. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +0 -78
  503. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +0 -64
  504. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +0 -201
  505. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +0 -160
  506. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +0 -8
  507. package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +0 -250
  508. package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +0 -647
  509. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +0 -110
  510. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +0 -216
  511. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +0 -290
  512. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +0 -613
  513. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +0 -356
  514. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +0 -343
  515. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +0 -253
  516. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +0 -484
  517. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +0 -183
  518. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +0 -175
  519. package/expansion-packs/bmad-2d-unity-game-dev/agent-teams/unity-2d-game-team.yaml +0 -14
  520. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.md +0 -80
  521. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.md +0 -77
  522. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +0 -78
  523. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.md +0 -65
  524. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +0 -391
  525. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-change-checklist.md +0 -203
  526. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-design-checklist.md +0 -201
  527. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +0 -124
  528. package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +0 -6
  529. package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +0 -769
  530. package/expansion-packs/bmad-2d-unity-game-dev/data/development-guidelines.md +0 -586
  531. package/expansion-packs/bmad-2d-unity-game-dev/tasks/advanced-elicitation.md +0 -110
  532. package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +0 -141
  533. package/expansion-packs/bmad-2d-unity-game-dev/tasks/create-game-story.md +0 -184
  534. package/expansion-packs/bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md +0 -290
  535. package/expansion-packs/bmad-2d-unity-game-dev/tasks/validate-game-story.md +0 -200
  536. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml +0 -1030
  537. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +0 -356
  538. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +0 -705
  539. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +0 -256
  540. package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +0 -484
  541. package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-dev-greenfield.yaml +0 -183
  542. package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-prototype.yaml +0 -175
  543. package/expansion-packs/bmad-infrastructure-devops/README.md +0 -147
  544. package/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.md +0 -71
  545. package/expansion-packs/bmad-infrastructure-devops/checklists/infrastructure-checklist.md +0 -484
  546. package/expansion-packs/bmad-infrastructure-devops/config.yaml +0 -9
  547. package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +0 -305
  548. package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +0 -159
  549. package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +0 -153
  550. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +0 -424
  551. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +0 -629
  552. package/release_notes.md +0 -32
  553. package/tools/bmad-npx-wrapper.js +0 -39
  554. package/tools/builders/web-builder.js +0 -675
  555. package/tools/bump-all-versions.js +0 -115
  556. package/tools/bump-expansion-version.js +0 -90
  557. package/tools/cli.js +0 -152
  558. package/tools/installer/README.md +0 -8
  559. package/tools/installer/bin/bmad.js +0 -585
  560. package/tools/installer/config/ide-agent-config.yaml +0 -58
  561. package/tools/installer/config/install.config.yaml +0 -123
  562. package/tools/installer/lib/config-loader.js +0 -257
  563. package/tools/installer/lib/file-manager.js +0 -389
  564. package/tools/installer/lib/ide-base-setup.js +0 -228
  565. package/tools/installer/lib/ide-setup.js +0 -1441
  566. package/tools/installer/lib/installer.js +0 -1995
  567. package/tools/installer/lib/memory-profiler.js +0 -225
  568. package/tools/installer/lib/module-manager.js +0 -114
  569. package/tools/installer/lib/resource-locator.js +0 -308
  570. package/tools/installer/package.json +0 -44
  571. package/tools/lib/dependency-resolver.js +0 -175
  572. package/tools/lib/yaml-utils.js +0 -29
  573. package/tools/md-assets/web-agent-startup-instructions.md +0 -39
  574. package/tools/preview-release-notes.js +0 -66
  575. package/tools/shared/bannerArt.js +0 -105
  576. package/tools/sync-installer-version.js +0 -32
  577. package/tools/update-expansion-version.js +0 -53
  578. package/tools/upgraders/v3-to-v4-upgrader.js +0 -672
  579. package/tools/version-bump.js +0 -94
@@ -1,3698 +0,0 @@
1
- # Web Agent Bundle Instructions
2
-
3
- You are now operating as a specialized AI agent from the BMad-Method framework. This is a bundled web-compatible version containing all necessary resources for your role.
4
-
5
- ## Important Instructions
6
-
7
- 1. **Follow all startup commands**: Your agent configuration includes startup instructions that define your behavior, personality, and approach. These MUST be followed exactly.
8
-
9
- 2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
10
-
11
- - `==================== START: .bmad-2d-unity-game-dev/folder/filename.md ====================`
12
- - `==================== END: .bmad-2d-unity-game-dev/folder/filename.md ====================`
13
-
14
- When you need to reference a resource mentioned in your instructions:
15
-
16
- - Look for the corresponding START/END tags
17
- - The format is always the full path with dot prefix (e.g., `.bmad-2d-unity-game-dev/personas/analyst.md`, `.bmad-2d-unity-game-dev/tasks/create-story.md`)
18
- - If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
19
-
20
- **Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
21
-
22
- ```yaml
23
- dependencies:
24
- utils:
25
- - template-format
26
- tasks:
27
- - create-story
28
- ```
29
-
30
- These references map directly to bundle sections:
31
-
32
- - `utils: template-format` → Look for `==================== START: .bmad-2d-unity-game-dev/utils/template-format.md ====================`
33
- - `tasks: create-story` → Look for `==================== START: .bmad-2d-unity-game-dev/tasks/create-story.md ====================`
34
-
35
- 3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
36
-
37
- 4. **Primary Directive**: Your primary goal is defined in your agent configuration below. Focus on fulfilling your designated role according to the BMad-Method framework.
38
-
39
- ---
40
-
41
-
42
- ==================== START: .bmad-2d-unity-game-dev/agents/game-designer.md ====================
43
- # game-designer
44
-
45
- CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
46
-
47
- ```yaml
48
- activation-instructions:
49
- - ONLY load dependency files when user selects them for execution via command or request of a task
50
- - The agent.customization field ALWAYS takes precedence over any conflicting instructions
51
- - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
52
- - STAY IN CHARACTER!
53
- agent:
54
- name: Alex
55
- id: game-designer
56
- title: Game Design Specialist
57
- icon: 🎮
58
- whenToUse: Use for game concept development, GDD creation, game mechanics design, and player experience planning
59
- customization: null
60
- persona:
61
- role: Expert Game Designer & Creative Director
62
- style: Creative, player-focused, systematic, data-informed
63
- identity: Visionary who creates compelling game experiences through thoughtful design and player psychology understanding
64
- focus: Defining engaging gameplay systems, balanced progression, and clear development requirements for implementation teams
65
- core_principles:
66
- - Player-First Design - Every mechanic serves player engagement and fun
67
- - Checklist-Driven Validation - Apply game-design-checklist meticulously
68
- - Document Everything - Clear specifications enable proper development
69
- - Iterative Design - Prototype, test, refine approach to all systems
70
- - Technical Awareness - Design within feasible implementation constraints
71
- - Data-Driven Decisions - Use metrics and feedback to guide design choices
72
- - Numbered Options Protocol - Always use numbered lists for selections
73
- commands:
74
- - help: Show numbered list of available commands for selection
75
- - chat-mode: Conversational mode with advanced-elicitation for design advice
76
- - create: Show numbered list of documents I can create (from templates below)
77
- - brainstorm {topic}: Facilitate structured game design brainstorming session
78
- - research {topic}: Generate deep research prompt for game-specific investigation
79
- - elicit: Run advanced elicitation to clarify game design requirements
80
- - checklist {checklist}: Show numbered list of checklists, execute selection
81
- - shard-gdd: run the task shard-doc.md for the provided game-design-doc.md (ask if not found)
82
- - exit: Say goodbye as the Game Designer, and then abandon inhabiting this persona
83
- dependencies:
84
- tasks:
85
- - create-doc.md
86
- - execute-checklist.md
87
- - shard-doc.md
88
- - game-design-brainstorming.md
89
- - create-deep-research-prompt.md
90
- - advanced-elicitation.md
91
- templates:
92
- - game-design-doc-tmpl.yaml
93
- - level-design-doc-tmpl.yaml
94
- - game-brief-tmpl.yaml
95
- checklists:
96
- - game-design-checklist.md
97
- data:
98
- - bmad-kb.md
99
- ```
100
- ==================== END: .bmad-2d-unity-game-dev/agents/game-designer.md ====================
101
-
102
- ==================== START: .bmad-2d-unity-game-dev/tasks/create-doc.md ====================
103
- # Create Document from Template (YAML Driven)
104
-
105
- ## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
106
-
107
- **THIS IS AN EXECUTABLE WORKFLOW - NOT REFERENCE MATERIAL**
108
-
109
- When this task is invoked:
110
-
111
- 1. **DISABLE ALL EFFICIENCY OPTIMIZATIONS** - This workflow requires full user interaction
112
- 2. **MANDATORY STEP-BY-STEP EXECUTION** - Each section must be processed sequentially with user feedback
113
- 3. **ELICITATION IS REQUIRED** - When `elicit: true`, you MUST use the 1-9 format and wait for user response
114
- 4. **NO SHORTCUTS ALLOWED** - Complete documents cannot be created without following this workflow
115
-
116
- **VIOLATION INDICATOR:** If you create a complete document without user interaction, you have violated this workflow.
117
-
118
- ## Critical: Template Discovery
119
-
120
- If a YAML Template has not been provided, list all templates from .bmad-core/templates or ask the user to provide another.
121
-
122
- ## CRITICAL: Mandatory Elicitation Format
123
-
124
- **When `elicit: true`, this is a HARD STOP requiring user interaction:**
125
-
126
- **YOU MUST:**
127
-
128
- 1. Present section content
129
- 2. Provide detailed rationale (explain trade-offs, assumptions, decisions made)
130
- 3. **STOP and present numbered options 1-9:**
131
- - **Option 1:** Always "Proceed to next section"
132
- - **Options 2-9:** Select 8 methods from data/elicitation-methods
133
- - End with: "Select 1-9 or just type your question/feedback:"
134
- 4. **WAIT FOR USER RESPONSE** - Do not proceed until user selects option or provides feedback
135
-
136
- **WORKFLOW VIOLATION:** Creating content for elicit=true sections without user interaction violates this task.
137
-
138
- **NEVER ask yes/no questions or use any other format.**
139
-
140
- ## Processing Flow
141
-
142
- 1. **Parse YAML template** - Load template metadata and sections
143
- 2. **Set preferences** - Show current mode (Interactive), confirm output file
144
- 3. **Process each section:**
145
- - Skip if condition unmet
146
- - Check agent permissions (owner/editors) - note if section is restricted to specific agents
147
- - Draft content using section instruction
148
- - Present content + detailed rationale
149
- - **IF elicit: true** → MANDATORY 1-9 options format
150
- - Save to file if possible
151
- 4. **Continue until complete**
152
-
153
- ## Detailed Rationale Requirements
154
-
155
- When presenting section content, ALWAYS include rationale that explains:
156
-
157
- - Trade-offs and choices made (what was chosen over alternatives and why)
158
- - Key assumptions made during drafting
159
- - Interesting or questionable decisions that need user attention
160
- - Areas that might need validation
161
-
162
- ## Elicitation Results Flow
163
-
164
- After user selects elicitation method (2-9):
165
-
166
- 1. Execute method from data/elicitation-methods
167
- 2. Present results with insights
168
- 3. Offer options:
169
- - **1. Apply changes and update section**
170
- - **2. Return to elicitation menu**
171
- - **3. Ask any questions or engage further with this elicitation**
172
-
173
- ## Agent Permissions
174
-
175
- When processing sections with agent permission fields:
176
-
177
- - **owner**: Note which agent role initially creates/populates the section
178
- - **editors**: List agent roles allowed to modify the section
179
- - **readonly**: Mark sections that cannot be modified after creation
180
-
181
- **For sections with restricted access:**
182
-
183
- - Include a note in the generated document indicating the responsible agent
184
- - Example: "_(This section is owned by dev-agent and can only be modified by dev-agent)_"
185
-
186
- ## YOLO Mode
187
-
188
- User can type `#yolo` to toggle to YOLO mode (process all sections at once).
189
-
190
- ## CRITICAL REMINDERS
191
-
192
- **❌ NEVER:**
193
-
194
- - Ask yes/no questions for elicitation
195
- - Use any format other than 1-9 numbered options
196
- - Create new elicitation methods
197
-
198
- **✅ ALWAYS:**
199
-
200
- - Use exact 1-9 format when elicit: true
201
- - Select options 2-9 from data/elicitation-methods only
202
- - Provide detailed rationale explaining decisions
203
- - End with "Select 1-9 or just type your question/feedback:"
204
- ==================== END: .bmad-2d-unity-game-dev/tasks/create-doc.md ====================
205
-
206
- ==================== START: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
207
- # Checklist Validation Task
208
-
209
- This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
210
-
211
- ## Available Checklists
212
-
213
- If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the .bmad-2d-unity-game-dev/checklists folder to select the appropriate one to run.
214
-
215
- ## Instructions
216
-
217
- 1. **Initial Assessment**
218
- - If user or the task being run provides a checklist name:
219
- - Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
220
- - If multiple matches found, ask user to clarify
221
- - Load the appropriate checklist from .bmad-2d-unity-game-dev/checklists/
222
- - If no checklist specified:
223
- - Ask the user which checklist they want to use
224
- - Present the available options from the files in the checklists folder
225
- - Confirm if they want to work through the checklist:
226
- - Section by section (interactive mode - very time consuming)
227
- - All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
228
-
229
- 2. **Document and Artifact Gathering**
230
- - Each checklist will specify its required documents/artifacts at the beginning
231
- - Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
232
-
233
- 3. **Checklist Processing**
234
-
235
- If in interactive mode:
236
- - Work through each section of the checklist one at a time
237
- - For each section:
238
- - Review all items in the section following instructions for that section embedded in the checklist
239
- - Check each item against the relevant documentation or artifacts as appropriate
240
- - Present summary of findings for that section, highlighting warnings, errors and non applicable items (rationale for non-applicability).
241
- - Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
242
-
243
- If in YOLO mode:
244
- - Process all sections at once
245
- - Create a comprehensive report of all findings
246
- - Present the complete analysis to the user
247
-
248
- 4. **Validation Approach**
249
-
250
- For each checklist item:
251
- - Read and understand the requirement
252
- - Look for evidence in the documentation that satisfies the requirement
253
- - Consider both explicit mentions and implicit coverage
254
- - Aside from this, follow all checklist llm instructions
255
- - Mark items as:
256
- - ✅ PASS: Requirement clearly met
257
- - ❌ FAIL: Requirement not met or insufficient coverage
258
- - ⚠️ PARTIAL: Some aspects covered but needs improvement
259
- - N/A: Not applicable to this case
260
-
261
- 5. **Section Analysis**
262
-
263
- For each section:
264
- - think step by step to calculate pass rate
265
- - Identify common themes in failed items
266
- - Provide specific recommendations for improvement
267
- - In interactive mode, discuss findings with user
268
- - Document any user decisions or explanations
269
-
270
- 6. **Final Report**
271
-
272
- Prepare a summary that includes:
273
- - Overall checklist completion status
274
- - Pass rates by section
275
- - List of failed items with context
276
- - Specific recommendations for improvement
277
- - Any sections or items marked as N/A with justification
278
-
279
- ## Checklist Execution Methodology
280
-
281
- Each checklist now contains embedded LLM prompts and instructions that will:
282
-
283
- 1. **Guide thorough thinking** - Prompts ensure deep analysis of each section
284
- 2. **Request specific artifacts** - Clear instructions on what documents/access is needed
285
- 3. **Provide contextual guidance** - Section-specific prompts for better validation
286
- 4. **Generate comprehensive reports** - Final summary with detailed findings
287
-
288
- The LLM will:
289
-
290
- - Execute the complete checklist validation
291
- - Present a final report with pass/fail rates and key findings
292
- - Offer to provide detailed analysis of any section, especially those with warnings or failures
293
- ==================== END: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
294
-
295
- ==================== START: .bmad-2d-unity-game-dev/tasks/shard-doc.md ====================
296
- # Document Sharding Task
297
-
298
- ## Purpose
299
-
300
- - Split a large document into multiple smaller documents based on level 2 sections
301
- - Create a folder structure to organize the sharded documents
302
- - Maintain all content integrity including code blocks, diagrams, and markdown formatting
303
-
304
- ## Primary Method: Automatic with markdown-tree
305
-
306
- [[LLM: First, check if markdownExploder is set to true in .bmad-2d-unity-game-dev/core-config.yaml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
307
-
308
- If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
309
-
310
- If the command fails (especially with an error indicating the command is not found or not available), inform the user: "The markdownExploder setting is enabled but the md-tree command is not available. Please either:
311
-
312
- 1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
313
- 2. Or set markdownExploder to false in .bmad-2d-unity-game-dev/core-config.yaml
314
-
315
- **IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
316
-
317
- If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
318
-
319
- 1. Set markdownExploder to true in .bmad-2d-unity-game-dev/core-config.yaml
320
- 2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
321
-
322
- I will now proceed with the manual sharding process."
323
-
324
- Then proceed with the manual method below ONLY if markdownExploder is false.]]
325
-
326
- ### Installation and Usage
327
-
328
- 1. **Install globally**:
329
-
330
- ```bash
331
- npm install -g @kayvan/markdown-tree-parser
332
- ```
333
-
334
- 2. **Use the explode command**:
335
-
336
- ```bash
337
- # For PRD
338
- md-tree explode docs/prd.md docs/prd
339
-
340
- # For Architecture
341
- md-tree explode docs/architecture.md docs/architecture
342
-
343
- # For any document
344
- md-tree explode [source-document] [destination-folder]
345
- ```
346
-
347
- 3. **What it does**:
348
- - Automatically splits the document by level 2 sections
349
- - Creates properly named files
350
- - Adjusts heading levels appropriately
351
- - Handles all edge cases with code blocks and special markdown
352
-
353
- If the user has @kayvan/markdown-tree-parser installed, use it and skip the manual process below.
354
-
355
- ---
356
-
357
- ## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
358
-
359
- ### Task Instructions
360
-
361
- 1. Identify Document and Target Location
362
-
363
- - Determine which document to shard (user-provided path)
364
- - Create a new folder under `docs/` with the same name as the document (without extension)
365
- - Example: `docs/prd.md` → create folder `docs/prd/`
366
-
367
- 2. Parse and Extract Sections
368
-
369
- CRITICAL AEGNT SHARDING RULES:
370
-
371
- 1. Read the entire document content
372
- 2. Identify all level 2 sections (## headings)
373
- 3. For each level 2 section:
374
- - Extract the section heading and ALL content until the next level 2 section
375
- - Include all subsections, code blocks, diagrams, lists, tables, etc.
376
- - Be extremely careful with:
377
- - Fenced code blocks (```) - ensure you capture the full block including closing backticks and account for potential misleading level 2's that are actually part of a fenced section example
378
- - Mermaid diagrams - preserve the complete diagram syntax
379
- - Nested markdown elements
380
- - Multi-line content that might contain ## inside code blocks
381
-
382
- CRITICAL: Use proper parsing that understands markdown context. A ## inside a code block is NOT a section header.]]
383
-
384
- ### 3. Create Individual Files
385
-
386
- For each extracted section:
387
-
388
- 1. **Generate filename**: Convert the section heading to lowercase-dash-case
389
- - Remove special characters
390
- - Replace spaces with dashes
391
- - Example: "## Tech Stack" → `tech-stack.md`
392
-
393
- 2. **Adjust heading levels**:
394
- - The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
395
- - All subsection levels decrease by 1:
396
-
397
- ```txt
398
- - ### → ##
399
- - #### → ###
400
- - ##### → ####
401
- - etc.
402
- ```
403
-
404
- 3. **Write content**: Save the adjusted content to the new file
405
-
406
- ### 4. Create Index File
407
-
408
- Create an `index.md` file in the sharded folder that:
409
-
410
- 1. Contains the original level 1 heading and any content before the first level 2 section
411
- 2. Lists all the sharded files with links:
412
-
413
- ```markdown
414
- # Original Document Title
415
-
416
- [Original introduction content if any]
417
-
418
- ## Sections
419
-
420
- - [Section Name 1](./section-name-1.md)
421
- - [Section Name 2](./section-name-2.md)
422
- - [Section Name 3](./section-name-3.md)
423
- ...
424
- ```
425
-
426
- ### 5. Preserve Special Content
427
-
428
- 1. **Code blocks**: Must capture complete blocks including:
429
-
430
- ```language
431
- content
432
- ```
433
-
434
- 2. **Mermaid diagrams**: Preserve complete syntax:
435
-
436
- ```mermaid
437
- graph TD
438
- ...
439
- ```
440
-
441
- 3. **Tables**: Maintain proper markdown table formatting
442
-
443
- 4. **Lists**: Preserve indentation and nesting
444
-
445
- 5. **Inline code**: Preserve backticks
446
-
447
- 6. **Links and references**: Keep all markdown links intact
448
-
449
- 7. **Template markup**: If documents contain {{placeholders}} ,preserve exactly
450
-
451
- ### 6. Validation
452
-
453
- After sharding:
454
-
455
- 1. Verify all sections were extracted
456
- 2. Check that no content was lost
457
- 3. Ensure heading levels were properly adjusted
458
- 4. Confirm all files were created successfully
459
-
460
- ### 7. Report Results
461
-
462
- Provide a summary:
463
-
464
- ```text
465
- Document sharded successfully:
466
- - Source: [original document path]
467
- - Destination: docs/[folder-name]/
468
- - Files created: [count]
469
- - Sections:
470
- - section-name-1.md: "Section Title 1"
471
- - section-name-2.md: "Section Title 2"
472
- ...
473
- ```
474
-
475
- ## Important Notes
476
-
477
- - Never modify the actual content, only adjust heading levels
478
- - Preserve ALL formatting, including whitespace where significant
479
- - Handle edge cases like sections with code blocks containing ## symbols
480
- - Ensure the sharding is reversible (could reconstruct the original from shards)
481
- ==================== END: .bmad-2d-unity-game-dev/tasks/shard-doc.md ====================
482
-
483
- ==================== START: .bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md ====================
484
- # Game Design Brainstorming Techniques Task
485
-
486
- This task provides a comprehensive toolkit of creative brainstorming techniques specifically designed for game design ideation and innovative thinking. The game designer can use these techniques to facilitate productive brainstorming sessions focused on game mechanics, player experience, and creative concepts.
487
-
488
- ## Process
489
-
490
- ### 1. Session Setup
491
-
492
- [[LLM: Begin by understanding the game design context and goals. Ask clarifying questions if needed to determine the best approach for game-specific ideation.]]
493
-
494
- 1. **Establish Game Context**
495
- - Understand the game genre or opportunity area
496
- - Identify target audience and platform constraints
497
- - Determine session goals (concept exploration vs. mechanic refinement)
498
- - Clarify scope (full game vs. specific feature)
499
-
500
- 2. **Select Technique Approach**
501
- - Option A: User selects specific game design techniques
502
- - Option B: Game Designer recommends techniques based on context
503
- - Option C: Random technique selection for creative variety
504
- - Option D: Progressive technique flow (broad concepts to specific mechanics)
505
-
506
- ### 2. Game Design Brainstorming Techniques
507
-
508
- #### Game Concept Expansion Techniques
509
-
510
- 1. **"What If" Game Scenarios**
511
- [[LLM: Generate provocative what-if questions that challenge game design assumptions and expand thinking beyond current genre limitations.]]
512
- - What if players could rewind time in any genre?
513
- - What if the game world reacted to the player's real-world location?
514
- - What if failure was more rewarding than success?
515
- - What if players controlled the antagonist instead?
516
- - What if the game played itself when no one was watching?
517
-
518
- 2. **Cross-Genre Fusion**
519
- [[LLM: Help user combine unexpected game genres and mechanics to create unique experiences.]]
520
- - "How might [genre A] mechanics work in [genre B]?"
521
- - Puzzle mechanics in action games
522
- - Dating sim elements in strategy games
523
- - Horror elements in racing games
524
- - Educational content in roguelike structure
525
-
526
- 3. **Player Motivation Reversal**
527
- [[LLM: Flip traditional player motivations to reveal new gameplay possibilities.]]
528
- - What if losing was the goal?
529
- - What if cooperation was forced in competitive games?
530
- - What if players had to help their enemies?
531
- - What if progress meant giving up abilities?
532
-
533
- 4. **Core Loop Deconstruction**
534
- [[LLM: Break down successful games to fundamental mechanics and rebuild differently.]]
535
- - What are the essential 3 actions in this game type?
536
- - How could we make each action more interesting?
537
- - What if we changed the order of these actions?
538
- - What if players could skip or automate certain actions?
539
-
540
- #### Mechanic Innovation Frameworks
541
-
542
- 1. **SCAMPER for Game Mechanics**
543
- [[LLM: Guide through each SCAMPER prompt specifically for game design.]]
544
- - **S** = Substitute: What mechanics can be substituted? (walking → flying → swimming)
545
- - **C** = Combine: What systems can be merged? (inventory + character growth)
546
- - **A** = Adapt: What mechanics from other media? (books, movies, sports)
547
- - **M** = Modify/Magnify: What can be exaggerated? (super speed, massive scale)
548
- - **P** = Put to other uses: What else could this mechanic do? (jumping → attacking)
549
- - **E** = Eliminate: What can be removed? (UI, tutorials, fail states)
550
- - **R** = Reverse/Rearrange: What sequence changes? (end-to-start, simultaneous)
551
-
552
- 2. **Player Agency Spectrum**
553
- [[LLM: Explore different levels of player control and agency across game systems.]]
554
- - Full Control: Direct character movement, combat, building
555
- - Indirect Control: Setting rules, giving commands, environmental changes
556
- - Influence Only: Suggestions, preferences, emotional reactions
557
- - No Control: Observation, interpretation, passive experience
558
-
559
- 3. **Temporal Game Design**
560
- [[LLM: Explore how time affects gameplay and player experience.]]
561
- - Real-time vs. turn-based mechanics
562
- - Time travel and manipulation
563
- - Persistent vs. session-based progress
564
- - Asynchronous multiplayer timing
565
- - Seasonal and event-based content
566
-
567
- #### Player Experience Ideation
568
-
569
- 1. **Emotion-First Design**
570
- [[LLM: Start with target emotions and work backward to mechanics that create them.]]
571
- - Target Emotion: Wonder → Mechanics: Discovery, mystery, scale
572
- - Target Emotion: Triumph → Mechanics: Challenge, skill growth, recognition
573
- - Target Emotion: Connection → Mechanics: Cooperation, shared goals, communication
574
- - Target Emotion: Flow → Mechanics: Clear feedback, progressive difficulty
575
-
576
- 2. **Player Archetype Brainstorming**
577
- [[LLM: Design for different player types and motivations.]]
578
- - Achievers: Progression, completion, mastery
579
- - Explorers: Discovery, secrets, world-building
580
- - Socializers: Interaction, cooperation, community
581
- - Killers: Competition, dominance, conflict
582
- - Creators: Building, customization, expression
583
-
584
- 3. **Accessibility-First Innovation**
585
- [[LLM: Generate ideas that make games more accessible while creating new gameplay.]]
586
- - Visual impairment considerations leading to audio-focused mechanics
587
- - Motor accessibility inspiring one-handed or simplified controls
588
- - Cognitive accessibility driving clear feedback and pacing
589
- - Economic accessibility creating free-to-play innovations
590
-
591
- #### Narrative and World Building
592
-
593
- 1. **Environmental Storytelling**
594
- [[LLM: Brainstorm ways the game world itself tells stories without explicit narrative.]]
595
- - How does the environment show history?
596
- - What do interactive objects reveal about characters?
597
- - How can level design communicate mood?
598
- - What stories do systems and mechanics tell?
599
-
600
- 2. **Player-Generated Narrative**
601
- [[LLM: Explore ways players create their own stories through gameplay.]]
602
- - Emergent storytelling through player choices
603
- - Procedural narrative generation
604
- - Player-to-player story sharing
605
- - Community-driven world events
606
-
607
- 3. **Genre Expectation Subversion**
608
- [[LLM: Identify and deliberately subvert player expectations within genres.]]
609
- - Fantasy RPG where magic is mundane
610
- - Horror game where monsters are friendly
611
- - Racing game where going slow is optimal
612
- - Puzzle game where there are multiple correct answers
613
-
614
- #### Technical Innovation Inspiration
615
-
616
- 1. **Platform-Specific Design**
617
- [[LLM: Generate ideas that leverage unique platform capabilities.]]
618
- - Mobile: GPS, accelerometer, camera, always-connected
619
- - Web: URLs, tabs, social sharing, real-time collaboration
620
- - Console: Controllers, TV viewing, couch co-op
621
- - VR/AR: Physical movement, spatial interaction, presence
622
-
623
- 2. **Constraint-Based Creativity**
624
- [[LLM: Use technical or design constraints as creative catalysts.]]
625
- - One-button games
626
- - Games without graphics
627
- - Games that play in notification bars
628
- - Games using only system sounds
629
- - Games with intentionally bad graphics
630
-
631
- ### 3. Game-Specific Technique Selection
632
-
633
- [[LLM: Help user select appropriate techniques based on their specific game design needs.]]
634
-
635
- **For Initial Game Concepts:**
636
-
637
- - What If Game Scenarios
638
- - Cross-Genre Fusion
639
- - Emotion-First Design
640
-
641
- **For Stuck/Blocked Creativity:**
642
-
643
- - Player Motivation Reversal
644
- - Constraint-Based Creativity
645
- - Genre Expectation Subversion
646
-
647
- **For Mechanic Development:**
648
-
649
- - SCAMPER for Game Mechanics
650
- - Core Loop Deconstruction
651
- - Player Agency Spectrum
652
-
653
- **For Player Experience:**
654
-
655
- - Player Archetype Brainstorming
656
- - Emotion-First Design
657
- - Accessibility-First Innovation
658
-
659
- **For World Building:**
660
-
661
- - Environmental Storytelling
662
- - Player-Generated Narrative
663
- - Platform-Specific Design
664
-
665
- ### 4. Game Design Session Flow
666
-
667
- [[LLM: Guide the brainstorming session with appropriate pacing for game design exploration.]]
668
-
669
- 1. **Inspiration Phase** (10-15 min)
670
- - Reference existing games and mechanics
671
- - Explore player experiences and emotions
672
- - Gather visual and thematic inspiration
673
-
674
- 2. **Divergent Exploration** (25-35 min)
675
- - Generate many game concepts or mechanics
676
- - Use expansion and fusion techniques
677
- - Encourage wild and impossible ideas
678
-
679
- 3. **Player-Centered Filtering** (15-20 min)
680
- - Consider target audience reactions
681
- - Evaluate emotional impact and engagement
682
- - Group ideas by player experience goals
683
-
684
- 4. **Feasibility and Synthesis** (15-20 min)
685
- - Assess technical and design feasibility
686
- - Combine complementary ideas
687
- - Develop most promising concepts
688
-
689
- ### 5. Game Design Output Format
690
-
691
- [[LLM: Present brainstorming results in a format useful for game development.]]
692
-
693
- **Session Summary:**
694
-
695
- - Techniques used and focus areas
696
- - Total concepts/mechanics generated
697
- - Key themes and patterns identified
698
-
699
- **Game Concept Categories:**
700
-
701
- 1. **Core Game Ideas** - Complete game concepts ready for prototyping
702
- 2. **Mechanic Innovations** - Specific gameplay mechanics to explore
703
- 3. **Player Experience Goals** - Emotional and engagement targets
704
- 4. **Technical Experiments** - Platform or technology-focused concepts
705
- 5. **Long-term Vision** - Ambitious ideas for future development
706
-
707
- **Development Readiness:**
708
-
709
- **Prototype-Ready Ideas:**
710
-
711
- - Ideas that can be tested immediately
712
- - Minimum viable implementations
713
- - Quick validation approaches
714
-
715
- **Research-Required Ideas:**
716
-
717
- - Concepts needing technical investigation
718
- - Player testing and market research needs
719
- - Competitive analysis requirements
720
-
721
- **Future Innovation Pipeline:**
722
-
723
- - Ideas requiring significant development
724
- - Technology-dependent concepts
725
- - Market timing considerations
726
-
727
- **Next Steps:**
728
-
729
- - Which concepts to prototype first
730
- - Recommended research areas
731
- - Suggested playtesting approaches
732
- - Documentation and GDD planning
733
-
734
- ## Game Design Specific Considerations
735
-
736
- ### Platform and Audience Awareness
737
-
738
- - Always consider target platform limitations and advantages
739
- - Keep target audience preferences and expectations in mind
740
- - Balance innovation with familiar game design patterns
741
- - Consider monetization and business model implications
742
-
743
- ### Rapid Prototyping Mindset
744
-
745
- - Focus on ideas that can be quickly tested
746
- - Emphasize core mechanics over complex features
747
- - Design for iteration and player feedback
748
- - Consider digital and paper prototyping approaches
749
-
750
- ### Player Psychology Integration
751
-
752
- - Understand motivation and engagement drivers
753
- - Consider learning curves and skill development
754
- - Design for different play session lengths
755
- - Balance challenge and reward appropriately
756
-
757
- ### Technical Feasibility
758
-
759
- - Keep development resources and timeline in mind
760
- - Consider art and audio asset requirements
761
- - Think about performance and optimization needs
762
- - Plan for testing and debugging complexity
763
-
764
- ## Important Notes for Game Design Sessions
765
-
766
- - Encourage "impossible" ideas - constraints can be added later
767
- - Build on game mechanics that have proven engagement
768
- - Consider how ideas scale from prototype to full game
769
- - Document player experience goals alongside mechanics
770
- - Think about community and social aspects of gameplay
771
- - Consider accessibility and inclusivity from the start
772
- - Balance innovation with market viability
773
- - Plan for iteration based on player feedback
774
- ==================== END: .bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md ====================
775
-
776
- ==================== START: .bmad-2d-unity-game-dev/tasks/create-deep-research-prompt.md ====================
777
- # Create Deep Research Prompt Task
778
-
779
- This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
780
-
781
- ## Purpose
782
-
783
- Generate well-structured research prompts that:
784
-
785
- - Define clear research objectives and scope
786
- - Specify appropriate research methodologies
787
- - Outline expected deliverables and formats
788
- - Guide systematic investigation of complex topics
789
- - Ensure actionable insights are captured
790
-
791
- ## Research Type Selection
792
-
793
- CRITICAL: First, help the user select the most appropriate research focus based on their needs and any input documents they've provided.
794
-
795
- ### 1. Research Focus Options
796
-
797
- Present these numbered options to the user:
798
-
799
- 1. **Product Validation Research**
800
- - Validate product hypotheses and market fit
801
- - Test assumptions about user needs and solutions
802
- - Assess technical and business feasibility
803
- - Identify risks and mitigation strategies
804
-
805
- 2. **Market Opportunity Research**
806
- - Analyze market size and growth potential
807
- - Identify market segments and dynamics
808
- - Assess market entry strategies
809
- - Evaluate timing and market readiness
810
-
811
- 3. **User & Customer Research**
812
- - Deep dive into user personas and behaviors
813
- - Understand jobs-to-be-done and pain points
814
- - Map customer journeys and touchpoints
815
- - Analyze willingness to pay and value perception
816
-
817
- 4. **Competitive Intelligence Research**
818
- - Detailed competitor analysis and positioning
819
- - Feature and capability comparisons
820
- - Business model and strategy analysis
821
- - Identify competitive advantages and gaps
822
-
823
- 5. **Technology & Innovation Research**
824
- - Assess technology trends and possibilities
825
- - Evaluate technical approaches and architectures
826
- - Identify emerging technologies and disruptions
827
- - Analyze build vs. buy vs. partner options
828
-
829
- 6. **Industry & Ecosystem Research**
830
- - Map industry value chains and dynamics
831
- - Identify key players and relationships
832
- - Analyze regulatory and compliance factors
833
- - Understand partnership opportunities
834
-
835
- 7. **Strategic Options Research**
836
- - Evaluate different strategic directions
837
- - Assess business model alternatives
838
- - Analyze go-to-market strategies
839
- - Consider expansion and scaling paths
840
-
841
- 8. **Risk & Feasibility Research**
842
- - Identify and assess various risk factors
843
- - Evaluate implementation challenges
844
- - Analyze resource requirements
845
- - Consider regulatory and legal implications
846
-
847
- 9. **Custom Research Focus**
848
- - User-defined research objectives
849
- - Specialized domain investigation
850
- - Cross-functional research needs
851
-
852
- ### 2. Input Processing
853
-
854
- **If Project Brief provided:**
855
-
856
- - Extract key product concepts and goals
857
- - Identify target users and use cases
858
- - Note technical constraints and preferences
859
- - Highlight uncertainties and assumptions
860
-
861
- **If Brainstorming Results provided:**
862
-
863
- - Synthesize main ideas and themes
864
- - Identify areas needing validation
865
- - Extract hypotheses to test
866
- - Note creative directions to explore
867
-
868
- **If Market Research provided:**
869
-
870
- - Build on identified opportunities
871
- - Deepen specific market insights
872
- - Validate initial findings
873
- - Explore adjacent possibilities
874
-
875
- **If Starting Fresh:**
876
-
877
- - Gather essential context through questions
878
- - Define the problem space
879
- - Clarify research objectives
880
- - Establish success criteria
881
-
882
- ## Process
883
-
884
- ### 3. Research Prompt Structure
885
-
886
- CRITICAL: collaboratively develop a comprehensive research prompt with these components.
887
-
888
- #### A. Research Objectives
889
-
890
- CRITICAL: collaborate with the user to articulate clear, specific objectives for the research.
891
-
892
- - Primary research goal and purpose
893
- - Key decisions the research will inform
894
- - Success criteria for the research
895
- - Constraints and boundaries
896
-
897
- #### B. Research Questions
898
-
899
- CRITICAL: collaborate with the user to develop specific, actionable research questions organized by theme.
900
-
901
- **Core Questions:**
902
-
903
- - Central questions that must be answered
904
- - Priority ranking of questions
905
- - Dependencies between questions
906
-
907
- **Supporting Questions:**
908
-
909
- - Additional context-building questions
910
- - Nice-to-have insights
911
- - Future-looking considerations
912
-
913
- #### C. Research Methodology
914
-
915
- **Data Collection Methods:**
916
-
917
- - Secondary research sources
918
- - Primary research approaches (if applicable)
919
- - Data quality requirements
920
- - Source credibility criteria
921
-
922
- **Analysis Frameworks:**
923
-
924
- - Specific frameworks to apply
925
- - Comparison criteria
926
- - Evaluation methodologies
927
- - Synthesis approaches
928
-
929
- #### D. Output Requirements
930
-
931
- **Format Specifications:**
932
-
933
- - Executive summary requirements
934
- - Detailed findings structure
935
- - Visual/tabular presentations
936
- - Supporting documentation
937
-
938
- **Key Deliverables:**
939
-
940
- - Must-have sections and insights
941
- - Decision-support elements
942
- - Action-oriented recommendations
943
- - Risk and uncertainty documentation
944
-
945
- ### 4. Prompt Generation
946
-
947
- **Research Prompt Template:**
948
-
949
- ```markdown
950
- ## Research Objective
951
-
952
- [Clear statement of what this research aims to achieve]
953
-
954
- ## Background Context
955
-
956
- [Relevant information from project brief, brainstorming, or other inputs]
957
-
958
- ## Research Questions
959
-
960
- ### Primary Questions (Must Answer)
961
-
962
- 1. [Specific, actionable question]
963
- 2. [Specific, actionable question]
964
- ...
965
-
966
- ### Secondary Questions (Nice to Have)
967
-
968
- 1. [Supporting question]
969
- 2. [Supporting question]
970
- ...
971
-
972
- ## Research Methodology
973
-
974
- ### Information Sources
975
-
976
- - [Specific source types and priorities]
977
-
978
- ### Analysis Frameworks
979
-
980
- - [Specific frameworks to apply]
981
-
982
- ### Data Requirements
983
-
984
- - [Quality, recency, credibility needs]
985
-
986
- ## Expected Deliverables
987
-
988
- ### Executive Summary
989
-
990
- - Key findings and insights
991
- - Critical implications
992
- - Recommended actions
993
-
994
- ### Detailed Analysis
995
-
996
- [Specific sections needed based on research type]
997
-
998
- ### Supporting Materials
999
-
1000
- - Data tables
1001
- - Comparison matrices
1002
- - Source documentation
1003
-
1004
- ## Success Criteria
1005
-
1006
- [How to evaluate if research achieved its objectives]
1007
-
1008
- ## Timeline and Priority
1009
-
1010
- [If applicable, any time constraints or phasing]
1011
- ```
1012
-
1013
- ### 5. Review and Refinement
1014
-
1015
- 1. **Present Complete Prompt**
1016
- - Show the full research prompt
1017
- - Explain key elements and rationale
1018
- - Highlight any assumptions made
1019
-
1020
- 2. **Gather Feedback**
1021
- - Are the objectives clear and correct?
1022
- - Do the questions address all concerns?
1023
- - Is the scope appropriate?
1024
- - Are output requirements sufficient?
1025
-
1026
- 3. **Refine as Needed**
1027
- - Incorporate user feedback
1028
- - Adjust scope or focus
1029
- - Add missing elements
1030
- - Clarify ambiguities
1031
-
1032
- ### 6. Next Steps Guidance
1033
-
1034
- **Execution Options:**
1035
-
1036
- 1. **Use with AI Research Assistant**: Provide this prompt to an AI model with research capabilities
1037
- 2. **Guide Human Research**: Use as a framework for manual research efforts
1038
- 3. **Hybrid Approach**: Combine AI and human research using this structure
1039
-
1040
- **Integration Points:**
1041
-
1042
- - How findings will feed into next phases
1043
- - Which team members should review results
1044
- - How to validate findings
1045
- - When to revisit or expand research
1046
-
1047
- ## Important Notes
1048
-
1049
- - The quality of the research prompt directly impacts the quality of insights gathered
1050
- - Be specific rather than general in research questions
1051
- - Consider both current state and future implications
1052
- - Balance comprehensiveness with focus
1053
- - Document assumptions and limitations clearly
1054
- - Plan for iterative refinement based on initial findings
1055
- ==================== END: .bmad-2d-unity-game-dev/tasks/create-deep-research-prompt.md ====================
1056
-
1057
- ==================== START: .bmad-2d-unity-game-dev/tasks/advanced-elicitation.md ====================
1058
- # Advanced Game Design Elicitation Task
1059
-
1060
- ## Purpose
1061
-
1062
- - Provide optional reflective and brainstorming actions to enhance game design content quality
1063
- - Enable deeper exploration of game mechanics and player experience through structured elicitation techniques
1064
- - Support iterative refinement through multiple game development perspectives
1065
- - Apply game-specific critical thinking to design decisions
1066
-
1067
- ## Task Instructions
1068
-
1069
- ### 1. Game Design Context and Review
1070
-
1071
- [[LLM: When invoked after outputting a game design section:
1072
-
1073
- 1. First, provide a brief 1-2 sentence summary of what the user should look for in the section just presented, with game-specific focus (e.g., "Please review the core mechanics for player engagement and implementation feasibility. Pay special attention to how these mechanics create the intended player experience and whether they're technically achievable with Unity.")
1074
-
1075
- 2. If the section contains game flow diagrams, level layouts, or system diagrams, explain each diagram briefly with game development context before offering elicitation options (e.g., "The gameplay loop diagram shows how player actions lead to rewards and progression. Notice how each step maintains player engagement and creates opportunities for skill development.")
1076
-
1077
- 3. If the section contains multiple game elements (like multiple mechanics, multiple levels, multiple systems, etc.), inform the user they can apply elicitation actions to:
1078
- - The entire section as a whole
1079
- - Individual game elements within the section (specify which element when selecting an action)
1080
-
1081
- 4. Then present the action list as specified below.]]
1082
-
1083
- ### 2. Ask for Review and Present Game Design Action List
1084
-
1085
- [[LLM: Ask the user to review the drafted game design section. In the SAME message, inform them that they can suggest additions, removals, or modifications, OR they can select an action by number from the 'Advanced Game Design Elicitation & Brainstorming Actions'. If there are multiple game elements in the section, mention they can specify which element(s) to apply the action to. Then, present ONLY the numbered list (0-9) of these actions. Conclude by stating that selecting 9 will proceed to the next section. Await user selection. If an elicitation action (0-8) is chosen, execute it and then re-offer this combined review/elicitation choice. If option 9 is chosen, or if the user provides direct feedback, proceed accordingly.]]
1086
-
1087
- **Present the numbered list (0-9) with this exact format:**
1088
-
1089
- ```text
1090
- **Advanced Game Design Elicitation & Brainstorming Actions**
1091
- Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
1092
-
1093
- 0. Expand or Contract for Target Audience
1094
- 1. Explain Game Design Reasoning (Step-by-Step)
1095
- 2. Critique and Refine from Player Perspective
1096
- 3. Analyze Game Flow and Mechanic Dependencies
1097
- 4. Assess Alignment with Player Experience Goals
1098
- 5. Identify Potential Player Confusion and Design Risks
1099
- 6. Challenge from Critical Game Design Perspective
1100
- 7. Explore Alternative Game Design Approaches
1101
- 8. Hindsight Postmortem: The 'If Only...' Game Design Reflection
1102
- 9. Proceed / No Further Actions
1103
- ```
1104
-
1105
- ### 2. Processing Guidelines
1106
-
1107
- **Do NOT show:**
1108
-
1109
- - The full protocol text with `[[LLM: ...]]` instructions
1110
- - Detailed explanations of each option unless executing or the user asks, when giving the definition you can modify to tie its game development relevance
1111
- - Any internal template markup
1112
-
1113
- **After user selection from the list:**
1114
-
1115
- - Execute the chosen action according to the game design protocol instructions below
1116
- - Ask if they want to select another action or proceed with option 9 once complete
1117
- - Continue until user selects option 9 or indicates completion
1118
-
1119
- ## Game Design Action Definitions
1120
-
1121
- 0. Expand or Contract for Target Audience
1122
- [[LLM: Ask the user whether they want to 'expand' on the game design content (add more detail, elaborate on mechanics, include more examples) or 'contract' it (simplify mechanics, focus on core features, reduce complexity). Also, ask if there's a specific player demographic or experience level they have in mind (casual players, hardcore gamers, children, etc.). Once clarified, perform the expansion or contraction from your current game design role's perspective, tailored to the specified player audience if provided.]]
1123
-
1124
- 1. Explain Game Design Reasoning (Step-by-Step)
1125
- [[LLM: Explain the step-by-step game design thinking process that you used to arrive at the current proposal for this game content. Focus on player psychology, engagement mechanics, technical feasibility, and how design decisions support the overall player experience goals.]]
1126
-
1127
- 2. Critique and Refine from Player Perspective
1128
- [[LLM: From your current game design role's perspective, review your last output or the current section for potential player confusion, engagement issues, balance problems, or areas for improvement. Consider how players will actually interact with and experience these systems, then suggest a refined version that better serves player enjoyment and understanding.]]
1129
-
1130
- 3. Analyze Game Flow and Mechanic Dependencies
1131
- [[LLM: From your game design role's standpoint, examine the content's structure for logical gameplay progression, mechanic interdependencies, and player learning curve. Confirm if game elements are introduced in an effective order that teaches players naturally and maintains engagement throughout the experience.]]
1132
-
1133
- 4. Assess Alignment with Player Experience Goals
1134
- [[LLM: Evaluate how well the current game design content contributes to the stated player experience goals and core game pillars. Consider whether the mechanics actually create the intended emotions and engagement patterns. Identify any misalignments between design intentions and likely player reactions.]]
1135
-
1136
- 5. Identify Potential Player Confusion and Design Risks
1137
- [[LLM: Based on your game design expertise, brainstorm potential sources of player confusion, overlooked edge cases in gameplay, balance issues, technical implementation risks, or unintended player behaviors that could emerge from the current design. Consider both new and experienced players' perspectives.]]
1138
-
1139
- 6. Challenge from Critical Game Design Perspective
1140
- [[LLM: Adopt a critical game design perspective on the current content. If the user specifies another viewpoint (e.g., 'as a casual player', 'as a speedrunner', 'as a mobile player', 'as a technical implementer'), critique the content from that specified perspective. If no other role is specified, play devil's advocate from your game design expertise, arguing against the current design proposal and highlighting potential weaknesses, player experience issues, or implementation challenges. This can include questioning scope creep, unnecessary complexity, or features that don't serve the core player experience.]]
1141
-
1142
- 7. Explore Alternative Game Design Approaches
1143
- [[LLM: From your game design role's perspective, first broadly brainstorm a range of diverse approaches to achieving the same player experience goals or solving the same design challenge. Consider different genres, mechanics, interaction models, or technical approaches. Then, from this wider exploration, select and present 2-3 distinct alternative design approaches, detailing the pros, cons, player experience implications, and technical feasibility you foresee for each.]]
1144
-
1145
- 8. Hindsight Postmortem: The 'If Only...' Game Design Reflection
1146
- [[LLM: In your current game design persona, imagine this is a postmortem for a shipped game based on the current design content. What's the one 'if only we had designed/considered/tested X...' that your role would highlight from a game design perspective? Include the imagined player reactions, review scores, or development consequences. This should be both insightful and somewhat humorous, focusing on common game design pitfalls.]]
1147
-
1148
- 9. Proceed / No Further Actions
1149
- [[LLM: Acknowledge the user's choice to finalize the current game design work, accept the AI's last output as is, or move on to the next step without selecting another action from this list. Prepare to proceed accordingly.]]
1150
-
1151
- ## Game Development Context Integration
1152
-
1153
- This elicitation task is specifically designed for game development and should be used in contexts where:
1154
-
1155
- - **Game Mechanics Design**: When defining core gameplay systems and player interactions
1156
- - **Player Experience Planning**: When designing for specific emotional responses and engagement patterns
1157
- - **Technical Game Architecture**: When balancing design ambitions with implementation realities
1158
- - **Game Balance and Progression**: When designing difficulty curves and player advancement systems
1159
- - **Platform Considerations**: When adapting designs for different devices and input methods
1160
-
1161
- The questions and perspectives offered should always consider:
1162
-
1163
- - Player psychology and motivation
1164
- - Technical feasibility with Unity and C#
1165
- - Performance implications for stable frame rate targets
1166
- - Cross-platform compatibility (PC, console, mobile)
1167
- - Game development best practices and common pitfalls
1168
- ==================== END: .bmad-2d-unity-game-dev/tasks/advanced-elicitation.md ====================
1169
-
1170
- ==================== START: .bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml ====================
1171
- template:
1172
- id: game-design-doc-template-v3
1173
- name: Game Design Document (GDD)
1174
- version: 4.0
1175
- output:
1176
- format: markdown
1177
- filename: docs/game-design-document.md
1178
- title: "{{game_title}} Game Design Document (GDD)"
1179
-
1180
- workflow:
1181
- mode: interactive
1182
- elicitation: advanced-elicitation
1183
-
1184
- sections:
1185
- - id: goals-context
1186
- title: Goals and Background Context
1187
- instruction: |
1188
- Ask if Project Brief document is available. If NO Project Brief exists, STRONGLY recommend creating one first using project-brief-tmpl (it provides essential foundation: problem statement, target users, success metrics, MVP scope, constraints). If user insists on GDD without brief, gather this information during Goals section. If Project Brief exists, review and use it to populate Goals (bullet list of desired game development outcomes) and Background Context (1-2 paragraphs on what game concept this will deliver and why) so we can determine what is and is not in scope for the GDD. Include Change Log table for version tracking.
1189
- sections:
1190
- - id: goals
1191
- title: Goals
1192
- type: bullet-list
1193
- instruction: Bullet list of 1 line desired outcomes the GDD will deliver if successful - game development and player experience goals
1194
- examples:
1195
- - Create an engaging 2D platformer that teaches players basic programming concepts
1196
- - Deliver a polished mobile game that runs smoothly on low-end Android devices
1197
- - Build a foundation for future expansion packs and content updates
1198
- - id: background
1199
- title: Background Context
1200
- type: paragraphs
1201
- instruction: 1-2 short paragraphs summarizing the game concept background, target audience needs, market opportunity, and what problem this game solves
1202
- - id: changelog
1203
- title: Change Log
1204
- type: table
1205
- columns: [Date, Version, Description, Author]
1206
- instruction: Track document versions and changes
1207
-
1208
- - id: executive-summary
1209
- title: Executive Summary
1210
- instruction: Create a compelling overview that captures the essence of the game. Present this section first and get user feedback before proceeding.
1211
- elicit: true
1212
- sections:
1213
- - id: core-concept
1214
- title: Core Concept
1215
- instruction: 2-3 sentences that clearly describe what the game is and why players will love it
1216
- examples:
1217
- - A fast-paced 2D platformer where players manipulate gravity to solve puzzles and defeat enemies in a hand-drawn world.
1218
- - An educational puzzle game that teaches coding concepts through visual programming blocks in a fantasy adventure setting.
1219
- - id: target-audience
1220
- title: Target Audience
1221
- instruction: Define the primary and secondary audience with demographics and gaming preferences
1222
- template: |
1223
- **Primary:** {{age_range}}, {{player_type}}, {{platform_preference}}
1224
- **Secondary:** {{secondary_audience}}
1225
- examples:
1226
- - "Primary: Ages 8-16, casual mobile gamers, prefer short play sessions"
1227
- - "Secondary: Adult puzzle enthusiasts, educators looking for teaching tools"
1228
- - id: platform-technical
1229
- title: Platform & Technical Requirements
1230
- instruction: Based on the technical preferences or user input, define the target platforms and Unity-specific requirements
1231
- template: |
1232
- **Primary Platform:** {{platform}}
1233
- **Engine:** Unity {{unity_version}} & C#
1234
- **Performance Target:** Stable {{fps_target}} FPS on {{minimum_device}}
1235
- **Screen Support:** {{resolution_range}}
1236
- **Build Targets:** {{build_targets}}
1237
- examples:
1238
- - "Primary Platform: Mobile (iOS/Android), Engine: Unity 2022.3 LTS & C#, Performance: 60 FPS on iPhone 8/Galaxy S8"
1239
- - id: unique-selling-points
1240
- title: Unique Selling Points
1241
- instruction: List 3-5 key features that differentiate this game from competitors
1242
- type: numbered-list
1243
- examples:
1244
- - Innovative gravity manipulation mechanic that affects both player and environment
1245
- - Seamless integration of educational content without compromising fun gameplay
1246
- - Adaptive difficulty system that learns from player behavior
1247
-
1248
- - id: core-gameplay
1249
- title: Core Gameplay
1250
- instruction: This section defines the fundamental game mechanics. After presenting each subsection, apply advanced elicitation to ensure completeness and gather additional details.
1251
- elicit: true
1252
- sections:
1253
- - id: game-pillars
1254
- title: Game Pillars
1255
- instruction: Define 3-5 core pillars that guide all design decisions. These should be specific and actionable for Unity development.
1256
- type: numbered-list
1257
- template: |
1258
- **{{pillar_name}}** - {{description}}
1259
- examples:
1260
- - Intuitive Controls - All interactions must be learnable within 30 seconds using touch or keyboard
1261
- - Immediate Feedback - Every player action provides visual and audio response within 0.1 seconds
1262
- - Progressive Challenge - Difficulty increases through mechanic complexity, not unfair timing
1263
- - id: core-gameplay-loop
1264
- title: Core Gameplay Loop
1265
- instruction: Define the 30-60 second loop that players will repeat. Be specific about timing and player actions for Unity implementation.
1266
- template: |
1267
- **Primary Loop ({{duration}} seconds):**
1268
-
1269
- 1. {{action_1}} ({{time_1}}s) - {{unity_component}}
1270
- 2. {{action_2}} ({{time_2}}s) - {{unity_component}}
1271
- 3. {{action_3}} ({{time_3}}s) - {{unity_component}}
1272
- 4. {{reward_feedback}} ({{time_4}}s) - {{unity_component}}
1273
- examples:
1274
- - Observe environment (2s) - Camera Controller, Identify puzzle elements (3s) - Highlight System
1275
- - id: win-loss-conditions
1276
- title: Win/Loss Conditions
1277
- instruction: Clearly define success and failure states with Unity-specific implementation notes
1278
- template: |
1279
- **Victory Conditions:**
1280
-
1281
- - {{win_condition_1}} - Unity Event: {{unity_event}}
1282
- - {{win_condition_2}} - Unity Event: {{unity_event}}
1283
-
1284
- **Failure States:**
1285
-
1286
- - {{loss_condition_1}} - Trigger: {{unity_trigger}}
1287
- - {{loss_condition_2}} - Trigger: {{unity_trigger}}
1288
- examples:
1289
- - "Victory: Player reaches exit portal - Unity Event: OnTriggerEnter2D with Portal tag"
1290
- - "Failure: Health reaches zero - Trigger: Health component value <= 0"
1291
-
1292
- - id: game-mechanics
1293
- title: Game Mechanics
1294
- instruction: Detail each major mechanic that will need Unity implementation. Each mechanic should be specific enough for developers to create C# scripts and prefabs.
1295
- elicit: true
1296
- sections:
1297
- - id: primary-mechanics
1298
- title: Primary Mechanics
1299
- repeatable: true
1300
- sections:
1301
- - id: mechanic
1302
- title: "{{mechanic_name}}"
1303
- template: |
1304
- **Description:** {{detailed_description}}
1305
-
1306
- **Player Input:** {{input_method}} - Unity Input System: {{input_action}}
1307
-
1308
- **System Response:** {{game_response}}
1309
-
1310
- **Unity Implementation Notes:**
1311
-
1312
- - **Components Needed:** {{component_list}}
1313
- - **Physics Requirements:** {{physics_2d_setup}}
1314
- - **Animation States:** {{animator_states}}
1315
- - **Performance Considerations:** {{optimization_notes}}
1316
-
1317
- **Dependencies:** {{other_mechanics_needed}}
1318
-
1319
- **Script Architecture:**
1320
-
1321
- - {{script_name}}.cs - {{responsibility}}
1322
- - {{manager_script}}.cs - {{management_role}}
1323
- examples:
1324
- - "Components Needed: Rigidbody2D, BoxCollider2D, PlayerMovement script"
1325
- - "Physics Requirements: 2D Physics material for ground friction, Gravity scale 3"
1326
- - id: controls
1327
- title: Controls
1328
- instruction: Define all input methods for different platforms using Unity's Input System
1329
- type: table
1330
- template: |
1331
- | Action | Desktop | Mobile | Gamepad | Unity Input Action |
1332
- | ------ | ------- | ------ | ------- | ------------------ |
1333
- | {{action}} | {{key}} | {{gesture}} | {{button}} | {{input_action}} |
1334
- examples:
1335
- - Move Left, A/Left Arrow, Swipe Left, Left Stick, <Move>/x
1336
-
1337
- - id: progression-balance
1338
- title: Progression & Balance
1339
- instruction: Define how players advance and how difficulty scales. This section should provide clear parameters for Unity implementation and scriptable objects.
1340
- elicit: true
1341
- sections:
1342
- - id: player-progression
1343
- title: Player Progression
1344
- template: |
1345
- **Progression Type:** {{linear|branching|metroidvania}}
1346
-
1347
- **Key Milestones:**
1348
-
1349
- 1. **{{milestone_1}}** - {{unlock_description}} - Unity: {{scriptable_object_update}}
1350
- 2. **{{milestone_2}}** - {{unlock_description}} - Unity: {{scriptable_object_update}}
1351
- 3. **{{milestone_3}}** - {{unlock_description}} - Unity: {{scriptable_object_update}}
1352
-
1353
- **Save Data Structure:**
1354
-
1355
- ```csharp
1356
- [System.Serializable]
1357
- public class PlayerProgress
1358
- {
1359
- {{progress_fields}}
1360
- }
1361
- ```
1362
- examples:
1363
- - public int currentLevel, public bool[] unlockedAbilities, public float totalPlayTime
1364
- - id: difficulty-curve
1365
- title: Difficulty Curve
1366
- instruction: Provide specific parameters for balancing that can be implemented as Unity ScriptableObjects
1367
- template: |
1368
- **Tutorial Phase:** {{duration}} - {{difficulty_description}}
1369
- - Unity Config: {{scriptable_object_values}}
1370
-
1371
- **Early Game:** {{duration}} - {{difficulty_description}}
1372
- - Unity Config: {{scriptable_object_values}}
1373
-
1374
- **Mid Game:** {{duration}} - {{difficulty_description}}
1375
- - Unity Config: {{scriptable_object_values}}
1376
-
1377
- **Late Game:** {{duration}} - {{difficulty_description}}
1378
- - Unity Config: {{scriptable_object_values}}
1379
- examples:
1380
- - "enemy speed: 2.0f, jump height: 4.5f, obstacle density: 0.3f"
1381
- - id: economy-resources
1382
- title: Economy & Resources
1383
- condition: has_economy
1384
- instruction: Define any in-game currencies, resources, or collectibles with Unity implementation details
1385
- type: table
1386
- template: |
1387
- | Resource | Earn Rate | Spend Rate | Purpose | Cap | Unity ScriptableObject |
1388
- | -------- | --------- | ---------- | ------- | --- | --------------------- |
1389
- | {{resource}} | {{rate}} | {{rate}} | {{use}} | {{max}} | {{so_name}} |
1390
- examples:
1391
- - Coins, 1-3 per enemy, 10-50 per upgrade, Buy abilities, 9999, CurrencyData
1392
-
1393
- - id: level-design-framework
1394
- title: Level Design Framework
1395
- instruction: Provide guidelines for level creation that developers can use to create Unity scenes and prefabs. Focus on modular design and reusable components.
1396
- elicit: true
1397
- sections:
1398
- - id: level-types
1399
- title: Level Types
1400
- repeatable: true
1401
- sections:
1402
- - id: level-type
1403
- title: "{{level_type_name}}"
1404
- template: |
1405
- **Purpose:** {{gameplay_purpose}}
1406
- **Target Duration:** {{target_time}}
1407
- **Key Elements:** {{required_mechanics}}
1408
- **Difficulty Rating:** {{relative_difficulty}}
1409
-
1410
- **Unity Scene Structure:**
1411
-
1412
- - **Environment:** {{tilemap_setup}}
1413
- - **Gameplay Objects:** {{prefab_list}}
1414
- - **Lighting:** {{lighting_setup}}
1415
- - **Audio:** {{audio_sources}}
1416
-
1417
- **Level Flow Template:**
1418
-
1419
- - **Introduction:** {{intro_description}} - Area: {{unity_area_bounds}}
1420
- - **Challenge:** {{main_challenge}} - Mechanics: {{active_components}}
1421
- - **Resolution:** {{completion_requirement}} - Trigger: {{completion_trigger}}
1422
-
1423
- **Reusable Prefabs:**
1424
-
1425
- - {{prefab_name}} - {{prefab_purpose}}
1426
- examples:
1427
- - "Environment: TilemapRenderer with Platform tileset, Lighting: 2D Global Light + Point Lights"
1428
- - id: level-progression
1429
- title: Level Progression
1430
- template: |
1431
- **World Structure:** {{linear|hub|open}}
1432
- **Total Levels:** {{number}}
1433
- **Unlock Pattern:** {{progression_method}}
1434
- **Scene Management:** {{unity_scene_loading}}
1435
-
1436
- **Unity Scene Organization:**
1437
-
1438
- - Scene Naming: {{naming_convention}}
1439
- - Addressable Assets: {{addressable_groups}}
1440
- - Loading Screens: {{loading_implementation}}
1441
- examples:
1442
- - "Scene Naming: World{X}_Level{Y}_Name, Addressable Groups: Levels_World1, World_Environments"
1443
-
1444
- - id: technical-specifications
1445
- title: Technical Specifications
1446
- instruction: Define Unity-specific technical requirements that will guide architecture and implementation decisions. Reference Unity documentation and best practices.
1447
- elicit: true
1448
- choices:
1449
- render_pipeline: [Built-in, URP, HDRP]
1450
- input_system: [Legacy, New Input System, Both]
1451
- physics: [2D Only, 3D Only, Hybrid]
1452
- sections:
1453
- - id: unity-configuration
1454
- title: Unity Project Configuration
1455
- template: |
1456
- **Unity Version:** {{unity_version}} (LTS recommended)
1457
- **Render Pipeline:** {{Built-in|URP|HDRP}}
1458
- **Input System:** {{Legacy|New Input System|Both}}
1459
- **Physics:** {{2D Only|3D Only|Hybrid}}
1460
- **Scripting Backend:** {{Mono|IL2CPP}}
1461
- **API Compatibility:** {{.NET Standard 2.1|.NET Framework}}
1462
-
1463
- **Required Packages:**
1464
-
1465
- - {{package_name}} {{version}} - {{purpose}}
1466
-
1467
- **Project Settings:**
1468
-
1469
- - Color Space: {{Linear|Gamma}}
1470
- - Quality Settings: {{quality_levels}}
1471
- - Physics Settings: {{physics_config}}
1472
- examples:
1473
- - com.unity.addressables 1.20.5 - Asset loading and memory management
1474
- - "Color Space: Linear, Quality: Mobile/Desktop presets, Gravity: -20"
1475
- - id: performance-requirements
1476
- title: Performance Requirements
1477
- template: |
1478
- **Frame Rate:** {{fps_target}} FPS (minimum {{min_fps}} on low-end devices)
1479
- **Memory Usage:** <{{memory_limit}}MB heap, <{{texture_memory}}MB textures
1480
- **Load Times:** <{{load_time}}s initial, <{{level_load}}s between levels
1481
- **Battery Usage:** Optimized for mobile devices - {{battery_target}} hours gameplay
1482
-
1483
- **Unity Profiler Targets:**
1484
-
1485
- - CPU Frame Time: <{{cpu_time}}ms
1486
- - GPU Frame Time: <{{gpu_time}}ms
1487
- - GC Allocs: <{{gc_limit}}KB per frame
1488
- - Draw Calls: <{{draw_calls}} per frame
1489
- examples:
1490
- - "60 FPS (minimum 30), CPU: <16.67ms, GPU: <16.67ms, GC: <4KB, Draws: <50"
1491
- - id: platform-specific
1492
- title: Platform Specific Requirements
1493
- template: |
1494
- **Desktop:**
1495
-
1496
- - Resolution: {{min_resolution}} - {{max_resolution}}
1497
- - Input: Keyboard, Mouse, Gamepad ({{gamepad_support}})
1498
- - Build Target: {{desktop_targets}}
1499
-
1500
- **Mobile:**
1501
-
1502
- - Resolution: {{mobile_min}} - {{mobile_max}}
1503
- - Input: Touch, Accelerometer ({{sensor_support}})
1504
- - OS: iOS {{ios_min}}+, Android {{android_min}}+ (API {{api_level}})
1505
- - Device Requirements: {{device_specs}}
1506
-
1507
- **Web (if applicable):**
1508
-
1509
- - WebGL Version: {{webgl_version}}
1510
- - Browser Support: {{browser_list}}
1511
- - Compression: {{compression_format}}
1512
- examples:
1513
- - "Resolution: 1280x720 - 4K, Gamepad: Xbox/PlayStation controllers via Input System"
1514
- - id: asset-requirements
1515
- title: Asset Requirements
1516
- instruction: Define asset specifications for Unity pipeline optimization
1517
- template: |
1518
- **2D Art Assets:**
1519
-
1520
- - Sprites: {{sprite_resolution}} at {{ppu}} PPU
1521
- - Texture Format: {{texture_compression}}
1522
- - Atlas Strategy: {{sprite_atlas_setup}}
1523
- - Animation: {{animation_type}} at {{framerate}} FPS
1524
-
1525
- **Audio Assets:**
1526
-
1527
- - Music: {{audio_format}} at {{sample_rate}} Hz
1528
- - SFX: {{sfx_format}} at {{sfx_sample_rate}} Hz
1529
- - Compression: {{audio_compression}}
1530
- - 3D Audio: {{spatial_audio}}
1531
-
1532
- **UI Assets:**
1533
-
1534
- - Canvas Resolution: {{ui_resolution}}
1535
- - UI Scale Mode: {{scale_mode}}
1536
- - Font: {{font_requirements}}
1537
- - Icon Sizes: {{icon_specifications}}
1538
- examples:
1539
- - "Sprites: 32x32 to 256x256 at 16 PPU, Format: RGBA32 for quality/RGBA16 for performance"
1540
-
1541
- - id: technical-architecture-requirements
1542
- title: Technical Architecture Requirements
1543
- instruction: Define high-level Unity architecture patterns and systems that the game must support. Focus on scalability and maintainability.
1544
- elicit: true
1545
- choices:
1546
- architecture_pattern: [MVC, MVVM, ECS, Component-Based]
1547
- save_system: [PlayerPrefs, JSON, Binary, Cloud]
1548
- audio_system: [Unity Audio, FMOD, Wwise]
1549
- sections:
1550
- - id: code-architecture
1551
- title: Code Architecture Pattern
1552
- template: |
1553
- **Architecture Pattern:** {{MVC|MVVM|ECS|Component-Based|Custom}}
1554
-
1555
- **Core Systems Required:**
1556
-
1557
- - **Scene Management:** {{scene_manager_approach}}
1558
- - **State Management:** {{state_pattern_implementation}}
1559
- - **Event System:** {{event_system_choice}}
1560
- - **Object Pooling:** {{pooling_strategy}}
1561
- - **Save/Load System:** {{save_system_approach}}
1562
-
1563
- **Folder Structure:**
1564
-
1565
- ```
1566
- Assets/
1567
- ├── _Project/
1568
- │ ├── Scripts/
1569
- │ │ ├── {{folder_structure}}
1570
- │ ├── Prefabs/
1571
- │ ├── Scenes/
1572
- │ └── {{additional_folders}}
1573
- ```
1574
-
1575
- **Naming Conventions:**
1576
-
1577
- - Scripts: {{script_naming}}
1578
- - Prefabs: {{prefab_naming}}
1579
- - Scenes: {{scene_naming}}
1580
- examples:
1581
- - "Architecture: Component-Based with ScriptableObject data containers"
1582
- - "Scripts: PascalCase (PlayerController), Prefabs: Player_Prefab, Scenes: Level_01_Forest"
1583
- - id: unity-systems-integration
1584
- title: Unity Systems Integration
1585
- template: |
1586
- **Required Unity Systems:**
1587
-
1588
- - **Input System:** {{input_implementation}}
1589
- - **Animation System:** {{animation_approach}}
1590
- - **Physics Integration:** {{physics_usage}}
1591
- - **Rendering Features:** {{rendering_requirements}}
1592
- - **Asset Streaming:** {{asset_loading_strategy}}
1593
-
1594
- **Third-Party Integrations:**
1595
-
1596
- - {{integration_name}}: {{integration_purpose}}
1597
-
1598
- **Performance Systems:**
1599
-
1600
- - **Profiling Integration:** {{profiling_setup}}
1601
- - **Memory Management:** {{memory_strategy}}
1602
- - **Build Pipeline:** {{build_automation}}
1603
- examples:
1604
- - "Input System: Action Maps for Menu/Gameplay contexts with device switching"
1605
- - "DOTween: Smooth UI transitions and gameplay animations"
1606
- - id: data-management
1607
- title: Data Management
1608
- template: |
1609
- **Save Data Architecture:**
1610
-
1611
- - **Format:** {{PlayerPrefs|JSON|Binary|Cloud}}
1612
- - **Structure:** {{save_data_organization}}
1613
- - **Encryption:** {{security_approach}}
1614
- - **Cloud Sync:** {{cloud_integration}}
1615
-
1616
- **Configuration Data:**
1617
-
1618
- - **ScriptableObjects:** {{scriptable_object_usage}}
1619
- - **Settings Management:** {{settings_system}}
1620
- - **Localization:** {{localization_approach}}
1621
-
1622
- **Runtime Data:**
1623
-
1624
- - **Caching Strategy:** {{cache_implementation}}
1625
- - **Memory Pools:** {{pooling_objects}}
1626
- - **Asset References:** {{asset_reference_system}}
1627
- examples:
1628
- - "Save Data: JSON format with AES encryption, stored in persistent data path"
1629
- - "ScriptableObjects: Game settings, level configurations, character data"
1630
-
1631
- - id: development-phases
1632
- title: Development Phases & Epic Planning
1633
- instruction: Break down the Unity development into phases that can be converted to agile epics. Each phase should deliver deployable functionality following Unity best practices.
1634
- elicit: true
1635
- sections:
1636
- - id: phases-overview
1637
- title: Phases Overview
1638
- instruction: Present a high-level list of all phases for user approval. Each phase's design should deliver significant Unity functionality.
1639
- type: numbered-list
1640
- examples:
1641
- - "Phase 1: Unity Foundation & Core Systems: Project setup, input handling, basic scene management"
1642
- - "Phase 2: Core Game Mechanics: Player controller, physics systems, basic gameplay loop"
1643
- - "Phase 3: Level Systems & Content Pipeline: Scene loading, prefab systems, level progression"
1644
- - "Phase 4: Polish & Platform Optimization: Performance tuning, platform-specific features, deployment"
1645
- - id: phase-1-foundation
1646
- title: "Phase 1: Unity Foundation & Core Systems ({{duration}})"
1647
- sections:
1648
- - id: foundation-design
1649
- title: "Design: Unity Project Foundation"
1650
- type: bullet-list
1651
- template: |
1652
- - Unity project setup with proper folder structure and naming conventions
1653
- - Core architecture implementation ({{architecture_pattern}})
1654
- - Input System configuration with action maps for all platforms
1655
- - Basic scene management and state handling
1656
- - Development tools setup (debugging, profiling integration)
1657
- - Initial build pipeline and platform configuration
1658
- examples:
1659
- - "Input System: Configure PlayerInput component with Action Maps for movement and UI"
1660
- - id: core-systems-design
1661
- title: "Design: Essential Game Systems"
1662
- type: bullet-list
1663
- template: |
1664
- - Save/Load system implementation with {{save_format}} format
1665
- - Audio system setup with {{audio_system}} integration
1666
- - Event system for decoupled component communication
1667
- - Object pooling system for performance optimization
1668
- - Basic UI framework and canvas configuration
1669
- - Settings and configuration management with ScriptableObjects
1670
- - id: phase-2-gameplay
1671
- title: "Phase 2: Core Gameplay Implementation ({{duration}})"
1672
- sections:
1673
- - id: gameplay-mechanics-design
1674
- title: "Design: Primary Game Mechanics"
1675
- type: bullet-list
1676
- template: |
1677
- - Player controller with {{movement_type}} movement system
1678
- - {{primary_mechanic}} implementation with Unity physics
1679
- - {{secondary_mechanic}} system with visual feedback
1680
- - Game state management (playing, paused, game over)
1681
- - Basic collision detection and response systems
1682
- - Animation system integration with Animator controllers
1683
- - id: level-systems-design
1684
- title: "Design: Level & Content Systems"
1685
- type: bullet-list
1686
- template: |
1687
- - Scene loading and transition system
1688
- - Level progression and unlock system
1689
- - Prefab-based level construction tools
1690
- - {{level_generation}} level creation workflow
1691
- - Collectibles and pickup systems
1692
- - Victory/defeat condition implementation
1693
- - id: phase-3-polish
1694
- title: "Phase 3: Polish & Optimization ({{duration}})"
1695
- sections:
1696
- - id: performance-design
1697
- title: "Design: Performance & Platform Optimization"
1698
- type: bullet-list
1699
- template: |
1700
- - Unity Profiler analysis and optimization passes
1701
- - Memory management and garbage collection optimization
1702
- - Asset optimization (texture compression, audio compression)
1703
- - Platform-specific performance tuning
1704
- - Build size optimization and asset bundling
1705
- - Quality settings configuration for different device tiers
1706
- - id: user-experience-design
1707
- title: "Design: User Experience & Polish"
1708
- type: bullet-list
1709
- template: |
1710
- - Complete UI/UX implementation with responsive design
1711
- - Audio implementation with dynamic mixing
1712
- - Visual effects and particle systems
1713
- - Accessibility features implementation
1714
- - Tutorial and onboarding flow
1715
- - Final testing and bug fixing across all platforms
1716
-
1717
- - id: epic-list
1718
- title: Epic List
1719
- instruction: |
1720
- Present a high-level list of all epics for user approval. Each epic should have a title and a short (1 sentence) goal statement. This allows the user to review the overall structure before diving into details.
1721
-
1722
- CRITICAL: Epics MUST be logically sequential following agile best practices:
1723
-
1724
- - Each epic should be focused on a single phase and it's design from the development-phases section and deliver a significant, end-to-end, fully deployable increment of testable functionality
1725
- - Epic 1 must establish Phase 1: Unity Foundation & Core Systems (Project setup, input handling, basic scene management) unless we are adding new functionality to an existing app, while also delivering an initial piece of functionality, remember this when we produce the stories for the first epic!
1726
- - Each subsequent epic builds upon previous epics' functionality delivering major blocks of functionality that provide tangible value to users or business when deployed
1727
- - Not every project needs multiple epics, an epic needs to deliver value. For example, an API, component, or scriptableobject completed can deliver value even if a scene, or gameobject is not complete and planned for a separate epic.
1728
- - Err on the side of less epics, but let the user know your rationale and offer options for splitting them if it seems some are too large or focused on disparate things.
1729
- - Cross Cutting Concerns should flow through epics and stories and not be final stories. For example, adding a logging framework as a last story of an epic, or at the end of a project as a final epic or story would be terrible as we would not have logging from the beginning.
1730
- elicit: true
1731
- examples:
1732
- - "Epic 1: Unity Foundation & Core Systems: Project setup, input handling, basic scene management"
1733
- - "Epic 2: Core Game Mechanics: Player controller, physics systems, basic gameplay loop"
1734
- - "Epic 3: Level Systems & Content Pipeline: Scene loading, prefab systems, level progression"
1735
- - "Epic 4: Polish & Platform Optimization: Performance tuning, platform-specific features, deployment"
1736
-
1737
- - id: epic-details
1738
- title: Epic {{epic_number}} {{epic_title}}
1739
- repeatable: true
1740
- instruction: |
1741
- After the epic list is approved, present each epic with all its stories and acceptance criteria as a complete review unit.
1742
-
1743
- For each epic provide expanded goal (2-3 sentences describing the objective and value all the stories will achieve).
1744
-
1745
- CRITICAL STORY SEQUENCING REQUIREMENTS:
1746
-
1747
- - Stories within each epic MUST be logically sequential
1748
- - Each story should be a "vertical slice" delivering complete functionality aside from early enabler stories for project foundation
1749
- - No story should depend on work from a later story or epic
1750
- - Identify and note any direct prerequisite stories
1751
- - Focus on "what" and "why" not "how" (leave technical implementation to Architect) yet be precise enough to support a logical sequential order of operations from story to story.
1752
- - Ensure each story delivers clear user or business value, try to avoid enablers and build them into stories that deliver value.
1753
- - Size stories for AI agent execution: Each story must be completable by a single AI agent in one focused session without context overflow
1754
- - Think "junior developer working for 2-4 hours" - stories must be small, focused, and self-contained
1755
- - If a story seems complex, break it down further as long as it can deliver a vertical slice
1756
- elicit: true
1757
- template: "{{epic_goal}}"
1758
- sections:
1759
- - id: story
1760
- title: Story {{epic_number}}.{{story_number}} {{story_title}}
1761
- repeatable: true
1762
- instruction: Provide a clear, concise description of what this story implements. Focus on the specific game feature or system being built. Reference the GDD section that defines this feature and reference the gamearchitecture section for additional implementation and integration specifics.
1763
- template: "{{clear_description_of_what_needs_to_be_implemented}}"
1764
- sections:
1765
- - id: acceptance-criteria
1766
- title: Acceptance Criteria
1767
- instruction: Define specific, testable conditions that must be met for the story to be considered complete. Each criterion should be verifiable and directly related to gameplay functionality.
1768
- sections:
1769
- - id: functional-requirements
1770
- title: Functional Requirements
1771
- type: checklist
1772
- items:
1773
- - "{{specific_functional_requirement}}"
1774
- - id: technical-requirements
1775
- title: Technical Requirements
1776
- type: checklist
1777
- items:
1778
- - Code follows C# best practices
1779
- - Maintains stable frame rate on target devices
1780
- - No memory leaks or performance degradation
1781
- - "{{specific_technical_requirement}}"
1782
- - id: game-design-requirements
1783
- title: Game Design Requirements
1784
- type: checklist
1785
- items:
1786
- - "{{gameplay_requirement_from_gdd}}"
1787
- - "{{balance_requirement_if_applicable}}"
1788
- - "{{player_experience_requirement}}"
1789
-
1790
- - id: success-metrics
1791
- title: Success Metrics & Quality Assurance
1792
- instruction: Define measurable goals for the Unity game development project with specific targets that can be validated through Unity Analytics and profiling tools.
1793
- elicit: true
1794
- sections:
1795
- - id: technical-metrics
1796
- title: Technical Performance Metrics
1797
- type: bullet-list
1798
- template: |
1799
- - **Frame Rate:** Consistent {{fps_target}} FPS with <5% drops below {{min_fps}}
1800
- - **Load Times:** Initial load <{{initial_load}}s, level transitions <{{level_load}}s
1801
- - **Memory Usage:** Heap memory <{{heap_limit}}MB, texture memory <{{texture_limit}}MB
1802
- - **Crash Rate:** <{{crash_threshold}}% across all supported platforms
1803
- - **Build Size:** Final build <{{size_limit}}MB for mobile, <{{desktop_limit}}MB for desktop
1804
- - **Battery Life:** Mobile gameplay sessions >{{battery_target}} hours on average device
1805
- examples:
1806
- - "Frame Rate: Consistent 60 FPS with <5% drops below 45 FPS on target hardware"
1807
- - "Crash Rate: <0.5% across iOS/Android, <0.1% on desktop platforms"
1808
- - id: gameplay-metrics
1809
- title: Gameplay & User Engagement Metrics
1810
- type: bullet-list
1811
- template: |
1812
- - **Tutorial Completion:** {{tutorial_rate}}% of players complete basic tutorial
1813
- - **Level Progression:** {{progression_rate}}% reach level {{target_level}} within first session
1814
- - **Session Duration:** Average session length {{session_target}} minutes
1815
- - **Player Retention:** Day 1: {{d1_retention}}%, Day 7: {{d7_retention}}%, Day 30: {{d30_retention}}%
1816
- - **Gameplay Completion:** {{completion_rate}}% complete main game content
1817
- - **Control Responsiveness:** Input lag <{{input_lag}}ms on all platforms
1818
- examples:
1819
- - "Tutorial Completion: 85% of players complete movement and basic mechanics tutorial"
1820
- - "Session Duration: Average 15-20 minutes per session for mobile, 30-45 minutes for desktop"
1821
- - id: platform-specific-metrics
1822
- title: Platform-Specific Quality Metrics
1823
- type: table
1824
- template: |
1825
- | Platform | Frame Rate | Load Time | Memory | Build Size | Battery |
1826
- | -------- | ---------- | --------- | ------ | ---------- | ------- |
1827
- | {{platform}} | {{fps}} | {{load}} | {{memory}} | {{size}} | {{battery}} |
1828
- examples:
1829
- - iOS, 60 FPS, <3s, <150MB, <80MB, 3+ hours
1830
- - Android, 60 FPS, <5s, <200MB, <100MB, 2.5+ hours
1831
-
1832
- - id: next-steps-integration
1833
- title: Next Steps & BMad Integration
1834
- instruction: Define how this GDD integrates with BMad's agent workflow and what follow-up documents or processes are needed.
1835
- sections:
1836
- - id: architecture-handoff
1837
- title: Unity Architecture Requirements
1838
- instruction: Summary of key architectural decisions that need to be implemented in Unity project setup
1839
- type: bullet-list
1840
- template: |
1841
- - Unity {{unity_version}} project with {{render_pipeline}} pipeline
1842
- - {{architecture_pattern}} code architecture with {{folder_structure}}
1843
- - Required packages: {{essential_packages}}
1844
- - Performance targets: {{key_performance_metrics}}
1845
- - Platform builds: {{deployment_targets}}
1846
- - id: story-creation-guidance
1847
- title: Story Creation Guidance for SM Agent
1848
- instruction: Provide guidance for the Story Manager (SM) agent on how to break down this GDD into implementable user stories
1849
- template: |
1850
- **Epic Prioritization:** {{epic_order_rationale}}
1851
-
1852
- **Story Sizing Guidelines:**
1853
-
1854
- - Foundation stories: {{foundation_story_scope}}
1855
- - Feature stories: {{feature_story_scope}}
1856
- - Polish stories: {{polish_story_scope}}
1857
-
1858
- **Unity-Specific Story Considerations:**
1859
-
1860
- - Each story should result in testable Unity scenes or prefabs
1861
- - Include specific Unity components and systems in acceptance criteria
1862
- - Consider cross-platform testing requirements
1863
- - Account for Unity build and deployment steps
1864
- examples:
1865
- - "Foundation stories: Individual Unity systems (Input, Audio, Scene Management) - 1-2 days each"
1866
- - "Feature stories: Complete gameplay mechanics with UI and feedback - 2-4 days each"
1867
- - id: recommended-agents
1868
- title: Recommended BMad Agent Sequence
1869
- type: numbered-list
1870
- template: |
1871
- 1. **{{agent_name}}**: {{agent_responsibility}}
1872
- examples:
1873
- - "Unity Architect: Create detailed technical architecture document with specific Unity implementation patterns"
1874
- - "Unity Developer: Implement core systems and gameplay mechanics according to architecture"
1875
- - "QA Tester: Validate performance metrics and cross-platform functionality"
1876
- ==================== END: .bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml ====================
1877
-
1878
- ==================== START: .bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml ====================
1879
- template:
1880
- id: level-design-doc-template-v2
1881
- name: Level Design Document
1882
- version: 2.1
1883
- output:
1884
- format: markdown
1885
- filename: docs/level-design-document.md
1886
- title: "{{game_title}} Level Design Document"
1887
-
1888
- workflow:
1889
- mode: interactive
1890
-
1891
- sections:
1892
- - id: initial-setup
1893
- instruction: |
1894
- This template creates comprehensive level design documentation that guides both content creation and technical implementation. This document should provide enough detail for developers to create level loading systems and for designers to create specific levels.
1895
-
1896
- If available, review: Game Design Document (GDD), Game Architecture Document. This document should align with the game mechanics and technical systems defined in those documents.
1897
-
1898
- - id: introduction
1899
- title: Introduction
1900
- instruction: Establish the purpose and scope of level design for this game
1901
- content: |
1902
- This document defines the level design framework for {{game_title}}, providing guidelines for creating engaging, balanced levels that support the core gameplay mechanics defined in the Game Design Document.
1903
-
1904
- This framework ensures consistency across all levels while providing flexibility for creative level design within established technical and design constraints.
1905
- sections:
1906
- - id: change-log
1907
- title: Change Log
1908
- instruction: Track document versions and changes
1909
- type: table
1910
- template: |
1911
- | Date | Version | Description | Author |
1912
- | :--- | :------ | :---------- | :----- |
1913
-
1914
- - id: level-design-philosophy
1915
- title: Level Design Philosophy
1916
- instruction: Establish the overall approach to level design based on the game's core pillars and mechanics. Apply `tasks#advanced-elicitation` after presenting this section.
1917
- sections:
1918
- - id: design-principles
1919
- title: Design Principles
1920
- instruction: Define 3-5 core principles that guide all level design decisions
1921
- type: numbered-list
1922
- template: |
1923
- **{{principle_name}}** - {{description}}
1924
- - id: player-experience-goals
1925
- title: Player Experience Goals
1926
- instruction: Define what players should feel and learn in each level category
1927
- template: |
1928
- **Tutorial Levels:** {{experience_description}}
1929
- **Standard Levels:** {{experience_description}}
1930
- **Challenge Levels:** {{experience_description}}
1931
- **Boss Levels:** {{experience_description}}
1932
- - id: level-flow-framework
1933
- title: Level Flow Framework
1934
- instruction: Define the standard structure for level progression
1935
- template: |
1936
- **Introduction Phase:** {{duration}} - {{purpose}}
1937
- **Development Phase:** {{duration}} - {{purpose}}
1938
- **Climax Phase:** {{duration}} - {{purpose}}
1939
- **Resolution Phase:** {{duration}} - {{purpose}}
1940
-
1941
- - id: level-categories
1942
- title: Level Categories
1943
- instruction: Define different types of levels based on the GDD requirements. Each category should be specific enough for implementation.
1944
- repeatable: true
1945
- sections:
1946
- - id: level-category
1947
- title: "{{category_name}} Levels"
1948
- template: |
1949
- **Purpose:** {{gameplay_purpose}}
1950
-
1951
- **Target Duration:** {{min_time}} - {{max_time}} minutes
1952
-
1953
- **Difficulty Range:** {{difficulty_scale}}
1954
-
1955
- **Key Mechanics Featured:**
1956
-
1957
- - {{mechanic_1}} - {{usage_description}}
1958
- - {{mechanic_2}} - {{usage_description}}
1959
-
1960
- **Player Objectives:**
1961
-
1962
- - Primary: {{primary_objective}}
1963
- - Secondary: {{secondary_objective}}
1964
- - Hidden: {{secret_objective}}
1965
-
1966
- **Success Criteria:**
1967
-
1968
- - {{completion_requirement_1}}
1969
- - {{completion_requirement_2}}
1970
-
1971
- **Technical Requirements:**
1972
-
1973
- - Maximum entities: {{entity_limit}}
1974
- - Performance target: {{fps_target}} FPS
1975
- - Memory budget: {{memory_limit}}MB
1976
- - Asset requirements: {{asset_needs}}
1977
-
1978
- - id: level-progression-system
1979
- title: Level Progression System
1980
- instruction: Define how players move through levels and how difficulty scales
1981
- sections:
1982
- - id: world-structure
1983
- title: World Structure
1984
- instruction: Based on GDD requirements, define the overall level organization
1985
- template: |
1986
- **Organization Type:** {{linear|hub_world|open_world}}
1987
-
1988
- **Total Level Count:** {{number}}
1989
-
1990
- **World Breakdown:**
1991
-
1992
- - World 1: {{level_count}} levels - {{theme}} - {{difficulty_range}}
1993
- - World 2: {{level_count}} levels - {{theme}} - {{difficulty_range}}
1994
- - World 3: {{level_count}} levels - {{theme}} - {{difficulty_range}}
1995
- - id: difficulty-progression
1996
- title: Difficulty Progression
1997
- instruction: Define how challenge increases across the game
1998
- sections:
1999
- - id: progression-curve
2000
- title: Progression Curve
2001
- type: code
2002
- language: text
2003
- template: |
2004
- Difficulty
2005
- ^ ___/```
2006
- | /
2007
- | / ___/```
2008
- | / /
2009
- | / /
2010
- |/ /
2011
- +-----------> Level Number
2012
- Tutorial Early Mid Late
2013
- - id: scaling-parameters
2014
- title: Scaling Parameters
2015
- type: bullet-list
2016
- template: |
2017
- - Enemy count: {{start_count}} → {{end_count}}
2018
- - Enemy difficulty: {{start_diff}} → {{end_diff}}
2019
- - Level complexity: {{start_complex}} → {{end_complex}}
2020
- - Time pressure: {{start_time}} → {{end_time}}
2021
- - id: unlock-requirements
2022
- title: Unlock Requirements
2023
- instruction: Define how players access new levels
2024
- template: |
2025
- **Progression Gates:**
2026
-
2027
- - Linear progression: Complete previous level
2028
- - Star requirements: {{star_count}} stars to unlock
2029
- - Skill gates: Demonstrate {{skill_requirement}}
2030
- - Optional content: {{unlock_condition}}
2031
-
2032
- - id: level-design-components
2033
- title: Level Design Components
2034
- instruction: Define the building blocks used to create levels
2035
- sections:
2036
- - id: environmental-elements
2037
- title: Environmental Elements
2038
- instruction: Define all environmental components that can be used in levels
2039
- template: |
2040
- **Terrain Types:**
2041
-
2042
- - {{terrain_1}}: {{properties_and_usage}}
2043
- - {{terrain_2}}: {{properties_and_usage}}
2044
-
2045
- **Interactive Objects:**
2046
-
2047
- - {{object_1}}: {{behavior_and_purpose}}
2048
- - {{object_2}}: {{behavior_and_purpose}}
2049
-
2050
- **Hazards and Obstacles:**
2051
-
2052
- - {{hazard_1}}: {{damage_and_behavior}}
2053
- - {{hazard_2}}: {{damage_and_behavior}}
2054
- - id: collectibles-rewards
2055
- title: Collectibles and Rewards
2056
- instruction: Define all collectible items and their placement rules
2057
- template: |
2058
- **Collectible Types:**
2059
-
2060
- - {{collectible_1}}: {{value_and_purpose}}
2061
- - {{collectible_2}}: {{value_and_purpose}}
2062
-
2063
- **Placement Guidelines:**
2064
-
2065
- - Mandatory collectibles: {{placement_rules}}
2066
- - Optional collectibles: {{placement_rules}}
2067
- - Secret collectibles: {{placement_rules}}
2068
-
2069
- **Reward Distribution:**
2070
-
2071
- - Easy to find: {{percentage}}%
2072
- - Moderate challenge: {{percentage}}%
2073
- - High skill required: {{percentage}}%
2074
- - id: enemy-placement-framework
2075
- title: Enemy Placement Framework
2076
- instruction: Define how enemies should be placed and balanced in levels
2077
- template: |
2078
- **Enemy Categories:**
2079
-
2080
- - {{enemy_type_1}}: {{behavior_and_usage}}
2081
- - {{enemy_type_2}}: {{behavior_and_usage}}
2082
-
2083
- **Placement Principles:**
2084
-
2085
- - Introduction encounters: {{guideline}}
2086
- - Standard encounters: {{guideline}}
2087
- - Challenge encounters: {{guideline}}
2088
-
2089
- **Difficulty Scaling:**
2090
-
2091
- - Enemy count progression: {{scaling_rule}}
2092
- - Enemy type introduction: {{pacing_rule}}
2093
- - Encounter complexity: {{complexity_rule}}
2094
-
2095
- - id: level-creation-guidelines
2096
- title: Level Creation Guidelines
2097
- instruction: Provide specific guidelines for creating individual levels
2098
- sections:
2099
- - id: level-layout-principles
2100
- title: Level Layout Principles
2101
- template: |
2102
- **Spatial Design:**
2103
-
2104
- - Grid size: {{grid_dimensions}}
2105
- - Minimum path width: {{width_units}}
2106
- - Maximum vertical distance: {{height_units}}
2107
- - Safe zones placement: {{safety_guidelines}}
2108
-
2109
- **Navigation Design:**
2110
-
2111
- - Clear path indication: {{visual_cues}}
2112
- - Landmark placement: {{landmark_rules}}
2113
- - Dead end avoidance: {{dead_end_policy}}
2114
- - Multiple path options: {{branching_rules}}
2115
- - id: pacing-and-flow
2116
- title: Pacing and Flow
2117
- instruction: Define how to control the rhythm and pace of gameplay within levels
2118
- template: |
2119
- **Action Sequences:**
2120
-
2121
- - High intensity duration: {{max_duration}}
2122
- - Rest period requirement: {{min_rest_time}}
2123
- - Intensity variation: {{pacing_pattern}}
2124
-
2125
- **Learning Sequences:**
2126
-
2127
- - New mechanic introduction: {{teaching_method}}
2128
- - Practice opportunity: {{practice_duration}}
2129
- - Skill application: {{application_context}}
2130
- - id: challenge-design
2131
- title: Challenge Design
2132
- instruction: Define how to create appropriate challenges for each level type
2133
- template: |
2134
- **Challenge Types:**
2135
-
2136
- - Execution challenges: {{skill_requirements}}
2137
- - Puzzle challenges: {{complexity_guidelines}}
2138
- - Time challenges: {{time_pressure_rules}}
2139
- - Resource challenges: {{resource_management}}
2140
-
2141
- **Difficulty Calibration:**
2142
-
2143
- - Skill check frequency: {{frequency_guidelines}}
2144
- - Failure recovery: {{retry_mechanics}}
2145
- - Hint system integration: {{help_system}}
2146
-
2147
- - id: technical-implementation
2148
- title: Technical Implementation
2149
- instruction: Define technical requirements for level implementation
2150
- sections:
2151
- - id: level-data-structure
2152
- title: Level Data Structure
2153
- instruction: Define how level data should be structured for implementation
2154
- template: |
2155
- **Level File Format:**
2156
-
2157
- - Data format: {{json|yaml|custom}}
2158
- - File naming: `level_{{world}}_{{number}}.{{extension}}`
2159
- - Data organization: {{structure_description}}
2160
- sections:
2161
- - id: required-data-fields
2162
- title: Required Data Fields
2163
- type: code
2164
- language: json
2165
- template: |
2166
- {
2167
- "levelId": "{{unique_identifier}}",
2168
- "worldId": "{{world_identifier}}",
2169
- "difficulty": {{difficulty_value}},
2170
- "targetTime": {{completion_time_seconds}},
2171
- "objectives": {
2172
- "primary": "{{primary_objective}}",
2173
- "secondary": ["{{secondary_objectives}}"],
2174
- "hidden": ["{{secret_objectives}}"]
2175
- },
2176
- "layout": {
2177
- "width": {{grid_width}},
2178
- "height": {{grid_height}},
2179
- "tilemap": "{{tilemap_reference}}"
2180
- },
2181
- "entities": [
2182
- {
2183
- "type": "{{entity_type}}",
2184
- "position": {"x": {{x}}, "y": {{y}}},
2185
- "properties": {{entity_properties}}
2186
- }
2187
- ]
2188
- }
2189
- - id: asset-integration
2190
- title: Asset Integration
2191
- instruction: Define how level assets are organized and loaded
2192
- template: |
2193
- **Tilemap Requirements:**
2194
-
2195
- - Tile size: {{tile_dimensions}}px
2196
- - Tileset organization: {{tileset_structure}}
2197
- - Layer organization: {{layer_system}}
2198
- - Collision data: {{collision_format}}
2199
-
2200
- **Audio Integration:**
2201
-
2202
- - Background music: {{music_requirements}}
2203
- - Ambient sounds: {{ambient_system}}
2204
- - Dynamic audio: {{dynamic_audio_rules}}
2205
- - id: performance-optimization
2206
- title: Performance Optimization
2207
- instruction: Define performance requirements for level systems
2208
- template: |
2209
- **Entity Limits:**
2210
-
2211
- - Maximum active entities: {{entity_limit}}
2212
- - Maximum particles: {{particle_limit}}
2213
- - Maximum audio sources: {{audio_limit}}
2214
-
2215
- **Memory Management:**
2216
-
2217
- - Texture memory budget: {{texture_memory}}MB
2218
- - Audio memory budget: {{audio_memory}}MB
2219
- - Level loading time: <{{load_time}}s
2220
-
2221
- **Culling and LOD:**
2222
-
2223
- - Off-screen culling: {{culling_distance}}
2224
- - Level-of-detail rules: {{lod_system}}
2225
- - Asset streaming: {{streaming_requirements}}
2226
-
2227
- - id: level-testing-framework
2228
- title: Level Testing Framework
2229
- instruction: Define how levels should be tested and validated
2230
- sections:
2231
- - id: automated-testing
2232
- title: Automated Testing
2233
- template: |
2234
- **Performance Testing:**
2235
-
2236
- - Frame rate validation: Maintain {{fps_target}} FPS
2237
- - Memory usage monitoring: Stay under {{memory_limit}}MB
2238
- - Loading time verification: Complete in <{{load_time}}s
2239
-
2240
- **Gameplay Testing:**
2241
-
2242
- - Completion path validation: All objectives achievable
2243
- - Collectible accessibility: All items reachable
2244
- - Softlock prevention: No unwinnable states
2245
- - id: manual-testing-protocol
2246
- title: Manual Testing Protocol
2247
- sections:
2248
- - id: playtesting-checklist
2249
- title: Playtesting Checklist
2250
- type: checklist
2251
- items:
2252
- - Level completes within target time range
2253
- - All mechanics function correctly
2254
- - Difficulty feels appropriate for level category
2255
- - Player guidance is clear and effective
2256
- - No exploits or sequence breaks (unless intended)
2257
- - id: player-experience-testing
2258
- title: Player Experience Testing
2259
- type: checklist
2260
- items:
2261
- - Tutorial levels teach effectively
2262
- - Challenge feels fair and rewarding
2263
- - Flow and pacing maintain engagement
2264
- - Audio and visual feedback support gameplay
2265
- - id: balance-validation
2266
- title: Balance Validation
2267
- template: |
2268
- **Metrics Collection:**
2269
-
2270
- - Completion rate: Target {{completion_percentage}}%
2271
- - Average completion time: {{target_time}} ± {{variance}}
2272
- - Death count per level: <{{max_deaths}}
2273
- - Collectible discovery rate: {{discovery_percentage}}%
2274
-
2275
- **Iteration Guidelines:**
2276
-
2277
- - Adjustment criteria: {{criteria_for_changes}}
2278
- - Testing sample size: {{minimum_testers}}
2279
- - Validation period: {{testing_duration}}
2280
-
2281
- - id: content-creation-pipeline
2282
- title: Content Creation Pipeline
2283
- instruction: Define the workflow for creating new levels
2284
- sections:
2285
- - id: design-phase
2286
- title: Design Phase
2287
- template: |
2288
- **Concept Development:**
2289
-
2290
- 1. Define level purpose and goals
2291
- 2. Create rough layout sketch
2292
- 3. Identify key mechanics and challenges
2293
- 4. Estimate difficulty and duration
2294
-
2295
- **Documentation Requirements:**
2296
-
2297
- - Level design brief
2298
- - Layout diagrams
2299
- - Mechanic integration notes
2300
- - Asset requirement list
2301
- - id: implementation-phase
2302
- title: Implementation Phase
2303
- template: |
2304
- **Technical Implementation:**
2305
-
2306
- 1. Create level data file
2307
- 2. Build tilemap and layout
2308
- 3. Place entities and objects
2309
- 4. Configure level logic and triggers
2310
- 5. Integrate audio and visual effects
2311
-
2312
- **Quality Assurance:**
2313
-
2314
- 1. Automated testing execution
2315
- 2. Internal playtesting
2316
- 3. Performance validation
2317
- 4. Bug fixing and polish
2318
- - id: integration-phase
2319
- title: Integration Phase
2320
- template: |
2321
- **Game Integration:**
2322
-
2323
- 1. Level progression integration
2324
- 2. Save system compatibility
2325
- 3. Analytics integration
2326
- 4. Achievement system integration
2327
-
2328
- **Final Validation:**
2329
-
2330
- 1. Full game context testing
2331
- 2. Performance regression testing
2332
- 3. Platform compatibility verification
2333
- 4. Final approval and release
2334
-
2335
- - id: success-metrics
2336
- title: Success Metrics
2337
- instruction: Define how to measure level design success
2338
- sections:
2339
- - id: player-engagement
2340
- title: Player Engagement
2341
- type: bullet-list
2342
- template: |
2343
- - Level completion rate: {{target_rate}}%
2344
- - Replay rate: {{replay_target}}%
2345
- - Time spent per level: {{engagement_time}}
2346
- - Player satisfaction scores: {{satisfaction_target}}/10
2347
- - id: technical-performance
2348
- title: Technical Performance
2349
- type: bullet-list
2350
- template: |
2351
- - Frame rate consistency: {{fps_consistency}}%
2352
- - Loading time compliance: {{load_compliance}}%
2353
- - Memory usage efficiency: {{memory_efficiency}}%
2354
- - Crash rate: <{{crash_threshold}}%
2355
- - id: design-quality
2356
- title: Design Quality
2357
- type: bullet-list
2358
- template: |
2359
- - Difficulty curve adherence: {{curve_accuracy}}
2360
- - Mechanic integration effectiveness: {{integration_score}}
2361
- - Player guidance clarity: {{guidance_score}}
2362
- - Content accessibility: {{accessibility_rate}}%
2363
- ==================== END: .bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml ====================
2364
-
2365
- ==================== START: .bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml ====================
2366
- template:
2367
- id: game-brief-template-v3
2368
- name: Game Brief
2369
- version: 3.0
2370
- output:
2371
- format: markdown
2372
- filename: docs/game-brief.md
2373
- title: "{{game_title}} Game Brief"
2374
-
2375
- workflow:
2376
- mode: interactive
2377
-
2378
- sections:
2379
- - id: initial-setup
2380
- instruction: |
2381
- 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.
2382
-
2383
- This brief is typically created early in the ideation process, often after brainstorming sessions, to crystallize the game concept before moving into detailed design.
2384
-
2385
- - id: game-vision
2386
- title: Game Vision
2387
- instruction: Establish the core vision and identity of the game. Present each subsection and gather user feedback before proceeding.
2388
- sections:
2389
- - id: core-concept
2390
- title: Core Concept
2391
- instruction: 2-3 sentences that clearly capture what the game is and why it will be compelling to players
2392
- - id: elevator-pitch
2393
- title: Elevator Pitch
2394
- instruction: Single sentence that captures the essence of the game in a memorable way
2395
- template: |
2396
- **"{{game_description_in_one_sentence}}"**
2397
- - id: vision-statement
2398
- title: Vision Statement
2399
- instruction: Inspirational statement about what the game will achieve for players and why it matters
2400
-
2401
- - id: target-market
2402
- title: Target Market
2403
- instruction: Define the audience and market context. Apply `tasks#advanced-elicitation` after presenting this section.
2404
- sections:
2405
- - id: primary-audience
2406
- title: Primary Audience
2407
- template: |
2408
- **Demographics:** {{age_range}}, {{platform_preference}}, {{gaming_experience}}
2409
- **Psychographics:** {{interests}}, {{motivations}}, {{play_patterns}}
2410
- **Gaming Preferences:** {{preferred_genres}}, {{session_length}}, {{difficulty_preference}}
2411
- - id: secondary-audiences
2412
- title: Secondary Audiences
2413
- template: |
2414
- **Audience 2:** {{description}}
2415
- **Audience 3:** {{description}}
2416
- - id: market-context
2417
- title: Market Context
2418
- template: |
2419
- **Genre:** {{primary_genre}} / {{secondary_genre}}
2420
- **Platform Strategy:** {{platform_focus}}
2421
- **Competitive Positioning:** {{differentiation_statement}}
2422
-
2423
- - id: game-fundamentals
2424
- title: Game Fundamentals
2425
- instruction: Define the core gameplay elements. Each subsection should be specific enough to guide detailed design work.
2426
- sections:
2427
- - id: core-gameplay-pillars
2428
- title: Core Gameplay Pillars
2429
- instruction: 3-5 fundamental principles that guide all design decisions
2430
- type: numbered-list
2431
- template: |
2432
- **{{pillar_name}}** - {{description_and_rationale}}
2433
- - id: primary-mechanics
2434
- title: Primary Mechanics
2435
- instruction: List the 3-5 most important gameplay mechanics that define the player experience
2436
- repeatable: true
2437
- template: |
2438
- **Core Mechanic: {{mechanic_name}}**
2439
-
2440
- - **Description:** {{how_it_works}}
2441
- - **Player Value:** {{why_its_fun}}
2442
- - **Implementation Scope:** {{complexity_estimate}}
2443
- - id: player-experience-goals
2444
- title: Player Experience Goals
2445
- instruction: Define what emotions and experiences the game should create for players
2446
- template: |
2447
- **Primary Experience:** {{main_emotional_goal}}
2448
- **Secondary Experiences:** {{supporting_emotional_goals}}
2449
- **Engagement Pattern:** {{how_player_engagement_evolves}}
2450
-
2451
- - id: scope-constraints
2452
- title: Scope and Constraints
2453
- instruction: Define the boundaries and limitations that will shape development. Apply `tasks#advanced-elicitation` to clarify any constraints.
2454
- sections:
2455
- - id: project-scope
2456
- title: Project Scope
2457
- template: |
2458
- **Game Length:** {{estimated_content_hours}}
2459
- **Content Volume:** {{levels_areas_content_amount}}
2460
- **Feature Complexity:** {{simple|moderate|complex}}
2461
- **Scope Comparison:** "Similar to {{reference_game}} but with {{key_differences}}"
2462
- - id: technical-constraints
2463
- title: Technical Constraints
2464
- template: |
2465
- **Platform Requirements:**
2466
-
2467
- - Primary: {{platform_1}} - {{requirements}}
2468
- - Secondary: {{platform_2}} - {{requirements}}
2469
-
2470
- **Technical Specifications:**
2471
-
2472
- - Engine: Unity & C#
2473
- - Performance Target: {{fps_target}} FPS on {{target_device}}
2474
- - Memory Budget: <{{memory_limit}}MB
2475
- - Load Time Goal: <{{load_time_seconds}}s
2476
- - id: resource-constraints
2477
- title: Resource Constraints
2478
- template: |
2479
- **Team Size:** {{team_composition}}
2480
- **Timeline:** {{development_duration}}
2481
- **Budget Considerations:** {{budget_constraints_or_targets}}
2482
- **Asset Requirements:** {{art_audio_content_needs}}
2483
- - id: business-constraints
2484
- title: Business Constraints
2485
- condition: has_business_goals
2486
- template: |
2487
- **Monetization Model:** {{free|premium|freemium|subscription}}
2488
- **Revenue Goals:** {{revenue_targets_if_applicable}}
2489
- **Platform Requirements:** {{store_certification_needs}}
2490
- **Launch Timeline:** {{target_launch_window}}
2491
-
2492
- - id: reference-framework
2493
- title: Reference Framework
2494
- instruction: Provide context through references and competitive analysis
2495
- sections:
2496
- - id: inspiration-games
2497
- title: Inspiration Games
2498
- sections:
2499
- - id: primary-references
2500
- title: Primary References
2501
- type: numbered-list
2502
- repeatable: true
2503
- template: |
2504
- **{{reference_game}}** - {{what_we_learn_from_it}}
2505
- - id: competitive-analysis
2506
- title: Competitive Analysis
2507
- template: |
2508
- **Direct Competitors:**
2509
-
2510
- - {{competitor_1}}: {{strengths_and_weaknesses}}
2511
- - {{competitor_2}}: {{strengths_and_weaknesses}}
2512
-
2513
- **Differentiation Strategy:**
2514
- {{how_we_differ_and_why_thats_valuable}}
2515
- - id: market-opportunity
2516
- title: Market Opportunity
2517
- template: |
2518
- **Market Gap:** {{underserved_need_or_opportunity}}
2519
- **Timing Factors:** {{why_now_is_the_right_time}}
2520
- **Success Metrics:** {{how_well_measure_success}}
2521
-
2522
- - id: content-framework
2523
- title: Content Framework
2524
- instruction: Outline the content structure and progression without full design detail
2525
- sections:
2526
- - id: game-structure
2527
- title: Game Structure
2528
- template: |
2529
- **Overall Flow:** {{linear|hub_world|open_world|procedural}}
2530
- **Progression Model:** {{how_players_advance}}
2531
- **Session Structure:** {{typical_play_session_flow}}
2532
- - id: content-categories
2533
- title: Content Categories
2534
- template: |
2535
- **Core Content:**
2536
-
2537
- - {{content_type_1}}: {{quantity_and_description}}
2538
- - {{content_type_2}}: {{quantity_and_description}}
2539
-
2540
- **Optional Content:**
2541
-
2542
- - {{optional_content_type}}: {{quantity_and_description}}
2543
-
2544
- **Replay Elements:**
2545
-
2546
- - {{replayability_features}}
2547
- - id: difficulty-accessibility
2548
- title: Difficulty and Accessibility
2549
- template: |
2550
- **Difficulty Approach:** {{how_challenge_is_structured}}
2551
- **Accessibility Features:** {{planned_accessibility_support}}
2552
- **Skill Requirements:** {{what_skills_players_need}}
2553
-
2554
- - id: art-audio-direction
2555
- title: Art and Audio Direction
2556
- instruction: Establish the aesthetic vision that will guide asset creation
2557
- sections:
2558
- - id: visual-style
2559
- title: Visual Style
2560
- template: |
2561
- **Art Direction:** {{style_description}}
2562
- **Reference Materials:** {{visual_inspiration_sources}}
2563
- **Technical Approach:** {{2d_style_pixel_vector_etc}}
2564
- **Color Strategy:** {{color_palette_mood}}
2565
- - id: audio-direction
2566
- title: Audio Direction
2567
- template: |
2568
- **Music Style:** {{genre_and_mood}}
2569
- **Sound Design:** {{audio_personality}}
2570
- **Implementation Needs:** {{technical_audio_requirements}}
2571
- - id: ui-ux-approach
2572
- title: UI/UX Approach
2573
- template: |
2574
- **Interface Style:** {{ui_aesthetic}}
2575
- **User Experience Goals:** {{ux_priorities}}
2576
- **Platform Adaptations:** {{cross_platform_considerations}}
2577
-
2578
- - id: risk-assessment
2579
- title: Risk Assessment
2580
- instruction: Identify potential challenges and mitigation strategies
2581
- sections:
2582
- - id: technical-risks
2583
- title: Technical Risks
2584
- type: table
2585
- template: |
2586
- | Risk | Probability | Impact | Mitigation Strategy |
2587
- | ---- | ----------- | ------ | ------------------- |
2588
- | {{technical_risk}} | {{high|med|low}} | {{high|med|low}} | {{mitigation_approach}} |
2589
- - id: design-risks
2590
- title: Design Risks
2591
- type: table
2592
- template: |
2593
- | Risk | Probability | Impact | Mitigation Strategy |
2594
- | ---- | ----------- | ------ | ------------------- |
2595
- | {{design_risk}} | {{high|med|low}} | {{high|med|low}} | {{mitigation_approach}} |
2596
- - id: market-risks
2597
- title: Market Risks
2598
- type: table
2599
- template: |
2600
- | Risk | Probability | Impact | Mitigation Strategy |
2601
- | ---- | ----------- | ------ | ------------------- |
2602
- | {{market_risk}} | {{high|med|low}} | {{high|med|low}} | {{mitigation_approach}} |
2603
-
2604
- - id: success-criteria
2605
- title: Success Criteria
2606
- instruction: Define measurable goals for the project
2607
- sections:
2608
- - id: player-experience-metrics
2609
- title: Player Experience Metrics
2610
- template: |
2611
- **Engagement Goals:**
2612
-
2613
- - Tutorial completion rate: >{{percentage}}%
2614
- - Average session length: {{duration}} minutes
2615
- - Player retention: D1 {{d1}}%, D7 {{d7}}%, D30 {{d30}}%
2616
-
2617
- **Quality Benchmarks:**
2618
-
2619
- - Player satisfaction: >{{rating}}/10
2620
- - Completion rate: >{{percentage}}%
2621
- - Technical performance: {{fps_target}} FPS consistent
2622
- - id: development-metrics
2623
- title: Development Metrics
2624
- template: |
2625
- **Technical Targets:**
2626
-
2627
- - Zero critical bugs at launch
2628
- - Performance targets met on all platforms
2629
- - Load times under {{seconds}}s
2630
-
2631
- **Process Goals:**
2632
-
2633
- - Development timeline adherence
2634
- - Feature scope completion
2635
- - Quality assurance standards
2636
- - id: business-metrics
2637
- title: Business Metrics
2638
- condition: has_business_goals
2639
- template: |
2640
- **Commercial Goals:**
2641
-
2642
- - {{revenue_target}} in first {{time_period}}
2643
- - {{user_acquisition_target}} players in first {{time_period}}
2644
- - {{retention_target}} monthly active users
2645
-
2646
- - id: next-steps
2647
- title: Next Steps
2648
- instruction: Define immediate actions following the brief completion
2649
- sections:
2650
- - id: immediate-actions
2651
- title: Immediate Actions
2652
- type: numbered-list
2653
- template: |
2654
- **{{action_item}}** - {{details_and_timeline}}
2655
- - id: development-roadmap
2656
- title: Development Roadmap
2657
- sections:
2658
- - id: phase-1-preproduction
2659
- title: "Phase 1: Pre-Production ({{duration}})"
2660
- type: bullet-list
2661
- template: |
2662
- - Detailed Game Design Document creation
2663
- - Technical architecture planning
2664
- - Art style exploration and pipeline setup
2665
- - id: phase-2-prototype
2666
- title: "Phase 2: Prototype ({{duration}})"
2667
- type: bullet-list
2668
- template: |
2669
- - Core mechanic implementation
2670
- - Technical proof of concept
2671
- - Initial playtesting and iteration
2672
- - id: phase-3-production
2673
- title: "Phase 3: Production ({{duration}})"
2674
- type: bullet-list
2675
- template: |
2676
- - Full feature development
2677
- - Content creation and integration
2678
- - Comprehensive testing and optimization
2679
- - id: documentation-pipeline
2680
- title: Documentation Pipeline
2681
- sections:
2682
- - id: required-documents
2683
- title: Required Documents
2684
- type: numbered-list
2685
- template: |
2686
- Game Design Document (GDD) - {{target_completion}}
2687
- Technical Architecture Document - {{target_completion}}
2688
- Art Style Guide - {{target_completion}}
2689
- Production Plan - {{target_completion}}
2690
- - id: validation-plan
2691
- title: Validation Plan
2692
- template: |
2693
- **Concept Testing:**
2694
-
2695
- - {{validation_method_1}} - {{timeline}}
2696
- - {{validation_method_2}} - {{timeline}}
2697
-
2698
- **Prototype Testing:**
2699
-
2700
- - {{testing_approach}} - {{timeline}}
2701
- - {{feedback_collection_method}} - {{timeline}}
2702
-
2703
- - id: appendices
2704
- title: Appendices
2705
- sections:
2706
- - id: research-materials
2707
- title: Research Materials
2708
- instruction: Include any supporting research, competitive analysis, or market data that informed the brief
2709
- - id: brainstorming-notes
2710
- title: Brainstorming Session Notes
2711
- instruction: Reference any brainstorming sessions that led to this brief
2712
- - id: stakeholder-input
2713
- title: Stakeholder Input
2714
- instruction: Include key input from stakeholders that shaped the vision
2715
- - id: change-log
2716
- title: Change Log
2717
- instruction: Track document versions and changes
2718
- type: table
2719
- template: |
2720
- | Date | Version | Description | Author |
2721
- | :--- | :------ | :---------- | :----- |
2722
- ==================== END: .bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml ====================
2723
-
2724
- ==================== START: .bmad-2d-unity-game-dev/checklists/game-design-checklist.md ====================
2725
- # Game Design Document Quality Checklist
2726
-
2727
- ## Document Completeness
2728
-
2729
- ### Executive Summary
2730
-
2731
- - [ ] **Core Concept** - Game concept is clearly explained in 2-3 sentences
2732
- - [ ] **Target Audience** - Primary and secondary audiences defined with demographics
2733
- - [ ] **Platform Requirements** - Technical platforms and requirements specified
2734
- - [ ] **Unique Selling Points** - 3-5 key differentiators from competitors identified
2735
- - [ ] **Technical Foundation** - Unity & C# requirements confirmed
2736
-
2737
- ### Game Design Foundation
2738
-
2739
- - [ ] **Game Pillars** - 3-5 core design pillars defined and actionable
2740
- - [ ] **Core Gameplay Loop** - 30-60 second loop documented with specific timings
2741
- - [ ] **Win/Loss Conditions** - Clear victory and failure states defined
2742
- - [ ] **Player Motivation** - Clear understanding of why players will engage
2743
- - [ ] **Scope Realism** - Game scope is achievable with available resources
2744
-
2745
- ## Gameplay Mechanics
2746
-
2747
- ### Core Mechanics Documentation
2748
-
2749
- - [ ] **Primary Mechanics** - 3-5 core mechanics detailed with implementation notes
2750
- - [ ] **Mechanic Integration** - How mechanics work together is clear
2751
- - [ ] **Player Input** - All input methods specified for each platform
2752
- - [ ] **System Responses** - Game responses to player actions documented
2753
- - [ ] **Performance Impact** - Performance considerations for each mechanic noted
2754
-
2755
- ### Controls and Interaction
2756
-
2757
- - [ ] **Multi-Platform Controls** - Desktop, mobile, and gamepad controls defined
2758
- - [ ] **Input Responsiveness** - Requirements for responsive game feel specified
2759
- - [ ] **Accessibility Options** - Control customization and accessibility considered
2760
- - [ ] **Touch Optimization** - Mobile-specific control adaptations designed
2761
- - [ ] **Edge Case Handling** - Unusual input scenarios addressed
2762
-
2763
- ## Progression and Balance
2764
-
2765
- ### Player Progression
2766
-
2767
- - [ ] **Progression Type** - Linear, branching, or metroidvania approach defined
2768
- - [ ] **Key Milestones** - Major progression points documented
2769
- - [ ] **Unlock System** - What players unlock and when is specified
2770
- - [ ] **Difficulty Scaling** - How challenge increases over time is detailed
2771
- - [ ] **Player Agency** - Meaningful player choices and consequences defined
2772
-
2773
- ### Game Balance
2774
-
2775
- - [ ] **Balance Parameters** - Numeric values for key game systems provided
2776
- - [ ] **Difficulty Curve** - Appropriate challenge progression designed
2777
- - [ ] **Economy Design** - Resource systems balanced for engagement
2778
- - [ ] **Player Testing** - Plan for validating balance through playtesting
2779
- - [ ] **Iteration Framework** - Process for adjusting balance post-implementation
2780
-
2781
- ## Level Design Framework
2782
-
2783
- ### Level Structure
2784
-
2785
- - [ ] **Level Types** - Different level categories defined with purposes
2786
- - [ ] **Level Progression** - How players move through levels specified
2787
- - [ ] **Duration Targets** - Expected play time for each level type
2788
- - [ ] **Difficulty Distribution** - Appropriate challenge spread across levels
2789
- - [ ] **Replay Value** - Elements that encourage repeated play designed
2790
-
2791
- ### Content Guidelines
2792
-
2793
- - [ ] **Level Creation Rules** - Clear guidelines for level designers
2794
- - [ ] **Mechanic Introduction** - How new mechanics are taught in levels
2795
- - [ ] **Pacing Variety** - Mix of action, puzzle, and rest moments planned
2796
- - [ ] **Secret Content** - Hidden areas and optional challenges designed
2797
- - [ ] **Accessibility Options** - Multiple difficulty levels or assist modes considered
2798
-
2799
- ## Technical Implementation Readiness
2800
-
2801
- ### Performance Requirements
2802
-
2803
- - [ ] **Frame Rate Targets** - Stable FPS target with minimum acceptable rates
2804
- - [ ] **Memory Budgets** - Maximum memory usage limits defined
2805
- - [ ] **Load Time Goals** - Acceptable loading times for different content
2806
- - [ ] **Battery Optimization** - Mobile battery usage considerations addressed
2807
- - [ ] **Scalability Plan** - How performance scales across different devices
2808
-
2809
- ### Platform Specifications
2810
-
2811
- - [ ] **Desktop Requirements** - Minimum and recommended PC/Mac specs
2812
- - [ ] **Mobile Optimization** - iOS and Android specific requirements
2813
- - [ ] **Browser Compatibility** - Supported browsers and versions listed
2814
- - [ ] **Cross-Platform Features** - Shared and platform-specific features identified
2815
- - [ ] **Update Strategy** - Plan for post-launch updates and patches
2816
-
2817
- ### Asset Requirements
2818
-
2819
- - [ ] **Art Style Definition** - Clear visual style with reference materials
2820
- - [ ] **Asset Specifications** - Technical requirements for all asset types
2821
- - [ ] **Audio Requirements** - Music and sound effect specifications
2822
- - [ ] **UI/UX Guidelines** - User interface design principles established
2823
- - [ ] **Localization Plan** - Text and cultural localization requirements
2824
-
2825
- ## Development Planning
2826
-
2827
- ### Implementation Phases
2828
-
2829
- - [ ] **Phase Breakdown** - Development divided into logical phases
2830
- - [ ] **Epic Definitions** - Major development epics identified
2831
- - [ ] **Dependency Mapping** - Prerequisites between features documented
2832
- - [ ] **Risk Assessment** - Technical and design risks identified with mitigation
2833
- - [ ] **Milestone Planning** - Key deliverables and deadlines established
2834
-
2835
- ### Team Requirements
2836
-
2837
- - [ ] **Role Definitions** - Required team roles and responsibilities
2838
- - [ ] **Skill Requirements** - Technical skills needed for implementation
2839
- - [ ] **Resource Allocation** - Time and effort estimates for major features
2840
- - [ ] **External Dependencies** - Third-party tools, assets, or services needed
2841
- - [ ] **Communication Plan** - How team members will coordinate work
2842
-
2843
- ## Quality Assurance
2844
-
2845
- ### Success Metrics
2846
-
2847
- - [ ] **Technical Metrics** - Measurable technical performance goals
2848
- - [ ] **Gameplay Metrics** - Player engagement and retention targets
2849
- - [ ] **Quality Benchmarks** - Standards for bug rates and polish level
2850
- - [ ] **User Experience Goals** - Specific UX objectives and measurements
2851
- - [ ] **Business Objectives** - Commercial or project success criteria
2852
-
2853
- ### Testing Strategy
2854
-
2855
- - [ ] **Playtesting Plan** - How and when player feedback will be gathered
2856
- - [ ] **Technical Testing** - Performance and compatibility testing approach
2857
- - [ ] **Balance Validation** - Methods for confirming game balance
2858
- - [ ] **Accessibility Testing** - Plan for testing with diverse players
2859
- - [ ] **Iteration Process** - How feedback will drive design improvements
2860
-
2861
- ## Documentation Quality
2862
-
2863
- ### Clarity and Completeness
2864
-
2865
- - [ ] **Clear Writing** - All sections are well-written and understandable
2866
- - [ ] **Complete Coverage** - No major game systems left undefined
2867
- - [ ] **Actionable Detail** - Enough detail for developers to create implementation stories
2868
- - [ ] **Consistent Terminology** - Game terms used consistently throughout
2869
- - [ ] **Reference Materials** - Links to inspiration, research, and additional resources
2870
-
2871
- ### Maintainability
2872
-
2873
- - [ ] **Version Control** - Change log established for tracking revisions
2874
- - [ ] **Update Process** - Plan for maintaining document during development
2875
- - [ ] **Team Access** - All team members can access and reference the document
2876
- - [ ] **Search Functionality** - Document organized for easy reference and searching
2877
- - [ ] **Living Document** - Process for incorporating feedback and changes
2878
-
2879
- ## Stakeholder Alignment
2880
-
2881
- ### Team Understanding
2882
-
2883
- - [ ] **Shared Vision** - All team members understand and agree with the game vision
2884
- - [ ] **Role Clarity** - Each team member understands their contribution
2885
- - [ ] **Decision Framework** - Process for making design decisions during development
2886
- - [ ] **Conflict Resolution** - Plan for resolving disagreements about design choices
2887
- - [ ] **Communication Channels** - Regular meetings and feedback sessions planned
2888
-
2889
- ### External Validation
2890
-
2891
- - [ ] **Market Validation** - Competitive analysis and market fit assessment
2892
- - [ ] **Technical Validation** - Feasibility confirmed with technical team
2893
- - [ ] **Resource Validation** - Required resources available and committed
2894
- - [ ] **Timeline Validation** - Development schedule is realistic and achievable
2895
- - [ ] **Quality Validation** - Quality standards align with available time and resources
2896
-
2897
- ## Final Readiness Assessment
2898
-
2899
- ### Implementation Preparedness
2900
-
2901
- - [ ] **Story Creation Ready** - Document provides sufficient detail for story creation
2902
- - [ ] **Architecture Alignment** - Game design aligns with technical capabilities
2903
- - [ ] **Asset Production** - Asset requirements enable art and audio production
2904
- - [ ] **Development Workflow** - Clear path from design to implementation
2905
- - [ ] **Quality Assurance** - Testing and validation processes established
2906
-
2907
- ### Document Approval
2908
-
2909
- - [ ] **Design Review Complete** - Document reviewed by all relevant stakeholders
2910
- - [ ] **Technical Review Complete** - Technical feasibility confirmed
2911
- - [ ] **Business Review Complete** - Project scope and goals approved
2912
- - [ ] **Final Approval** - Document officially approved for implementation
2913
- - [ ] **Baseline Established** - Current version established as development baseline
2914
-
2915
- ## Overall Assessment
2916
-
2917
- **Document Quality Rating:** ⭐⭐⭐⭐⭐
2918
-
2919
- **Ready for Development:** [ ] Yes [ ] No
2920
-
2921
- **Key Recommendations:**
2922
- _List any critical items that need attention before moving to implementation phase._
2923
-
2924
- **Next Steps:**
2925
- _Outline immediate next actions for the team based on this assessment._
2926
- ==================== END: .bmad-2d-unity-game-dev/checklists/game-design-checklist.md ====================
2927
-
2928
- ==================== START: .bmad-2d-unity-game-dev/data/bmad-kb.md ====================
2929
- # BMad Knowledge Base - 2D Unity Game Development
2930
-
2931
- ## Overview
2932
-
2933
- This is the game development expansion of BMad-Method (Breakthrough Method of Agile AI-driven Development), specializing in creating 2D games using Unity and C#. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments, specifically optimized for game development workflows.
2934
-
2935
- ### Key Features for Game Development
2936
-
2937
- - **Game-Specialized Agent System**: AI agents for each game development role (Designer, Developer, Scrum Master)
2938
- - **Unity-Optimized Build System**: Automated dependency resolution for game assets and scripts
2939
- - **Dual Environment Support**: Optimized for both web UIs and game development IDEs
2940
- - **Game Development Resources**: Specialized templates, tasks, and checklists for 2D Unity games
2941
- - **Performance-First Approach**: Built-in optimization patterns for cross-platform game deployment
2942
-
2943
- ### Game Development Focus
2944
-
2945
- - **Target Engine**: Unity 2022 LTS or newer with C# 10+
2946
- - **Platform Strategy**: Cross-platform (PC, Console, Mobile) with a focus on 2D
2947
- - **Development Approach**: Agile story-driven development with game-specific workflows
2948
- - **Performance Target**: Stable frame rate on target devices
2949
- - **Architecture**: Component-based architecture using Unity's best practices
2950
-
2951
- ### When to Use BMad for Game Development
2952
-
2953
- - **New Game Projects (Greenfield)**: Complete end-to-end game development from concept to deployment
2954
- - **Existing Game Projects (Brownfield)**: Feature additions, level expansions, and gameplay enhancements
2955
- - **Game Team Collaboration**: Multiple specialized roles working together on game features
2956
- - **Game Quality Assurance**: Structured testing, performance validation, and gameplay balance
2957
- - **Game Documentation**: Professional Game Design Documents, technical architecture, user stories
2958
-
2959
- ## How BMad Works for Game Development
2960
-
2961
- ### The Core Method
2962
-
2963
- BMad transforms you into a "Player Experience CEO" - directing a team of specialized game development AI agents through structured workflows. Here's how:
2964
-
2965
- 1. **You Direct, AI Executes**: You provide game vision and creative decisions; agents handle implementation details
2966
- 2. **Specialized Game Agents**: Each agent masters one game development role (Designer, Developer, Scrum Master)
2967
- 3. **Game-Focused Workflows**: Proven patterns guide you from game concept to deployed 2D Unity game
2968
- 4. **Clean Handoffs**: Fresh context windows ensure agents stay focused and effective for game development
2969
-
2970
- ### The Two-Phase Game Development Approach
2971
-
2972
- #### Phase 1: Game Design & Planning (Web UI - Cost Effective)
2973
-
2974
- - Use large context windows for comprehensive game design
2975
- - Generate complete Game Design Documents and technical architecture
2976
- - Leverage multiple agents for creative brainstorming and mechanics refinement
2977
- - Create once, use throughout game development
2978
-
2979
- #### Phase 2: Game Development (IDE - Implementation)
2980
-
2981
- - Shard game design documents into manageable pieces
2982
- - Execute focused SM → Dev cycles for game features
2983
- - One game story at a time, sequential progress
2984
- - Real-time Unity operations, C# coding, and game testing
2985
-
2986
- ### The Game Development Loop
2987
-
2988
- ```text
2989
- 1. Game SM Agent (New Chat) → Creates next game story from sharded docs
2990
- 2. You → Review and approve game story
2991
- 3. Game Dev Agent (New Chat) → Implements approved game feature in Unity
2992
- 4. QA Agent (New Chat) → Reviews code and tests gameplay
2993
- 5. You → Verify game feature completion
2994
- 6. Repeat until game epic complete
2995
- ```
2996
-
2997
- ### Why This Works for Games
2998
-
2999
- - **Context Optimization**: Clean chats = better AI performance for complex game logic
3000
- - **Role Clarity**: Agents don't context-switch = higher quality game features
3001
- - **Incremental Progress**: Small game stories = manageable complexity
3002
- - **Player-Focused Oversight**: You validate each game feature = quality control
3003
- - **Design-Driven**: Game specs guide everything = consistent player experience
3004
-
3005
- ### Core Game Development Philosophy
3006
-
3007
- #### Player-First Development
3008
-
3009
- 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.
3010
-
3011
- #### Game Development Principles
3012
-
3013
- 1. **MAXIMIZE_PLAYER_ENGAGEMENT**: Push the AI to create compelling gameplay. Challenge mechanics and iterate.
3014
- 2. **GAMEPLAY_QUALITY_CONTROL**: You are the ultimate arbiter of fun. Review all game features.
3015
- 3. **CREATIVE_OVERSIGHT**: Maintain the high-level game vision and ensure design alignment.
3016
- 4. **ITERATIVE_REFINEMENT**: Expect to revisit game mechanics. Game development is not linear.
3017
- 5. **CLEAR_GAME_INSTRUCTIONS**: Precise game requirements lead to better implementations.
3018
- 6. **DOCUMENTATION_IS_KEY**: Good game design docs lead to good game features.
3019
- 7. **START_SMALL_SCALE_FAST**: Test core mechanics, then expand and polish.
3020
- 8. **EMBRACE_CREATIVE_CHAOS**: Adapt and overcome game development challenges.
3021
-
3022
- ## Getting Started with Game Development
3023
-
3024
- ### Quick Start Options for Game Development
3025
-
3026
- #### Option 1: Web UI for Game Design
3027
-
3028
- **Best for**: Game designers who want to start with comprehensive planning
3029
-
3030
- 1. Navigate to `dist/teams/` (after building)
3031
- 2. Copy `unity-2d-game-team.txt` content
3032
- 3. Create new Gemini Gem or CustomGPT
3033
- 4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
3034
- 5. Type `/help` to see available game development commands
3035
-
3036
- #### Option 2: IDE Integration for Game Development
3037
-
3038
- **Best for**: Unity developers using Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot
3039
-
3040
- ```bash
3041
- # Interactive installation (recommended)
3042
- npx bmad-method install
3043
- # Select the bmad-2d-unity-game-dev expansion pack when prompted
3044
- ```
3045
-
3046
- **Installation Steps for Game Development**:
3047
-
3048
- - Choose "Install expansion pack" when prompted
3049
- - Select "bmad-2d-unity-game-dev" from the list
3050
- - Select your IDE from supported options:
3051
- - **Cursor**: Native AI integration with Unity support
3052
- - **Claude Code**: Anthropic's official IDE
3053
- - **Windsurf**: Built-in AI capabilities
3054
- - **Trae**: Built-in AI capabilities
3055
- - **Cline**: VS Code extension with AI features
3056
- - **Roo Code**: Web-based IDE with agent support
3057
- - **GitHub Copilot**: VS Code extension with AI peer programming assistant
3058
-
3059
- **Verify Game Development Installation**:
3060
-
3061
- - `.bmad-core/` folder created with all core agents
3062
- - `.bmad-2d-unity-game-dev/` folder with game development agents
3063
- - IDE-specific integration files created
3064
- - Game development agents available with `/bmad2du` prefix (per config.yaml)
3065
-
3066
- ### Environment Selection Guide for Game Development
3067
-
3068
- **Use Web UI for**:
3069
-
3070
- - Game design document creation and brainstorming
3071
- - Cost-effective comprehensive game planning (especially with Gemini)
3072
- - Multi-agent game design consultation
3073
- - Creative ideation and mechanics refinement
3074
-
3075
- **Use IDE for**:
3076
-
3077
- - Unity project development and C# coding
3078
- - Game asset operations and project integration
3079
- - Game story management and implementation workflow
3080
- - Unity testing, profiling, and debugging
3081
-
3082
- **Cost-Saving Tip for Game Development**: Create large game design documents in web UI, then copy to `docs/game-design-doc.md` and `docs/game-architecture.md` in your Unity project before switching to IDE for development.
3083
-
3084
- ### IDE-Only Game Development Workflow Considerations
3085
-
3086
- **Can you do everything in IDE?** Yes, but understand the game development tradeoffs:
3087
-
3088
- **Pros of IDE-Only Game Development**:
3089
-
3090
- - Single environment workflow from design to Unity deployment
3091
- - Direct Unity project operations from start
3092
- - No copy/paste between environments
3093
- - Immediate Unity project integration
3094
-
3095
- **Cons of IDE-Only Game Development**:
3096
-
3097
- - Higher token costs for large game design document creation
3098
- - Smaller context windows for comprehensive game planning
3099
- - May hit limits during creative brainstorming phases
3100
- - Less cost-effective for extensive game design iteration
3101
-
3102
- **CRITICAL RULE for Game Development**:
3103
-
3104
- - **ALWAYS use Game SM agent for story creation** - Never use bmad-master or bmad-orchestrator
3105
- - **ALWAYS use Game Dev agent for Unity implementation** - Never use bmad-master or bmad-orchestrator
3106
- - **Why this matters**: Game SM and Game Dev agents are specifically optimized for Unity workflows
3107
- - **No exceptions**: Even if using bmad-master for design, switch to Game SM → Game Dev for implementation
3108
-
3109
- ## Core Configuration for Game Development (core-config.yaml)
3110
-
3111
- **New in V4**: The `expansion-packs/bmad-2d-unity-game-dev/core-config.yaml` file enables BMad to work seamlessly with any Unity project structure, providing maximum flexibility for game development.
3112
-
3113
- ### Game Development Configuration
3114
-
3115
- The expansion pack follows the standard BMad configuration patterns. Copy your core-config.yaml file to expansion-packs/bmad-2d-unity-game-dev/ and add Game-specific configurations to your project's `core-config.yaml`:
3116
-
3117
- ```yaml
3118
- markdownExploder: true
3119
- prd:
3120
- prdFile: docs/prd.md
3121
- prdVersion: v4
3122
- prdSharded: true
3123
- prdShardedLocation: docs/prd
3124
- epicFilePattern: epic-{n}*.md
3125
- architecture:
3126
- architectureFile: docs/architecture.md
3127
- architectureVersion: v4
3128
- architectureSharded: true
3129
- architectureShardedLocation: docs/architecture
3130
- gdd:
3131
- gddVersion: v4
3132
- gddSharded: true
3133
- gddLocation: docs/game-design-doc.md
3134
- gddShardedLocation: docs/gdd
3135
- epicFilePattern: epic-{n}*.md
3136
- gamearchitecture:
3137
- gamearchitectureFile: docs/architecture.md
3138
- gamearchitectureVersion: v3
3139
- gamearchitectureLocation: docs/game-architecture.md
3140
- gamearchitectureSharded: true
3141
- gamearchitectureShardedLocation: docs/game-architecture
3142
- gamebriefdocLocation: docs/game-brief.md
3143
- levelDesignLocation: docs/level-design.md
3144
- #Specify the location for your unity editor
3145
- unityEditorLocation: /home/USER/Unity/Hub/Editor/VERSION/Editor/Unity
3146
- customTechnicalDocuments: null
3147
- devDebugLog: .ai/debug-log.md
3148
- devStoryLocation: docs/stories
3149
- slashPrefix: bmad2du
3150
- #replace old devLoadAlwaysFiles with this once you have sharded your gamearchitecture document
3151
- devLoadAlwaysFiles:
3152
- - docs/game-architecture/9-coding-standards.md
3153
- - docs/game-architecture/3-tech-stack.md
3154
- - docs/game-architecture/8-unity-project-structure.md
3155
- ```
3156
-
3157
- ## Complete Game Development Workflow
3158
-
3159
- ### Planning Phase (Web UI Recommended - Especially Gemini for Game Design!)
3160
-
3161
- **Ideal for cost efficiency with Gemini's massive context for game brainstorming:**
3162
-
3163
- **For All Game Projects**:
3164
-
3165
- 1. **Game Concept Brainstorming**: `/bmad2du/game-designer` - Use `*game-design-brainstorming` task
3166
- 2. **Game Brief**: Create foundation game document using `game-brief-tmpl`
3167
- 3. **Game Design Document Creation**: `/bmad2du/game-designer` - Use `game-design-doc-tmpl` for comprehensive game requirements
3168
- 4. **Game Architecture Design**: `/bmad2du/game-architect` - Use `game-architecture-tmpl` for Unity technical foundation
3169
- 5. **Level Design Framework**: `/bmad2du/game-designer` - Use `level-design-doc-tmpl` for level structure planning
3170
- 6. **Document Preparation**: Copy final documents to Unity project as `docs/game-design-doc.md`, `docs/game-brief.md`, `docs/level-design.md` and `docs/game-architecture.md`
3171
-
3172
- #### Example Game Planning Prompts
3173
-
3174
- **For Game Design Document Creation**:
3175
-
3176
- ```text
3177
- "I want to build a [genre] 2D game that [core gameplay].
3178
- Help me brainstorm mechanics and create a comprehensive Game Design Document."
3179
- ```
3180
-
3181
- **For Game Architecture Design**:
3182
-
3183
- ```text
3184
- "Based on this Game Design Document, design a scalable Unity architecture
3185
- that can handle [specific game requirements] with stable performance."
3186
- ```
3187
-
3188
- ### Critical Transition: Web UI to Unity IDE
3189
-
3190
- **Once game planning is complete, you MUST switch to IDE for Unity development:**
3191
-
3192
- - **Why**: Unity development workflow requires C# operations, asset management, and real-time Unity testing
3193
- - **Cost Benefit**: Web UI is more cost-effective for large game design creation; IDE is optimized for Unity development
3194
- - **Required Files**: Ensure `docs/game-design-doc.md` and `docs/game-architecture.md` exist in your Unity project
3195
-
3196
- ### Unity IDE Development Workflow
3197
-
3198
- **Prerequisites**: Game planning documents must exist in `docs/` folder of Unity project
3199
-
3200
- 1. **Document Sharding** (CRITICAL STEP for Game Development):
3201
- - Documents created by Game Designer/Architect (in Web or IDE) MUST be sharded for development
3202
- - Use core BMad agents or tools to shard:
3203
- a) **Manual**: Use core BMad `shard-doc` task if available
3204
- b) **Agent**: Ask core `@bmad-master` agent to shard documents
3205
- - Shards `docs/game-design-doc.md` → `docs/game-design/` folder
3206
- - Shards `docs/game-architecture.md` → `docs/game-architecture/` folder
3207
- - **WARNING**: Do NOT shard in Web UI - copying many small files to Unity is painful!
3208
-
3209
- 2. **Verify Sharded Game Content**:
3210
- - At least one `feature-n.md` file in `docs/game-design/` with game stories in development order
3211
- - Unity system documents and coding standards for game dev agent reference
3212
- - Sharded docs for Game SM agent story creation
3213
-
3214
- Resulting Unity Project Folder Structure:
3215
-
3216
- - `docs/game-design/` - Broken down game design sections
3217
- - `docs/game-architecture/` - Broken down Unity architecture sections
3218
- - `docs/game-stories/` - Generated game development stories
3219
-
3220
- 3. **Game Development Cycle** (Sequential, one game story at a time):
3221
-
3222
- **CRITICAL CONTEXT MANAGEMENT for Unity Development**:
3223
- - **Context windows matter!** Always use fresh, clean context windows
3224
- - **Model selection matters!** Use most powerful thinking model for Game SM story creation
3225
- - **ALWAYS start new chat between Game SM, Game Dev, and QA work**
3226
-
3227
- **Step 1 - Game Story Creation**:
3228
- - **NEW CLEAN CHAT** → Select powerful model → `/bmad2du/game-sm` → `*draft`
3229
- - Game SM executes create-game-story task using `game-story-tmpl`
3230
- - Review generated story in `docs/game-stories/`
3231
- - Update status from "Draft" to "Approved"
3232
-
3233
- **Step 2 - Unity Game Story Implementation**:
3234
- - **NEW CLEAN CHAT** → `/bmad2du/game-developer`
3235
- - Agent asks which game story to implement
3236
- - Include story file content to save game dev agent lookup time
3237
- - Game Dev follows tasks/subtasks, marking completion
3238
- - Game Dev maintains File List of all Unity/C# changes
3239
- - Game Dev marks story as "Review" when complete with all Unity tests passing
3240
-
3241
- **Step 3 - Game QA Review**:
3242
- - **NEW CLEAN CHAT** → Use core `@qa` agent → execute review-story task
3243
- - QA performs senior Unity developer code review
3244
- - QA can refactor and improve Unity code directly
3245
- - QA appends results to story's QA Results section
3246
- - If approved: Status → "Done"
3247
- - If changes needed: Status stays "Review" with unchecked items for game dev
3248
-
3249
- **Step 4 - Repeat**: Continue Game SM → Game Dev → QA cycle until all game feature stories complete
3250
-
3251
- **Important**: Only 1 game story in progress at a time, worked sequentially until all game feature stories complete.
3252
-
3253
- ### Game Story Status Tracking Workflow
3254
-
3255
- Game stories progress through defined statuses:
3256
-
3257
- - **Draft** → **Approved** → **InProgress** → **Done**
3258
-
3259
- Each status change requires user verification and approval before proceeding.
3260
-
3261
- ### Game Development Workflow Types
3262
-
3263
- #### Greenfield Game Development
3264
-
3265
- - Game concept brainstorming and mechanics design
3266
- - Game design requirements and feature definition
3267
- - Unity system architecture and technical design
3268
- - Game development execution
3269
- - Game testing, performance optimization, and deployment
3270
-
3271
- #### Brownfield Game Enhancement (Existing Unity Projects)
3272
-
3273
- **Key Concept**: Brownfield game development requires comprehensive documentation of your existing Unity project for AI agents to understand game mechanics, Unity patterns, and technical constraints.
3274
-
3275
- **Brownfield Game Enhancement Workflow**:
3276
-
3277
- Since this expansion pack doesn't include specific brownfield templates, you'll adapt the existing templates:
3278
-
3279
- 1. **Upload Unity project to Web UI** (GitHub URL, files, or zip)
3280
- 2. **Create adapted Game Design Document**: `/bmad2du/game-designer` - Modify `game-design-doc-tmpl` to include:
3281
- - Analysis of existing game systems
3282
- - Integration points for new features
3283
- - Compatibility requirements
3284
- - Risk assessment for changes
3285
-
3286
- 3. **Game Architecture Planning**:
3287
- - Use `/bmad2du/game-architect` with `game-architecture-tmpl`
3288
- - Focus on how new features integrate with existing Unity systems
3289
- - Plan for gradual rollout and testing
3290
-
3291
- 4. **Story Creation for Enhancements**:
3292
- - Use `/bmad2du/game-sm` with `*create-game-story`
3293
- - Stories should explicitly reference existing code to modify
3294
- - Include integration testing requirements
3295
-
3296
- **When to Use Each Game Development Approach**:
3297
-
3298
- **Full Game Enhancement Workflow** (Recommended for):
3299
-
3300
- - Major game feature additions
3301
- - Game system modernization
3302
- - Complex Unity integrations
3303
- - Multiple related gameplay changes
3304
-
3305
- **Quick Story Creation** (Use when):
3306
-
3307
- - Single, focused game enhancement
3308
- - Isolated gameplay fixes
3309
- - Small feature additions
3310
- - Well-documented existing Unity game
3311
-
3312
- **Critical Success Factors for Game Development**:
3313
-
3314
- 1. **Game Documentation First**: Always document existing code thoroughly before making changes
3315
- 2. **Unity Context Matters**: Provide agents access to relevant Unity scripts and game systems
3316
- 3. **Gameplay Integration Focus**: Emphasize compatibility and non-breaking changes to game mechanics
3317
- 4. **Incremental Approach**: Plan for gradual rollout and extensive game testing
3318
-
3319
- ## Document Creation Best Practices for Game Development
3320
-
3321
- ### Required File Naming for Game Framework Integration
3322
-
3323
- - `docs/game-design-doc.md` - Game Design Document
3324
- - `docs/game-architecture.md` - Unity System Architecture Document
3325
-
3326
- **Why These Names Matter for Game Development**:
3327
-
3328
- - Game agents automatically reference these files during Unity development
3329
- - Game sharding tasks expect these specific filenames
3330
- - Game workflow automation depends on standard naming
3331
-
3332
- ### Cost-Effective Game Document Creation Workflow
3333
-
3334
- **Recommended for Large Game Documents (Game Design Document, Game Architecture):**
3335
-
3336
- 1. **Use Web UI**: Create game documents in web interface for cost efficiency
3337
- 2. **Copy Final Output**: Save complete markdown to your Unity project
3338
- 3. **Standard Names**: Save as `docs/game-design-doc.md` and `docs/game-architecture.md`
3339
- 4. **Switch to Unity IDE**: Use IDE agents for Unity development and smaller game documents
3340
-
3341
- ### Game Document Sharding
3342
-
3343
- Game templates with Level 2 headings (`##`) can be automatically sharded:
3344
-
3345
- **Original Game Design Document**:
3346
-
3347
- ```markdown
3348
- ## Core Gameplay Mechanics
3349
-
3350
- ## Player Progression System
3351
-
3352
- ## Level Design Framework
3353
-
3354
- ## Technical Requirements
3355
- ```
3356
-
3357
- **After Sharding**:
3358
-
3359
- - `docs/game-design/core-gameplay-mechanics.md`
3360
- - `docs/game-design/player-progression-system.md`
3361
- - `docs/game-design/level-design-framework.md`
3362
- - `docs/game-design/technical-requirements.md`
3363
-
3364
- Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic game document sharding.
3365
-
3366
- ## Game Agent System
3367
-
3368
- ### Core Game Development Team
3369
-
3370
- | Agent | Role | Primary Functions | When to Use |
3371
- | ---------------- | ----------------- | ------------------------------------------- | ------------------------------------------- |
3372
- | `game-designer` | Game Designer | Game mechanics, creative design, GDD | Game concept, mechanics, creative direction |
3373
- | `game-developer` | Unity Developer | C# implementation, Unity optimization | All Unity development tasks |
3374
- | `game-sm` | Game Scrum Master | Game story creation, sprint planning | Game project management, workflow |
3375
- | `game-architect` | Game Architect | Unity system design, technical architecture | Complex Unity systems, performance planning |
3376
-
3377
- **Note**: For QA and other roles, use the core BMad agents (e.g., `@qa` from bmad-core).
3378
-
3379
- ### Game Agent Interaction Commands
3380
-
3381
- #### IDE-Specific Syntax for Game Development
3382
-
3383
- **Game Agent Loading by IDE**:
3384
-
3385
- - **Claude Code**: `/bmad2du/game-designer`, `/bmad2du/game-developer`, `/bmad2du/game-sm`, `/bmad2du/game-architect`
3386
- - **Cursor**: `@bmad2du/game-designer`, `@bmad2du/game-developer`, `@bmad2du/game-sm`, `@bmad2du/game-architect`
3387
- - **Windsurf**: `/bmad2du/game-designer`, `/bmad2du/game-developer`, `/bmad2du/game-sm`, `/bmad2du/game-architect`
3388
- - **Trae**: `@bmad2du/game-designer`, `@bmad2du/game-developer`, `@bmad2du/game-sm`, `@bmad2du/game-architect`
3389
- - **Roo Code**: Select mode from mode selector with bmad2du prefix
3390
- - **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select the appropriate game agent.
3391
-
3392
- **Common Game Development Task Commands**:
3393
-
3394
- - `*help` - Show available game development commands
3395
- - `*status` - Show current game development context/progress
3396
- - `*exit` - Exit the game agent mode
3397
- - `*game-design-brainstorming` - Brainstorm game concepts and mechanics (Game Designer)
3398
- - `*draft` - Create next game development story (Game SM agent)
3399
- - `*validate-game-story` - Validate a game story implementation (with core QA agent)
3400
- - `*correct-course-game` - Course correction for game development issues
3401
- - `*advanced-elicitation` - Deep dive into game requirements
3402
-
3403
- **In Web UI (after building with unity-2d-game-team)**:
3404
-
3405
- ```text
3406
- /bmad2du/game-designer - Access game designer agent
3407
- /bmad2du/game-architect - Access game architect agent
3408
- /bmad2du/game-developer - Access game developer agent
3409
- /bmad2du/game-sm - Access game scrum master agent
3410
- /help - Show available game development commands
3411
- /switch agent-name - Change active agent (if orchestrator available)
3412
- ```
3413
-
3414
- ## Game-Specific Development Guidelines
3415
-
3416
- ### Unity + C# Standards
3417
-
3418
- **Project Structure:**
3419
-
3420
- ```text
3421
- UnityProject/
3422
- ├── Assets/
3423
- │ └── _Project
3424
- │ ├── Scenes/ # Game scenes (Boot, Menu, Game, etc.)
3425
- │ ├── Scripts/ # C# scripts
3426
- │ │ ├── Editor/ # Editor-specific scripts
3427
- │ │ └── Runtime/ # Runtime scripts
3428
- │ ├── Prefabs/ # Reusable game objects
3429
- │ ├── Art/ # Art assets (sprites, models, etc.)
3430
- │ ├── Audio/ # Audio assets
3431
- │ ├── Data/ # ScriptableObjects and other data
3432
- │ └── Tests/ # Unity Test Framework tests
3433
- │ ├── EditMode/
3434
- │ └── PlayMode/
3435
- ├── Packages/ # Package Manager manifest
3436
- └── ProjectSettings/ # Unity project settings
3437
- ```
3438
-
3439
- **Performance Requirements:**
3440
-
3441
- - Maintain stable frame rate on target devices
3442
- - Memory usage under specified limits per level
3443
- - Loading times under 3 seconds for levels
3444
- - Smooth animation and responsive controls
3445
-
3446
- **Code Quality:**
3447
-
3448
- - C# best practices compliance
3449
- - Component-based architecture (SOLID principles)
3450
- - Efficient use of the MonoBehaviour lifecycle
3451
- - Error handling and graceful degradation
3452
-
3453
- ### Game Development Story Structure
3454
-
3455
- **Story Requirements:**
3456
-
3457
- - Clear reference to Game Design Document section
3458
- - Specific acceptance criteria for game functionality
3459
- - Technical implementation details for Unity and C#
3460
- - Performance requirements and optimization considerations
3461
- - Testing requirements including gameplay validation
3462
-
3463
- **Story Categories:**
3464
-
3465
- - **Core Mechanics**: Fundamental gameplay systems
3466
- - **Level Content**: Individual levels and content implementation
3467
- - **UI/UX**: User interface and player experience features
3468
- - **Performance**: Optimization and technical improvements
3469
- - **Polish**: Visual effects, audio, and game feel enhancements
3470
-
3471
- ### Quality Assurance for Games
3472
-
3473
- **Testing Approach:**
3474
-
3475
- - Unit tests for C# logic (EditMode tests)
3476
- - Integration tests for game systems (PlayMode tests)
3477
- - Performance benchmarking and profiling with Unity Profiler
3478
- - Gameplay testing and balance validation
3479
- - Cross-platform compatibility testing
3480
-
3481
- **Performance Monitoring:**
3482
-
3483
- - Frame rate consistency tracking
3484
- - Memory usage monitoring
3485
- - Asset loading performance
3486
- - Input responsiveness validation
3487
- - Battery usage optimization (mobile)
3488
-
3489
- ## Usage Patterns and Best Practices for Game Development
3490
-
3491
- ### Environment-Specific Usage for Games
3492
-
3493
- **Web UI Best For Game Development**:
3494
-
3495
- - Initial game design and creative brainstorming phases
3496
- - Cost-effective large game document creation
3497
- - Game agent consultation and mechanics refinement
3498
- - Multi-agent game workflows with orchestrator
3499
-
3500
- **Unity IDE Best For Game Development**:
3501
-
3502
- - Active Unity development and C# implementation
3503
- - Unity asset operations and project integration
3504
- - Game story management and development cycles
3505
- - Unity testing, profiling, and debugging
3506
-
3507
- ### Quality Assurance for Game Development
3508
-
3509
- - Use appropriate game agents for specialized tasks
3510
- - Follow Agile ceremonies and game review processes
3511
- - Use game-specific checklists:
3512
- - `game-architect-checklist` for architecture reviews
3513
- - `game-change-checklist` for change validation
3514
- - `game-design-checklist` for design reviews
3515
- - `game-story-dod-checklist` for story quality
3516
- - Regular validation with game templates
3517
-
3518
- ### Performance Optimization for Game Development
3519
-
3520
- - Use specific game agents vs. `bmad-master` for focused Unity tasks
3521
- - Choose appropriate game team size for project needs
3522
- - Leverage game-specific technical preferences for consistency
3523
- - Regular context management and cache clearing for Unity workflows
3524
-
3525
- ## Game Development Team Roles
3526
-
3527
- ### Game Designer
3528
-
3529
- - **Primary Focus**: Game mechanics, player experience, design documentation
3530
- - **Key Outputs**: Game Brief, Game Design Document, Level Design Framework
3531
- - **Specialties**: Brainstorming, game balance, player psychology, creative direction
3532
-
3533
- ### Game Developer
3534
-
3535
- - **Primary Focus**: Unity implementation, C# excellence, performance optimization
3536
- - **Key Outputs**: Working game features, optimized Unity code, technical architecture
3537
- - **Specialties**: C#/Unity, performance optimization, cross-platform development
3538
-
3539
- ### Game Scrum Master
3540
-
3541
- - **Primary Focus**: Game story creation, development planning, agile process
3542
- - **Key Outputs**: Detailed implementation stories, sprint planning, quality assurance
3543
- - **Specialties**: Story breakdown, developer handoffs, process optimization
3544
-
3545
- ## Platform-Specific Considerations
3546
-
3547
- ### Cross-Platform Development
3548
-
3549
- - Abstract input using the new Input System
3550
- - Use platform-dependent compilation for specific logic
3551
- - Test on all target platforms regularly
3552
- - Optimize for different screen resolutions and aspect ratios
3553
-
3554
- ### Mobile Optimization
3555
-
3556
- - Touch gesture support and responsive controls
3557
- - Battery usage optimization
3558
- - Performance scaling for different device capabilities
3559
- - App store compliance and packaging
3560
-
3561
- ### Performance Targets
3562
-
3563
- - **PC/Console**: 60+ FPS at target resolution
3564
- - **Mobile**: 60 FPS on mid-range devices, 30 FPS minimum on low-end
3565
- - **Loading**: Initial load under 5 seconds, scene transitions under 2 seconds
3566
- - **Memory**: Within platform-specific memory budgets
3567
-
3568
- ## Success Metrics for Game Development
3569
-
3570
- ### Technical Metrics
3571
-
3572
- - Frame rate consistency (>90% of time at target FPS)
3573
- - Memory usage within budgets
3574
- - Loading time targets met
3575
- - Zero critical bugs in core gameplay systems
3576
-
3577
- ### Player Experience Metrics
3578
-
3579
- - Tutorial completion rate >80%
3580
- - Level completion rates appropriate for difficulty curve
3581
- - Average session length meets design targets
3582
- - Player retention and engagement metrics
3583
-
3584
- ### Development Process Metrics
3585
-
3586
- - Story completion within estimated timeframes
3587
- - Code quality metrics (test coverage, code analysis)
3588
- - Documentation completeness and accuracy
3589
- - Team velocity and delivery consistency
3590
-
3591
- ## Common Unity Development Patterns
3592
-
3593
- ### Scene Management
3594
-
3595
- - Use a loading scene for asynchronous loading of game scenes
3596
- - Use additive scene loading for large levels or streaming
3597
- - Manage scenes with a dedicated SceneManager class
3598
-
3599
- ### Game State Management
3600
-
3601
- - Use ScriptableObjects to store shared game state
3602
- - Implement a finite state machine (FSM) for complex behaviors
3603
- - Use a GameManager singleton for global state management
3604
-
3605
- ### Input Handling
3606
-
3607
- - Use the new Input System for robust, cross-platform input
3608
- - Create Action Maps for different input contexts (e.g., menu, gameplay)
3609
- - Use PlayerInput component for easy player input handling
3610
-
3611
- ### Performance Optimization
3612
-
3613
- - Object pooling for frequently instantiated objects (e.g., bullets, enemies)
3614
- - Use the Unity Profiler to identify performance bottlenecks
3615
- - Optimize physics settings and collision detection
3616
- - Use LOD (Level of Detail) for complex models
3617
-
3618
- ## Success Tips for Game Development
3619
-
3620
- - **Use Gemini for game design planning** - The team-game-dev bundle provides collaborative game expertise
3621
- - **Use bmad-master for game document organization** - Sharding creates manageable game feature chunks
3622
- - **Follow the Game SM → Game Dev cycle religiously** - This ensures systematic game progress
3623
- - **Keep conversations focused** - One game agent, one Unity task per conversation
3624
- - **Review everything** - Always review and approve before marking game features complete
3625
-
3626
- ## Contributing to BMad-Method Game Development
3627
-
3628
- ### Game Development Contribution Guidelines
3629
-
3630
- For full details, see `CONTRIBUTING.md`. Key points for game development:
3631
-
3632
- **Fork Workflow for Game Development**:
3633
-
3634
- 1. Fork the repository
3635
- 2. Create game development feature branches
3636
- 3. Submit PRs to `next` branch (default) or `main` for critical game development fixes only
3637
- 4. Keep PRs small: 200-400 lines ideal, 800 lines maximum
3638
- 5. One game feature/fix per PR
3639
-
3640
- **Game Development PR Requirements**:
3641
-
3642
- - Clear descriptions (max 200 words) with What/Why/How/Testing for game features
3643
- - Use conventional commits (feat:, fix:, docs:) with game context
3644
- - Atomic commits - one logical game change per commit
3645
- - Must align with game development guiding principles
3646
-
3647
- **Game Development Core Principles**:
3648
-
3649
- - **Game Dev Agents Must Be Lean**: Minimize dependencies, save context for Unity code
3650
- - **Natural Language First**: Everything in markdown, no code in game development core
3651
- - **Core vs Game Expansion Packs**: Core for universal needs, game packs for Unity specialization
3652
- - **Game Design Philosophy**: "Game dev agents code Unity, game planning agents plan gameplay"
3653
-
3654
- ## Game Development Expansion Pack System
3655
-
3656
- ### This Game Development Expansion Pack
3657
-
3658
- This 2D Unity Game Development expansion pack extends BMad-Method beyond traditional software development into professional game development. It provides specialized game agent teams, Unity templates, and game workflows while keeping the core framework lean and focused on general development.
3659
-
3660
- ### Why Use This Game Development Expansion Pack?
3661
-
3662
- 1. **Keep Core Lean**: Game dev agents maintain maximum context for Unity coding
3663
- 2. **Game Domain Expertise**: Deep, specialized Unity and game development knowledge
3664
- 3. **Community Game Innovation**: Game developers can contribute and share Unity patterns
3665
- 4. **Modular Game Design**: Install only game development capabilities you need
3666
-
3667
- ### Using This Game Development Expansion Pack
3668
-
3669
- 1. **Install via CLI**:
3670
-
3671
- ```bash
3672
- npx bmad-method install
3673
- # Select "Install game development expansion pack" option
3674
- ```
3675
-
3676
- 2. **Use in Your Game Workflow**: Installed game agents integrate seamlessly with existing BMad agents
3677
-
3678
- ### Creating Custom Game Development Extensions
3679
-
3680
- Use the **expansion-creator** pack to build your own game development extensions:
3681
-
3682
- 1. **Define Game Domain**: What game development expertise are you capturing?
3683
- 2. **Design Game Agents**: Create specialized game roles with clear Unity boundaries
3684
- 3. **Build Game Resources**: Tasks, templates, checklists for your game domain
3685
- 4. **Test & Share**: Validate with real Unity use cases, share with game development community
3686
-
3687
- **Key Principle**: Game development expansion packs democratize game development expertise by making specialized Unity and game design knowledge accessible through AI agents.
3688
-
3689
- ## Getting Help with Game Development
3690
-
3691
- - **Commands**: Use `*/*help` in any environment to see available game development commands
3692
- - **Game Agent Switching**: Use `*/*switch game-agent-name` with orchestrator for role changes
3693
- - **Game Documentation**: Check `docs/` folder for Unity project-specific context
3694
- - **Game Community**: Discord and GitHub resources available for game development support
3695
- - **Game Contributing**: See `CONTRIBUTING.md` for full game development guidelines
3696
-
3697
- This knowledge base provides the foundation for effective game development using the BMad-Method framework with specialized focus on 2D game creation using Unity and C#.
3698
- ==================== END: .bmad-2d-unity-game-dev/data/bmad-kb.md ====================