bmad-method 6.0.0-alpha.22 → 6.0.0-alpha.23

package/docs/modules/bmb-bmad-builder/agent-creation-guide.md

@@ -1,166 +0,0 @@
-# Agent Creation Guide
-
-Create your own custom agents using the BMAD Builder workflow.
-
-## Overview
-
-The BMAD Builder (BMB) module provides an interactive workflow that guides you through creating a custom agent from concept to completion. You define the agent's purpose, personality, capabilities, and menu - then the workflow generates a complete, ready-to-use agent file.
-
-## Before You Start
-
-**Prerequisites:**
-- BMAD installed with the BMB module
-- An idea for what you want your agent to do
-- About 15-30 minutes for your first agent
-
-**Know Before You Go:**
-- What problem should your agent solve?
-- Who will use this agent?
-- What should the agent be able to do?
-
-## Quick Start
-
-### 1. Start the Workflow
-
-In your IDE (Claude Code, Cursor, etc.), invoke the create-agent workflow:
-
-```
-"Run the BMAD Builder create-agent workflow"
-```
-
-Or trigger it via the BMAD Master menu.
-
-### 2. Follow the Steps
-
-The workflow guides you through:
-
-| Step | What You'll Do |
-|------|----------------|
-| **Brainstorm** (optional) | Explore ideas with creative techniques |
-| **Discovery** | Define the agent's purpose and goals |
-| **Type & Metadata** | Choose Simple or Expert, name your agent |
-| **Persona** | Craft the agent's personality and principles |
-| **Commands** | Define what the agent can do |
-| **Activation** | Set up autonomous behaviors (optional) |
-| **Build** | Generate the agent file |
-| **Validation** | Review and verify everything works |
-
-### 3. Install Your Agent
-
-Once created, package your agent for installation:
-
-```
-my-custom-stuff/
-├── module.yaml          # Contains: unitary: true
-├── agents/
-│   └── {agent-name}/
-│       ├── {agent-name}.agent.yaml
-│       └── _memory/              # Expert agents only
-│           └── {sidecar-folder}/
-└── workflows/           # Optional: custom workflows
-```
-
-See [Custom Content Installation](./custom-content-installation.md) for details.
-
-## Choosing Your Agent Type
-
-The workflow will help you decide, but here's the quick reference:
-
-### Choose Simple Agent When:
-
-- Task is well-defined and focused
-- Don't need persistent memory
-- Want fast setup and deployment
-- Single-purpose assistant (e.g., commit messages, code review)
-
-**Example:** A "Code Commenter" that reads files and adds helpful comments.
-
-### Choose Expert Agent When:
-
-- Domain requires specialized knowledge
-- Need persistent memory across sessions
-- Agent coordinates complex workflows
-- Building ongoing project infrastructure
-
-**Example:** A "Security Architect" that remembers your design decisions and maintains security standards across the project.
-
-### Choose Module Agent When:
-
-- Agent builds other agents or workflows
-- Need integration with module system
-- Creating professional tooling
-
-**Example:** A "Team Builder" that helps set up agents for new team members.
-
-## The Persona System
-
-Your agent's personality is defined by four fields:
-
-| Field | Purpose | Example |
-|-------|---------|---------|
-| **Role** | What they do | "Senior code reviewer who catches bugs and suggests improvements" |
-| **Identity** | Who they are | "Friendly but exacting, believes clean code is a craft" |
-| **Communication Style** | How they speak | "Direct, constructive, explains the 'why' behind suggestions" |
-| **Principles** | Why they act | "Security first, clarity over cleverness, test what you fix" |
-
-**Key:** Keep each field focused on its purpose. The role isn't personality; the identity isn't job description.
-
-## Tips for Success
-
-### Start Small
-
-Your first agent should solve **one problem well**. You can always add more capabilities later.
-
-### Learn by Example
-
-Study the reference agents in `src/modules/bmb/reference/agents/`:
-- **Simple:** [commit-poet](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml)
-- **Expert:** [journal-keeper](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper)
-
-### Write Great Principles
-
-The first principle should "activate" the agent's expertise:
-
-❌ **Weak:** "Be helpful and accurate"
-✅ **Strong:** "Channel decades of security expertise: threat modeling begins with trust boundaries, never trust client input, defense in depth is non-negotiable"
-
-### Use the Menu System
-
-The workflow provides options at each step:
-- **[A] Advanced** - Get deeper insights and reasoning
-- **[P] Party** - Get multiple agent perspectives
-- **[C] Continue** - Move to the next step
-
-Use these when you need extra input or creative options.
-
-## After Creation
-
-### Test Your Agent
-
-1. Install your custom module using the BMAD installer
-2. Invoke your new agent in your IDE
-3. Try each menu command
-4. Verify the personality feels right
-
-### Iterate
-
-If something isn't right:
-1. Edit the agent YAML directly, or
-2. Edit the customization file in `_bmad/_config/agents/`
-3. Rebuild using `npx bmad-method build <agent-name>`
-
-### Share
-
-Package your agent as a standalone module (see [Installation Guide](../../bmad-core-concepts/installing/)) and share it with your team or the community.
-
-## Further Reading
-
-- **[Agent Architecture](./index.md)** - Deep technical details on agent types
-- **[Agent Customization](../../bmad-core-concepts/agent-customization/)** - Modify agents without editing core files
-- **[Custom Content Installation](./custom-content-installation.md)** - Package and distribute your agents
-
----
-
-**Ready?** Start the workflow and create your first agent!
-
-[← Back to BMB Documentation](./index.md)

