fix: build web bundles with new file extension includsion
This commit is contained in:
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -50,6 +50,10 @@ activation-instructions:
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- Offer to help with game story preparation but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
- 'CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Game Developer Agent'
|
||||
agent:
|
||||
name: Jordan
|
||||
id: game-sm
|
||||
@@ -69,13 +73,6 @@ core_principles:
|
||||
- Focus on One Story at a Time - Complete one before starting next
|
||||
- Game-Specific Context - Understand Phaser 3, game mechanics, and performance requirements
|
||||
- Numbered Options Protocol - Always use numbered lists for selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- CRITICAL: Do NOT automatically execute create-game-story tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with game story preparation but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
- 'CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Game Developer Agent'
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation for game dev advice'
|
||||
@@ -84,12 +81,12 @@ commands:
|
||||
- '*exit" - Say goodbye as the Game Scrum Master, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-game-story
|
||||
- execute-checklist
|
||||
- create-game-story.md
|
||||
- execute-checklist.md
|
||||
templates:
|
||||
- game-story-tmpl
|
||||
- game-story-tmpl.yaml
|
||||
checklists:
|
||||
- game-story-dod-checklist
|
||||
- game-story-dod-checklist.md
|
||||
```
|
||||
==================== END: .bmad-2d-phaser-game-dev/agents/game-sm.md ====================
|
||||
|
||||
@@ -408,243 +405,261 @@ The LLM will:
|
||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||
==================== END: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
|
||||
|
||||
==================== START: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.md ====================
|
||||
# Story: {{Story Title}}
|
||||
|
||||
**Epic:** {{Epic Name}}
|
||||
**Story ID:** {{ID}}
|
||||
**Priority:** {{High|Medium|Low}}
|
||||
**Points:** {{Story Points}}
|
||||
**Status:** Draft
|
||||
|
||||
[[LLM: This template creates detailed game development stories that are immediately actionable by game developers. Each story should focus on a single, implementable feature that contributes to the overall game functionality.
|
||||
|
||||
Before starting, ensure you have access to:
|
||||
|
||||
- Game Design Document (GDD)
|
||||
- Game Architecture Document
|
||||
- Any existing stories in this epic
|
||||
|
||||
The story should be specific enough that a developer can implement it without requiring additional design decisions.]]
|
||||
|
||||
## Description
|
||||
|
||||
[[LLM: Provide a clear, concise description of what this story implements. Focus on the specific game feature or system being built. Reference the GDD section that defines this feature.]]
|
||||
|
||||
{{clear_description_of_what_needs_to_be_implemented}}
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
[[LLM: Define specific, testable conditions that must be met for the story to be considered complete. Each criterion should be verifiable and directly related to gameplay functionality.]]
|
||||
|
||||
### Functional Requirements
|
||||
|
||||
- [ ] {{specific_functional_requirement_1}}
|
||||
- [ ] {{specific_functional_requirement_2}}
|
||||
- [ ] {{specific_functional_requirement_3}}
|
||||
|
||||
### Technical Requirements
|
||||
|
||||
- [ ] Code follows TypeScript strict mode standards
|
||||
- [ ] Maintains 60 FPS on target devices
|
||||
- [ ] No memory leaks or performance degradation
|
||||
- [ ] {{specific_technical_requirement}}
|
||||
|
||||
### Game Design Requirements
|
||||
|
||||
- [ ] {{gameplay_requirement_from_gdd}}
|
||||
- [ ] {{balance_requirement_if_applicable}}
|
||||
- [ ] {{player_experience_requirement}}
|
||||
|
||||
## Technical Specifications
|
||||
|
||||
[[LLM: Provide specific technical details that guide implementation. Include class names, file locations, and integration points based on the game architecture.]]
|
||||
|
||||
### Files to Create/Modify
|
||||
|
||||
**New Files:**
|
||||
|
||||
- `{{file_path_1}}` - {{purpose}}
|
||||
- `{{file_path_2}}` - {{purpose}}
|
||||
|
||||
**Modified Files:**
|
||||
|
||||
- `{{existing_file_1}}` - {{changes_needed}}
|
||||
- `{{existing_file_2}}` - {{changes_needed}}
|
||||
|
||||
### Class/Interface Definitions
|
||||
|
||||
[[LLM: Define specific TypeScript interfaces and class structures needed]]
|
||||
|
||||
```typescript
|
||||
// {{interface_name}}
|
||||
interface {{InterfaceName}} {
|
||||
{{property_1}}: {{type}};
|
||||
{{property_2}}: {{type}};
|
||||
{{method_1}}({{params}}): {{return_type}};
|
||||
}
|
||||
|
||||
// {{class_name}}
|
||||
class {{ClassName}} extends {{PhaseClass}} {
|
||||
private {{property}}: {{type}};
|
||||
|
||||
constructor({{params}}) {
|
||||
// Implementation requirements
|
||||
}
|
||||
|
||||
public {{method}}({{params}}): {{return_type}} {
|
||||
// Method requirements
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Integration Points
|
||||
|
||||
[[LLM: Specify how this feature integrates with existing systems]]
|
||||
|
||||
**Scene Integration:**
|
||||
|
||||
- {{scene_name}}: {{integration_details}}
|
||||
|
||||
**System Dependencies:**
|
||||
|
||||
- {{system_name}}: {{dependency_description}}
|
||||
|
||||
**Event Communication:**
|
||||
|
||||
- Emits: `{{event_name}}` when {{condition}}
|
||||
- Listens: `{{event_name}}` to {{response}}
|
||||
|
||||
## Implementation Tasks
|
||||
|
||||
[[LLM: Break down the implementation into specific, ordered tasks. Each task should be completable in 1-4 hours.]]
|
||||
|
||||
### Dev Agent Record
|
||||
|
||||
**Tasks:**
|
||||
|
||||
- [ ] {{task_1_description}}
|
||||
- [ ] {{task_2_description}}
|
||||
- [ ] {{task_3_description}}
|
||||
- [ ] {{task_4_description}}
|
||||
- [ ] Write unit tests for {{component}}
|
||||
- [ ] Integration testing with {{related_system}}
|
||||
- [ ] Performance testing and optimization
|
||||
|
||||
**Debug Log:**
|
||||
| Task | File | Change | Reverted? |
|
||||
|------|------|--------|-----------|
|
||||
| | | | |
|
||||
|
||||
**Completion Notes:**
|
||||
|
||||
<!-- Only note deviations from requirements, keep under 50 words -->
|
||||
|
||||
**Change Log:**
|
||||
|
||||
<!-- Only requirement changes during implementation -->
|
||||
|
||||
## Game Design Context
|
||||
|
||||
[[LLM: Reference the specific sections of the GDD that this story implements]]
|
||||
|
||||
**GDD Reference:** {{section_name}} ({{page_or_section_number}})
|
||||
|
||||
**Game Mechanic:** {{mechanic_name}}
|
||||
|
||||
**Player Experience Goal:** {{experience_description}}
|
||||
|
||||
**Balance Parameters:**
|
||||
|
||||
- {{parameter_1}}: {{value_or_range}}
|
||||
- {{parameter_2}}: {{value_or_range}}
|
||||
|
||||
## Testing Requirements
|
||||
|
||||
[[LLM: Define specific testing criteria for this game feature]]
|
||||
|
||||
### Unit Tests
|
||||
|
||||
**Test Files:**
|
||||
|
||||
- `tests/{{component_name}}.test.ts`
|
||||
|
||||
**Test Scenarios:**
|
||||
|
||||
- {{test_scenario_1}}
|
||||
- {{test_scenario_2}}
|
||||
- {{edge_case_test}}
|
||||
|
||||
### Game Testing
|
||||
|
||||
**Manual Test Cases:**
|
||||
|
||||
1. {{test_case_1_description}}
|
||||
|
||||
- Expected: {{expected_behavior}}
|
||||
- Performance: {{performance_expectation}}
|
||||
|
||||
2. {{test_case_2_description}}
|
||||
- Expected: {{expected_behavior}}
|
||||
- Edge Case: {{edge_case_handling}}
|
||||
|
||||
### Performance Tests
|
||||
|
||||
**Metrics to Verify:**
|
||||
|
||||
- Frame rate maintains {{fps_target}} FPS
|
||||
- Memory usage stays under {{memory_limit}}MB
|
||||
- {{feature_specific_performance_metric}}
|
||||
|
||||
## Dependencies
|
||||
|
||||
[[LLM: List any dependencies that must be completed before this story can be implemented]]
|
||||
|
||||
**Story Dependencies:**
|
||||
|
||||
- {{story_id}}: {{dependency_description}}
|
||||
|
||||
**Technical Dependencies:**
|
||||
|
||||
- {{system_or_file}}: {{requirement}}
|
||||
|
||||
**Asset Dependencies:**
|
||||
|
||||
- {{asset_type}}: {{asset_description}}
|
||||
- Location: `{{asset_path}}`
|
||||
|
||||
## Definition of Done
|
||||
|
||||
[[LLM: Checklist that must be completed before the story is considered finished]]
|
||||
|
||||
- [ ] All acceptance criteria met
|
||||
- [ ] Code reviewed and approved
|
||||
- [ ] Unit tests written and passing
|
||||
- [ ] Integration tests passing
|
||||
- [ ] Performance targets met
|
||||
- [ ] No linting errors
|
||||
- [ ] Documentation updated
|
||||
- [ ] {{game_specific_dod_item}}
|
||||
|
||||
## Notes
|
||||
|
||||
[[LLM: Any additional context, design decisions, or implementation notes]]
|
||||
|
||||
**Implementation Notes:**
|
||||
|
||||
- {{note_1}}
|
||||
- {{note_2}}
|
||||
|
||||
**Design Decisions:**
|
||||
|
||||
- {{decision_1}}: {{rationale}}
|
||||
- {{decision_2}}: {{rationale}}
|
||||
|
||||
**Future Considerations:**
|
||||
|
||||
- {{future_enhancement_1}}
|
||||
- {{future_optimization_1}}
|
||||
==================== END: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.md ====================
|
||||
==================== START: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
|
||||
template:
|
||||
id: game-story-template-v2
|
||||
name: Game Development Story
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: "stories/{{epic_name}}/{{story_id}}-{{story_name}}.md"
|
||||
title: "Story: {{story_title}}"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: initial-setup
|
||||
instruction: |
|
||||
This template creates detailed game development stories that are immediately actionable by game developers. Each story should focus on a single, implementable feature that contributes to the overall game functionality.
|
||||
|
||||
Before starting, ensure you have access to:
|
||||
|
||||
- Game Design Document (GDD)
|
||||
- Game Architecture Document
|
||||
- Any existing stories in this epic
|
||||
|
||||
The story should be specific enough that a developer can implement it without requiring additional design decisions.
|
||||
|
||||
- id: story-header
|
||||
content: |
|
||||
**Epic:** {{epic_name}}
|
||||
**Story ID:** {{story_id}}
|
||||
**Priority:** {{High|Medium|Low}}
|
||||
**Points:** {{story_points}}
|
||||
**Status:** Draft
|
||||
|
||||
- id: description
|
||||
title: Description
|
||||
instruction: Provide a clear, concise description of what this story implements. Focus on the specific game feature or system being built. Reference the GDD section that defines this feature.
|
||||
template: "{{clear_description_of_what_needs_to_be_implemented}}"
|
||||
|
||||
- id: acceptance-criteria
|
||||
title: Acceptance Criteria
|
||||
instruction: Define specific, testable conditions that must be met for the story to be considered complete. Each criterion should be verifiable and directly related to gameplay functionality.
|
||||
sections:
|
||||
- id: functional-requirements
|
||||
title: Functional Requirements
|
||||
type: checklist
|
||||
items:
|
||||
- "{{specific_functional_requirement}}"
|
||||
- id: technical-requirements
|
||||
title: Technical Requirements
|
||||
type: checklist
|
||||
items:
|
||||
- "Code follows TypeScript strict mode standards"
|
||||
- "Maintains 60 FPS on target devices"
|
||||
- "No memory leaks or performance degradation"
|
||||
- "{{specific_technical_requirement}}"
|
||||
- id: game-design-requirements
|
||||
title: Game Design Requirements
|
||||
type: checklist
|
||||
items:
|
||||
- "{{gameplay_requirement_from_gdd}}"
|
||||
- "{{balance_requirement_if_applicable}}"
|
||||
- "{{player_experience_requirement}}"
|
||||
|
||||
- id: technical-specifications
|
||||
title: Technical Specifications
|
||||
instruction: Provide specific technical details that guide implementation. Include class names, file locations, and integration points based on the game architecture.
|
||||
sections:
|
||||
- id: files-to-modify
|
||||
title: Files to Create/Modify
|
||||
template: |
|
||||
**New Files:**
|
||||
|
||||
- `{{file_path_1}}` - {{purpose}}
|
||||
- `{{file_path_2}}` - {{purpose}}
|
||||
|
||||
**Modified Files:**
|
||||
|
||||
- `{{existing_file_1}}` - {{changes_needed}}
|
||||
- `{{existing_file_2}}` - {{changes_needed}}
|
||||
- id: class-interface-definitions
|
||||
title: Class/Interface Definitions
|
||||
instruction: Define specific TypeScript interfaces and class structures needed
|
||||
type: code
|
||||
language: typescript
|
||||
template: |
|
||||
// {{interface_name}}
|
||||
interface {{interface_name}} {
|
||||
{{property_1}}: {{type}};
|
||||
{{property_2}}: {{type}};
|
||||
{{method_1}}({{params}}): {{return_type}};
|
||||
}
|
||||
|
||||
// {{class_name}}
|
||||
class {{class_name}} extends {{phaser_class}} {
|
||||
private {{property}}: {{type}};
|
||||
|
||||
constructor({{params}}) {
|
||||
// Implementation requirements
|
||||
}
|
||||
|
||||
public {{method}}({{params}}): {{return_type}} {
|
||||
// Method requirements
|
||||
}
|
||||
}
|
||||
- id: integration-points
|
||||
title: Integration Points
|
||||
instruction: Specify how this feature integrates with existing systems
|
||||
template: |
|
||||
**Scene Integration:**
|
||||
|
||||
- {{scene_name}}: {{integration_details}}
|
||||
|
||||
**System Dependencies:**
|
||||
|
||||
- {{system_name}}: {{dependency_description}}
|
||||
|
||||
**Event Communication:**
|
||||
|
||||
- Emits: `{{event_name}}` when {{condition}}
|
||||
- Listens: `{{event_name}}` to {{response}}
|
||||
|
||||
- id: implementation-tasks
|
||||
title: Implementation Tasks
|
||||
instruction: Break down the implementation into specific, ordered tasks. Each task should be completable in 1-4 hours.
|
||||
sections:
|
||||
- id: dev-agent-record
|
||||
title: Dev Agent Record
|
||||
template: |
|
||||
**Tasks:**
|
||||
|
||||
- [ ] {{task_1_description}}
|
||||
- [ ] {{task_2_description}}
|
||||
- [ ] {{task_3_description}}
|
||||
- [ ] {{task_4_description}}
|
||||
- [ ] Write unit tests for {{component}}
|
||||
- [ ] Integration testing with {{related_system}}
|
||||
- [ ] Performance testing and optimization
|
||||
|
||||
**Debug Log:**
|
||||
| Task | File | Change | Reverted? |
|
||||
|------|------|--------|-----------|
|
||||
| | | | |
|
||||
|
||||
**Completion Notes:**
|
||||
|
||||
<!-- Only note deviations from requirements, keep under 50 words -->
|
||||
|
||||
**Change Log:**
|
||||
|
||||
<!-- Only requirement changes during implementation -->
|
||||
|
||||
- id: game-design-context
|
||||
title: Game Design Context
|
||||
instruction: Reference the specific sections of the GDD that this story implements
|
||||
template: |
|
||||
**GDD Reference:** {{section_name}} ({{page_or_section_number}})
|
||||
|
||||
**Game Mechanic:** {{mechanic_name}}
|
||||
|
||||
**Player Experience Goal:** {{experience_description}}
|
||||
|
||||
**Balance Parameters:**
|
||||
|
||||
- {{parameter_1}}: {{value_or_range}}
|
||||
- {{parameter_2}}: {{value_or_range}}
|
||||
|
||||
- id: testing-requirements
|
||||
title: Testing Requirements
|
||||
instruction: Define specific testing criteria for this game feature
|
||||
sections:
|
||||
- id: unit-tests
|
||||
title: Unit Tests
|
||||
template: |
|
||||
**Test Files:**
|
||||
|
||||
- `tests/{{component_name}}.test.ts`
|
||||
|
||||
**Test Scenarios:**
|
||||
|
||||
- {{test_scenario_1}}
|
||||
- {{test_scenario_2}}
|
||||
- {{edge_case_test}}
|
||||
- id: game-testing
|
||||
title: Game Testing
|
||||
template: |
|
||||
**Manual Test Cases:**
|
||||
|
||||
1. {{test_case_1_description}}
|
||||
|
||||
- Expected: {{expected_behavior}}
|
||||
- Performance: {{performance_expectation}}
|
||||
|
||||
2. {{test_case_2_description}}
|
||||
- Expected: {{expected_behavior}}
|
||||
- Edge Case: {{edge_case_handling}}
|
||||
- id: performance-tests
|
||||
title: Performance Tests
|
||||
template: |
|
||||
**Metrics to Verify:**
|
||||
|
||||
- Frame rate maintains {{fps_target}} FPS
|
||||
- Memory usage stays under {{memory_limit}}MB
|
||||
- {{feature_specific_performance_metric}}
|
||||
|
||||
- id: dependencies
|
||||
title: Dependencies
|
||||
instruction: List any dependencies that must be completed before this story can be implemented
|
||||
template: |
|
||||
**Story Dependencies:**
|
||||
|
||||
- {{story_id}}: {{dependency_description}}
|
||||
|
||||
**Technical Dependencies:**
|
||||
|
||||
- {{system_or_file}}: {{requirement}}
|
||||
|
||||
**Asset Dependencies:**
|
||||
|
||||
- {{asset_type}}: {{asset_description}}
|
||||
- Location: `{{asset_path}}`
|
||||
|
||||
- id: definition-of-done
|
||||
title: Definition of Done
|
||||
instruction: Checklist that must be completed before the story is considered finished
|
||||
type: checklist
|
||||
items:
|
||||
- "All acceptance criteria met"
|
||||
- "Code reviewed and approved"
|
||||
- "Unit tests written and passing"
|
||||
- "Integration tests passing"
|
||||
- "Performance targets met"
|
||||
- "No linting errors"
|
||||
- "Documentation updated"
|
||||
- "{{game_specific_dod_item}}"
|
||||
|
||||
- id: notes
|
||||
title: Notes
|
||||
instruction: Any additional context, design decisions, or implementation notes
|
||||
template: |
|
||||
**Implementation Notes:**
|
||||
|
||||
- {{note_1}}
|
||||
- {{note_2}}
|
||||
|
||||
**Design Decisions:**
|
||||
|
||||
- {{decision_1}}: {{rationale}}
|
||||
- {{decision_2}}: {{rationale}}
|
||||
|
||||
**Future Considerations:**
|
||||
|
||||
- {{future_enhancement_1}}
|
||||
- {{future_optimization_1}}
|
||||
==================== END: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
|
||||
|
||||
==================== START: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
|
||||
# Game Development Story Definition of Done Checklist
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -50,6 +50,9 @@ activation-instructions:
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- Offer to help with BMad framework extensions but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
agent:
|
||||
name: The Creator
|
||||
id: bmad-the-creator
|
||||
@@ -69,12 +72,6 @@ core_principles:
|
||||
- Convention Over Configuration - Follow BMad naming and structure patterns
|
||||
- Extensibility First - Design for future expansion and customization
|
||||
- Numbered Options Protocol - Always use numbered lists for user selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- CRITICAL: Do NOT automatically create documents or execute tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with BMad framework extensions but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation for framework design advice'
|
||||
@@ -85,13 +82,13 @@ commands:
|
||||
- '*exit" - Say goodbye as The Creator, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-agent
|
||||
- generate-expansion-pack
|
||||
- advanced-elicitation
|
||||
- create-deep-research-prompt
|
||||
- create-agent.md
|
||||
- generate-expansion-pack.md
|
||||
- advanced-elicitation.md
|
||||
- create-deep-research-prompt.md
|
||||
templates:
|
||||
- agent-tmpl
|
||||
- expansion-pack-plan-tmpl
|
||||
- agent-tmpl.yaml
|
||||
- expansion-pack-plan-tmpl.yaml
|
||||
```
|
||||
==================== END: .bmad-creator-tools/agents/bmad-the-creator.md ====================
|
||||
|
||||
@@ -1745,242 +1742,282 @@ Present these numbered options to the user:
|
||||
- Plan for iterative refinement based on initial findings
|
||||
==================== END: .bmad-creator-tools/tasks/create-deep-research-prompt.md ====================
|
||||
|
||||
==================== START: .bmad-creator-tools/templates/agent-tmpl.md ====================
|
||||
# [AGENT_ID]
|
||||
==================== START: .bmad-creator-tools/templates/agent-tmpl.yaml ====================
|
||||
template:
|
||||
id: agent-template-v2
|
||||
name: Agent Definition
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: "agents/{{agent_id}}.md"
|
||||
title: "{{agent_id}}"
|
||||
|
||||
[[LLM: This is an agent definition template. When creating a new agent:
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
1. ALL dependencies (tasks, templates, checklists, data) MUST exist or be created
|
||||
2. For output generation, use the create-doc pattern with appropriate templates
|
||||
3. Templates should include LLM instructions for guiding users through content creation
|
||||
4. Character personas should be consistent and domain-appropriate
|
||||
5. Follow the numbered options protocol for all user interactions]]
|
||||
sections:
|
||||
- id: header
|
||||
title: "{{agent_id}}"
|
||||
instruction: |
|
||||
This is an agent definition template. When creating a new agent:
|
||||
|
||||
1. ALL dependencies (tasks, templates, checklists, data) MUST exist or be created
|
||||
2. For output generation, use the create-doc pattern with appropriate templates
|
||||
3. Templates should include LLM instructions for guiding users through content creation
|
||||
4. Character personas should be consistent and domain-appropriate
|
||||
5. Follow the numbered options protocol for all user interactions
|
||||
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
- id: agent-definition
|
||||
content: |
|
||||
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
||||
sections:
|
||||
- id: yaml-definition
|
||||
type: code
|
||||
language: yaml
|
||||
template: |
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Command
|
||||
|
||||
agent:
|
||||
name: {{agent_name}}
|
||||
id: {{agent_id}}
|
||||
title: {{agent_title}}
|
||||
customization: {{optional_customization}}
|
||||
|
||||
persona:
|
||||
role: {{agent_role_description}}
|
||||
style: {{communication_style}}
|
||||
identity: {{agent_identity_description}}
|
||||
focus: {{primary_focus_areas}}
|
||||
|
||||
core_principles:
|
||||
- {{principle_1}}
|
||||
- {{principle_2}}
|
||||
- {{principle_3}}
|
||||
# Add more principles as needed
|
||||
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- {{startup_instruction_1}}
|
||||
- {{startup_instruction_2}}
|
||||
|
||||
commands:
|
||||
- "*help" - Show: numbered list of the following commands to allow selection
|
||||
- "*chat-mode" - (Default) {{default_mode_description}}
|
||||
- "*create-doc {template}" - Create doc (no template = show available templates)
|
||||
{{custom_commands}}
|
||||
- "*exit" - Say goodbye as the {{agent_title}}, and then abandon inhabiting this persona
|
||||
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc # Required if agent creates documents from templates
|
||||
{{task_list}}
|
||||
|
||||
templates:
|
||||
{{template_list}}
|
||||
|
||||
checklists:
|
||||
{{checklist_list}}
|
||||
|
||||
data:
|
||||
{{data_list}}
|
||||
|
||||
utils:
|
||||
- template-format # Required if using templates
|
||||
{{util_list}}
|
||||
instruction: |
|
||||
For output generation tasks, always use create-doc with templates rather than custom tasks.
|
||||
Example: Instead of a "create-blueprint" task, use "*create-doc blueprint-tmpl"
|
||||
The template should contain LLM instructions for guiding users through the creation process
|
||||
|
||||
Only create custom tasks for actions that don't produce documents, like analysis, validation, or process execution
|
||||
|
||||
CRITICAL - All dependencies listed here MUST exist in the expansion pack or be created:
|
||||
- Tasks: Must exist in tasks/ directory (include create-doc if using templates)
|
||||
- Templates: Must exist in templates/ directory with proper LLM instructions
|
||||
- Checklists: Must exist in checklists/ directory for quality validation
|
||||
- Data: Must exist in data/ directory or be documented as user-required
|
||||
- Utils: Must exist in utils/ directory (include template-format if using templates)
|
||||
|
||||
```yaml
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
||||
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
||||
- The customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
||||
- Command
|
||||
- id: example
|
||||
title: Example: Construction Contractor Agent
|
||||
type: code
|
||||
language: yaml
|
||||
template: |
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file
|
||||
- Stay in character as Marcus Thompson, Construction Manager
|
||||
- Use numbered options for all interactions
|
||||
agent:
|
||||
name: Marcus Thompson
|
||||
id: construction-contractor
|
||||
title: Construction Project Manager
|
||||
customization: null
|
||||
persona:
|
||||
role: Licensed general contractor with 20 years experience
|
||||
style: Professional, detail-oriented, safety-conscious
|
||||
identity: Former site foreman who worked up to project management
|
||||
focus: Building design, code compliance, project scheduling, cost estimation
|
||||
core_principles:
|
||||
- Safety first - all designs must prioritize worker and occupant safety
|
||||
- Code compliance - ensure all work meets local building codes
|
||||
- Quality craftsmanship - no shortcuts on structural integrity
|
||||
startup:
|
||||
- Greet as Marcus Thompson, Construction Project Manager
|
||||
- Briefly mention your experience and readiness to help
|
||||
- Ask what type of construction project they're planning
|
||||
- DO NOT auto-execute any commands
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands'
|
||||
- '*chat-mode" - Discuss construction projects and provide expertise'
|
||||
- '*create-doc blueprint-tmpl" - Create architectural blueprints'
|
||||
- '*create-doc estimate-tmpl" - Create project cost estimate'
|
||||
- '*create-doc schedule-tmpl" - Create construction schedule'
|
||||
- '*validate-plans" - Review plans for code compliance'
|
||||
- '*safety-assessment" - Evaluate safety considerations'
|
||||
- '*exit" - Say goodbye as Marcus and exit'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- validate-plans
|
||||
- safety-assessment
|
||||
templates:
|
||||
- blueprint-tmpl
|
||||
- estimate-tmpl
|
||||
- schedule-tmpl
|
||||
checklists:
|
||||
- blueprint-checklist
|
||||
- safety-checklist
|
||||
data:
|
||||
- building-codes.md
|
||||
- materials-guide.md
|
||||
utils:
|
||||
- template-format
|
||||
==================== END: .bmad-creator-tools/templates/agent-tmpl.yaml ====================
|
||||
|
||||
agent:
|
||||
name: [AGENT_NAME]
|
||||
id: [AGENT_ID]
|
||||
title: [AGENT_TITLE]
|
||||
customization: [OPTIONAL_CUSTOMIZATION]
|
||||
==================== START: .bmad-creator-tools/templates/expansion-pack-plan-tmpl.yaml ====================
|
||||
template:
|
||||
id: expansion-pack-plan-template-v2
|
||||
name: Expansion Pack Plan
|
||||
version: 2.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: "{{pack_name}}-expansion-pack-plan.md"
|
||||
title: "{{pack_display_name}} Expansion Pack Plan"
|
||||
|
||||
persona:
|
||||
role: [AGENT_ROLE_DESCRIPTION]
|
||||
style: [COMMUNICATION_STYLE]
|
||||
identity: [AGENT_IDENTITY_DESCRIPTION]
|
||||
focus: [PRIMARY_FOCUS_AREAS]
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
core_principles:
|
||||
- [PRINCIPLE_1]
|
||||
- [PRINCIPLE_2]
|
||||
- [PRINCIPLE_3]
|
||||
# Add more principles as needed
|
||||
sections:
|
||||
- id: overview
|
||||
title: Overview
|
||||
template: |
|
||||
- **Pack Name**: {{pack_identifier}}
|
||||
- **Display Name**: {{full_expansion_pack_name}}
|
||||
- **Description**: {{brief_description}}
|
||||
- **Target Domain**: {{industry_domain}}
|
||||
- **Author**: {{author_name_organization}}
|
||||
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- [STARTUP_INSTRUCTION]
|
||||
- [STARTUP_INSTRUCTION]...
|
||||
- id: problem-statement
|
||||
title: Problem Statement
|
||||
instruction: What specific challenges does this expansion pack solve?
|
||||
template: "{{problem_description}}"
|
||||
|
||||
commands:
|
||||
- "*help" - Show: numbered list of the following commands to allow selection
|
||||
- "*chat-mode" - (Default) [DEFAULT_MODE_DESCRIPTION]
|
||||
- "*create-doc {template}" - Create doc (no template = show available templates)
|
||||
[[LLM: For output generation tasks, always use create-doc with templates rather than custom tasks.
|
||||
Example: Instead of a "create-blueprint" task, use "*create-doc blueprint-tmpl"
|
||||
The template should contain LLM instructions for guiding users through the creation process]]
|
||||
- [tasks] specific to the agent that are not covered by a template
|
||||
[[LLM: Only create custom tasks for actions that don't produce documents, like analysis, validation, or process execution]]
|
||||
- "*exit" - Say goodbye as the [AGENT_TITLE], and then abandon inhabiting this persona
|
||||
- id: target-users
|
||||
title: Target Users
|
||||
instruction: Who will benefit from this expansion pack?
|
||||
template: "{{target_user_description}}"
|
||||
|
||||
dependencies:
|
||||
[[LLM: CRITICAL - All dependencies listed here MUST exist in the expansion pack or be created:
|
||||
- Tasks: Must exist in tasks/ directory (include create-doc if using templates)
|
||||
- Templates: Must exist in templates/ directory with proper LLM instructions
|
||||
- Checklists: Must exist in checklists/ directory for quality validation
|
||||
- Data: Must exist in data/ directory or be documented as user-required
|
||||
- Utils: Must exist in utils/ directory (include template-format if using templates)]]
|
||||
- id: components
|
||||
title: Components to Create
|
||||
sections:
|
||||
- id: agents
|
||||
title: Agents
|
||||
type: checklist
|
||||
instruction: List all agents to be created with their roles and dependencies
|
||||
items:
|
||||
- id: orchestrator
|
||||
template: |
|
||||
`{{pack_name}}-orchestrator` - **REQUIRED**: Master orchestrator for {{domain}} workflows
|
||||
- Key commands: {{command_list}}
|
||||
- Manages: {{orchestration_scope}}
|
||||
- id: agent-list
|
||||
repeatable: true
|
||||
template: |
|
||||
`{{agent_name}}` - {{role_description}}
|
||||
- Tasks used: {{task_list}}
|
||||
- Templates used: {{template_list}}
|
||||
- Data required: {{data_requirements}}
|
||||
|
||||
- id: tasks
|
||||
title: Tasks
|
||||
type: checklist
|
||||
instruction: List all tasks to be created
|
||||
repeatable: true
|
||||
template: "`{{task_name}}.md` - {{purpose}} (used by: {{using_agents}})"
|
||||
|
||||
- id: templates
|
||||
title: Templates
|
||||
type: checklist
|
||||
instruction: List all templates to be created
|
||||
repeatable: true
|
||||
template: "`{{template_name}}-tmpl.md` - {{document_type}} (used by: {{using_components}})"
|
||||
|
||||
- id: checklists
|
||||
title: Checklists
|
||||
type: checklist
|
||||
instruction: List all checklists to be created
|
||||
repeatable: true
|
||||
template: "`{{checklist_name}}-checklist.md` - {{validation_purpose}}"
|
||||
|
||||
- id: data-files
|
||||
title: Data Files Required from User
|
||||
instruction: |
|
||||
Users must add these files to `bmad-core/data/`:
|
||||
type: checklist
|
||||
repeatable: true
|
||||
template: |
|
||||
`{{data_filename}}.{{extension}}` - {{content_description}}
|
||||
- Format: {{file_format}}
|
||||
- Purpose: {{why_needed}}
|
||||
- Example: {{brief_example}}
|
||||
|
||||
tasks:
|
||||
- create-doc # Required if agent creates documents from templates
|
||||
- [TASK_1] # Custom task for non-document operations
|
||||
- [TASK_2] # Another custom task
|
||||
[[LLM: Example tasks: validate-design, analyze-requirements, execute-tests]]
|
||||
- id: workflow-overview
|
||||
title: Workflow Overview
|
||||
type: numbered-list
|
||||
instruction: Describe the typical workflow steps
|
||||
template: "{{workflow_step}}"
|
||||
|
||||
templates:
|
||||
- [TEMPLATE_1] # Template with LLM instructions for guided creation
|
||||
- [TEMPLATE_2] # Another template for different document type
|
||||
[[LLM: Example: blueprint-tmpl, contract-tmpl, report-tmpl
|
||||
Each template should include [[LLM: guidance]] and other conventions from `template-format.md` sections for user interaction]]
|
||||
- id: integration-points
|
||||
title: Integration Points
|
||||
template: |
|
||||
- Depends on core agents: {{core_agent_dependencies}}
|
||||
- Extends teams: {{team_updates}}
|
||||
|
||||
checklists:
|
||||
- [CHECKLIST_1] # Quality validation for template outputs
|
||||
[[LLM: Example: blueprint-checklist, contract-checklist
|
||||
Checklists validate documents created from templates]]
|
||||
- id: success-criteria
|
||||
title: Success Criteria
|
||||
type: checklist
|
||||
items:
|
||||
- "All components created and cross-referenced"
|
||||
- "No orphaned task/template references"
|
||||
- "Data requirements clearly documented"
|
||||
- "Orchestrator provides clear workflow"
|
||||
- "README includes setup instructions"
|
||||
|
||||
data:
|
||||
- [DATA_1] # Domain knowledge files
|
||||
[[LLM: Example: building-codes.md, legal-terminology.md
|
||||
Can be embedded in pack or required from user]]
|
||||
- id: user-approval
|
||||
title: User Approval
|
||||
type: checklist
|
||||
items:
|
||||
- "Plan reviewed by user"
|
||||
- "Approval to proceed with implementation"
|
||||
|
||||
utils:
|
||||
- template-format # Required if using templates
|
||||
- [UTIL_1] # Other utilities as needed
|
||||
[[LLM: Include workflow-management if agent participates in workflows]]
|
||||
```
|
||||
|
||||
@{example: Construction Contractor Agent}
|
||||
|
||||
```yaml
|
||||
activation-instructions:
|
||||
- Follow all instructions in this file
|
||||
- Stay in character as Marcus Thompson, Construction Manager
|
||||
- Use numbered options for all interactions
|
||||
agent:
|
||||
name: Marcus Thompson
|
||||
id: construction-contractor
|
||||
title: Construction Project Manager
|
||||
customization: null
|
||||
persona:
|
||||
role: Licensed general contractor with 20 years experience
|
||||
style: Professional, detail-oriented, safety-conscious
|
||||
identity: Former site foreman who worked up to project management
|
||||
focus: Building design, code compliance, project scheduling, cost estimation
|
||||
core_principles:
|
||||
- Safety first - all designs must prioritize worker and occupant safety
|
||||
- Code compliance - ensure all work meets local building codes
|
||||
- Quality craftsmanship - no shortcuts on structural integrity
|
||||
startup:
|
||||
- Greet as Marcus Thompson, Construction Project Manager
|
||||
- Briefly mention your experience and readiness to help
|
||||
- Ask what type of construction project they're planning
|
||||
- DO NOT auto-execute any commands
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands'
|
||||
- '*chat-mode" - Discuss construction projects and provide expertise'
|
||||
- '*create-doc blueprint-tmpl" - Create architectural blueprints'
|
||||
- '*create-doc estimate-tmpl" - Create project cost estimate'
|
||||
- '*create-doc schedule-tmpl" - Create construction schedule'
|
||||
- '*validate-plans" - Review plans for code compliance'
|
||||
- '*safety-assessment" - Evaluate safety considerations'
|
||||
- '*exit" - Say goodbye as Marcus and exit'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-doc
|
||||
- validate-plans
|
||||
- safety-assessment
|
||||
templates:
|
||||
- blueprint-tmpl
|
||||
- estimate-tmpl
|
||||
- schedule-tmpl
|
||||
checklists:
|
||||
- blueprint-checklist
|
||||
- safety-checklist
|
||||
data:
|
||||
- building-codes.md
|
||||
- materials-guide.md
|
||||
utils:
|
||||
- template-format
|
||||
```
|
||||
==================== END: .bmad-creator-tools/templates/agent-tmpl.md ====================
|
||||
|
||||
==================== START: .bmad-creator-tools/templates/expansion-pack-plan-tmpl.md ====================
|
||||
# {Pack Name} Expansion Pack Plan
|
||||
|
||||
## Overview
|
||||
|
||||
- **Pack Name**: {pack-identifier}
|
||||
- **Display Name**: {Full Expansion Pack Name}
|
||||
- **Description**: {Brief description of what this pack does}
|
||||
- **Target Domain**: {Industry/domain this serves}
|
||||
- **Author**: {Your name/organization}
|
||||
|
||||
## Problem Statement
|
||||
|
||||
{What specific challenges does this expansion pack solve?}
|
||||
|
||||
## Target Users
|
||||
|
||||
{Who will benefit from this expansion pack?}
|
||||
|
||||
## Components to Create
|
||||
|
||||
### Agents
|
||||
|
||||
- [ ] `{pack-name}-orchestrator` - **REQUIRED**: Master orchestrator for {domain} workflows
|
||||
- Key commands: {list main commands}
|
||||
- Manages: {what it orchestrates}
|
||||
- [ ] `{agent-1-name}` - {Role description}
|
||||
- Tasks used: {task-1}, {task-2}
|
||||
- Templates used: {template-1}
|
||||
- Data required: {data-file-1}
|
||||
- [ ] `{agent-2-name}` - {Role description}
|
||||
- Tasks used: {task-3}
|
||||
- Templates used: {template-2}
|
||||
- Data required: {data-file-2}
|
||||
|
||||
### Tasks
|
||||
|
||||
- [ ] `{task-1}.md` - {Purpose} (used by: {agent})
|
||||
- [ ] `{task-2}.md` - {Purpose} (used by: {agent})
|
||||
- [ ] `{task-3}.md` - {Purpose} (used by: {agent})
|
||||
|
||||
### Templates
|
||||
|
||||
- [ ] `{template-1}-tmpl.md` - {Document type} (used by: {agent/task})
|
||||
- [ ] `{template-2}-tmpl.md` - {Document type} (used by: {agent/task})
|
||||
|
||||
### Checklists
|
||||
|
||||
- [ ] `{checklist-1}-checklist.md` - {What it validates}
|
||||
- [ ] `{checklist-2}-checklist.md` - {What it validates}
|
||||
|
||||
### Data Files Required from User
|
||||
|
||||
Users must add these files to `bmad-core/data/`:
|
||||
|
||||
- [ ] `{data-file-1}.{ext}` - {Description of required content}
|
||||
- Format: {file format}
|
||||
- Purpose: {why needed}
|
||||
- Example: {brief example}
|
||||
- [ ] `{data-file-2}.{ext}` - {Description of required content}
|
||||
- Format: {file format}
|
||||
- Purpose: {why needed}
|
||||
- Example: {brief example}
|
||||
|
||||
## Workflow Overview
|
||||
|
||||
1. {Step 1 - typically starts with orchestrator}
|
||||
2. {Step 2}
|
||||
3. {Step 3}
|
||||
4. {Final output/deliverable}
|
||||
|
||||
## Integration Points
|
||||
|
||||
- Depends on core agents: {list any core BMad agents used}
|
||||
- Extends teams: {which teams to update}
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- [ ] All components created and cross-referenced
|
||||
- [ ] No orphaned task/template references
|
||||
- [ ] Data requirements clearly documented
|
||||
- [ ] Orchestrator provides clear workflow
|
||||
- [ ] README includes setup instructions
|
||||
|
||||
## User Approval
|
||||
|
||||
- [ ] Plan reviewed by user
|
||||
- [ ] Approval to proceed with implementation
|
||||
|
||||
---
|
||||
|
||||
**Next Steps**: Once approved, proceed with Phase 3 implementation starting with the orchestrator agent.
|
||||
==================== END: .bmad-creator-tools/templates/expansion-pack-plan-tmpl.md ====================
|
||||
- id: next-steps
|
||||
content: |
|
||||
---
|
||||
|
||||
**Next Steps**: Once approved, proceed with Phase 3 implementation starting with the orchestrator agent.
|
||||
==================== END: .bmad-creator-tools/templates/expansion-pack-plan-tmpl.yaml ====================
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user