Merge branch 'main' into main

This commit is contained in:
Brian 2025-12-23 23:09:44 +08:00 committed by GitHub
commit 87286876d8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
266 changed files with 19563 additions and 3883 deletions

72
.github/workflows/docs.yaml vendored Normal file
View File

@ -0,0 +1,72 @@
name: Deploy Documentation
on:
push:
branches:
- main
paths:
- "docs/**"
- "src/modules/*/docs/**"
- "website/**"
- "tools/build-docs.js"
- ".github/workflows/docs.yaml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: "20"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: Determine site URL
id: site-url
run: |
if [ "${{ github.repository }}" = "bmad-code-org/BMAD-METHOD" ]; then
echo "url=https://bmad-code-org.github.io/BMAD-METHOD" >> $GITHUB_OUTPUT
else
OWNER="${{ github.repository_owner }}"
REPO="${{ github.event.repository.name }}"
echo "url=https://${OWNER}.github.io/${REPO}" >> $GITHUB_OUTPUT
fi
- name: Build documentation
env:
SITE_URL: ${{ steps.site-url.outputs.url }}
run: npm run docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: build/site
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

View File

@ -92,6 +92,3 @@ jobs:
- name: Test agent compilation components - name: Test agent compilation components
run: npm run test:install run: npm run test:install
- name: Validate web bundles
run: npm run validate:bundles

6
.gitignore vendored
View File

@ -74,4 +74,8 @@ _bmad
.kiro/ .kiro/
.roo .roo
bmad-custom-src/ bmad-custom-src/
# Docusaurus / Documentation Build
.docusaurus/
build/

View File

@ -236,10 +236,8 @@ Each commit should represent one logical change:
3. **Don't paste code in issues** - create a proper PR instead 3. **Don't paste code in issues** - create a proper PR instead
4. **Don't submit your whole project** - contribute specific improvements 4. **Don't submit your whole project** - contribute specific improvements
## Code Style ## Prompt & Agent Guidelines
- Follow the existing code style and conventions
- Write clear comments for complex logic
- Keep dev agents lean - they need context for coding, not documentation - Keep dev agents lean - they need context for coding, not documentation
- Web/planning agents can be larger with more complex tasks - Web/planning agents can be larger with more complex tasks
- Everything is natural language (markdown) - no code in core framework - Everything is natural language (markdown) - no code in core framework

View File