package/docs/modules/bmb-bmad-builder/index.md

@@ -1,60 +0,0 @@
-# BMB Module Documentation
-
-Create custom agents, workflows, and modules for BMAD.
-
-## Quick Start
-
-- **[Agent Creation Guide](./agent-creation-guide.md)** - Step-by-step guide to building your first agent
-- **[Understanding Agent Types](./understanding-agent-types.md)** - Learn the differences between Simple and Expert agents
-
-## Agent Architecture
-
-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"
-- [Simple Agent Architecture](./simple-agent-architecture.md) - Self-contained, optimized, personality-driven
-- [Expert Agent Architecture](./expert-agent-architecture.md) - Memory, sidecar files, domain restrictions
-- Module Agent Architecture _(TODO)_ - Workflow integration, professional tools
-
-## Agent Design Patterns
-
-- [Agent Menu Patterns](./agent-menu-patterns.md) - Menu handlers, triggers, prompts, organization
-- [Agent Compilation](./agent-compilation.md) - What compiler auto-injects (AVOID DUPLICATION)
-
-## Reference Examples
-
-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/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/simple-examples))
-
-- [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/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples))
-
-- [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/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/module-examples))
-
-- [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](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
-
-For installing standalone simple and expert agents, see:
-
-- [Custom Agent Installation](/docs/modules/bmb-bmad-builder/custom-content-installation.md)
-
-## Key Concepts
-
-### YAML to XML Compilation
-
-Agents are authored in YAML with Handlebars templating. The compiler auto-injects:
-
-1. **Frontmatter** - Name and description from metadata
-2. **Activation Block** - Steps, menu handlers, rules (YOU don't write this)
-3. **Menu Enhancement** - `*help` and `*exit` commands added automatically
-4. **Trigger Prefixing** - Your triggers auto-prefixed with `*`
-
-**Critical:** See [Agent Compilation](./agent-compilation.md) to avoid duplicating auto-injected content.
-
-Source: `tools/cli/lib/agent/compiler.js`

package/docs/modules/bmgd-bmad-game-dev/glossary.md

@@ -1,293 +0,0 @@
-# BMGD Glossary
-
-Key game development terminology used in BMGD workflows.
-
----
-
-## A
-
-### Acceptance Criteria
-
-Specific conditions that must be met for a story to be considered complete. Defines "done" for implementation.
-
-### Act Structure
-
-Story organization into major sections (typically 3 acts: Setup, Confrontation, Resolution).
-
----
-
-## B
-
-### Backlog
-
-List of pending work items (epics, stories) waiting to be scheduled and implemented.
-
-### Boss Design
-
-Design of significant enemy encounters, typically featuring unique mechanics and increased challenge.
-
----
-
-## C
-
-### Character Arc
-
-The transformation a character undergoes through the story, from initial state to final state.
-
-### Core Fantasy
-
-The emotional experience players seek from your game. What they want to FEEL.
-
-### Core Loop
-
-The fundamental cycle of actions players repeat throughout gameplay. The heart of your game.
-
----
-
-## D
-
-### Definition of Done (DoD)
-
-Checklist of requirements that must be satisfied before work is considered complete.
-
-### Design Pillar
-
-Core principle that guides all design decisions. Typically 3-5 pillars define a game's identity.
-
----
-
-## E
-
-### Environmental Storytelling
-
-Narrative communicated through the game world itself—visual details, audio, found documents—rather than explicit dialogue.
-
-### Epic
-
-Large body of work that can be broken down into smaller stories. Represents a major feature or system.
-
----
-
-## F
-
-### Frame Data
-
-In fighting games, the precise timing information for moves (startup, active, recovery frames).
-
-### Frontmatter
-
-YAML metadata at the beginning of markdown files, used for workflow state tracking.
-
----
-
-## G
-
-### Game Brief
-
-Document capturing the game's core vision, pillars, target audience, and scope. Foundation for the GDD.
-
-### Game Design Document (GDD)
-
-Comprehensive document detailing all aspects of game design: mechanics, systems, content, and more.
-
-### Game Type
-
-Genre classification that determines which specialized GDD sections are included.
-
----
-
-## H
-
-### Hot Path
-
-Code that executes frequently (every frame). Must be optimized for performance.
-
----
-
-## I
-
-### Idle Progression
-
-Game mechanics where progress continues even when the player isn't actively playing.
-
----
-
-## K
-
-### Kishotenketsu
-
-Four-act story structure from East Asian narrative tradition (Introduction, Development, Twist, Conclusion).
-
----
-
-## L
-
-### Localization
-
-Adapting game content for different languages and cultures.
-
----
-
-## M
-
-### MDA Framework
-
-Mechanics → Dynamics → Aesthetics. Framework for analyzing and designing games.
-
-### Meta-Progression
-
-Persistent progression that carries between individual runs or sessions.
-
-### Metroidvania
-
-Genre featuring interconnected world exploration with ability-gated progression.
-
----
-
-## N
-
-### Narrative Complexity
-
-How central story is to the game experience (Critical, Heavy, Moderate, Light).
-
-### Netcode
-
-Networking code handling multiplayer communication and synchronization.
-
----
-
-## P
-
-### Permadeath
-
-Game mechanic where character death is permanent, typically requiring a new run.
-
-### Player Agency
-
-The degree to which players can make meaningful choices that affect outcomes.
-
-### Procedural Generation
-
-Algorithmic creation of game content (levels, items, characters) rather than hand-crafted.
-
----
-
-## R
-
-### Retrospective
-
-Team meeting after completing work to reflect on what went well and what to improve.
-
-### Roguelike
-
-Genre featuring procedural generation, permadeath, and run-based progression.
-
-### Run
-
-A single playthrough in a roguelike or run-based game, from start to death/completion.
-
----
-
-## S
-
-### Sprint
-
-Time-boxed period of development work, typically 1-2 weeks.
-
-### Sprint Status
-
-Tracking document showing current sprint progress, story states, and blockers.
-
-### Story
-
-Smallest unit of implementable work with clear acceptance criteria. Part of an epic.
-
-### Story Context
-
-Assembled documentation and code context needed to implement a specific story.
-
-### Story Gates
-
-Points where story progression is blocked until certain gameplay conditions are met.
-
----
-
-## T
-
-### Tech Spec
-
-Technical specification document detailing how a feature will be implemented.
-
-### TDD (Test-Driven Development)
-
-Development approach: write tests first, then implement code to pass them.
-
----
-
-## U
-
-### UI/UX
-
-User Interface / User Experience. How players interact with and experience the game.
-
----
-
-## V
-
-### Visual Novel
-
-Genre focused on narrative with static images, dialogue, and player choices.
-
-### Voice Acting
-
-Recorded spoken dialogue for game characters.
-
----
-
-## W
-
-### Workflow
-
-Structured process for completing a specific type of work (e.g., GDD creation, story implementation).
-
-### Workflow Status
-
-Current state of project workflows, tracking which phases and documents are complete.
-
-### World Building
-
-Creation of the game's setting, including history, culture, geography, and lore.
-
----
-
-## BMGD-Specific Terms
-
-### A/P/C Menu
-
-Options presented after content generation:
-
-- **A** - Advanced Elicitation (explore deeper)
-- **P** - Party Mode (multi-agent discussion)
-- **C** - Continue (save and proceed)
-
-### Narrative Complexity Levels
-
-- **Critical** - Story IS the game (visual novels)
-- **Heavy** - Deep narrative with gameplay (RPGs)
-- **Moderate** - Meaningful story supporting gameplay
-- **Light** - Minimal story, gameplay-focused
-
-### Step-File Architecture
-
-BMGD workflow pattern using separate markdown files for each workflow step.
-
-### Workflow-Install Pattern
-
-Phase 4 workflows inherit from BMM base and add BMGD-specific overrides.
-
----
-
-## Next Steps
-
-- **[Quick Start Guide](./quick-start.md)** - Get started with BMGD
-- **[Game Types Guide](./game-types-guide.md)** - Game genre reference

package/docs/modules/bmgd-bmad-game-dev/index.md

@@ -1,175 +0,0 @@
-# BMGD Documentation
-
-Complete guides for the BMad Game Development Module (BMGD) - AI-powered workflows for game design and development that adapt to your project's needs.
-
----
-
-## Getting Started
-
-**New to BMGD?** Start here:
-
-- **[Quick Start Guide](./quick-start.md)** - Get started building your first game
-  - Installation and setup
-  - Understanding the game development phases
-  - Running your first workflows
-  - Agent-based development flow
-
-**Quick Path:** Install BMGD module → Game Brief → GDD → Architecture → Build
-
----
-
-## Core Concepts
-
-Understanding how BMGD works:
-
-- **[Agents Guide](./agents-guide.md)** - Complete reference for game development agents
-  - Game Designer, Game Developer, Game Architect, Game Scrum Master, Game QA, Game Solo Dev
-  - Agent roles and when to use them
-  - Agent workflows and menus
-
-- **[Workflows Guide](./workflows-guide.md)** - Complete workflow reference
-  - Phase 1: Preproduction (Brainstorm, Game Brief)
-  - Phase 2: Design (GDD, Narrative)
-  - Phase 3: Technical (Architecture)
-  - Phase 4: Production (Sprint-based development)
-
-- **[Game Types Guide](./game-types-guide.md)** - Selecting and using game type templates
-  - 24 supported game types
-  - Genre-specific GDD sections
-  - Hybrid game type handling
-
-- **[Quick-Flow Guide](./quick-flow-guide.md)** - Fast-track workflows for rapid development
-  - Quick-Prototype for testing ideas
-  - Quick-Dev for flexible implementation
-  - When to use quick-flow vs full BMGD
-
----
-
-## Quick References
-
-Essential reference materials:
-
-- **[Glossary](./glossary.md)** - Key game development terminology
-
----
-
-## Choose Your Path
-
-### I need to...
-
-**Start a new game project**
-→ Start with [Quick Start Guide](./quick-start.md)
-→ Run `brainstorm-game` for ideation
-→ Create a Game Brief with `create-brief`
-
-**Design my game**
-→ Create a GDD with `create-gdd`
-→ If story-heavy, add Narrative Design with `create-narrative`
-
-**Plan the technical architecture**
-→ Run `create-architecture` with the Game Architect
-
-**Build my game**
-→ Use Phase 4 production workflows
-→ Follow the sprint-based development cycle
-
-**Quickly test an idea or implement a feature**
-→ Use [Quick-Flow](./quick-flow-guide.md) for rapid prototyping and development
-→ `quick-prototype` to test mechanics, `quick-dev` to implement
-
-**Set up testing and QA**
-→ Use Game QA agent for test framework setup
-→ Run `test-framework` to initialize testing for Unity/Unreal/Godot
-→ Use `test-design` to create test scenarios
-→ Plan playtests with `playtest-plan`
-
-**Understand game type templates**
-→ See [Game Types Guide](./game-types-guide.md)
-
----
-
-## Game Development Phases
-
-BMGD follows four phases aligned with game development:
-
-![BMGD Workflow Overview](./workflow-overview.jpg)
-
-### Phase 1: Preproduction
-
-- **Brainstorm Game** - Ideation with game-specific techniques
-- **Game Brief** - Capture vision, market, and fundamentals
-
-### Phase 2: Design
-
-- **GDD (Game Design Document)** - Comprehensive game design
-- **Narrative Design** - Story, characters, world (for story-driven games)
-
-### Phase 3: Technical
-
-- **Game Architecture** - Engine, systems, patterns, structure
-
-### Phase 4: Production
-
-- **Sprint Planning** - Epic and story management
-- **Story Development** - Implementation workflow
-- **Code Review** - Quality assurance
-- **Testing** - Automated tests, playtesting, performance
-- **Retrospective** - Continuous improvement
-
----
-
-## BMGD vs BMM
-
-BMGD extends BMM with game-specific capabilities:
-
-| Aspect         | BMM                                   | BMGD                                                                     |
-| -------------- | ------------------------------------- | ------------------------------------------------------------------------ |
-| **Focus**      | General software                      | Game development                                                         |
-| **Agents**     | PM, Architect, Dev, SM, TEA, Solo Dev | Game Designer, Game Dev, Game Architect, Game SM, Game QA, Game Solo Dev |
-| **Planning**   | PRD, Tech Spec                        | Game Brief, GDD                                                          |
-| **Types**      | N/A                                   | 24 game type templates                                                   |
-| **Narrative**  | N/A                                   | Full narrative workflow                                                  |
-| **Testing**    | Web-focused testarch                  | Engine-specific (Unity, Unreal, Godot)                                   |
-| **Production** | Inherited from BMM                    | BMM workflows with game overrides                                        |
-
-BMGD production workflows inherit from BMM and add game-specific checklists and templates.
-
----
-
-## Documentation Map
-
-```
-BMGD Documentation
-├── README.md (this file)
-├── quick-start.md          # Getting started
-├── agents-guide.md         # Agent reference
-├── workflows-guide.md      # Workflow reference
-├── quick-flow-guide.md     # Rapid prototyping and development
-├── game-types-guide.md     # Game type templates
-├── glossary.md             # Terminology
-```
-
----
-
-## External Resources
-
-### Community and Support
-
-- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community
-- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
-- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials
-
-### Related Documentation
-
-- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation
-
-## Tips for Using This Documentation
-
-1. **Start with Quick Start** if you're new to BMGD
-2. **Check Game Types Guide** when creating your GDD
-3. **Reference Glossary** for game development terminology
-4. **Use Troubleshooting** when you encounter issues
-
----
-
-**Ready to make games?** → [Start with the Quick Start Guide](./quick-start.md)