bmad-game-dev-studio 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +97 -23
- package/package.json +1 -1
- package/src/module-help.csv +25 -25
package/README.md
CHANGED
|
@@ -1,41 +1,115 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BMad Game Dev Studio
|
|
2
2
|
|
|
3
|
-
](https://www.npmjs.com/package/bmad-game-dev-studio)
|
|
4
|
+
[](LICENSE)
|
|
5
|
+
[](https://discord.gg/gk8jAdXWmj)
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
**BMGD brings BMad's structured development to game development.** Create working prototypes quickly in Unity, Unreal, Godot—or any engine you choose.
|
|
6
8
|
|
|
7
|
-
|
|
9
|
+
|
|
8
10
|
|
|
9
|
-
##
|
|
11
|
+
## About BMGD
|
|
10
12
|
|
|
11
|
-
|
|
13
|
+
BMad Game Dev Studio (BMGD) adapts the BMad Method framework for game development. Developed by game industry veterans, BMGD guides you through product research, technical design, narrative design, and a full epic-driven production cycle.
|
|
12
14
|
|
|
13
|
-
|
|
14
|
-
* [Unreal](https://www.unrealengine.com/)
|
|
15
|
-
* [Godot](https://godotengine.org/)
|
|
15
|
+
## Supported Engines
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
BMGD has first-class support for:
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
- [Unity](https://unity.com) — C# scripting, industry-standard for many game types
|
|
20
|
+
- [Unreal Engine](https://www.unrealengine.com/) — Blueprint and C++, AAA powerhouse
|
|
21
|
+
- [Godot](https://godotengine.org/) — Open-source, GDScript, rapidly growing
|
|
20
22
|
|
|
21
|
-
|
|
23
|
+
But you're not limited to these—BMGD works with any platform, from pure C to custom engines.
|
|
22
24
|
|
|
23
|
-
|
|
25
|
+
## What You Can Create
|
|
24
26
|
|
|
25
|
-
|
|
27
|
+
BMGD supports **21 game types**, including:
|
|
26
28
|
|
|
27
|
-
|
|
29
|
+
| Genre | Examples |
|
|
30
|
+
|-------|----------|
|
|
31
|
+
| Action | Platformers, shooters, hack-and-slash |
|
|
32
|
+
| RPG | Action RPG, tactical RPG, dungeon crawlers |
|
|
33
|
+
| Strategy | Turn-based, RTS, tower defense |
|
|
34
|
+
| Simulation | Life sim, tycoon, management |
|
|
35
|
+
| Adventure | Visual novels, point-and-click, walking simulators |
|
|
36
|
+
| And more... | Survival, horror, puzzle, racing, etc. |
|
|
28
37
|
|
|
29
|
-
## What
|
|
38
|
+
## What BMGD Does
|
|
30
39
|
|
|
31
|
-
|
|
40
|
+
- **Product Research** — Market analysis, competitor research, positioning
|
|
41
|
+
- **Game Design Document** — Comprehensive GDD with mechanics, progression, and balance
|
|
42
|
+
- **Narrative Design** — Story structure, characters, dialogue, world-building
|
|
43
|
+
- **Technical Architecture** — Engine patterns, performance considerations
|
|
44
|
+
- **Production Planning** — Epic-driven sprints, story tracking, retrospectives
|
|
45
|
+
- **Quick Prototyping** — Skip the planning, jump straight into building
|
|
32
46
|
|
|
33
|
-
|
|
34
|
-
* Read this tutorial TODO! on using Quick-Dev to create a prototype quickly
|
|
35
|
-
* Consult the tomes of documentation TODO! on all the functionality GDS has to offer.
|
|
47
|
+
## What BMGD Doesn't Do
|
|
36
48
|
|
|
37
|
-
|
|
49
|
+
BMGD works *with* coding agents like Claude Code, Cursor, or GitHub Copilot—but it can't create everything:
|
|
38
50
|
|
|
39
|
-
|
|
51
|
+
- Art assets (models, textures, sprites)
|
|
52
|
+
- Animations
|
|
53
|
+
- Music and sound effects
|
|
54
|
+
- Full game implementation from scratch
|
|
40
55
|
|
|
41
|
-
|
|
56
|
+
Think of BMGD as your senior game dev colleague—not a replacement for your entire team.
|
|
57
|
+
|
|
58
|
+
## Installation
|
|
59
|
+
|
|
60
|
+
BMGD is installed as a module during BMad Method setup:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
npx bmad-method@alpha install
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Select **Game Dev Studio** from the modules list.
|
|
67
|
+
|
|
68
|
+
## Quick Start
|
|
69
|
+
|
|
70
|
+
After installing, run from your project root:
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
/bmgd-help # Get guided help for game development
|
|
74
|
+
/bmgd-quick-dev # Jump straight into prototyping
|
|
75
|
+
/bmgd-gdd # Create a Game Design Document
|
|
76
|
+
/bmgd-narrative # Design your game's story
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Two Ways to Work
|
|
80
|
+
|
|
81
|
+
| Approach | When to Use | Workflow |
|
|
82
|
+
|----------|-------------|----------|
|
|
83
|
+
| **Quick Flow** | Rapid prototyping, small projects | `/bmgd-quick-dev` |
|
|
84
|
+
| **Full Production** | Full games, teams, long-term | `/bmgd-help` for guided path |
|
|
85
|
+
|
|
86
|
+
## Example: Starting a New Game
|
|
87
|
+
|
|
88
|
+
```
|
|
89
|
+
You: /bmgd-help
|
|
90
|
+
BMGD: What kind of game are you making?
|
|
91
|
+
You: A tactical sci-fi RPG
|
|
92
|
+
BMGD: Great choice! Here's what I recommend...
|
|
93
|
+
[Guides you through genre-specific planning]
|
|
94
|
+
[Helps select appropriate workflows]
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Documentation
|
|
98
|
+
|
|
99
|
+
- [BMad Method Docs](http://docs.bmad-method.org)
|
|
100
|
+
- [BMGD Guide](http://docs.bmad-method.org/bmgd/)
|
|
101
|
+
|
|
102
|
+
## Community
|
|
103
|
+
|
|
104
|
+
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help from other game devs
|
|
105
|
+
- [GitHub Issues](https://github.com/bmad-code-org/bmad-module-game-dev-studio/issues) — Report bugs
|
|
106
|
+
|
|
107
|
+
## License
|
|
108
|
+
|
|
109
|
+
MIT License — see [LICENSE](LICENSE) for details.
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
**BMad Game Dev Studio** — Part of the [BMad Method](https://github.com/bmad-code-org/BMAD-METHOD) ecosystem.
|
|
114
|
+
|
|
115
|
+
*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.
|
|
4
|
+
"version": "0.1.1",
|
|
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",
|
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,
|
|
3
|
-
gds,anytime,Quick Prototype,QP,30,_bmad/gds/workflows/gds-quick-flow/quick-prototype/workflow.yaml,
|
|
4
|
-
gds,anytime,Quick Spec,TS,35,_bmad/gds/workflows/gds-quick-flow/quick-spec/workflow.yaml,
|
|
5
|
-
gds,anytime,Quick Dev,QD,40,_bmad/gds/workflows/gds-quick-flow/quick-dev/workflow.yaml,
|
|
6
|
-
gds,anytime,Correct Course,CC,50,_bmad/gds/workflows/4-production/correct-course/workflow.yaml,
|
|
7
|
-
gds,1-preproduction,Brainstorm Game,BG,10,_bmad/gds/workflows/1-preproduction/brainstorm-game/workflow.yaml,
|
|
8
|
-
gds,1-preproduction,Game Brief,GB,20,_bmad/gds/workflows/1-preproduction/game-brief/workflow.yaml,
|
|
9
|
-
gds,2-design,Game Design Document,GDD,10,_bmad/gds/workflows/2-design/gdd/workflow.yaml,
|
|
10
|
-
gds,2-design,Narrative Design,ND,20,_bmad/gds/workflows/2-design/narrative/workflow.yaml,
|
|
11
|
-
gds,3-technical,Project Context,PC,10,_bmad/gds/workflows/3-technical/generate-project-context/workflow.md,
|
|
12
|
-
gds,3-technical,Game Architecture,GA,20,_bmad/gds/workflows/3-technical/game-architecture/workflow.yaml,
|
|
13
|
-
gds,3-technical,Test Framework,TF,30,_bmad/gds/workflows/gametest/test-framework/workflow.yaml,
|
|
14
|
-
gds,3-technical,Test Design,TD,35,_bmad/gds/workflows/gametest/test-design/workflow.yaml,
|
|
15
|
-
gds,4-production,Sprint Planning,SP,10,_bmad/gds/workflows/4-production/sprint-planning/workflow.yaml,
|
|
16
|
-
gds,4-production,Sprint Status,SS,20,_bmad/gds/workflows/4-production/sprint-status/workflow.yaml,
|
|
17
|
-
gds,4-production,Create Story,CS,30,_bmad/gds/workflows/4-production/create-story/workflow.yaml,
|
|
18
|
-
gds,4-production,Validate Story,VS,35,_bmad/gds/workflows/4-production/create-story/workflow.yaml,
|
|
19
|
-
gds,4-production,Dev Story,DS,40,_bmad/gds/workflows/4-production/dev-story/workflow.yaml,
|
|
20
|
-
gds,4-production,Code Review,CR,50,_bmad/gds/workflows/4-production/code-review/workflow.yaml,
|
|
21
|
-
gds,4-production,Retrospective,ER,60,_bmad/gds/workflows/4-production/retrospective/workflow.yaml,
|
|
22
|
-
gds,gametest,Test Automate,TA,10,_bmad/gds/workflows/gametest/automate/workflow.yaml,
|
|
23
|
-
gds,gametest,E2E Scaffold,ES,20,_bmad/gds/workflows/gametest/e2e-scaffold/workflow.yaml,
|
|
24
|
-
gds,gametest,Playtest Plan,PP,30,_bmad/gds/workflows/gametest/playtest-plan/workflow.yaml,
|
|
25
|
-
gds,gametest,Performance Test,PT,40,_bmad/gds/workflows/gametest/performance/workflow.yaml,
|
|
26
|
-
gds,gametest,Test Review,TR,50,_bmad/gds/workflows/gametest/test-review/workflow.yaml,
|
|
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",,,
|