251 lines
6.1 KiB
Markdown
Raw Normal View History

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 Quick Start Guide
Get started building games with the BMad Game Development Module.
---
## Prerequisites
Before starting with BMGD, ensure you have:
1. **BMAD-METHOD installed** - Follow the main installation guide
2. **A game idea** - Even a rough concept is enough to start
3. **Your preferred AI tool** - Claude Code, Cursor, or web-based chat
---
## Installation
BMGD is a custom module that extends BMM. Install it using the BMAD installer:
```bash
# During installation, select BMGD when prompted for custom modules
npx bmad-cli install
```
Or add to an existing installation:
```bash
npx bmad-cli install --add-module bmgd
```
---
## Understanding the Phases
BMGD follows four game development phases:
![BMGD Workflow Overview](./workflow-overview.jpg)
### Phase 1: Preproduction
**What happens:** Capture your game vision and core concept.
**Workflows:**
- `brainstorm-game` - Guided ideation with game-specific techniques
- `create-game-brief` - Document vision, market, pillars, and fundamentals
**Output:** Game Brief document
### Phase 2: Design
**What happens:** Detail your game's mechanics, systems, and (optionally) narrative.
**Workflows:**
- `create-gdd` - Create comprehensive Game Design Document
- `narrative` - Create Narrative Design Document (for story-driven games)
**Output:** GDD (and Narrative Design document if applicable)
### Phase 3: Technical
**What happens:** Plan how you'll build the game.
**Workflows:**
- `create-architecture` - Define engine, systems, patterns, and structure
**Output:** Game Architecture document
### Phase 4: Production
**What happens:** Build your game in sprints.
**Workflows:**
- `sprint-planning` - Plan and track sprints
- `sprint-status` - View progress and get recommendations
- `create-story` - Create implementable stories
- `dev-story` - Implement stories
- `code-review` - Quality assurance
- `retrospective` - Learn and improve after epics
**Output:** Working game code
---
## Your First Game Project
### Step 1: Start with Brainstorming (Optional)
If you have a vague idea and want help developing it:
```
You: brainstorm-game
Agent: [Guides you through game-specific ideation techniques]
```
### Step 2: Create Your Game Brief
Capture your game's core vision:
```
You: create-game-brief
Agent: [Walks you through game concept, pillars, market, and fundamentals]
```
**Output:** `{output_folder}/game-brief.md`
### Step 3: Create Your GDD
Detail your game's design:
```
You: create-gdd
Agent: [Guides you through mechanics, systems, and game-type-specific sections]
```
**Output:** `{output_folder}/gdd.md` (or sharded into `{output_folder}/gdd/`)
### Step 4: Add Narrative Design (If Story-Driven)
For games with significant story:
```
You: narrative
Agent: [Facilitates story, characters, world, and dialogue design]
```
**Output:** `{output_folder}/narrative-design.md`
### Step 5: Create Architecture
Plan your technical implementation:
```
You: create-architecture
Agent: [Guides engine selection, system design, and technical decisions]
```
**Output:** `{output_folder}/game-architecture.md`
### Step 6: Start Building
Begin sprint-based development:
```
You: sprint-planning
Agent: [Sets up sprint tracking and epic management]
```
---
## Choosing Your Agent
BMGD provides six specialized agents:
| Agent | Icon | When to Use |
| --------------------- | ---- | ----------------------------------------- |
| **Game Designer** | 🎲 | Brainstorming, Game Brief, GDD, Narrative |
| **Game Architect** | 🏛️ | Architecture, technical decisions |
| **Game Developer** | 🕹️ | Implementation, code reviews |
| **Game Scrum Master** | 🎯 | Sprint planning, story management |
| **Game QA** | 🧪 | Test framework, test design, automation |
| **Game Solo Dev** | 🎮 | Quick prototyping, indie development |
### Typical Flow
1. **Game Designer** (Phases 1-2): Brainstorm → Brief → GDD → Narrative
2. **Game Architect** (Phase 3): Architecture
3. **Game Scrum Master** (Phase 4): Sprint planning, story creation
4. **Game Developer** (Phase 4): Implementation, code reviews
---
## Quick Command Reference
### Phase 1: Preproduction
- `brainstorm-game` - Ideation session
- `create-game-brief` - Create Game Brief
### Phase 2: Design
- `create-gdd` - Create GDD
- `narrative` - Create Narrative Design
### Phase 3: Technical
- `create-architecture` - Create Architecture
### Phase 4: Production
- `sprint-planning` - Plan sprints
- `sprint-status` - View progress and recommendations
- `create-story` - Create story
- `dev-story` - Implement story
- `code-review` - Review code
- `retrospective` - Team retrospective
- `correct-course` - Handle sprint changes
### Quick-Flow (Fast-Track)
- `quick-prototype` - Rapid prototyping (IDE only)
- `quick-dev` - Flexible development (IDE only)
### Utility
- `workflow-status` - Check project status
- `party-mode` - Multi-agent collaboration
- `advanced-elicitation` - Deep exploration
---
## Tips for Success
### 1. Start Small
Begin with a simple game concept. You can always expand later.
### 2. Use Game Type Templates
When creating your GDD, BMGD offers 24 game type templates that provide genre-specific sections.
### 3. Iterate
Documents are living artifacts. Return to update them as your vision evolves.
### 4. Trust the Process
Each workflow builds on previous outputs. The Game Brief informs the GDD, which informs the Architecture, which informs implementation.
### 5. Collaborate with Agents
Use `party-mode` to get perspectives from multiple agents when facing complex decisions.
---
## Next Steps
- **[Agents Guide](./agents-guide.md)** - Learn about each agent's capabilities
- **[Workflows Guide](./workflows-guide.md)** - Detailed workflow reference
- **[Quick-Flow Guide](./quick-flow-guide.md)** - Rapid prototyping and development
- **[Game Types Guide](./game-types-guide.md)** - Understand game type templates
- **[Glossary](./glossary.md)** - Game development terminology
---
**Ready to start?** Chat with the **Game Designer** agent and say `brainstorm-game` or `create-game-brief`!