feat(bmgd): comprehensive BMGD module upgrade (#1151)
* feat(bmgd): comprehensive BMGD module upgrade
## New Agents
- **Game QA (GLaDOS)**: Game QA Architect + Test Automation Specialist
- Engine-specific testing (Unity, Unreal, Godot)
- Knowledge base with 15+ testing topics
- Workflows: test-framework, test-design, automate, playtest-plan, performance-test, test-review
- **Game Solo Dev (Indie)**: Elite Indie Game Developer + Quick Flow Specialist
- Rapid prototyping and iteration focused
- Quick-flow workflows for solo/small team development
## Production Workflow Alignment
Aligned BMGD 4-production workflows with BMM 4-implementation:
### Removed Obsolete Workflows
- story-done (merged into dev-story)
- story-ready (merged into create-story)
- story-context (merged into create-story)
- epic-tech-context (no longer separate workflow)
### Added Workflows
- sprint-status: View sprint progress, surface risks, recommend next action
### Updated Workflows (now standalone, copied from BMM)
- code-review: Adversarial review with instructions.xml
- correct-course: Sprint change management
- create-story: Direct ready-for-dev marking
- dev-story: TDD implementation with instructions.xml
- retrospective: Epic completion review
- sprint-planning: Sprint status generation
## Game Testing Architecture (gametest/)
New knowledge base for game-specific testing:
- qa-index.csv: Knowledge fragment index
- 15 knowledge files covering:
- Engine-specific: Unity, Unreal, Godot testing
- Game-specific: Playtesting, balance, save systems, multiplayer
- Platform: Certification (TRC/XR), localization, input
- General QA: Automation, performance, regression, smoke tests
## Quick-Flow Workflows (bmgd-quick-flow/)
- quick-prototype: Rapid mechanic testing
- quick-dev: Flexible feature implementation
## Documentation
Complete documentation suite in docs/:
- README.md: Documentation index
- quick-start.md: Getting started guide
- agents-guide.md: All 6 agents reference
- workflows-guide.md: Complete workflow reference
- quick-flow-guide.md: Rapid development guide
- game-types-guide.md: 24 game type templates
- glossary.md: Game dev terminology
- troubleshooting.md: Common issues
## Teams & Installer
- Updated team-gamedev.yaml with all 6 agents and workflows
- Updated default-party.csv with Game QA and Game Solo Dev
- Created _module-installer/ with:
- installer.js: Creates directories, logs engine selection
- platform-specifics/: Claude Code and Windsurf handlers
## Agent Updates
All agents now reference standalone BMGD workflows:
- game-architect: correct-course → BMGD
- game-dev: dev-story, code-review → BMGD
- game-scrum-master: All production workflows → BMGD
- game-solo-dev: code-review → BMGD
## Module Configuration
- Added sprint_artifacts alias for workflow compatibility
- All workflows use bmgd/config.yaml
* fix(bmgd): update sprint-status workflow to reference bmgd instead of bmm
Replace all /bmad:bmm:workflows references with /bmad:bmgd:workflows
in the sprint-status workflow instructions.
* feat(bmgd): add workflow-status and create-tech-spec workflows
Add BMGD-native workflow-status and create-tech-spec workflows,
replacing all BMM references with BMGD paths.
## New Workflows
### workflow-status
- Multi-mode status checker for game projects
- Game-specific project levels (Game Jam → AAA)
- Workflow paths: gamedev-greenfield, gamedev-brownfield,
quickflow-greenfield, quickflow-brownfield
- Init workflow for new game project setup
### create-tech-spec
- Game-focused spec engineering workflow
- Engine-aware (Unity/Unreal/Godot)
- Performance and gameplay feel considerations
## Agent Updates
Updated all BMGD agents to reference BMGD workflows:
- game-architect, game-designer, game-dev, game-qa,
game-scrum-master, game-solo-dev
All agents now use /bmad:bmgd:workflows instead of /bmad:bmm:workflows
* fix(bmgd): address PR review findings and enhance playtesting docs
## PR Review Fixes (F1-F20)
### Configuration & Naming
- F1: Changed user_skill_level to game_dev_experience in module.yaml
- F3: Renamed gametest/framework to gametest/test-framework
### Cleanup
- F2: Deleted 4 orphaned root-level template files
- F6: Removed duplicate code block in create-story/instructions.xml
- F9: Removed trailing empty line from qa-index.csv
- F20: Deleted orphaned docs/unnamed.jpg
### Installer Improvements
- F7: Simplified platform handler stubs (removed unused code)
- F8: Added return value checking for platform handlers
- F13: Added path traversal validation (isWithinProjectRoot)
- F18: Added type validation for config string values
### Agent Fixes
- F10: Added workflow-status and advanced-elicitation to game-solo-dev
- F12: Fixed "GOTO step 2a" → "GOTO step 2" references
- F14: Removed duplicate project-context.md from principles in 5 agents
### Workflow Updates
- F17: Added input_file_patterns to playtest-plan workflow
### Documentation
- F4-F5: Updated quick-start.md with 6 agents and fixed table
- Updated workflows-guide.md with test-framework reference
### Knowledge Base Updates (from earlier CodeRabbit comments)
- Updated unity-testing.md to Test Framework 1.6.0
- Fixed unreal-testing.md (MarkAsGarbage, UnrealEditor.exe)
- Added FVerifyPlayerMoved note to smoke-testing.md
- Fixed certification-testing.md table formatting
### Playtesting Documentation Enhancement
- Added "Playtesting by Game Type" section (7 genres)
- Added "Processing Feedback Effectively" section
- Expanded from ~138 to ~340 lines
* refactor(bmgd): use exec for step-file workflows and multi format
Update agent menu items to use correct notation for step-file workflows:
**game-designer.agent.yaml:**
- Convert 4 step-file workflows to multi format with shortcodes:
- [BG] brainstorm-game
- [GB] create-game-brief
- [GDD] create-gdd
- [ND] narrative
- Changed from workflow: .yaml to exec: .md
**game-architect.agent.yaml:**
- Changed create-architecture from workflow: to exec: with workflow.md
---------
Co-authored-by: Scott Jennings <scott.jennings+CIGINT@cloudimperiumgames.com>
2025-12-17 00:33:22 -06:00
|
|
|
# BMGD Documentation
|
|
|
|
|
|
|
|
|
|
Complete guides for the BMad Game Development Module (BMGD) - AI-powered workflows for game design and development that adapt to your project's needs.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
|
|
|
|
**New to BMGD?** Start here:
|
|
|
|
|
|
|
|
|
|
- **[Quick Start Guide](./quick-start.md)** - Get started building your first game
|
|
|
|
|
- Installation and setup
|
|
|
|
|
- Understanding the game development phases
|
|
|
|
|
- Running your first workflows
|
|
|
|
|
- Agent-based development flow
|
|
|
|
|
|
|
|
|
|
**Quick Path:** Install BMGD module → Game Brief → GDD → Architecture → Build
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Core Concepts
|
|
|
|
|
|
|
|
|
|
Understanding how BMGD works:
|
|
|
|
|
|
|
|
|
|
- **[Agents Guide](./agents-guide.md)** - Complete reference for game development agents
|
|
|
|
|
- Game Designer, Game Developer, Game Architect, Game Scrum Master, Game QA, Game Solo Dev
|
|
|
|
|
- Agent roles and when to use them
|
|
|
|
|
- Agent workflows and menus
|
|
|
|
|
|
|
|
|
|
- **[Workflows Guide](./workflows-guide.md)** - Complete workflow reference
|
|
|
|
|
- Phase 1: Preproduction (Brainstorm, Game Brief)
|
|
|
|
|
- Phase 2: Design (GDD, Narrative)
|
|
|
|
|
- Phase 3: Technical (Architecture)
|
|
|
|
|
- Phase 4: Production (Sprint-based development)
|
|
|
|
|
|
|
|
|
|
- **[Game Types Guide](./game-types-guide.md)** - Selecting and using game type templates
|
|
|
|
|
- 24 supported game types
|
|
|
|
|
- Genre-specific GDD sections
|
|
|
|
|
- Hybrid game type handling
|
|
|
|
|
|
|
|
|
|
- **[Quick-Flow Guide](./quick-flow-guide.md)** - Fast-track workflows for rapid development
|
|
|
|
|
- Quick-Prototype for testing ideas
|
|
|
|
|
- Quick-Dev for flexible implementation
|
|
|
|
|
- When to use quick-flow vs full BMGD
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Quick References
|
|
|
|
|
|
|
|
|
|
Essential reference materials:
|
|
|
|
|
|
|
|
|
|
- **[Glossary](./glossary.md)** - Key game development terminology
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Choose Your Path
|
|
|
|
|
|
|
|
|
|
### I need to...
|
|
|
|
|
|
|
|
|
|
**Start a new game project**
|
|
|
|
|
→ Start with [Quick Start Guide](./quick-start.md)
|
|
|
|
|
→ Run `brainstorm-game` for ideation
|
|
|
|
|
→ Create a Game Brief with `create-brief`
|
|
|
|
|
|
|
|
|
|
**Design my game**
|
|
|
|
|
→ Create a GDD with `create-gdd`
|
|
|
|
|
→ If story-heavy, add Narrative Design with `create-narrative`
|
|
|
|
|
|
|
|
|
|
**Plan the technical architecture**
|
|
|
|
|
→ Run `create-architecture` with the Game Architect
|
|
|
|
|
|
|
|
|
|
**Build my game**
|
|
|
|
|
→ Use Phase 4 production workflows
|
|
|
|
|
→ Follow the sprint-based development cycle
|
|
|
|
|
|
|
|
|
|
**Quickly test an idea or implement a feature**
|
|
|
|
|
→ Use [Quick-Flow](./quick-flow-guide.md) for rapid prototyping and development
|
|
|
|
|
→ `quick-prototype` to test mechanics, `quick-dev` to implement
|
|
|
|
|
|
|
|
|
|
**Set up testing and QA**
|
|
|
|
|
→ Use Game QA agent for test framework setup
|
|
|
|
|
→ Run `test-framework` to initialize testing for Unity/Unreal/Godot
|
|
|
|
|
→ Use `test-design` to create test scenarios
|
|
|
|
|
→ Plan playtests with `playtest-plan`
|
|
|
|
|
|
|
|
|
|
**Understand game type templates**
|
|
|
|
|
→ See [Game Types Guide](./game-types-guide.md)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Game Development Phases
|
|
|
|
|
|
|
|
|
|
BMGD follows four phases aligned with game development:
|
|
|
|
|
|
|
|
|
|

|
|
|
|
|
|
|
|
|
|
### Phase 1: Preproduction
|
|
|
|
|
|
|
|
|
|
- **Brainstorm Game** - Ideation with game-specific techniques
|
|
|
|
|
- **Game Brief** - Capture vision, market, and fundamentals
|
|
|
|
|
|
|
|
|
|
### Phase 2: Design
|
|
|
|
|
|
|
|
|
|
- **GDD (Game Design Document)** - Comprehensive game design
|
|
|
|
|
- **Narrative Design** - Story, characters, world (for story-driven games)
|
|
|
|
|
|
|
|
|
|
### Phase 3: Technical
|
|
|
|
|
|
|
|
|
|
- **Game Architecture** - Engine, systems, patterns, structure
|
|
|
|
|
|
|
|
|
|
### Phase 4: Production
|
|
|
|
|
|
|
|
|
|
- **Sprint Planning** - Epic and story management
|
|
|
|
|
- **Story Development** - Implementation workflow
|
|
|
|
|
- **Code Review** - Quality assurance
|
|
|
|
|
- **Testing** - Automated tests, playtesting, performance
|
|
|
|
|
- **Retrospective** - Continuous improvement
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## BMGD vs BMM
|
|
|
|
|
|
|
|
|
|
BMGD extends BMM with game-specific capabilities:
|
|
|
|
|
|
|
|
|
|
| Aspect | BMM | BMGD |
|
|
|
|
|
| -------------- | ------------------------------------- | ------------------------------------------------------------------------ |
|
|
|
|
|
| **Focus** | General software | Game development |
|
|
|
|
|
| **Agents** | PM, Architect, Dev, SM, TEA, Solo Dev | Game Designer, Game Dev, Game Architect, Game SM, Game QA, Game Solo Dev |
|
|
|
|
|
| **Planning** | PRD, Tech Spec | Game Brief, GDD |
|
|
|
|
|
| **Types** | N/A | 24 game type templates |
|
|
|
|
|
| **Narrative** | N/A | Full narrative workflow |
|
|
|
|
|
| **Testing** | Web-focused testarch | Engine-specific (Unity, Unreal, Godot) |
|
|
|
|
|
| **Production** | Inherited from BMM | BMM workflows with game overrides |
|
|
|
|
|
|
|
|
|
|
BMGD production workflows inherit from BMM and add game-specific checklists and templates.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Documentation Map
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
BMGD Documentation
|
|
|
|
|
├── README.md (this file)
|
|
|
|
|
├── quick-start.md # Getting started
|
|
|
|
|
├── agents-guide.md # Agent reference
|
|
|
|
|
├── workflows-guide.md # Workflow reference
|
|
|
|
|
├── quick-flow-guide.md # Rapid prototyping and development
|
|
|
|
|
├── game-types-guide.md # Game type templates
|
|
|
|
|
├── glossary.md # Terminology
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## External Resources
|
|
|
|
|
|
|
|
|
|
### Community and Support
|
|
|
|
|
|
|
|
|
|
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community
|
|
|
|
|
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
|
|
|
|
|
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials
|
|
|
|
|
|
|
|
|
|
### Related Documentation
|
|
|
|
|
|
2025-12-23 07:01:36 -08:00
|
|
|
- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation
|
feat(bmgd): comprehensive BMGD module upgrade (#1151)
* feat(bmgd): comprehensive BMGD module upgrade
## New Agents
- **Game QA (GLaDOS)**: Game QA Architect + Test Automation Specialist
- Engine-specific testing (Unity, Unreal, Godot)
- Knowledge base with 15+ testing topics
- Workflows: test-framework, test-design, automate, playtest-plan, performance-test, test-review
- **Game Solo Dev (Indie)**: Elite Indie Game Developer + Quick Flow Specialist
- Rapid prototyping and iteration focused
- Quick-flow workflows for solo/small team development
## Production Workflow Alignment
Aligned BMGD 4-production workflows with BMM 4-implementation:
### Removed Obsolete Workflows
- story-done (merged into dev-story)
- story-ready (merged into create-story)
- story-context (merged into create-story)
- epic-tech-context (no longer separate workflow)
### Added Workflows
- sprint-status: View sprint progress, surface risks, recommend next action
### Updated Workflows (now standalone, copied from BMM)
- code-review: Adversarial review with instructions.xml
- correct-course: Sprint change management
- create-story: Direct ready-for-dev marking
- dev-story: TDD implementation with instructions.xml
- retrospective: Epic completion review
- sprint-planning: Sprint status generation
## Game Testing Architecture (gametest/)
New knowledge base for game-specific testing:
- qa-index.csv: Knowledge fragment index
- 15 knowledge files covering:
- Engine-specific: Unity, Unreal, Godot testing
- Game-specific: Playtesting, balance, save systems, multiplayer
- Platform: Certification (TRC/XR), localization, input
- General QA: Automation, performance, regression, smoke tests
## Quick-Flow Workflows (bmgd-quick-flow/)
- quick-prototype: Rapid mechanic testing
- quick-dev: Flexible feature implementation
## Documentation
Complete documentation suite in docs/:
- README.md: Documentation index
- quick-start.md: Getting started guide
- agents-guide.md: All 6 agents reference
- workflows-guide.md: Complete workflow reference
- quick-flow-guide.md: Rapid development guide
- game-types-guide.md: 24 game type templates
- glossary.md: Game dev terminology
- troubleshooting.md: Common issues
## Teams & Installer
- Updated team-gamedev.yaml with all 6 agents and workflows
- Updated default-party.csv with Game QA and Game Solo Dev
- Created _module-installer/ with:
- installer.js: Creates directories, logs engine selection
- platform-specifics/: Claude Code and Windsurf handlers
## Agent Updates
All agents now reference standalone BMGD workflows:
- game-architect: correct-course → BMGD
- game-dev: dev-story, code-review → BMGD
- game-scrum-master: All production workflows → BMGD
- game-solo-dev: code-review → BMGD
## Module Configuration
- Added sprint_artifacts alias for workflow compatibility
- All workflows use bmgd/config.yaml
* fix(bmgd): update sprint-status workflow to reference bmgd instead of bmm
Replace all /bmad:bmm:workflows references with /bmad:bmgd:workflows
in the sprint-status workflow instructions.
* feat(bmgd): add workflow-status and create-tech-spec workflows
Add BMGD-native workflow-status and create-tech-spec workflows,
replacing all BMM references with BMGD paths.
## New Workflows
### workflow-status
- Multi-mode status checker for game projects
- Game-specific project levels (Game Jam → AAA)
- Workflow paths: gamedev-greenfield, gamedev-brownfield,
quickflow-greenfield, quickflow-brownfield
- Init workflow for new game project setup
### create-tech-spec
- Game-focused spec engineering workflow
- Engine-aware (Unity/Unreal/Godot)
- Performance and gameplay feel considerations
## Agent Updates
Updated all BMGD agents to reference BMGD workflows:
- game-architect, game-designer, game-dev, game-qa,
game-scrum-master, game-solo-dev
All agents now use /bmad:bmgd:workflows instead of /bmad:bmm:workflows
* fix(bmgd): address PR review findings and enhance playtesting docs
## PR Review Fixes (F1-F20)
### Configuration & Naming
- F1: Changed user_skill_level to game_dev_experience in module.yaml
- F3: Renamed gametest/framework to gametest/test-framework
### Cleanup
- F2: Deleted 4 orphaned root-level template files
- F6: Removed duplicate code block in create-story/instructions.xml
- F9: Removed trailing empty line from qa-index.csv
- F20: Deleted orphaned docs/unnamed.jpg
### Installer Improvements
- F7: Simplified platform handler stubs (removed unused code)
- F8: Added return value checking for platform handlers
- F13: Added path traversal validation (isWithinProjectRoot)
- F18: Added type validation for config string values
### Agent Fixes
- F10: Added workflow-status and advanced-elicitation to game-solo-dev
- F12: Fixed "GOTO step 2a" → "GOTO step 2" references
- F14: Removed duplicate project-context.md from principles in 5 agents
### Workflow Updates
- F17: Added input_file_patterns to playtest-plan workflow
### Documentation
- F4-F5: Updated quick-start.md with 6 agents and fixed table
- Updated workflows-guide.md with test-framework reference
### Knowledge Base Updates (from earlier CodeRabbit comments)
- Updated unity-testing.md to Test Framework 1.6.0
- Fixed unreal-testing.md (MarkAsGarbage, UnrealEditor.exe)
- Added FVerifyPlayerMoved note to smoke-testing.md
- Fixed certification-testing.md table formatting
### Playtesting Documentation Enhancement
- Added "Playtesting by Game Type" section (7 genres)
- Added "Processing Feedback Effectively" section
- Expanded from ~138 to ~340 lines
* refactor(bmgd): use exec for step-file workflows and multi format
Update agent menu items to use correct notation for step-file workflows:
**game-designer.agent.yaml:**
- Convert 4 step-file workflows to multi format with shortcodes:
- [BG] brainstorm-game
- [GB] create-game-brief
- [GDD] create-gdd
- [ND] narrative
- Changed from workflow: .yaml to exec: .md
**game-architect.agent.yaml:**
- Changed create-architecture from workflow: to exec: with workflow.md
---------
Co-authored-by: Scott Jennings <scott.jennings+CIGINT@cloudimperiumgames.com>
2025-12-17 00:33:22 -06:00
|
|
|
|
|
|
|
|
## Tips for Using This Documentation
|
|
|
|
|
|
|
|
|
|
1. **Start with Quick Start** if you're new to BMGD
|
|
|
|
|
2. **Check Game Types Guide** when creating your GDD
|
|
|
|
|
3. **Reference Glossary** for game development terminology
|
|
|
|
|
4. **Use Troubleshooting** when you encounter issues
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
**Ready to make games?** → [Start with the Quick Start Guide](./quick-start.md)
|