@ -26,8 +26,8 @@ The completely revamped **BMAD V6 installer** now includes built-in support for
- [**Custom Content Overview**](./docs/custom-content.md) - Discover all supported content types - [**Custom Content Overview**](./docs/custom-content.md) - Discover all supported content types
- [**Installation Guide**](./docs/custom-content-installation.md) - Learn to create and install custom content - [**Installation Guide**](./docs/custom-content-installation.md) - Learn to create and install custom content
- [**Detail Content Docs**](./src/modules/bmb/docs/README.md) - Reference details for agents, modules, workflows and the bmad builder - [**Detail Content Docs**](./src/modules/bmb/docs/index.md) - Reference details for agents, modules, workflows and the bmad builder
- [**2 Very simple Custom Modules of questionable quality**](./docs/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules. - [**2 Very simple Custom Modules of questionable quality**](./samples/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
</div> </div>
@ -142,18 +142,17 @@ Each agent brings deep expertise and can be customized to match your team's styl
- 12 specialized agents - 12 specialized agents
- 34 workflows across 4 phases - 34 workflows across 4 phases
- Scale-adaptive planning - Scale-adaptive planning
- [→ Documentation Hub](./src/modules/bmm/docs/README.md) - [→ Documentation Hub](./src/modules/bmm/docs/index.md)
- **BMad Builder (BMB)** - Create custom agents and workflows - **BMad Builder (BMB)** - Create custom agents and workflows
- Build anything from simple agents to complex modules - Build anything from simple agents to complex modules
- Create domain-specific solutions (legal, medical, finance, education) - Create domain-specific solutions (legal, medical, finance, education)
- [→ Builder Guide](src/modules/bmb/docs/README.md) marketplace - [→ Builder Guide](./src/modules/bmb/docs/index.md)
- [→ Builder Guide](./src/modules/bmb/README.md)
- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving - **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
- Brainstorming, design thinking, storytelling - Brainstorming, design thinking, storytelling
- 5 creative facilitation workflows - 5 creative facilitation workflows
- [→ Creative Workflows](./src/modules/cis/README.md) - [→ Creative Workflows](./src/modules/cis/docs/index.md)
### Key Features ### Key Features
@ -168,7 +167,7 @@ Each agent brings deep expertise and can be customized to match your team's styl
### Quick Links ### Quick Links
- **[Quick Start Guide](./src/modules/bmm/docs/quick-start.md)** - 15-minute introduction - **[Quick Start Guide](./src/modules/bmm/docs/quick-start.md)** - 15-minute introduction
- **[Complete BMM Documentation](./src/modules/bmm/docs/README.md)** - All guides and references - **[Complete BMM Documentation](./src/modules/bmm/docs/index.md)** - All guides and references
- **[Agent Customization](./docs/agent-customization-guide.md)** - Personalize your agents - **[Agent Customization](./docs/agent-customization-guide.md)** - Personalize your agents
- **[All Documentation](./docs/index.md)** - Complete documentation index - **[All Documentation](./docs/index.md)** - Complete documentation index

View File

@ -203,6 +203,6 @@ memories:
## Next Steps ## Next Steps
- **[BMM Agents Guide](../src/modules/bmm/docs/agents-guide.md)** - Learn about the BMad Method agents - **[BMM Agents Guide](./modules/bmm/agents-guide)** - Learn about the BMad Method agents
- **[BMB Create Agent Workflow](../src/modules/bmb/workflows/create-agent/README.md)** - Build completely custom agents - **[BMB Create Agent Workflow](./modules/bmb/agents/index)** - Build completely custom agents
- **[BMM Complete Documentation](../src/modules/bmm/docs/README.md)** - Full BMad Method reference - **[BMM Complete Documentation](./modules/bmm/index)** - Full BMad Method reference

View File

@ -4,7 +4,7 @@ This guide explains how to create and install custom BMAD content including agen
For detailed information about the different types of custom content available, see [Custom Content](./custom-content.md). For detailed information about the different types of custom content available, see [Custom Content](./custom-content.md).
If you download either of the folders within the [Sample Custom Modules](./sample-custom-modules/readme.md) folder You can find example custom modules in the `samples/sample-custom-modules/` folder of the repository. Download either of the sample folders to try them out.
## Content Types Overview ## Content Types Overview

View File

@ -441,8 +441,8 @@ input_file_patterns:
## Related Documentation ## Related Documentation
- [shard-doc Tool](../src/core/tools/shard-doc.xml) - Tool implementation - [shard-doc Tool](../src/core/tools/shard-doc.xml) - Tool implementation
- [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Workflow overview - [BMM Workflows Guide](./modules/bmm/index.md#-workflow-guides) - Workflow overview
- [Workflow Creation Guide](../src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md) - Custom workflow patterns - [Workflow Creation Guide](./modules/bmb/workflows/index) - Custom workflow patterns
--- ---

View File

@ -0,0 +1,76 @@
# Installation
Get BMAD Method running in your project in under 2 minutes.
## Quick Install
```bash
npx bmad-method@alpha install
```
This interactive installer will:
1. Detect your IDE (Claude Code, Cursor, VS Code, etc.)
2. Let you choose which modules to install
3. Configure agents and workflows for your project
## Requirements
- **Node.js** 18+ (for the installer)
- **Git** (recommended for version control)
- An **AI-powered IDE** or access to Claude/ChatGPT/Gemini
## Module Options
During installation, you'll choose which modules to install:
| Module | Description | Best For |
| -------- | ---------------- | ---------------------------------------- |
| **BMM** | BMAD Method Core | Software development projects |
| **BMGD** | Game Development | Game projects with specialized workflows |
| **BMB** | Builder | Creating custom agents and workflows |
## Post-Installation
After installation, your project will have:
```
your-project/
├── _bmad/ # BMAD configuration and agents
│ ├── bmm/ # Method module (if installed)
│ ├── bmgd/ # Game dev module (if installed)
│ └── config.yaml # Your project configuration
├── .claude/ # IDE-specific setup (varies by IDE)
└── ... your code
```
## Next Steps
1. **Read the [Quick Start Guide](../modules/bmm/quick-start.md)** to build your first feature
2. **Check your [IDE Guide](../ide-info/index.md)** for IDE-specific tips
3. **Explore [Workflows](../modules/bmm/workflows-planning.md)** to understand the methodology
## Alternative: Web Bundles
Don't want to install? Use BMAD agents directly in:
- **Claude Projects** - Upload the web bundle
- **ChatGPT** - Use custom GPT bundles
- **Gemini** - Import agent prompts
See the [Web Bundles Guide](../web-bundles-gemini-gpt-guide.md) for details.
## Troubleshooting
### Common Issues
**"Command not found: npx"**
: Install Node.js 18+ from [nodejs.org](https://nodejs.org)
**"Permission denied"**
: Run with appropriate permissions or check your npm configuration
**IDE not detected**
: The installer will prompt you to select your IDE manually
For more help, see [Troubleshooting](../modules/bmm/troubleshooting.md) or join our [Discord](https://discord.gg/bmad).

24
docs/ide-info/index.md Normal file
View File

@ -0,0 +1,24 @@
# IDE Guides
BMAD Method works with any AI-powered development environment. Choose your IDE below for specific setup instructions and tips.
## All Supported IDEs
| IDE | Type | BMAD Support |
| ----------------------------------- | ----------------- | --------------------- |
| [Claude Code](claude-code.md) | CLI/Terminal | Native slash commands |
| [Cursor](cursor.md) | Desktop Editor | Full agent support |
| [VS Code / Windsurf](windsurf.md) | Desktop Editor | Extension-based |
| [Cline](cline.md) | VS Code Extension | Full support |
| [GitHub Copilot](github-copilot.md) | Extension | Workspace agents |
| [Augment](auggie.md) | Extension | Agent loading |
| [Codex](codex.md) | CLI | Prompt injection |
| [Gemini](gemini.md) | Web/API | Web bundles |
| [Roo](roo.md) | VS Code Extension | Mode support |
| [Kilo](kilo.md) | Extension | Basic support |
| [OpenCode](opencode.md) | Open Source | Full support |
| [Qwen](qwen.md) | Web/API | Web bundles |
| [Trae](trae.md) | Extension | Basic support |
| [Crush](crush.md) | Desktop | Agent support |
| [iFlow](iflow.md) | Extension | Prompt loading |
| [Rovo Dev](rovo-dev.md) | Atlassian | Integration |

View File

@ -1,388 +1,22 @@
# Rovo Dev IDE Integration # BMAD Method - Rovo Dev Instructions
This document describes how BMAD-METHOD integrates with [Atlassian Rovo Dev](https://www.atlassian.com/rovo-dev), an AI-powered software development assistant. ## Activating Agents
## Overview BMAD agents are installed as subagents in `.rovodev/subagents/`.
Rovo Dev is designed to integrate deeply with developer workflows and organizational knowledge bases. When you install BMAD-METHOD in a Rovo Dev project, it automatically installs BMAD agents, workflows, tasks, and tools just like it does for other IDEs (Cursor, VS Code, etc.). ### How to Use
BMAD-METHOD provides: 1. **Open Project**: Subagents auto-load when project opens
2. **Invoke Agent**: Type `@` and select agent (e.g., `@bmad-bmm-dev`, `@bmad-bmm-architect`)
3. **Reference Files**: Check `.rovodev/workflows/` and `.rovodev/references/`
- **Agents**: Specialized subagents for various development tasks ### Directory Structure
- **Workflows**: Multi-step workflow guides and coordinators
- **Tasks & Tools**: Reference documentation for BMAD tasks and tools
### What are Rovo Dev Subagents? - `.rovodev/subagents/` - BMAD agents
- `.rovodev/workflows/` - Workflow guides
- `.rovodev/references/` - Tasks and tools
Subagents are specialized agents that Rovo Dev can delegate tasks to. They are defined as Markdown files with YAML frontmatter stored in the `.rovodev/subagents/` directory. Rovo Dev automatically discovers these files and makes them available through the `@subagent-name` syntax. ### Notes
## Installation and Setup - Agents are automatically discovered by Rovo Dev
- Subagents use YAML frontmatter for configuration
### Automatic Installation
When you run the BMAD-METHOD installer and select Rovo Dev as your IDE:
```bash
bmad install
```
The installer will:
1. Create a `.rovodev/subagents/` directory in your project (if it doesn't exist)
2. Convert BMAD agents into Rovo Dev subagent format
3. Write subagent files with the naming pattern: `bmad-<module>-<agent-name>.md`
### File Structure
After installation, your project will have:
```
project-root/
├── .rovodev/
│ ├── subagents/
│ │ ├── bmad-core-code-reviewer.md
│ │ ├── bmad-bmm-pm.md
│ │ ├── bmad-bmm-dev.md
│ │ └── ... (more agents from selected modules)
│ ├── workflows/
│ │ ├── bmad-brainstorming.md
│ │ ├── bmad-prd-creation.md
│ │ └── ... (workflow guides)
│ ├── references/
│ │ ├── bmad-task-core-code-review.md
│ │ ├── bmad-tool-core-analysis.md
│ │ └── ... (task/tool references)
│ ├── config.yml (Rovo Dev configuration)
│ ├── prompts.yml (Optional: reusable prompts)
│ └── ...
├── _bmad/ (BMAD installation directory)
└── ...
```
**Directory Structure Explanation:**
- **subagents/**: Agents discovered and used by Rovo Dev with `@agent-name` syntax
- **workflows/**: Multi-step workflow guides and instructions
- **references/**: Documentation for available tasks and tools in BMAD
## Subagent File Format
BMAD agents are converted to Rovo Dev subagent format, which uses Markdown with YAML frontmatter:
### Basic Structure
```markdown
---
name: bmad-module-agent-name
description: One sentence description of what this agent does
tools:
- bash
- open_files
- grep
- expand_code_chunks
model: anthropic.claude-3-5-sonnet-20241022-v2:0 # Optional
load_memory: true # Optional
---
You are a specialized agent for [specific task].
## Your Role
Describe the agent's role and responsibilities...
## Key Instructions
1. First instruction
2. Second instruction
3. Third instruction
## When to Use This Agent
Explain when and how to use this agent...
```
### YAML Frontmatter Fields
| Field | Type | Required | Description |
| ------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string | Yes | Unique identifier for the subagent (kebab-case, no spaces) |
| `description` | string | Yes | One-line description of the subagent's purpose |
| `tools` | array | No | List of tools the subagent can use. If not specified, uses parent agent's tools |
| `model` | string | No | Specific LLM model for this subagent (e.g., `anthropic.claude-3-5-sonnet-20241022-v2:0`). If not specified, uses parent agent's model |
| `load_memory` | boolean | No | Whether to load default memory files (AGENTS.md, AGENTS.local.md). Defaults to `true` |
### System Prompt
The content after the closing `---` is the subagent's system prompt. This defines:
- The agent's persona and role
- Its capabilities and constraints
- Step-by-step instructions for task execution
- Examples of expected behavior
## Using BMAD Components in Rovo Dev
### Invoking a Subagent (Agent)
In Rovo Dev, you can invoke a BMAD agent as a subagent using the `@` syntax:
```
@bmad-core-code-reviewer Please review this PR for potential issues
@bmad-bmm-pm Help plan this feature release
@bmad-bmm-dev Implement this feature
```
### Accessing Workflows
Workflow guides are available in `.rovodev/workflows/` directory:
```
@bmad-core-code-reviewer Use the brainstorming workflow from .rovodev/workflows/bmad-brainstorming.md
```
Workflow files contain step-by-step instructions and can be referenced or copied into Rovo Dev for collaborative workflow execution.
### Accessing Tasks and Tools
Task and tool documentation is available in `.rovodev/references/` directory. These provide:
- Task execution instructions
- Tool capabilities and usage
- Integration examples
- Parameter documentation
### Example Usage Scenarios
#### Code Review
```
@bmad-core-code-reviewer Review the changes in src/components/Button.tsx
for best practices, performance, and potential bugs
```
#### Documentation
```
@bmad-core-documentation-writer Generate API documentation for the new
user authentication module
```
#### Feature Design
```
@bmad-module-feature-designer Design a solution for implementing
dark mode support across the application
```
## Customizing BMAD Subagents
You can customize BMAD subagents after installation by editing their files directly in `.rovodev/subagents/`.
### Example: Adding Tool Restrictions
By default, BMAD subagents inherit tools from the parent Rovo Dev agent. You can restrict which tools a specific subagent can use:
```yaml
---
name: bmad-core-code-reviewer
description: Reviews code and suggests improvements
tools:
- open_files
- expand_code_chunks
- grep
---
```
### Example: Using a Specific Model
Some agents might benefit from using a different model. You can specify this:
```yaml
---
name: bmad-core-documentation-writer
description: Writes clear and comprehensive documentation
model: anthropic.claude-3-5-sonnet-20241022-v2:0
---
```
### Example: Enhancing the System Prompt
You can add additional context to a subagent's system prompt:
```markdown
---
name: bmad-core-code-reviewer
description: Reviews code and suggests improvements
---
You are a specialized code review agent for our project.
## Project Context
Our codebase uses:
- React 18 for frontend
- Node.js 18+ for backend
- TypeScript for type safety
- Jest for testing
## Review Checklist
1. Type safety and TypeScript correctness
2. React best practices and hooks usage
3. Performance considerations
4. Test coverage
5. Documentation and comments
...rest of original system prompt...
```
## Memory and Context
By default, BMAD subagents have `load_memory: true`, which means they will load memory files from your project:
- **Project-level**: `.rovodev/AGENTS.md` and `.rovodev/.agent.md`
- **User-level**: `~/.rovodev/AGENTS.md` (global memory across all projects)
These files can contain:
- Project guidelines and conventions
- Common patterns and best practices
- Recent decisions and context
- Custom instructions for all agents
### Creating Project Memory
Create `.rovodev/AGENTS.md` in your project:
```markdown
# Project Guidelines
## Code Style
- Use 2-space indentation
- Use camelCase for variables
- Use PascalCase for classes
## Architecture
- Follow modular component structure
- Use dependency injection for services
- Implement proper error handling
## Testing Requirements
- Minimum 80% code coverage
- Write tests before implementation
- Use descriptive test names
```
## Troubleshooting
### Subagents Not Appearing in Rovo Dev
1. **Verify files exist**: Check that `.rovodev/subagents/bmad-*.md` files are present
2. **Check Rovo Dev is reloaded**: Rovo Dev may cache agent definitions. Restart Rovo Dev or reload the project
3. **Verify file format**: Ensure files have proper YAML frontmatter (between `---` markers)
4. **Check file permissions**: Ensure files are readable by Rovo Dev
### Agent Name Conflicts
If you have custom subagents with the same names as BMAD agents, Rovo Dev will load both but may show a warning. Use unique prefixes for custom subagents to avoid conflicts.
### Tools Not Available
If a subagent's tools aren't working:
1. Verify the tool names match Rovo Dev's available tools
2. Check that the parent Rovo Dev agent has access to those tools
3. Ensure tool permissions are properly configured in `.rovodev/config.yml`
## Advanced: Tool Configuration
Rovo Dev agents have access to a set of tools for various tasks. Common tools available include:
- `bash`: Execute shell commands
- `open_files`: View file contents
- `grep`: Search across files
- `expand_code_chunks`: View specific code sections
- `find_and_replace_code`: Modify files
- `create_file`: Create new files
- `delete_file`: Delete files
- `move_file`: Rename or move files
### MCP Servers
Rovo Dev can also connect to Model Context Protocol (MCP) servers, which provide additional tools and data sources:
- **Atlassian Integration**: Access to Jira, Confluence, and Bitbucket
- **Code Analysis**: Custom code analysis and metrics
- **External Services**: APIs and third-party integrations
Configure MCP servers in `~/.rovodev/mcp.json` or `.rovodev/mcp.json`.
## Integration with Other IDE Handlers
BMAD-METHOD supports multiple IDEs simultaneously. You can have both Rovo Dev and other IDE configurations (Cursor, VS Code, etc.) in the same project. Each IDE will have its own artifacts installed in separate directories.
For example:
- Rovo Dev agents: `.rovodev/subagents/bmad-*.md`
- Cursor rules: `.cursor/rules/bmad/`
- Claude Code: `.claude/rules/bmad/`
## Performance Considerations
- BMAD subagent files are typically small (1-5 KB each)
- Rovo Dev lazy-loads subagents, so having many subagents doesn't impact startup time
- System prompts are cached by Rovo Dev after first load
## Best Practices
1. **Keep System Prompts Concise**: Shorter, well-structured prompts are more effective
2. **Use Project Memory**: Leverage `.rovodev/AGENTS.md` for shared context
3. **Customize Tool Restrictions**: Give subagents only the tools they need
4. **Test Subagent Invocations**: Verify each subagent works as expected for your project
5. **Version Control**: Commit `.rovodev/subagents/` to version control for team consistency
6. **Document Custom Subagents**: Add comments explaining the purpose of customized subagents
## Related Documentation
- [Rovo Dev Official Documentation](https://www.atlassian.com/rovo-dev)
- [BMAD-METHOD Installation Guide](./installation.md)
- [IDE Handler Architecture](./ide-handlers.md)
- [Rovo Dev Configuration Reference](https://www.atlassian.com/rovo-dev/configuration)
## Examples
### Example 1: Code Review Workflow
```
User: @bmad-core-code-reviewer Review src/auth/login.ts for security issues
Rovo Dev → Subagent: Opens file, analyzes code, suggests improvements
Subagent output: Security vulnerabilities found, recommendations provided
```
### Example 2: Documentation Generation
```
User: @bmad-core-documentation-writer Generate API docs for the new payment module
Rovo Dev → Subagent: Analyzes code structure, generates documentation
Subagent output: Markdown documentation with examples and API reference
```
### Example 3: Architecture Design
```
User: @bmad-module-feature-designer Design a caching strategy for the database layer
Rovo Dev → Subagent: Reviews current architecture, proposes design
Subagent output: Detailed architecture proposal with implementation plan
```
## Support
For issues or questions about:
- **Rovo Dev**: See [Atlassian Rovo Dev Documentation](https://www.atlassian.com/rovo-dev)
- **BMAD-METHOD**: See [BMAD-METHOD README](../README.md)
- **IDE Integration**: See [IDE Handler Guide](./ide-handlers.md)

View File

@ -8,11 +8,11 @@ Complete map of all BMad Method v6 documentation with recommended reading paths.
**New users:** Start with one of these based on your situation: **New users:** Start with one of these based on your situation:
| Your Situation | Start Here | Then Read | | Your Situation | Start Here | Then Read |
| ---------------------- | --------------------------------------------------------------- | ------------------------------------------------------------- | | ---------------------- | -------------------------------------------------- | ----------------------------------------------------------- |
| **Brand new to BMad** | [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) | [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) | | **Brand new to BMad** | [Quick Start Guide](./modules/bmm/quick-start) | [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) |
| **Upgrading from v4** | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) | [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) | | **Upgrading from v4** | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) | [Quick Start Guide](./modules/bmm/quick-start) |
| **Brownfield project** | [Brownfield Guide](../src/modules/bmm/docs/brownfield-guide.md) | [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) | | **Brownfield project** | [Brownfield Guide](./modules/bmm/brownfield-guide) | [Quick Start Guide](./modules/bmm/quick-start) |
--- ---
@ -20,16 +20,14 @@ Complete map of all BMad Method v6 documentation with recommended reading paths.
### Project-Level Docs (Root) ### Project-Level Docs (Root)
- **[README.md](../README.md)** - Main project overview, feature summary, and module introductions - **[README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md)** - Main project overview, feature summary, and module introductions
- **[CONTRIBUTING.md](../CONTRIBUTING.md)** - How to contribute, pull request guidelines, code style - **[CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)** - How to contribute, pull request guidelines, code style
- **[CHANGELOG.md](../CHANGELOG.md)** - Version history and breaking changes - **[CHANGELOG.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)** - Version history and breaking changes
- **[CLAUDE.md](../CLAUDE.md)** - Claude Code specific guidelines for this project
### Installation & Setup ### Installation & Setup
- **[v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)** - Migration path for v4 users - **[v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)** - Migration path for v4 users
- **[Document Sharding Guide](./document-sharding-guide.md)** - Split large documents for 90%+ token savings - **[Document Sharding Guide](./document-sharding-guide.md)** - Split large documents for 90%+ token savings
- **[Web Bundles](./USING_WEB_BUNDLES.md)** - Use BMAD agents in Claude Projects, ChatGPT, or Gemini without installation
- **[Bundle Distribution Setup](./BUNDLE_DISTRIBUTION_SETUP.md)** - Maintainer guide for bundle auto-publishing - **[Bundle Distribution Setup](./BUNDLE_DISTRIBUTION_SETUP.md)** - Maintainer guide for bundle auto-publishing
--- ---
@ -40,27 +38,27 @@ Complete map of all BMad Method v6 documentation with recommended reading paths.
The flagship module for agile AI-driven development. The flagship module for agile AI-driven development.
- **[BMM Module README](../src/modules/bmm/README.md)** - Module overview, agents, and complete documentation index - **[BMM Module README](./modules/bmm/)** - Module overview, agents, and complete documentation index
- **[BMM Documentation](../src/modules/bmm/docs/)** - All BMM-specific guides and references: - **[BMM Documentation](./modules/bmm/)** - All BMM-specific guides and references:
- [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Step-by-step guide to building your first project - [Quick Start Guide](./modules/bmm/quick-start) - Step-by-step guide to building your first project
- [Quick Spec Flow](../src/modules/bmm/docs/quick-spec-flow.md) - Rapid Level 0-1 development - [Quick Spec Flow](./modules/bmm/quick-spec-flow) - Rapid Level 0-1 development
- [Scale Adaptive System](../src/modules/bmm/docs/scale-adaptive-system.md) - Understanding the 5-level system - [Scale Adaptive System](./modules/bmm/scale-adaptive-system) - Understanding the 5-level system
- [Brownfield Guide](../src/modules/bmm/docs/brownfield-guide.md) - Working with existing codebases - [Brownfield Guide](./modules/bmm/brownfield-guide) - Working with existing codebases
- **[BMM Workflows Guide](../src/modules/bmm/workflows/README.md)** - **ESSENTIAL READING** - **[BMM Workflows Guide](./modules/bmm/index#-workflow-guides)** - **ESSENTIAL READING**
- **[Test Architect Guide](../src/modules/bmm/testarch/README.md)** - Testing strategy and quality assurance - **[Test Architect Guide](./modules/bmm/test-architecture)** - Testing strategy and quality assurance
### BMad Builder (BMB) - Create Custom Solutions ### BMad Builder (BMB) - Create Custom Solutions
Build your own agents, workflows, and modules. Build your own agents, workflows, and modules.
- **[BMB Module README](../src/modules/bmb/docs/README.md)** - Module overview and capabilities - **[BMB Module Overview](./modules/bmb/index)** - Module overview and capabilities
- **[Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md)** - Design custom agents - **[Agent Creation Guide](./modules/bmb/agents/index)** - Design custom agents
### Creative Intelligence Suite (CIS) - Innovation & Creativity ### Creative Intelligence Suite (CIS) - Innovation & Creativity
AI-powered creative thinking and brainstorming. AI-powered creative thinking and brainstorming.
- **[CIS Module README](../src/modules/cis/README.md)** - Module overview and workflows - **[CIS Module README](./modules/cis/)** - Module overview and workflows
--- ---
@ -101,52 +99,45 @@ Instructions for loading agents and running workflows in your development enviro
- **[Custom Content Installation](./custom-content-installation.md)** - Install and personalize agents, workflows and modules with the default bmad-method installer! - **[Custom Content Installation](./custom-content-installation.md)** - Install and personalize agents, workflows and modules with the default bmad-method installer!
- [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses - [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses
### Installation & Bundling
- [IDE Injections Reference](./installers-bundlers/ide-injections.md) - How agents are installed to IDEs
- [Installers & Platforms Reference](./installers-bundlers/installers-modules-platforms-reference.md) - CLI tool and platform support
- [Web Bundler Usage](./installers-bundlers/web-bundler-usage.md) - Creating web-compatible bundles
--- ---
## 🎓 Recommended Reading Paths ## 🎓 Recommended Reading Paths
### Path 1: Brand New to BMad (Software Project) ### Path 1: Brand New to BMad (Software Project)
1. [README.md](../README.md) - Understand the vision 1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
2. [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Get hands-on 2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
3. [BMM Module README](../src/modules/bmm/README.md) - Understand agents 3. [BMM Module README](./modules/bmm/) - Understand agents
4. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Master the methodology 4. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology
5. [Your IDE guide](./ide-info/) - Optimize your workflow 5. [Your IDE guide](./ide-info/) - Optimize your workflow
### Path 2: Game Development Project ### Path 2: Game Development Project
1. [README.md](../README.md) - Understand the vision 1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
2. [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Get hands-on 2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
3. [BMM Module README](../src/modules/bmm/README.md) - Game agents are included 3. [BMM Module README](./modules/bmm/) - Game agents are included
4. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Game workflows 4. [BMGD Workflows Guide](./modules/bmgd/workflows-guide) - Game-specific workflows
5. [Your IDE guide](./ide-info/) - Optimize your workflow 5. [Your IDE guide](./ide-info/) - Optimize your workflow
### Path 3: Upgrading from v4 ### Path 3: Upgrading from v4
1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed 1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed
2. [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Reorient yourself 2. [Quick Start Guide](./modules/bmm/quick-start) - Reorient yourself
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Learn new v6 workflows 3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Learn new v6 workflows
### Path 4: Working with Existing Codebase (Brownfield) ### Path 4: Working with Existing Codebase (Brownfield)
1. [Brownfield Guide](../src/modules/bmm/docs/brownfield-guide.md) - Approach for legacy code 1. [Brownfield Guide](./modules/bmm/brownfield-guide) - Approach for legacy code
2. [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Follow the process 2. [Quick Start Guide](./modules/bmm/quick-start) - Follow the process
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Master the methodology 3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology
### Path 5: Building Custom Solutions ### Path 5: Building Custom Solutions
1. [BMB Module README](../src/modules/bmb/docs/README.md) - Understand capabilities 1. [BMB Module Overview](./modules/bmb/index) - Understand capabilities
2. [Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md) - Create agents 2. [Agent Creation Guide](./modules/bmb/agents/index) - Create agents
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Understand workflow structure 3. [BMB Workflows Guide](./modules/bmb/workflows/) - Understand workflow structure
### Path 6: Contributing to BMad ### Path 6: Contributing to BMad
1. [CONTRIBUTING.md](../CONTRIBUTING.md) - Contribution guidelines 1. [CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md) - Contribution guidelines
2. Relevant module README - Understand the area you're contributing to 2. Relevant module README - Understand the area you're contributing to
3. [Code Style section in CONTRIBUTING.md](../CONTRIBUTING.md#code-style) - Follow standards

View File

@ -1,186 +0,0 @@
# IDE Content Injection Standard
## Overview
This document defines the standard for IDE-specific content injection in BMAD modules. Each IDE can inject its own specific content into BMAD templates during installation without polluting the source files with IDE-specific code. The installation process is interactive, allowing users to choose what IDE-specific features they want to install.
## Architecture
### 1. Injection Points
Files that support IDE-specific content define injection points using HTML comments:
```xml
<!-- IDE-INJECT-POINT: unique-point-name -->
```
### 2. Module Structure
Each module that needs IDE-specific content creates a sub-module folder:
```
src/modules/{module-name}/sub-modules/{ide-name}/
├── injections.yaml # Injection configuration
├── sub-agents/ # IDE-specific subagents (if applicable)
└── config.yaml # Other IDE-specific config
```
### 3. Injection Configuration Format
The `injections.yaml` file defines what content to inject where:
```yaml
# injections.yaml structure
injections:
- file: 'relative/path/to/file.md' # Path relative to installation root
point: 'injection-point-name' # Must match IDE-INJECT-POINT name
requires: 'subagent-name' # Which subagent must be selected (or "any")
content: | # Content to inject (preserves formatting)
<llm>
<i>Instructions specific to this IDE</i>
</llm>
# Subagents available for installation
subagents:
source: 'sub-agents' # Source folder relative to this config
target: '.claude/agents' # Claude's expected location (don't change)
files:
- 'agent1.md'
- 'agent2.md'
```
### 4. Interactive Installation Process
For Claude Code specifically, the installer will:
1. **Detect available subagents** from the module's `injections.yaml`
2. **Ask the user** about subagent installation:
- Install all subagents (default)
- Select specific subagents
- Skip subagent installation
3. **Ask installation location** (if subagents selected):
- Project level: `.claude/agents/`
- User level: `~/.claude/agents/`
4. **Copy selected subagents** to the chosen location
5. **Inject only relevant content** based on selected subagents
Other IDEs can implement their own installation logic appropriate to their architecture.
## Implementation
### IDE Installer Responsibilities
Each IDE installer (e.g., `claude-code.js`) must:
1. **Check for sub-modules**: Look for `sub-modules/{ide-name}/` in each installed module
2. **Load injection config**: Parse `injections.yaml` if present
3. **Process injections**: Replace injection points with configured content
4. **Copy additional files**: Handle subagents or other IDE-specific files
### Example Implementation (Claude Code)
```javascript
async processModuleInjections(projectDir, bmadDir, options) {
for (const moduleName of options.selectedModules) {
const configPath = path.join(
bmadDir, 'src/modules', moduleName,
'sub-modules/claude-code/injections.yaml'
);
if (exists(configPath)) {
const config = yaml.load(configPath);
// Interactive: Ask user about subagent installation
const choices = await this.promptSubagentInstallation(config.subagents);
if (choices.install !== 'none') {
// Ask where to install
const location = await this.promptInstallLocation();
// Process injections based on selections
for (const injection of config.injections) {
if (this.shouldInject(injection, choices)) {
await this.injectContent(projectDir, injection, choices);
}
}
// Copy selected subagents
await this.copySelectedSubagents(projectDir, config.subagents, choices, location);
}
}
}
}
```
## Benefits
1. **Clean Source Files**: No IDE-specific conditionals in source
2. **Modular**: Each IDE manages its own injections
3. **Scalable**: Easy to add support for new IDEs
4. **Maintainable**: IDE-specific content lives with IDE config
5. **Flexible**: Different modules can inject different content
## Adding Support for a New IDE
1. Create sub-module folder: `src/modules/{module}/sub-modules/{new-ide}/`
2. Add `injections.yaml` with IDE-specific content
3. Update IDE installer to process injections using this standard
4. Test installation with and without the IDE selected
## Example: BMM Module with Claude Code
### File Structure
```
src/modules/bmm/
├── agents/pm.md # Has injection point
├── templates/prd.md # Has multiple injection points
└── sub-modules/
└── claude-code/
├── injections.yaml # Defines what to inject
└── sub-agents/ # Claude Code specific subagents
├── market-researcher.md
├── requirements-analyst.md
└── ...
```
### Injection Point in pm.md
```xml
<agent>
<persona>...</persona>
<!-- IDE-INJECT-POINT: pm-agent-instructions -->
<cmds>...</cmds>
</agent>
```
### Injection Configuration
```yaml
injections:
- file: '_bmad/bmm/agents/pm.md'
point: 'pm-agent-instructions'
requires: 'any' # Injected if ANY subagent is selected
content: |
<llm critical="true">
<i>Use 'market-researcher' subagent for analysis</i>
</llm>
- file: '_bmad/bmm/templates/prd.md'
point: 'prd-goals-context-delegation'
requires: 'market-researcher' # Only if this specific subagent selected
content: |
<i>DELEGATE: Use 'market-researcher' subagent...</i>
```
### Result After Installation
```xml
<agent>
<persona>...</persona>
<llm critical="true">
<i>Use 'market-researcher' subagent for analysis</i>
</llm>
<cmds>...</cmds>
</agent>
```

View File

@ -1,389 +0,0 @@
# BMAD Installation & Module System Reference
## Table of Contents
1. [Overview](#overview)
2. [Quick Start](#quick-start)
3. [Architecture](#architecture)
4. [Modules](#modules)
5. [Configuration System](#configuration-system)
6. [Platform Integration](#platform-integration)
7. [Development Guide](#development-guide)
8. [Troubleshooting](#troubleshooting)
## Overview
BMad Core is a modular AI agent framework with intelligent installation, platform-agnostic support, and configuration inheritance.
### Key Features
- **Modular Design**: Core + optional modules (BMB, BMM, CIS)
- **Smart Installation**: Interactive configuration with dependency resolution
- **Clean Architecture**: Centralized `_bmad` directory add to project, no source pollution with multiple folders added
## Architecture
### Directory Structure upon installation
```
project-root/
├── _bmad/ # Centralized installation
│ ├── _config/ # Configuration
│ │ ├── agents/ # Agent configs
│ │ └── agent-manifest.csv # Agent manifest
│ ├── core/ # Core module
│ │ ├── agents/
│ │ ├── tasks/
│ │ └── config.yaml
│ ├── bmm/ # BMad Method module
│ │ ├── agents/
│ │ ├── tasks/
│ │ ├── workflows/
│ │ └── config.yaml
│ └── cis/ # Creative Innovation Studio
│ └── ...
└── .claude/ # Platform-specific (example)
└── agents/
```
### Installation Flow
1. **Detection**: Check existing installation
2. **Selection**: Choose modules interactively or via CLI
3. **Configuration**: Collect module-specific settings
4. **Installation**: Compile Process and copy files
5. **Generation**: Create config files with inheritance
6. **Post-Install**: Run module installers
7. **Manifest**: Track installed components
### Key Exclusions
- `_module-installer/` directories are never copied to destination
- module.yaml
- `localskip="true"` agents are filtered out
- Source `config.yaml` templates are replaced with generated configs
## Modules
### Core Module (Required)
Foundation framework with C.O.R.E. (Collaboration Optimized Reflection Engine)
- **Components**: Base agents, activation system, advanced elicitation
- **Config**: `user_name`, `communication_language`
### BMM Module
BMad Method for software development workflows
- **Components**: PM agent, dev tasks, PRD templates, story generation
- **Config**: `project_name`, `tech_docs`, `output_folder`, `story_location`
- **Dependencies**: Core
### CIS Module
Creative Innovation Studio for design workflows
- **Components**: Design agents, creative tasks
- **Config**: `output_folder`, design preferences
- **Dependencies**: Core
### Module Structure
```
src/modules/{module}/
├── _module-installer/ # Not copied to destination
│ ├── installer.js # Post-install logic
├── module.yaml
├── agents/
├── tasks/
├── templates/
└── sub-modules/ # Platform-specific content
└── {platform}/
├── injections.yaml
└── sub-agents/
```
## Configuration System
### Collection Process
Modules define prompts in `module.yaml`:
```yaml
project_name:
prompt: 'Project title?'
default: 'My Project'
result: '{value}'
output_folder:
prompt: 'Output location?'
default: 'docs'
result: '{project-root}/{value}'
tools:
prompt: 'Select tools:'
multi-select:
- 'Tool A'
- 'Tool B'
```
### Configuration Inheritance
Core values cascade to ALL modules automatically:
```yaml
# core/config.yaml
user_name: "Jane"
communication_language: "English"
# bmm/config.yaml (generated)
project_name: "My App"
tech_docs: "/path/to/docs"
# Core Configuration Values (inherited)
user_name: "Jane"
communication_language: "English"
```
**Reserved Keys**: Core configuration keys cannot be redefined by other modules.
### Path Placeholders
- `{project-root}`: Project directory path
- `{value}`: User input
- `{module}`: Module name
- `{core:field}`: Reference core config value
### Config Generation Rules
1. ALL installed modules get a `config.yaml` (even without prompts)
2. Core values are ALWAYS included in module configs
3. Module-specific values come first, core values appended
4. Source templates are never copied, only generated configs
## Platform Integration
### Supported Platforms
**Preferred** (Full Integration):
- Claude Code
- Cursor
- Windsurf
**Additional**:
Cline, Roo, Rovo Dev,Auggie, GitHub Copilot, Codex, Gemini, Qwen, Trae, Kilo, Crush, iFlow
### Platform Features
1. **Setup Handler** (`tools/cli/installers/lib/ide/{platform}.js`)
- Directory creation
- Configuration generation
- Agent processing
2. **Content Injection** (`sub-modules/{platform}/injections.yaml`)
```yaml
injections:
- file: '_bmad/bmm/agents/pm.md'
point: 'pm-agent-instructions'
content: |
<i>Platform-specific instruction</i>
subagents:
source: 'sub-agents'
target: '.claude/agents'
files: ['agent.md']
```
3. **Interactive Config**
- Subagent selection
- Installation scope (project/user)
- Feature toggles
### Injection System
Platform-specific content without source modification:
- Inject points marked in source: `<!-- IDE-INJECT-POINT:name -->`
- Content added during installation only
- Source files remain clean
## Development Guide
### Creating a Module
1. **Structure**
```
src/modules/mymod/
├── _module-installer/
│ ├── installer.js
├── module.yaml
├── agents/
└── tasks/
```
2. **Configuration** (`module.yaml`)
```yaml
code: mymod
name: 'My Module'
prompt: 'Welcome message'
setting_name:
prompt: 'Configure X?'
default: 'value'
```
3. **Installer** (`installer.js`)
```javascript
async function install(options) {
const { projectRoot, config, installedIDEs, logger } = options;
// Custom logic
return true;
}
module.exports = { install };
```
### Adding Platform Support
1. Create handler: `tools/cli/installers/lib/ide/myplatform.js`
2. Extend `BaseIdeSetup` class
3. Add sub-module: `src/modules/{mod}/sub-modules/myplatform/`
4. Define injections and platform agents
### Agent Configuration
Extractable config nodes:
```xml
<agent>
<setting agentConfig="true">
Default value
</setting>
</agent>
```
Generated in: `bmad/_config/agents/{module}-{agent}.md`
## Troubleshooting
### Common Issues
| Issue | Solution |
| ----------------------- | ------------------------------------ |
| Existing installation | Use `bmad update` or remove `_bmad/` |
| Module not found | Check `src/modules/` exists |
| Config not applied | Verify `_bmad/{module}/config.yaml` |
| Missing config.yaml | Fixed: All modules now get configs |
| Agent unavailable | Check for `localskip="true"` |
| module-installer copied | Fixed: Now excluded from copy |
### Debug Commands
```bash
bmad install -v # Verbose installation
bmad status -v # Detailed status
```
### Best Practices
1. Run from project root
2. Backup `_bmad/_config/` before updates
3. Use interactive mode for guidance
4. Review generated configs post-install
## Migration from v4
| v4 | v6 |
| ------------------- | -------------------- |
| Scattered files | Centralized `_bmad/` |
| Monolithic | Modular |
| Manual config | Interactive setup |
| Limited IDE support | 15+ platforms |
| Source modification | Clean injection |
## Technical Notes
### Dependency Resolution
- Direct dependencies (module → module)
- Agent references (cross-module)
- Template dependencies
- Partial module installation (only required files)
- Workflow vendoring for standalone module operation
## Workflow Vendoring
**Problem**: Modules that reference workflows from other modules create dependencies, forcing users to install multiple modules even when they only need one.
**Solution**: Workflow vendoring allows modules to copy workflows from other modules during installation, making them fully standalone.
### How It Works
Agents can specify both `workflow` (source location) and `workflow-install` (destination location) in their menu items:
```yaml
menu:
- trigger: create-story
workflow: '{project-root}/_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml'
workflow-install: '{project-root}/_bmad/bmgd/workflows/4-production/create-story/workflow.yaml'
description: 'Create a game feature story'
```
**During Installation:**
1. **Vendoring Phase**: Before copying module files, the installer:
- Scans source agent YAML files for `workflow-install` attributes
- Copies entire workflow folders from `workflow` path to `workflow-install` path
- Updates vendored `workflow.yaml` files to reference target module's config
2. **Compilation Phase**: When compiling agents:
- If `workflow-install` exists, uses its value for the `workflow` attribute
- `workflow-install` is build-time metadata only, never appears in final XML
- Compiled agent references vendored workflow location
3. **Config Update**: Vendored workflows get their `config_source` updated:
```yaml
# Source workflow (in bmm):
config_source: "{project-root}/_bmad/bmm/config.yaml"
# Vendored workflow (in bmgd):
config_source: "{project-root}/_bmad/bmgd/config.yaml"
```
**Result**: Modules become completely standalone with their own copies of needed workflows, configured for their specific use case.
### Example Use Case: BMGD Module
The BMad Game Development module vendors implementation workflows from BMM:
- Game Dev Scrum Master agent references BMM workflows
- During installation, workflows are copied to `bmgd/workflows/4-production/`
- Vendored workflows use BMGD's config (with game-specific settings)
- BMGD can be installed without BMM dependency
### Benefits
**Module Independence** - No forced dependencies
**Clean Namespace** - Workflows live in their module
**Config Isolation** - Each module uses its own configuration
**Customization Ready** - Vendored workflows can be modified independently
**No User Confusion** - Avoid partial module installations
### File Processing
- Filters `localskip="true"` agents
- Excludes `_module-installer/` directories
- Replaces path placeholders at runtime
- Injects activation blocks
- Vendors cross-module workflows (see Workflow Vendoring below)
### Web Bundling
```bash
bmad bundle --web # Filter for web deployment
npm run validate:bundles # Validate bundles
```

View File

@ -18,6 +18,10 @@ export default [
'test/fixtures/**/*.yaml', 'test/fixtures/**/*.yaml',
'_bmad/**', '_bmad/**',
'_bmad*/**', '_bmad*/**',
// Docusaurus build artifacts
'.docusaurus/**',
'build/**',
'website/**',
// Gitignored patterns // Gitignored patterns
'z*/**', // z-samples, z1, z2, etc. 'z*/**', // z-samples, z1, z2, etc.
'.claude/**', '.claude/**',
@ -77,9 +81,9 @@ export default [
}, },
}, },
// CLI/CommonJS scripts under tools/** and test/** // CLI scripts under tools/** and test/**
{ {
files: ['tools/**/*.js', 'test/**/*.js'], files: ['tools/**/*.js', 'tools/**/*.mjs', 'test/**/*.js'],
rules: { rules: {
// Allow CommonJS patterns for Node CLI scripts // Allow CommonJS patterns for Node CLI scripts
'unicorn/prefer-module': 'off', 'unicorn/prefer-module': 'off',
@ -106,6 +110,7 @@ export default [
'no-useless-catch': 'off', 'no-useless-catch': 'off',
'unicorn/prefer-number-properties': 'off', 'unicorn/prefer-number-properties': 'off',
'no-unreachable': 'off', 'no-unreachable': 'off',
'unicorn/text-encoding-identifier-case': 'off',
}, },
}, },

15929
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -25,11 +25,13 @@
}, },
"scripts": { "scripts": {
"bmad:install": "node tools/cli/bmad-cli.js install", "bmad:install": "node tools/cli/bmad-cli.js install",
"bmad:status": "node tools/cli/bmad-cli.js status",
"bundle": "node tools/cli/bundlers/bundle-web.js all", "bundle": "node tools/cli/bundlers/bundle-web.js all",
"docs:build": "node tools/build-docs.js",
"docs:dev": "npm run docs:build && npm run docs:serve",
"docs:serve": "docusaurus start --config website/docusaurus.config.js --host localhost",
"flatten": "node tools/flattener/main.js", "flatten": "node tools/flattener/main.js",
"format:check": "prettier --check \"**/*.{js,cjs,mjs,json,md,yaml}\"", "format:check": "prettier --check \"**/*.{js,cjs,mjs,json,yaml}\"",
"format:fix": "prettier --write \"**/*.{js,cjs,mjs,json,md,yaml}\"", "format:fix": "prettier --write \"**/*.{js,cjs,mjs,json,yaml}\"",
"install:bmad": "node tools/cli/bmad-cli.js install", "install:bmad": "node tools/cli/bmad-cli.js install",
"lint": "eslint . --ext .js,.cjs,.mjs,.yaml --max-warnings=0", "lint": "eslint . --ext .js,.cjs,.mjs,.yaml --max-warnings=0",
"lint:fix": "eslint . --ext .js,.cjs,.mjs,.yaml --fix", "lint:fix": "eslint . --ext .js,.cjs,.mjs,.yaml --fix",
@ -40,11 +42,10 @@
"release:minor": "gh workflow run \"Manual Release\" -f version_bump=minor", "release:minor": "gh workflow run \"Manual Release\" -f version_bump=minor",
"release:patch": "gh workflow run \"Manual Release\" -f version_bump=patch", "release:patch": "gh workflow run \"Manual Release\" -f version_bump=patch",
"release:watch": "gh run watch", "release:watch": "gh run watch",
"test": "npm run test:schemas && npm run test:install && npm run validate:bundles && npm run validate:schemas && npm run lint && npm run lint:md && npm run format:check", "test": "npm run test:schemas && npm run test:install && npm run validate:schemas && npm run lint && npm run lint:md && npm run format:check",
"test:coverage": "c8 --reporter=text --reporter=html npm run test:schemas", "test:coverage": "c8 --reporter=text --reporter=html npm run test:schemas",
"test:install": "node test/test-installation-components.js", "test:install": "node test/test-installation-components.js",
"test:schemas": "node test/test-agent-schema.js", "test:schemas": "node test/test-agent-schema.js",
"validate:bundles": "node tools/validate-bundles.js",
"validate:schemas": "node tools/validate-agent-schema.js" "validate:schemas": "node tools/validate-agent-schema.js"
}, },
"lint-staged": { "lint-staged": {
@ -60,8 +61,7 @@
"npm run format:fix" "npm run format:fix"
], ],
"*.md": [ "*.md": [
"markdownlint-cli2", "markdownlint-cli2"
"npm run format:fix"
] ]
}, },
"dependencies": { "dependencies": {
@ -84,7 +84,10 @@
"yaml": "^2.7.0" "yaml": "^2.7.0"
}, },
"devDependencies": { "devDependencies": {
"@docusaurus/core": "^3.6.0",
"@docusaurus/preset-classic": "^3.6.0",
"@eslint/js": "^9.33.0", "@eslint/js": "^9.33.0",
"archiver": "^7.0.1",
"c8": "^10.1.3", "c8": "^10.1.3",
"eslint": "^9.33.0", "eslint": "^9.33.0",
"eslint-config-prettier": "^10.1.8", "eslint-config-prettier": "^10.1.8",
@ -97,6 +100,9 @@
"markdownlint-cli2": "^0.19.1", "markdownlint-cli2": "^0.19.1",
"prettier": "^3.5.3", "prettier": "^3.5.3",
"prettier-plugin-packagejson": "^2.5.19", "prettier-plugin-packagejson": "^2.5.19",
"prism-react-renderer": "^2.4.1",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"yaml-eslint-parser": "^1.2.3", "yaml-eslint-parser": "^1.2.3",
"yaml-lint": "^1.7.0", "yaml-lint": "^1.7.0",
"zod": "^4.1.12" "zod": "^4.1.12"

View File

@ -4,7 +4,7 @@ These are quickly put together examples of both a stand alone somewhat cohesive
To try these out, download either or both folders to your local machine, and run the normal bmad installer, and when asked about custom local content, say yes, and give the path to one of these two folders. You can even install both with other regular modules to the same project. To try these out, download either or both folders to your local machine, and run the normal bmad installer, and when asked about custom local content, say yes, and give the path to one of these two folders. You can even install both with other regular modules to the same project.
Note - a project is just a folder with .bmad in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose. Note - a project is just a folder with \_bmad in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose.
Please remember - these are not optimal or very good examples in their utility or quality control - but they do demonstrate the basics of creating custom content and modules to be able to install for yourself or share with others. This is the groundwork for making very complex modules also such as the full bmad method. Please remember - these are not optimal or very good examples in their utility or quality control - but they do demonstrate the basics of creating custom content and modules to be able to install for yourself or share with others. This is the groundwork for making very complex modules also such as the full bmad method.

View File

@ -30,7 +30,7 @@
### IDE Manager & Base ### IDE Manager & Base
- @/tools/cli/installers/lib/ide/manager.js - IdeManager class (dynamic handler loading) - @/tools/cli/installers/lib/ide/manager.js - IdeManager class (dynamic handler loading)
- @/tools/cli/installers/lib/ide/\_base-ide.js - BaseIdeSetup class (all handlers extend this) - @/tools/cli/installers/lib/ide/_base-ide.js - BaseIdeSetup class (all handlers extend this)
### Shared Utilities ### Shared Utilities
@ -117,7 +117,7 @@ Contains:
- Add new IDE handler: Create file in /tools/cli/installers/lib/ide/, extend BaseIdeSetup - Add new IDE handler: Create file in /tools/cli/installers/lib/ide/, extend BaseIdeSetup
- Fix installer bug: Check installer.js (94KB - main logic) - Fix installer bug: Check installer.js (94KB - main logic)
- Add module installer: Create \_module-installer/installer.js if custom installer logic needed - Add module installer: Create _module-installer/installer.js if custom installer logic needed
- Update shared generators: Modify files in /shared/ directory - Update shared generators: Modify files in /shared/ directory
## Relationships ## Relationships

View File

@ -142,7 +142,7 @@ Defined in @/tools/cli/lib/platform-codes.js
## Common Tasks ## Common Tasks
- Create new module installer: Add \_module-installer/installer.js - Create new module installer: Add _module-installer/installer.js
- Add IDE sub-module: Create sub-modules/{ide-name}/ with config - Add IDE sub-module: Create sub-modules/{ide-name}/ with config
- Add new IDE support: Create handler in installers/lib/ide/ - Add new IDE support: Create handler in installers/lib/ide/
- Customize module installation: Modify module.yaml - Customize module installation: Modify module.yaml

View File

@ -66,7 +66,7 @@ To set up the quiz game by selecting game mode, choosing a category, and prepari
### 1. Welcome and Configuration Loading ### 1. Welcome and Configuration Loading
Load config from {project-root}/\_bmad/bmb/config.yaml to get user_name. Load config from {project-root}/_bmad/bmb/config.yaml to get user_name.
Present dramatic welcome: Present dramatic welcome:
"🎺 _DRAMATIC MUSIC PLAYS_ 🎺 "🎺 _DRAMATIC MUSIC PLAYS_ 🎺

View File

@ -45,7 +45,7 @@ web_bundle: true
### 1. Module Configuration Loading ### 1. Module Configuration Loading
Load and read full config from {project-root}/\_bmad/bmb/config.yaml and resolve: Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve:
- `user_name`, `output_folder`, `communication_language`, `document_output_language` - `user_name`, `output_folder`, `communication_language`, `document_output_language`

View File

@ -0,0 +1,41 @@
<!-- if possible, run this in a separate subagent or process with read access to the project,
but no context except the content to review -->
<task id="_bmad/core/tasks/review-adversarial-general.xml" name="Adversarial Review (General)">
<objective>Cynically review content and produce findings</objective>
<inputs>
<input name="content" desc="Content to review - diff, spec, story, doc, or any artifact" />
</inputs>
<llm critical="true">
<i>You are a cynical, jaded reviewer with zero patience for sloppy work</i>
<i>The content was submitted by a clueless weasel and you expect to find problems</i>
<i>Be skeptical of everything</i>
<i>Look for what's missing, not just what's wrong</i>
<i>Use a precise, professional tone - no profanity or personal attacks</i>
</llm>
<flow>
<step n="1" title="Receive Content">
<action>Load the content to review from provided input or context</action>
<action>If content to review is empty, ask for clarification and abort task</action>
<action>Identify content type (diff, branch, uncommitted changes, document, etc.)</action>
</step>
<step n="2" title="Adversarial Analysis" critical="true">
<mandate>Review with extreme skepticism - assume problems exist</mandate>
<action>Find at least ten issues to fix or improve in the provided content</action>
</step>
<step n="3" title="Present Findings">
<action>Output findings as a Markdown list (descriptions only)</action>
</step>
</flow>
<halt-conditions>
<condition>HALT if zero findings - this is suspicious, re-analyze or ask for guidance</condition>
<condition>HALT if content is empty or unreadable</condition>
</halt-conditions>
</task>

25
src/modules/bmb/README.md Normal file
View File

@ -0,0 +1,25 @@
# BMB - BMad Builder Module
Specialized tools and workflows for creating, customizing, and extending BMad components including agents, workflows, and complete modules.
## Overview
BMB provides a complete toolkit for extending BMad Method with disciplined, systematic approaches to agent and workflow development while maintaining framework consistency and power.
**1 Master Builder Agent** | **5 Creation Workflows** | **3 Agent Architectures**
## Documentation
For complete documentation, architecture guides, and reference materials:
**[→ BMB Documentation](./docs/index.md)**
## Quick Links
- [Agent Creation Guide](./docs/agents/index.md) - Build custom agents
- [Workflow Architecture](./docs/workflows/index.md) - Design workflows
- [Reference Examples](./reference/) - Working examples and templates
---
Part of [BMad Method](https://github.com/bmadcode/bmad-method) v6.0

View File

@ -223,7 +223,7 @@ Same as simple agents, PLUS:
## Reference Example ## Reference Example
See: `bmb/reference/agents/expert-examples/journal-keeper/` See: [journal-keeper/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper)
Features demonstrated: Features demonstrated:
@ -355,8 +355,8 @@ identity: |
- [ ] Sidecar folder structure created and populated - [ ] Sidecar folder structure created and populated
- [ ] memories.md has clear section structure - [ ] memories.md has clear section structure
- [ ] instructions.md contains core directives - [ ] instructions.md contains core directives
- [ ] Menu actions reference \_bmad/\_memory correctly - [ ] Menu actions reference _bmad/_memory correctly
- [ ] File paths use \_bmad/\_memory/[agentname]-sidecar/ to reference sidecar content - [ ] File paths use _bmad/_memory/[agentname]-sidecar/ to reference sidecar content
- [ ] Install config personalizes sidecar references - [ ] Install config personalizes sidecar references
- [ ] Agent folder named consistently: `{agent-name}/` - [ ] Agent folder named consistently: `{agent-name}/`
- [ ] YAML file named: `{agent-name}.agent.yaml` - [ ] YAML file named: `{agent-name}.agent.yaml`

View File

@ -9,7 +9,7 @@ Comprehensive guides for each agent type (choose based on use case):
- [Understanding Agent Types](./understanding-agent-types.md) - **START HERE** - Architecture vs capability, "The Same Agent, Three Ways" - [Understanding Agent Types](./understanding-agent-types.md) - **START HERE** - Architecture vs capability, "The Same Agent, Three Ways"
- [Simple Agent Architecture](./simple-agent-architecture.md) - Self-contained, optimized, personality-driven - [Simple Agent Architecture](./simple-agent-architecture.md) - Self-contained, optimized, personality-driven
- [Expert Agent Architecture](./expert-agent-architecture.md) - Memory, sidecar files, domain restrictions - [Expert Agent Architecture](./expert-agent-architecture.md) - Memory, sidecar files, domain restrictions
- [Module Agent Architecture](./module-agent-architecture.md) - Workflow integration, professional tools - Module Agent Architecture _(TODO)_ - Workflow integration, professional tools
## Agent Design Patterns ## Agent Design Patterns
@ -18,20 +18,20 @@ Comprehensive guides for each agent type (choose based on use case):
## Reference Examples ## Reference Examples
Production-ready examples in `/bmb/reference/agents/`: Production-ready examples in [bmb/reference/agents/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents):
**Simple Agents** (`simple-examples/`) **Simple Agents** ([simple-examples/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/simple-examples))
- `commit-poet.agent.yaml` - Commit message artisan with style customization - [commit-poet.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml) - Commit message artisan with style customization
**Expert Agents** (`expert-examples/`) **Expert Agents** ([expert-examples/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples))
- `journal-keeper/` - Personal journal companion with memory and pattern recognition - [journal-keeper/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper) - Personal journal companion with memory and pattern recognition
**Module Agents** (`module-examples/`) **Module Agents** ([module-examples/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/module-examples))
- `security-engineer.agent.yaml` - BMM security specialist with threat modeling - [security-engineer.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml) - BMM security specialist with threat modeling
- `trend-analyst.agent.yaml` - CIS trend intelligence expert - [trend-analyst.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml) - CIS trend intelligence expert
## Installation Guide ## Installation Guide

View File

@ -206,7 +206,7 @@ The `tools/cli/lib/agent/compiler.js` automatically adds:
## Reference Example ## Reference Example
See: `../../reference/agents/simple-examples/commit-poet.agent.yaml` See: [commit-poet.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml)
Features demonstrated: Features demonstrated:

View File

@ -7,7 +7,7 @@ ALL agent types can:
- ✓ Write to {output_folder}, {project-root}, or anywhere on system - ✓ Write to {output_folder}, {project-root}, or anywhere on system
- ✓ Update artifacts and files - ✓ Update artifacts and files
- ✓ Execute bash commands - ✓ Execute bash commands
- ✓ Use core variables (\_bmad, {output_folder}, etc.) - ✓ Use core variables (_bmad, {output_folder}, etc.)
- ✓ Have complex prompts and logic - ✓ Have complex prompts and logic
- ✓ Invoke external tools - ✓ Invoke external tools

View File

@ -20,8 +20,6 @@ Specialized tools and workflows for creating, customizing, and extending BMad co
- Install Location: `_bmad/bmb/agents/bmad-builder.md` - Install Location: `_bmad/bmb/agents/bmad-builder.md`
### 📋 Workflows
### 📚 Documentation ### 📚 Documentation
- Comprehensive guides for agents, workflows, and modules - Comprehensive guides for agents, workflows, and modules
@ -46,33 +44,33 @@ Specialized tools and workflows for creating, customizing, and extending BMad co
- **[Workflow Index](./workflows/index.md)** - Core workflow system overview - **[Workflow Index](./workflows/index.md)** - Core workflow system overview
- **[Architecture Guide](./workflows/architecture.md)** - Step-file design and JIT loading - **[Architecture Guide](./workflows/architecture.md)** - Step-file design and JIT loading
- **[Template System](./workflows/templates/step-template.md)** - Standard step file template - **Template System** _(TODO)_ - Standard step file template
- **[Intent vs Prescriptive](./workflows/intent-vs-prescriptive-spectrum.md)** - Design philosophy - **[Intent vs Prescriptive](./workflows/intent-vs-prescriptive-spectrum.md)** - Design philosophy
## Reference Materials ## Reference Materials
### 🤖 Agent Examples ### 🤖 Agent Examples
- **[Simple Agent Example](../reference/agents/simple-examples/commit-poet.agent.yaml)** - Self-contained agent - **[Simple Agent Example](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml)** - Self-contained agent
- **[Expert Agent Example](../reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml)** - Agent with persistent memory - **[Expert Agent Example](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml)** - Agent with persistent memory
- **[Module Add On Agent Examples](../reference/agents/module-examples/security-engineer.agent.yaml)** - Integration patterns (BMM, CIS) - **[Module Add On Agent Examples](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml)** - Integration patterns (BMM, CIS)
### 📋 Workflow Examples ### 📋 Workflow Examples
- **[Meal Prep & Nutrition](./reference/workflows/meal-prep-nutrition/)** - Complete step-file workflow demonstration - **[Meal Prep & Nutrition](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/workflows/meal-prep-nutrition)** - Complete step-file workflow demonstration
- **Template patterns** for document generation and state management - **Template patterns** for document generation and state management
## Core Workflows ## Core Workflows
### Creation Workflows (Step-File Architecture) ### Creation Workflows (Step-File Architecture)
**[create-agent](./workflows/create-agent/)** - Build BMad agents **create-agent** _(TODO)_ - Build BMad agents
- 11 guided steps from brainstorming to celebration - 11 guided steps from brainstorming to celebration
- 18 reference data files with validation checklists - 18 reference data files with validation checklists
- Template-based agent generation - Template-based agent generation
**[create-workflow](./workflows/create-workflow/)** - Design workflows **create-workflow** _(TODO)_ - Design workflows
- 12 structured steps from init to review - 12 structured steps from init to review
- 9 template files for workflow creation - 9 template files for workflow creation
@ -80,13 +78,13 @@ Specialized tools and workflows for creating, customizing, and extending BMad co
### Editing Workflows ### Editing Workflows
**[edit-agent](./workflows/edit-agent/)** - Modify existing agents **edit-agent** _(TODO)_ - Modify existing agents
- 5 steps: discovery → validation - 5 steps: discovery → validation
- Intent-driven analysis and updates - Intent-driven analysis and updates
- Best practice compliance - Best practice compliance
**[edit-workflow](./workflows/edit-workflow/)** - Update workflows **edit-workflow** _(TODO)_ - Update workflows
- 5 steps: analyze → compliance check - 5 steps: analyze → compliance check
- Structure maintenance and validation - Structure maintenance and validation
@ -94,7 +92,7 @@ Specialized tools and workflows for creating, customizing, and extending BMad co
### Quality Assurance ### Quality Assurance
**[workflow-compliance-check](./workflows/workflow-compliance-check/)** - Validation **workflow-compliance-check** _(TODO)_ - Validation
- 8 systematic validation steps - 8 systematic validation steps
- Adversarial analysis approach - Adversarial analysis approach

View File

@ -12,27 +12,27 @@ Essential terminology and concepts for understanding BMAD workflows.
The micro-file architecture, JIT step loading, state management, and collaboration patterns that make BMAD workflows optimal for AI execution. The micro-file architecture, JIT step loading, state management, and collaboration patterns that make BMAD workflows optimal for AI execution.
### [Writing Workflows](./writing-workflows.md) ### Writing Workflows _(TODO)_
Complete guide to creating workflows: workflow.md control files, step files, CSV data integration, and frontmatter design. Complete guide to creating workflows: workflow.md control files, step files, CSV data integration, and frontmatter design.
### [Step Files & Dialog Patterns](./step-files.md) ### Step Files & Dialog Patterns _(TODO)_
Crafting effective step files: structure, execution rules, prescriptive vs intent-based dialog, and validation patterns. Crafting effective step files: structure, execution rules, prescriptive vs intent-based dialog, and validation patterns.
### [Templates & Content Generation](./templates.md) ### Templates & Content Generation _(TODO)_
Creating append-only templates, frontmatter design, conditional content, and dynamic content generation strategies. Creating append-only templates, frontmatter design, conditional content, and dynamic content generation strategies.
### [Workflow Patterns](./patterns.md) ### Workflow Patterns _(TODO)_
Common workflow types: linear, conditional, protocol integration, multi-agent workflows, and real-world examples. Common workflow types: linear, conditional, protocol integration, multi-agent workflows, and real-world examples.
### [Migration Guide](./migration.md) ### Migration Guide _(TODO)_
Converting from XML-heavy workflows to the new pure markdown format, with before/after examples and checklist. Converting from XML-heavy workflows to the new pure markdown format, with before/after examples and checklist.
### [Best Practices & Reference](./best-practices.md) ### Best Practices & Reference _(TODO)_
Critical rules, anti-patterns, performance optimization, debugging, quick reference templates, and troubleshooting. Critical rules, anti-patterns, performance optimization, debugging, quick reference templates, and troubleshooting.

View File

@ -13,16 +13,16 @@ description: 'Initialize the [workflow-type] workflow by detecting continuation
<!-- Path Definitions --> <!-- Path Definitions -->
workflow\*path: '{project-root}/\_bmad/[module-path]/workflows/[workflow-name]' workflow\*path: `{project-root}/_bmad/[module-path]/workflows/[workflow-name]`
# File References (all use {variable} format in file) # File References (all use {variable} format in file)
thisStepFile: '{workflow_path}/steps/step-01-init.md' thisStepFile: `{workflow_path}/steps/step-01-init.md`
nextStepFile: '{workflow_path}/steps/step-02-[step-name].md' nextStepFile: `{workflow_path}/steps/step-02-[step-name].md`
workflowFile: '{workflow_path}/workflow.md' workflowFile: `{workflow_path}/workflow.md`
outputFile: '{output_folder}/[output-file-name]-{project_name}.md' outputFile: `{output_folder}/[output-file-name]-{project_name}.md`
continueFile: '{workflow_path}/steps/step-01b-continue.md' continueFile: `{workflow_path}/steps/step-01b-continue.md`
templateFile: '{workflow_path}/templates/[main-template].md' templateFile: `{workflow_path}/templates/[main-template].md`
# Template References # Template References

View File

@ -13,7 +13,7 @@ description: 'Handle workflow continuation from previous session'
<!-- Path Definitions --> <!-- Path Definitions -->
workflow\*path: '{project-root}/\_bmad/[module-path]/workflows/[workflow-name]' workflow\*path: '{project-root}/_bmad/[module-path]/workflows/[workflow-name]'
# File References (all use {variable} format in file) # File References (all use {variable} format in file)

View File

@ -11,7 +11,7 @@ description: '[Brief description of what this step accomplishes]'
<!-- Path Definitions --> <!-- Path Definitions -->
workflow\*path: '{project-root}/\_bmad/[module]/reference/workflows/[workflow-name]' # the folder the workflow.md file is in workflow\*path: '{project-root}/_bmad/[module]/reference/workflows/[workflow-name]' # the folder the workflow.md file is in
# File References (all use {variable} format in file) # File References (all use {variable} format in file)
@ -23,8 +23,8 @@ outputFile: '{output_folder}/[output-file-name]-{project_name}.md'
# Task References (IF THE workflow uses and it makes sense in this step to have these ) # Task References (IF THE workflow uses and it makes sense in this step to have these )
advancedElicitationTask: '{project-root}/\_bmad/core/tasks/advanced-elicitation.xml' advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/\_bmad/core/workflows/party-mode/workflow.md' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
# Template References (if this step uses a specific templates) # Template References (if this step uses a specific templates)
@ -243,7 +243,7 @@ Display: "**Select an Option:** [A] [Continue to Step Foo] [A] [Continue to Step
### Initialization Step Example ### Initialization Step Example
See [step-01-init.md](../reference/workflows/meal-prep-nutrition/steps/step-01-init.md) for an example of: See [step-01-init.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md) for an example of:
- Detecting existing workflow state and short circuit to 1b - Detecting existing workflow state and short circuit to 1b
- Creating output documents from templates - Creating output documents from templates
@ -252,7 +252,7 @@ See [step-01-init.md](../reference/workflows/meal-prep-nutrition/steps/step-01-i
### Continuation Step Example ### Continuation Step Example
See [step-01b-continue.md](../reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md) for an example of: See [step-01b-continue.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md) for an example of:
- Handling already-in-progress workflows - Handling already-in-progress workflows
- Detecting completion status - Detecting completion status
@ -261,7 +261,7 @@ See [step-01b-continue.md](../reference/workflows/meal-prep-nutrition/steps/step
### Standard Step with Menu Example ### Standard Step with Menu Example
See [step-02-profile.md](../reference/workflows/meal-prep-nutrition/steps/step-02-profile.md) for an example of: See [step-02-profile.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md) for an example of:
- Presenting a menu with A/P/C options - Presenting a menu with A/P/C options
- Forcing halt until user selects 'C' (Continue) - Forcing halt until user selects 'C' (Continue)
@ -271,7 +271,7 @@ See [step-02-profile.md](../reference/workflows/meal-prep-nutrition/steps/step-0
### Final Step Example ### Final Step Example
See [step-06-prep-schedule.md](../reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md) for an example of: See [step-06-prep-schedule.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md) for an example of:
- Completing workflow deliverables - Completing workflow deliverables
- Marking workflow as complete in frontmatter - Marking workflow as complete in frontmatter

View File

@ -53,7 +53,7 @@ web_bundle: [true/false] # Set to true for inclusion in web bundle builds
### 1. Module Configuration Loading ### 1. Module Configuration Loading
Load and read full config from {project-root}/\_bmad/[MODULE FOLDER]/config.yaml and resolve: Load and read full config from {project-root}/_bmad/[MODULE FOLDER]/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, [MODULE VARS] - `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, [MODULE VARS]

View File

@ -49,7 +49,7 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading ### 1. Configuration Loading
Load and read full config from {project-root}/\_bmad/{{targetModule}}/config.yaml and resolve: Load and read full config from {project-root}/_bmad/{{targetModule}}/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language` - `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`

View File

@ -49,7 +49,7 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading ### 1. Configuration Loading
Load and read full config from {project-root}/\_bmad/core/config.yaml and resolve: Load and read full config from {project-root}/_bmad/core/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language` - `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`

View File

@ -126,7 +126,7 @@ Use this checklist to validate module edits meet BMAD Core standards.
- [ ] Web bundles configured in workflow.yaml files - [ ] Web bundles configured in workflow.yaml files
- [ ] All referenced files included in web_bundle_files - [ ] All referenced files included in web_bundle_files
- [ ] Paths are \_bmad/-relative (not project-root) - [ ] Paths are _bmad/-relative (not project-root)
- [ ] No config_source references in web bundles - [ ] No config_source references in web bundles
- [ ] Invoked workflows included in dependencies - [ ] Invoked workflows included in dependencies

View File

@ -1,7 +1,7 @@
# Edit Module - Module Editor Instructions # Edit Module - Module Editor Instructions
<critical>The workflow execution engine is governed by: {project-root}/\_bmad/core/tasks/workflow.xml</critical> <critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
<critical>You MUST have already loaded and processed: {project-root}/\_bmad/bmb/workflows/edit-module/workflow.yaml</critical> <critical>You MUST have already loaded and processed: {project-root}/_bmad/bmb/workflows/edit-module/workflow.yaml</critical>
<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs</critical> <critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs</critical>
<critical>The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them</critical> <critical>The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them</critical>
<critical>Communicate all responses in {communication_language}</critical> <critical>Communicate all responses in {communication_language}</critical>
@ -186,7 +186,7 @@ Let the conversation flow naturally. Build a shared vision of what "better" look
**If setting up cross-module integration:** **If setting up cross-module integration:**
- Identify which workflows from other modules are needed - Identify which workflows from other modules are needed
- Show how to reference workflows properly: {project-root}/\_bmad/{{module}}/workflows/{{workflow}}/workflow.yaml - Show how to reference workflows properly: {project-root}/_bmad/{{module}}/workflows/{{workflow}}/workflow.yaml
- Document the integration in README - Document the integration in README
- Ensure dependencies are clear - Ensure dependencies are clear
- Consider adding example usage - Consider adding example usage

View File

@ -1,7 +1,7 @@
# Module Brief Instructions # Module Brief Instructions
<critical>The workflow execution engine is governed by: {project-root}/\_bmad/core/tasks/workflow.xml</critical> <critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
<critical>You MUST have already loaded and processed: {project-root}/\_bmad/bmb/workflows/module-brief/workflow.yaml</critical> <critical>You MUST have already loaded and processed: {project-root}/_bmad/bmb/workflows/module-brief/workflow.yaml</critical>
<critical>Communicate in {communication_language} throughout the module brief creation process</critical> <critical>Communicate in {communication_language} throughout the module brief creation process</critical>
<critical>⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever.</critical> <critical>⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever.</critical>

View File

@ -49,7 +49,7 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading ### 1. Configuration Loading
Load and read full config from {project-root}/\_bmad/bmm/config.yaml and resolve: Load and read full config from {project-root}/_bmad/bmm/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `user_skill_level` - `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `user_skill_level`

View File

@ -313,7 +313,7 @@ critical_actions:
1. **Load sidecar files in critical_actions** - Must be explicit and MANDATORY 1. **Load sidecar files in critical_actions** - Must be explicit and MANDATORY
2. **Enforce domain restrictions** - Clear boundaries prevent scope creep 2. **Enforce domain restrictions** - Clear boundaries prevent scope creep
3. **Use \_bmad/\_memory/[agentname]-sidcar/ paths** - For reference to any sidecar content 3. **Use _bmad/_memory/[agentname]-sidcar/ paths** - For reference to any sidecar content
4. **Design for memory growth** - Structure sidecar files for accumulation 4. **Design for memory growth** - Structure sidecar files for accumulation
5. **Reference past naturally** - Don't dump memory, weave it into conversation 5. **Reference past naturally** - Don't dump memory, weave it into conversation
6. **Separate concerns** - Memories, instructions, knowledge in distinct files 6. **Separate concerns** - Memories, instructions, knowledge in distinct files
@ -356,8 +356,8 @@ identity: |
- [ ] Sidecar folder structure created and populated - [ ] Sidecar folder structure created and populated
- [ ] memories.md has clear section structure - [ ] memories.md has clear section structure
- [ ] instructions.md contains core directives - [ ] instructions.md contains core directives
- [ ] Menu actions reference \_bmad/\_memory/[agentname]-sidcar/ correctly if needing sidecar content reference - [ ] Menu actions reference _bmad/_memory/[agentname]-sidcar/ correctly if needing sidecar content reference
- [ ] File paths use \_bmad/\_memory/[agentname]-sidcar/ to reference where the file will be after sidecar content is installed - [ ] File paths use _bmad/_memory/[agentname]-sidcar/ to reference where the file will be after sidecar content is installed
- [ ] Install config personalizes sidecar references - [ ] Install config personalizes sidecar references
- [ ] Agent folder named consistently: `{agent-name}/` - [ ] Agent folder named consistently: `{agent-name}/`
- [ ] YAML file named: `{agent-name}.agent.yaml` - [ ] YAML file named: `{agent-name}.agent.yaml`

View File

@ -129,7 +129,7 @@ Create all directories in {bmb_creations_output_folder}/{module_name}/:
3. **tasks/** - For task files (if tasks planned) 3. **tasks/** - For task files (if tasks planned)
4. **templates/** - For shared templates 4. **templates/** - For shared templates
5. **data/** - For module data 5. **data/** - For module data
6. **\_module-installer/** - For installation configuration 6. **_module-installer/** - For installation configuration
### 4. Create Placeholder README ### 4. Create Placeholder README

View File

@ -71,8 +71,8 @@ From step 5, we planned these configuration fields:
### 2. Create Installer Directory ### 2. Create Installer Directory
Ensure \_module-installer directory exists Ensure _module-installer directory exists
Directory: {bmb_creations_output_folder}/{module_name}/\_module-installer/ Directory: {bmb_creations_output_folder}/{module_name}/_module-installer/
### 3. Create module.yaml ### 3. Create module.yaml
@ -95,7 +95,7 @@ Does your module need any special setup during installation? For example:
"I'll create an installer.js file for custom logic." "I'll create an installer.js file for custom logic."
Create file: {bmb_creations_output_folder}/{module_name}/\_module-installer/installer.js from {installerTemplate} Create file: {bmb_creations_output_folder}/{module_name}/_module-installer/installer.js from {installerTemplate}
Update installer.js with module-specific logic Update installer.js with module-specific logic
@ -105,7 +105,7 @@ Update installer.js with module-specific logic
If your module needs to copy files during installation (templates, examples, documentation), we can add them to the assets directory." If your module needs to copy files during installation (templates, examples, documentation), we can add them to the assets directory."
Create directory: \_module-installer/assets/ Create directory: _module-installer/assets/
Add note about what assets to include Add note about what assets to include
### 6. Document Installer Setup ### 6. Document Installer Setup
@ -131,7 +131,7 @@ Update module-plan.md with installer section:
1. User runs: `bmad install {module_name}` 1. User runs: `bmad install {module_name}`
2. Installer asks: [list of questions] 2. Installer asks: [list of questions]
3. Creates: \_bmad/{module_name}/ 3. Creates: _bmad/{module_name}/
4. Generates: config.yaml with user settings 4. Generates: config.yaml with user settings
### Validation ### Validation

View File

@ -264,7 +264,7 @@ Analyze the visual design with my signature dramatic flair
menu: # Core interactions - multi: "[CH] Chat with Caravaggio or [SPM] Start Party Mode" menu: # Core interactions - multi: "[CH] Chat with Caravaggio or [SPM] Start Party Mode"
triggers: - party-mode: triggers: - party-mode:
input: SPM or fuzzy match start party mode input: SPM or fuzzy match start party mode
route: "{project-root}/\_bmad/core/workflows/edit-agent/workflow.md" route: "{project-root}/_bmad/core/workflows/edit-agent/workflow.md"
data: what's being discussed, plus custom party agents if specified data: what's being discussed, plus custom party agents if specified
type: exec - expert-chat: type: exec - expert-chat:
input: CH or fuzzy match validate agent input: CH or fuzzy match validate agent

View File

@ -11,11 +11,11 @@ This document provides the validation criteria used in step-11-validate.md to en
- [ ] tasks/ - Task files (if needed) - [ ] tasks/ - Task files (if needed)
- [ ] templates/ - Shared templates - [ ] templates/ - Shared templates
- [ ] data/ - Module data - [ ] data/ - Module data
- [ ] \_module-installer/ - Installation config - [ ] _module-installer/ - Installation config
- [ ] README.md - Module documentation - [ ] README.md - Module documentation
- [ ] module.yaml - module config file - [ ] module.yaml - module config file
### Optional File in \_module-installer/ ### Optional File in _module-installer/
- [ ] installer.js - Custom logic (if needed) - [ ] installer.js - Custom logic (if needed)

View File

@ -46,7 +46,7 @@ installed_path: '{project-root}/_bmad/bmb/workflows/create-module'
### 1. Module Configuration Loading ### 1. Module Configuration Loading
Load and read full config from {project-root}/\_bmad/bmb/config.yaml and resolve: Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `bmb_creations_output_folder` - `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `bmb_creations_output_folder`

View File

@ -72,7 +72,7 @@ To generate all the workflow files (workflow.md, step files, templates, and supp
- When building continuable step-01-init.md files, use template `{project-root}/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md` - When building continuable step-01-init.md files, use template `{project-root}/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md`
- When building continuation steps, use template `{project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md` - When building continuation steps, use template `{project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md`
- When building the main workflow.md file, you must follow template `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md` - When building the main workflow.md file, you must follow template `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md`
- Example step files from {project-root}/\_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md for patterns - Example step files from {project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md for patterns
## FILE GENERATION SEQUENCE: ## FILE GENERATION SEQUENCE:
@ -117,7 +117,7 @@ Load and follow {workflowTemplate}:
- Create workflow.md using template structure - Create workflow.md using template structure
- Insert workflow name and description - Insert workflow name and description
- Configure all path variables ({project-root}, \_bmad, {workflow_path}) - Configure all path variables ({project-root}, _bmad, {workflow_path})
- Set web_bundle flag to true unless user has indicated otherwise - Set web_bundle flag to true unless user has indicated otherwise
- Define role and goal - Define role and goal
- Include initialization path to step-01 - Include initialization path to step-01

View File

@ -49,7 +49,7 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading ### 1. Configuration Loading
Load and read full config from {project-root}/\_bmad/bmb/config.yaml and resolve: Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `bmb_creations_output_folder` - `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `bmb_creations_output_folder`

View File

@ -49,7 +49,7 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading ### 1. Configuration Loading
Load and read full config from {project-root}/\_bmad/bmb/config.yaml and resolve: Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language` - `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`

View File

@ -49,7 +49,7 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading ### 1. Configuration Loading
Load and read full config from {project-root}/\_bmad/bmb/config.yaml and resolve: Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language` - `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`

View File

@ -135,7 +135,7 @@ For each deviation:
- Configuration Loading uses correct path format: `{project-root}/_bmad/[module]/config.yaml` (variable substitution pattern) - Configuration Loading uses correct path format: `{project-root}/_bmad/[module]/config.yaml` (variable substitution pattern)
- First step follows pattern: `step-01-init.md` OR documented deviation - First step follows pattern: `step-01-init.md` OR documented deviation
- Required config variables properly listed - Required config variables properly listed
- Variables use proper substitution pattern: {project-root}, \_bmad, {workflow_path}, etc. - Variables use proper substitution pattern: {project-root}, _bmad, {workflow_path}, etc.
For violations: For violations:

View File

@ -49,7 +49,7 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading ### 1. Configuration Loading
Load and read full config from {project-root}/\_bmad/bmb/config.yaml and resolve: Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language` - `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`

View File

@ -1,209 +0,0 @@
# BMad Game Development (BMGD)
A comprehensive game development toolkit providing specialized agents and workflows for creating games from initial concept through production.
## Overview
The BMGD module brings together game-specific development workflows organized around industry-standard development phases:
- **Preproduction** - Concept development, brainstorming, game brief creation
- **Design** - Game Design Document (GDD) and narrative design
- **Technical** - Game architecture and technical specifications
- **Production** - Sprint-based implementation using BMM workflows
## Installation
```bash
bmad install bmgd
```
During installation, you'll be asked to configure:
- Game project name
- Document storage locations
- Development experience level
- Primary target platform
## Components
### Agents (4)
**Game Designer** 🎨
Creative vision and game design documentation specialist. Creates compelling GDDs and defines game mechanics.
**Game Developer** 🕹️
Senior implementation specialist with expertise across Unity, Unreal, and custom engines. Handles gameplay programming, physics, AI, and optimization.
**Game Architect** 🏗️
Technical systems and infrastructure expert. Designs scalable game architecture and engine-level solutions.
**Game Dev Scrum Master** 🎯
Sprint orchestrator specialized in game development workflows. Coordinates multi-disciplinary teams and translates GDDs into actionable development stories.
### Team Bundle
**Team Game Development** 🎮
Pre-configured team including Game Designer, Game Developer, and Game Architect for comprehensive game projects.
### Workflows
#### Phase 1: Preproduction
- **brainstorm-game** - Interactive game concept brainstorming
- **game-brief** - Create focused game brief document
#### Phase 2: Design
- **gdd** - Generate comprehensive Game Design Document
- **narrative** - Design narrative structure and story elements
#### Phase 3: Technical
- **game-architecture** - Define technical architecture (adapted from BMM architecture workflow)
#### Phase 4: Production
Production workflows are provided by the BMM module and accessible through the Game Dev Scrum Master agent:
- Sprint planning
- Story creation and management
- Epic technical specifications
- Code review and retrospectives
## Quick Start
### 1. Start with Concept Development
```
Load agent: game-designer
Run workflow: brainstorm-game
```
### 2. Create Game Brief
```
Run workflow: game-brief
```
### 3. Develop Game Design Document
```
Run workflow: gdd
```
### 4. Define Technical Architecture
```
Load agent: game-architect
Run workflow: game-architecture
```
### 5. Begin Production Sprints
```
Load agent: game-scrum-master
Run: *sprint-planning
```
## Module Structure
```
bmgd/
├── agents/
│ ├── game-designer.agent.yaml
│ ├── game-dev.agent.yaml
│ ├── game-architect.agent.yaml
│ └── game-scrum-master.agent.yaml
├── teams/
│ └── team-gamedev.yaml
├── workflows/
│ ├── 1-preproduction/
│ │ ├── brainstorm-game/
│ │ └── game-brief/
│ ├── 2-design/
│ │ ├── gdd/
│ │ └── narrative/
│ ├── 3-technical/
│ │ └── game-architecture/
│ └── 4-production/
│ (Uses BMM workflows via cross-module references)
├── templates/
├── data/
├── module.yaml
└── _module-installer/
└── installer.js (optional)
```
## Configuration
After installation, configure the module in `_bmad/bmgd/config.yaml`
Key settings:
- **game_project_name** - Your game's working title
- **game_design_docs** - Location for GDD and design documents
- **game_tech_docs** - Location for technical documentation
- **game_story_location** - Location for development user stories
- **game_dev_experience** - Your experience level (affects agent communication)
- **primary_platform** - Target platform (PC, mobile, console, web, multi-platform)
## Workflow Integration
BMGD leverages the BMM module for production/implementation workflows. The Game Dev Scrum Master agent provides access to:
- Sprint planning and management
- Story creation from GDD specifications
- Epic technical context generation
- Code review workflows
- Retrospectives and course correction
This separation allows BMGD to focus on game-specific design and architecture while using battle-tested agile implementation workflows.
## Example: Creating a 2D Platformer
1. **Brainstorm** concepts with `brainstorm-game` workflow
2. **Define** the vision with `game-brief` workflow
3. **Design** mechanics and progression with `gdd` workflow
4. **Craft** character arcs and story with `narrative` workflow
5. **Architect** technical systems with `game-architecture` workflow
6. **Implement** via Game Dev Scrum Master sprint workflows
## Development Roadmap
### Phase 1: Core Enhancement
- [ ] Customize game-architecture workflow for game-specific patterns
- [ ] Add game-specific templates (level design, character sheets, etc.)
- [ ] Create asset pipeline workflows
### Phase 2: Expanded Features
- [ ] Add monetization planning workflows
- [ ] Create playtesting and feedback workflows
- [ ] Develop game balancing tools
### Phase 3: Platform Integration
- [ ] Add platform-specific deployment workflows
- [ ] Create build and release automation
- [ ] Develop live ops workflows
## Contributing
To extend this module:
1. Add new agents using `/bmad:bmb:workflows:create-agent`
2. Add new workflows using `/bmad:bmb:workflows:create-workflow`
3. Submit improvements via pull request
## Dependencies
- **BMM Module** - Required for production/implementation workflows
## Author
Extracted and refined from BMM module on 2025-11-05
## License
Part of the BMAD Method ecosystem

View File

@ -46,8 +46,8 @@ async function install(options) {
} }
// Create implementation artifacts directory (sprint status, stories, reviews) // Create implementation artifacts directory (sprint status, stories, reviews)
// Check both implementation_artifacts and sprint_artifacts for compatibility // Check both implementation_artifacts and implementation_artifacts for compatibility
const implConfig = config['implementation_artifacts'] || config['sprint_artifacts']; const implConfig = config['implementation_artifacts'] || config['implementation_artifacts'];
if (implConfig && typeof implConfig === 'string') { if (implConfig && typeof implConfig === 'string') {
// Strip project-root prefix variations // Strip project-root prefix variations
const implConfigClean = implConfig.replace(/^\{project-root\}\/?/, ''); const implConfigClean = implConfig.replace(/^\{project-root\}\/?/, '');

View File

@ -163,8 +163,8 @@ BMGD Documentation
### Related Documentation ### Related Documentation
- **[BMM Documentation](../../bmm/docs/README.md)** - Core BMad Method documentation - **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation
- **[IDE Setup Guides](../../../../docs/ide-info/)** - Configure your development environment - **[IDE Guides](../../ide-info/)** - Configure your development environment
--- ---

View File

@ -1,4 +1,4 @@
<critical>The workflow execution engine is governed by: {project_root}/\_bmad/core/tasks/workflow.xml</critical> <critical>The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml</critical>
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical> <critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
<critical>Communicate all responses in {communication_language}</critical> <critical>Communicate all responses in {communication_language}</critical>
<critical>This is a meta-workflow that orchestrates the CIS brainstorming workflow with game-specific context and additional game design techniques</critical> <critical>This is a meta-workflow that orchestrates the CIS brainstorming workflow with game-specific context and additional game design techniques</critical>

View File

@ -1,6 +1,6 @@
# Game Brief - Interactive Workflow Instructions # Game Brief - Interactive Workflow Instructions
<critical>The workflow execution engine is governed by: {project-root}/\_bmad/core/tasks/workflow.xml</critical> <critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical> <critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
<critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical> <critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical>
<critical>Generate all documents in {document_output_language}</critical> <critical>Generate all documents in {document_output_language}</critical>

View File

@ -2,7 +2,7 @@
<workflow> <workflow>
<critical>The workflow execution engine is governed by: {project_root}/\_bmad/core/tasks/workflow.xml</critical> <critical>The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml</critical>
<critical>You MUST have already completed the GDD workflow</critical> <critical>You MUST have already completed the GDD workflow</critical>
<critical>Communicate all responses in {communication_language}</critical> <critical>Communicate all responses in {communication_language}</critical>
<critical>This workflow creates detailed narrative content for story-driven games</critical> <critical>This workflow creates detailed narrative content for story-driven games</critical>

View File

@ -2,7 +2,7 @@
<workflow name="architecture"> <workflow name="architecture">
<critical>The workflow execution engine is governed by: {project-root}/\_bmad/core/tasks/workflow.xml</critical> <critical>The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml</critical>
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical> <critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication style based on {user_skill_level}</critical> <critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication style based on {user_skill_level}</critical>
<critical>The goal is ARCHITECTURAL DECISIONS that prevent AI agent conflicts, not detailed implementation specs</critical> <critical>The goal is ARCHITECTURAL DECISIONS that prevent AI agent conflicts, not detailed implementation specs</critical>
@ -74,7 +74,7 @@ For Level {{project_level}}, we'll keep the architecture appropriately scoped.
Decision Architecture works from your Product Requirements Document (PRD). Decision Architecture works from your Product Requirements Document (PRD).
Looking for: _prd_.md, or prd/index.md + files in {output_folder} Looking for: `*prd*.md`, or `prd/index.md` + files in {output_folder}
Please run the PRD workflow first to define your requirements. Please run the PRD workflow first to define your requirements.

View File

@ -28,8 +28,8 @@ This step will generate content and present choices for each rule category:
## PROTOCOL INTEGRATION: ## PROTOCOL INTEGRATION:
- When 'A' selected: Execute {project-root}/\_bmad/core/tasks/advanced-elicitation.xml - When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml
- When 'P' selected: Execute {project-root}/\_bmad/core/workflows/party-mode - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed - PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
- User accepts/rejects protocol changes before proceeding - User accepts/rejects protocol changes before proceeding

View File

@ -11,8 +11,8 @@ communication_language: "{config_source}:communication_language"
user_skill_level: "{config_source}:user_skill_level" user_skill_level: "{config_source}:user_skill_level"
document_output_language: "{config_source}:document_output_language" document_output_language: "{config_source}:document_output_language"
date: system-generated date: system-generated
sprint_artifacts: "{config_source}:sprint_artifacts" implementation_artifacts: "{config_source}:implementation_artifacts"
sprint_status: "{sprint_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml"
# Workflow components # Workflow components
installed_path: "{project-root}/_bmad/bmgd/workflows/4-production/code-review" installed_path: "{project-root}/_bmad/bmgd/workflows/4-production/code-review"
@ -23,7 +23,7 @@ template: false
variables: variables:
# Project context # Project context
project_context: "**/project-context.md" project_context: "**/project-context.md"
story_dir: "{sprint_artifacts}" story_dir: "{implementation_artifacts}"
# Smart input file references - game-specific patterns # Smart input file references - game-specific patterns
# Priority: Whole document first, then sharded version # Priority: Whole document first, then sharded version

Some files were not shown because too many files have changed in this diff Show More