bmad-game-dev-studio 0.1.1 → 0.1.3

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 (5) hide show
  1. package/README.md +4 -0
  2. package/package.json +4 -4
  3. package/src/_module-installer/installer.js +1 -1
  4. package/src/agents/tech-writer/tech-writer.agent.yaml +2 -2
  5. package/src/module-help.csv +25 -25
package/README.md CHANGED
@@ -112,4 +112,8 @@ MIT License — see [LICENSE](LICENSE) for details.
112
112
 
113
113
  **BMad Game Dev Studio** — Part of the [BMad Method](https://github.com/bmad-code-org/BMAD-METHOD) ecosystem.
114
114
 
115
+ [![Contributors](https://contrib.rocks/image?repo=bmad-code-org/bmad-module-game-dev-studio)](https://github.com/bmad-code-org/bmad-module-game-dev-studio/graphs/contributors)
116
+
117
+ See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor information.
118
+
115
119
  *If you can dream it, you can build it.*
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package.json",
3
3
  "name": "bmad-game-dev-studio",
4
- "version": "0.1.1",
4
+ "version": "0.1.3",
5
5
  "description": "A BMad MEthod Core Module that offers a substantial stand alone module for Game Development across multiple supported platforms",
6
6
  "keywords": [
7
7
  "bmad",
@@ -21,7 +21,7 @@
21
21
  "lint": "eslint . --ext .js,.cjs,.mjs,.yaml --max-warnings=0",
22
22
  "lint:fix": "eslint . --ext .js,.cjs,.mjs,.yaml --fix",
23
23
  "lint:md": "markdownlint-cli2 \"**/*.md\"",
24
- "prepare": "husky",
24
+ "prepare": "husky || exit 0",
25
25
  "release": "npm run release:patch",
26
26
  "release:major": "npm version major && git push --follow-tags",
27
27
  "release:minor": "npm version minor && git push --follow-tags",
@@ -79,9 +79,9 @@
79
79
  "sharp": "^0.33.5",
80
80
  "wrap-ansi": "^7.0.0",
81
81
  "xml2js": "^0.6.2",
82
+ "yaml": "^2.7.0",
82
83
  "yaml-eslint-parser": "^1.2.3",
83
- "yaml-lint": "^1.7.0",
84
- "yaml": "^2.7.0"
84
+ "yaml-lint": "^1.7.0"
85
85
  },
86
86
  "engines": {
87
87
  "node": ">=22.0.0"
package/src/_module-installer/installer.js CHANGED
@@ -26,7 +26,7 @@ function isWithinProjectRoot(resolvedPath, projectRoot) {
26
26
  * @returns {Promise<boolean>} - Success status
27
27
  */
28
28
  async function install(options) {
29
- const { projectRoot, config, installedIDEs, logger } = options;
29
+ const { projectRoot, config, logger } = options;
30
30
 
31
31
  try {
32
32
  logger.log(chalk.blue('🎮 Installing BMGD Module...'));
package/src/agents/tech-writer/tech-writer.agent.yaml CHANGED
@@ -28,9 +28,9 @@ agent:
28
28
  action: "Engage in multi-turn conversation until you fully understand the ask, use subprocess if available for any web search, research or document review required to extract and return only relevant info to parent context. Author final document following all `_bmad/_memory/tech-writer-sidecar/documentation-standards.md`. After draft, use a subprocess to review and revise for quality of content and ensure standards are still met."
29
29
  description: "[WD] Write Document: Describe in detail what you want, and the agent will follow the documentation best practices defined in agent memory."
30
30
 
31
- - trigger: WD or fuzzy match on write-document
31
+ - trigger: US or fuzzy match on update-standards
32
32
  action: "Update `_bmad/_memory/tech-writer-sidecar/documentation-standards.md` adding user preferences to User Specified CRITICAL Rules section. Remove any contradictory rules as needed. Share with user the updates made."
33
- description: "[US]: Update Standards: Agent Memory records your specific preferences if you discover missing document conventions."
33
+ description: "[US] Update Standards: Agent Memory records your specific preferences if you discover missing document conventions."
34
34
 
35
35
  - trigger: MG or fuzzy match on mermaid-gen
36
36
  action: "Create a Mermaid diagram based on user description multi-turn user conversation until the complete details are understood to produce the requested artifact. If not specified, suggest diagram types based on ask. Strictly follow Mermaid syntax and CommonMark fenced code block standards."
package/src/module-help.csv CHANGED
@@ -1,26 +1,26 @@
1
1
  module,phase,name,code,sequence,workflow-file,command,required,agent,options,description,output-location,outputs,
2
- gds,anytime,Document Project,DP,20,_bmad/gds/workflows/document-project/workflow.yaml,bmad_gds_document-project,false,tech-writer,Create Mode,"Analyze an existing game project to produce useful documentation",project_knowledge,"project documentation",
3
- gds,anytime,Quick Prototype,QP,30,_bmad/gds/workflows/gds-quick-flow/quick-prototype/workflow.yaml,bmad_gds_quick-prototype,false,game-solo-dev,Create Mode,"Rapid game prototyping - test mechanics and ideas quickly",,,
4
- gds,anytime,Quick Spec,TS,35,_bmad/gds/workflows/gds-quick-flow/quick-spec/workflow.yaml,bmad_gds_quick-spec,false,game-solo-dev,Create Mode,"Quick one-off tasks small changes simple apps utilities without extensive planning",planning_artifacts,"tech spec",
5
- gds,anytime,Quick Dev,QD,40,_bmad/gds/workflows/gds-quick-flow/quick-dev/workflow.yaml,bmad_gds_quick-dev,false,game-solo-dev,Create Mode,"Flexible game development - implement features with game-specific considerations",,,
6
- gds,anytime,Correct Course,CC,50,_bmad/gds/workflows/4-production/correct-course/workflow.yaml,bmad_gds_correct-course,false,game-scrum-master,Create Mode,"Navigate significant changes during game dev sprint when implementation is off-track",planning_artifacts,"change proposal",
7
- gds,1-preproduction,Brainstorm Game,BG,10,_bmad/gds/workflows/1-preproduction/brainstorm-game/workflow.yaml,bmad_gds_brainstorm-game,false,game-designer,Create Mode,"Facilitate game brainstorming sessions with game-specific context and techniques",output_folder,"brainstorming session",
8
- gds,1-preproduction,Game Brief,GB,20,_bmad/gds/workflows/1-preproduction/game-brief/workflow.yaml,bmad_gds_game-brief,false,game-designer,Create Mode,"Interactive game brief creation workflow that guides users through defining their game vision",output_folder,"game brief",
9
- gds,2-design,Game Design Document,GDD,10,_bmad/gds/workflows/2-design/gdd/workflow.yaml,bmad_gds_gdd,false,game-designer,Create Mode,"Create a Game Design Document with mechanics, systems, progression, and implementation guidance",planning_artifacts,"gdd",
10
- gds,2-design,Narrative Design,ND,20,_bmad/gds/workflows/2-design/narrative/workflow.yaml,bmad_gds_narrative,false,game-designer,Create Mode,"Create comprehensive narrative documentation including story structure, character arcs, and world-building",planning_artifacts,"narrative design",
11
- gds,3-technical,Project Context,PC,10,_bmad/gds/workflows/3-technical/generate-project-context/workflow.md,bmad_gds_project-context,false,game-architect,Create Mode,"Create optimized project-context.md for AI agent consistency",,,
12
- gds,3-technical,Game Architecture,GA,20,_bmad/gds/workflows/3-technical/game-architecture/workflow.yaml,bmad_gds_game-architecture,true,game-architect,Create Mode,"Produce a scale adaptive game architecture with engine, systems, networking, and technical design",planning_artifacts,"game architecture",
13
- gds,3-technical,Test Framework,TF,30,_bmad/gds/workflows/gametest/test-framework/workflow.yaml,bmad_gds_test-framework,false,game-qa,Create Mode,"Initialize game test framework architecture for Unity, Unreal Engine, or Godot projects",,,
14
- gds,3-technical,Test Design,TD,35,_bmad/gds/workflows/gametest/test-design/workflow.yaml,bmad_gds_test-design,false,game-qa,Create Mode,"Create comprehensive game test scenarios covering gameplay, progression, and quality requirements",planning_artifacts,"test design",
15
- gds,4-production,Sprint Planning,SP,10,_bmad/gds/workflows/4-production/sprint-planning/workflow.yaml,bmad_gds_sprint-planning,true,game-scrum-master,Create Mode,"Generate or update sprint-status.yaml from epic files",implementation_artifacts,"sprint status",
16
- gds,4-production,Sprint Status,SS,20,_bmad/gds/workflows/4-production/sprint-status/workflow.yaml,bmad_gds_sprint-status,false,game-scrum-master,Create Mode,"View sprint progress, surface risks, and get next action recommendation",,,
17
- gds,4-production,Create Story,CS,30,_bmad/gds/workflows/4-production/create-story/workflow.yaml,bmad_gds_create-story,true,game-scrum-master,Create Mode,"Create Story with direct ready-for-dev marking",implementation_artifacts,"story",
18
- gds,4-production,Validate Story,VS,35,_bmad/gds/workflows/4-production/create-story/workflow.yaml,bmad_gds_validate-story,false,game-scrum-master,Validate Mode,"Validate Story Draft with Independent Review",implementation_artifacts,"story validation report",
19
- gds,4-production,Dev Story,DS,40,_bmad/gds/workflows/4-production/dev-story/workflow.yaml,bmad_gds_dev-story,true,game-dev,Create Mode,"Execute Dev Story workflow implementing tasks and tests",,,
20
- gds,4-production,Code Review,CR,50,_bmad/gds/workflows/4-production/code-review/workflow.yaml,bmad_gds_code-review,false,game-dev,Create Mode,"Perform a thorough clean context QA code review on a story flagged Ready for Review",,,
21
- gds,4-production,Retrospective,ER,60,_bmad/gds/workflows/4-production/retrospective/workflow.yaml,bmad_gds_retrospective,false,game-scrum-master,Create Mode,"Facilitate team retrospective after a game development epic is completed",implementation_artifacts,"retrospective",
22
- gds,gametest,Test Automate,TA,10,_bmad/gds/workflows/gametest/automate/workflow.yaml,bmad_gds_test-automate,false,game-qa,Create Mode,"Generate automated game tests",,,
23
- gds,gametest,E2E Scaffold,ES,20,_bmad/gds/workflows/gametest/e2e-scaffold/workflow.yaml,bmad_gds_e2e-scaffold,false,game-qa,Create Mode,"Scaffold E2E testing infrastructure",,,
24
- gds,gametest,Playtest Plan,PP,30,_bmad/gds/workflows/gametest/playtest-plan/workflow.yaml,bmad_gds_playtest-plan,false,game-qa,Create Mode,"Create structured playtesting plan",planning_artifacts,"playtest plan",
25
- gds,gametest,Performance Test,PT,40,_bmad/gds/workflows/gametest/performance/workflow.yaml,bmad_gds_performance-test,false,game-qa,Create Mode,"Design performance testing strategy",planning_artifacts,"performance strategy",
26
- gds,gametest,Test Review,TR,50,_bmad/gds/workflows/gametest/test-review/workflow.yaml,bmad_gds_test-review,false,game-qa,Create Mode,"Review test quality and coverage",,,
2
+ gds,anytime,Document Project,DP,20,_bmad/gds/workflows/document-project/workflow.yaml,bmad-gds-document-project,false,tech-writer,Create Mode,"Analyze an existing game project to produce useful documentation",project_knowledge,"project documentation",
3
+ gds,anytime,Quick Prototype,QP,30,_bmad/gds/workflows/gds-quick-flow/quick-prototype/workflow.yaml,bmad-gds-quick-prototype,false,game-solo-dev,Create Mode,"Rapid game prototyping - test mechanics and ideas quickly",,,
4
+ gds,anytime,Quick Spec,TS,35,_bmad/gds/workflows/gds-quick-flow/quick-spec/workflow.yaml,bmad-gds-quick-spec,false,game-solo-dev,Create Mode,"Quick one-off tasks small changes simple apps utilities without extensive planning",planning_artifacts,"tech spec",
5
+ gds,anytime,Quick Dev,QD,40,_bmad/gds/workflows/gds-quick-flow/quick-dev/workflow.yaml,bmad-gds-quick-dev,false,game-solo-dev,Create Mode,"Flexible game development - implement features with game-specific considerations",,,
6
+ gds,anytime,Correct Course,CC,50,_bmad/gds/workflows/4-production/correct-course/workflow.yaml,bmad-gds-correct-course,false,game-scrum-master,Create Mode,"Navigate significant changes during game dev sprint when implementation is off-track",planning_artifacts,"change proposal",
7
+ gds,1-preproduction,Brainstorm Game,BG,10,_bmad/gds/workflows/1-preproduction/brainstorm-game/workflow.yaml,bmad-gds-brainstorm-game,false,game-designer,Create Mode,"Facilitate game brainstorming sessions with game-specific context and techniques",output_folder,"brainstorming session",
8
+ gds,1-preproduction,Game Brief,GB,20,_bmad/gds/workflows/1-preproduction/game-brief/workflow.yaml,bmad-gds-game-brief,false,game-designer,Create Mode,"Interactive game brief creation workflow that guides users through defining their game vision",output_folder,"game brief",
9
+ gds,2-design,Game Design Document,GDD,10,_bmad/gds/workflows/2-design/gdd/workflow.yaml,bmad-gds-gdd,false,game-designer,Create Mode,"Create a Game Design Document with mechanics, systems, progression, and implementation guidance",planning_artifacts,"gdd",
10
+ gds,2-design,Narrative Design,ND,20,_bmad/gds/workflows/2-design/narrative/workflow.yaml,bmad-gds-narrative,false,game-designer,Create Mode,"Create comprehensive narrative documentation including story structure, character arcs, and world-building",planning_artifacts,"narrative design",
11
+ gds,3-technical,Project Context,PC,10,_bmad/gds/workflows/3-technical/generate-project-context/workflow.md,bmad-gds-project-context,false,game-architect,Create Mode,"Create optimized project-context.md for AI agent consistency",,,
12
+ gds,3-technical,Game Architecture,GA,20,_bmad/gds/workflows/3-technical/game-architecture/workflow.yaml,bmad-gds-game-architecture,true,game-architect,Create Mode,"Produce a scale adaptive game architecture with engine, systems, networking, and technical design",planning_artifacts,"game architecture",
13
+ gds,3-technical,Test Framework,TF,30,_bmad/gds/workflows/gametest/test-framework/workflow.yaml,bmad-gds-test-framework,false,game-qa,Create Mode,"Initialize game test framework architecture for Unity, Unreal Engine, or Godot projects",,,
14
+ gds,3-technical,Test Design,TD,35,_bmad/gds/workflows/gametest/test-design/workflow.yaml,bmad-gds-test-design,false,game-qa,Create Mode,"Create comprehensive game test scenarios covering gameplay, progression, and quality requirements",planning_artifacts,"test design",
15
+ gds,4-production,Sprint Planning,SP,10,_bmad/gds/workflows/4-production/sprint-planning/workflow.yaml,bmad-gds-sprint-planning,true,game-scrum-master,Create Mode,"Generate or update sprint-status.yaml from epic files",implementation_artifacts,"sprint status",
16
+ gds,4-production,Sprint Status,SS,20,_bmad/gds/workflows/4-production/sprint-status/workflow.yaml,bmad-gds-sprint-status,false,game-scrum-master,Create Mode,"View sprint progress, surface risks, and get next action recommendation",,,
17
+ gds,4-production,Create Story,CS,30,_bmad/gds/workflows/4-production/create-story/workflow.yaml,bmad-gds-create-story,true,game-scrum-master,Create Mode,"Create Story with direct ready-for-dev marking",implementation_artifacts,"story",
18
+ gds,4-production,Validate Story,VS,35,_bmad/gds/workflows/4-production/create-story/workflow.yaml,bmad-gds-validate-story,false,game-scrum-master,Validate Mode,"Validate Story Draft with Independent Review",implementation_artifacts,"story validation report",
19
+ gds,4-production,Dev Story,DS,40,_bmad/gds/workflows/4-production/dev-story/workflow.yaml,bmad-gds-dev-story,true,game-dev,Create Mode,"Execute Dev Story workflow implementing tasks and tests",,,
20
+ gds,4-production,Code Review,CR,50,_bmad/gds/workflows/4-production/code-review/workflow.yaml,bmad-gds-code-review,false,game-dev,Create Mode,"Perform a thorough clean context QA code review on a story flagged Ready for Review",,,
21
+ gds,4-production,Retrospective,ER,60,_bmad/gds/workflows/4-production/retrospective/workflow.yaml,bmad-gds-retrospective,false,game-scrum-master,Create Mode,"Facilitate team retrospective after a game development epic is completed",implementation_artifacts,"retrospective",
22
+ gds,gametest,Test Automate,TA,10,_bmad/gds/workflows/gametest/automate/workflow.yaml,bmad-gds-test-automate,false,game-qa,Create Mode,"Generate automated game tests",,,
23
+ gds,gametest,E2E Scaffold,ES,20,_bmad/gds/workflows/gametest/e2e-scaffold/workflow.yaml,bmad-gds-e2e-scaffold,false,game-qa,Create Mode,"Scaffold E2E testing infrastructure",,,
24
+ gds,gametest,Playtest Plan,PP,30,_bmad/gds/workflows/gametest/playtest-plan/workflow.yaml,bmad-gds-playtest-plan,false,game-qa,Create Mode,"Create structured playtesting plan",planning_artifacts,"playtest plan",
25
+ gds,gametest,Performance Test,PT,40,_bmad/gds/workflows/gametest/performance/workflow.yaml,bmad-gds-performance-test,false,game-qa,Create Mode,"Design performance testing strategy",planning_artifacts,"performance strategy",
26
+ gds,gametest,Test Review,TR,50,_bmad/gds/workflows/gametest/test-review/workflow.yaml,bmad-gds-test-review,false,game-qa,Create Mode,"Review test quality and coverage",,,