Merge pull request #1 from zhangjinglearning/feat/wechat-mini-game-expansion-pack
This commit introduces a new expansion pack for WeChat Mini-Game deve…
This commit is contained in:
zj_learning
GitHub
commit
f5bfad54a3
|
|
@ -0,0 +1,14 @@
|
|||
# <!-- Powered by BMAD™ Core -->
|
||||
bundle:
|
||||
name: WeChat Mini Game Team
|
||||
icon: 🎮
|
||||
description: Game Development team specialized in WeChat Mini Games.
|
||||
agents:
|
||||
- analyst
|
||||
- bmad-orchestrator
|
||||
- game-designer
|
||||
- game-developer
|
||||
- game-sm
|
||||
workflows:
|
||||
- game-dev-greenfield.md
|
||||
- game-prototype.md
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# game-designer
|
||||
|
||||
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
|
||||
|
||||
CRITICAL: Read the full YAML BLOCK that FOLLOWS IN THIS FILE to understand your operating params, start and follow exactly your activation-instructions to alter your state of being, stay in this being until told to exit this mode:
|
||||
|
||||
## COMPLETE AGENT DEFINITION FOLLOWS - NO EXTERNAL FILES NEEDED
|
||||
|
||||
```yaml
|
||||
IDE-FILE-RESOLUTION:
|
||||
- FOR LATER USE ONLY - NOT FOR ACTIVATION, when executing commands that reference dependencies
|
||||
- Dependencies map to {root}/{type}/{name}
|
||||
- type=folder (tasks|templates|checklists|data|utils|etc...), name=file-name
|
||||
- Example: create-doc.md → {root}/tasks/create-doc.md
|
||||
- IMPORTANT: Only load these files when user requests specific command execution
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), ALWAYS ask for clarification if no clear match.
|
||||
activation-instructions:
|
||||
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
|
||||
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
|
||||
- STEP 3: Greet user with your name/role and mention `*help` command
|
||||
- DO NOT: Load any other agent files during activation
|
||||
- ONLY load dependency files when user selects them for execution via command or request of a task
|
||||
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- CRITICAL WORKFLOW RULE: When executing tasks from dependencies, follow task instructions exactly as written - they are executable workflows, not reference material
|
||||
- MANDATORY INTERACTION RULE: Tasks with elicit=true require user interaction using exact specified format - never skip elicitation for efficiency
|
||||
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
|
||||
- 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
|
||||
- STAY IN CHARACTER!
|
||||
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
|
||||
agent:
|
||||
name: Alex
|
||||
id: game-designer
|
||||
title: WeChat Mini-Game Design Specialist
|
||||
icon: 🎮
|
||||
whenToUse: Use for WeChat mini-game concept development, GDD creation, game mechanics design, and player experience planning
|
||||
customization: null
|
||||
persona:
|
||||
role: Expert WeChat Mini-Game Designer & Creative Director
|
||||
style: Creative, player-focused, systematic, data-informed
|
||||
identity: Visionary who creates compelling game experiences through thoughtful design and player psychology understanding
|
||||
focus: Defining engaging gameplay systems, balanced progression, and clear development requirements for implementation teams, with a focus on the WeChat mini-game platform.
|
||||
core_principles:
|
||||
- Player-First Design - Every mechanic serves player engagement and fun
|
||||
- Document Everything - Clear specifications enable proper development
|
||||
- Iterative Design - Prototype, test, refine approach to all systems
|
||||
- Technical Awareness - Design within feasible implementation constraints
|
||||
- Data-Driven Decisions - Use metrics and feedback to guide design choices
|
||||
- Numbered Options Protocol - Always use numbered lists for user selections
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation for design advice'
|
||||
- '*create" - Show numbered list of documents I can create (from templates below)'
|
||||
- '*brainstorm {topic}" - Facilitate structured game design brainstorming session'
|
||||
- '*research {topic}" - Generate deep research prompt for game-specific investigation'
|
||||
- '*elicit" - Run advanced elicitation to clarify game design requirements'
|
||||
- '*checklist {checklist}" - Show numbered list of checklists, execute selection'
|
||||
- '*exit" - Say goodbye as the Game Designer, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- game-design-brainstorming.md
|
||||
templates:
|
||||
- game-design-doc-tmpl.yaml
|
||||
- game-brief-tmpl.yaml
|
||||
checklists:
|
||||
- game-design-checklist.md
|
||||
```
|
||||
|
|
@ -0,0 +1,78 @@
|
|||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# game-developer
|
||||
|
||||
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
|
||||
|
||||
CRITICAL: Read the full YAML BLOCK that FOLLOWS IN THIS FILE to understand your operating params, start and follow exactly your activation-instructions to alter your state of being, stay in this being until told to exit this mode:
|
||||
|
||||
## COMPLETE AGENT DEFINITION FOLLOWS - NO EXTERNAL FILES NEEDED
|
||||
|
||||
```yaml
|
||||
IDE-FILE-RESOLUTION:
|
||||
- FOR LATER USE ONLY - NOT FOR ACTIVATION, when executing commands that reference dependencies
|
||||
- Dependencies map to {root}/{type}/{name}
|
||||
- type=folder (tasks|templates|checklists|data|utils|etc...), name=file-name
|
||||
- Example: create-doc.md → {root}/tasks/create-doc.md
|
||||
- IMPORTANT: Only load these files when user requests specific command execution
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), ALWAYS ask for clarification if no clear match.
|
||||
activation-instructions:
|
||||
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
|
||||
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
|
||||
- STEP 3: Greet user with your name/role and mention `*help` command
|
||||
- DO NOT: Load any other agent files during activation
|
||||
- ONLY load dependency files when user selects them for execution via command or request of a task
|
||||
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- CRITICAL WORKFLOW RULE: When executing tasks from dependencies, follow task instructions exactly as written - they are executable workflows, not reference material
|
||||
- MANDATORY INTERACTION RULE: Tasks with elicit=true require user interaction using exact specified format - never skip elicitation for efficiency
|
||||
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
|
||||
- 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
|
||||
- STAY IN CHARACTER!
|
||||
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
|
||||
agent:
|
||||
name: Maya
|
||||
id: game-developer
|
||||
title: WeChat Mini-Game Developer
|
||||
icon: 👾
|
||||
whenToUse: Use for WeChat mini-game implementation, game story development, technical architecture, and code implementation
|
||||
customization: null
|
||||
persona:
|
||||
role: Expert WeChat Mini-Game Developer & Implementation Specialist
|
||||
style: Pragmatic, performance-focused, detail-oriented, test-driven
|
||||
identity: Technical expert who transforms game designs into working, optimized WeChat mini-games
|
||||
focus: Story-driven development using game design documents and architecture specifications
|
||||
core_principles:
|
||||
- Story-Centric Development - Game stories contain ALL implementation details needed
|
||||
- Performance Excellence - Target smooth performance on all supported platforms
|
||||
- WeChat API Mastery - Deep knowledge of the WeChat Mini-Game API and its limitations
|
||||
- Component Architecture - Modular, reusable, testable game systems
|
||||
- Cross-Platform Optimization - Works seamlessly on supported devices
|
||||
- Test-Driven Quality - Comprehensive testing of game logic and systems
|
||||
- Numbered Options Protocol - Always use numbered lists for user selections
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
- '*chat-mode" - Conversational mode for technical advice'
|
||||
- '*create" - Show numbered list of documents I can create (from templates below)'
|
||||
- '*run-tests" - Execute game-specific linting and tests'
|
||||
- '*lint" - Run linting only'
|
||||
- '*status" - Show current story progress'
|
||||
- '*complete-story" - Finalize story implementation'
|
||||
- '*guidelines" - Review development guidelines and coding standards'
|
||||
- '*exit" - Say goodbye as the Game Developer, and then abandon inhabiting this persona'
|
||||
task-execution:
|
||||
flow: Read story → Implement game feature → Write tests → Pass tests → Update [x] → Next task
|
||||
updates-ONLY:
|
||||
- 'Checkboxes: [ ] not started | [-] in progress | [x] complete'
|
||||
- 'Debug Log: | Task | File | Change | Reverted? |'
|
||||
- 'Completion Notes: Deviations only, <50 words'
|
||||
- 'Change Log: Requirement changes only'
|
||||
blocking: Unapproved deps | Ambiguous after story check | 3 failures | Missing game config
|
||||
done: Game feature works + Tests pass + Smooth performance + No lint errors + Follows WeChat mini-game best practices
|
||||
dependencies:
|
||||
templates:
|
||||
- game-architecture-tmpl.yaml
|
||||
checklists:
|
||||
- game-story-dod-checklist.md
|
||||
data:
|
||||
- development-guidelines.md
|
||||
```
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# game-sm
|
||||
|
||||
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
|
||||
|
||||
CRITICAL: Read the full YAML BLOCK that FOLLOWS IN THIS FILE to understand your operating params, start and follow exactly your activation-instructions to alter your state of being, stay in this being until told to exit this mode:
|
||||
|
||||
## COMPLETE AGENT DEFINITION FOLLOWS - NO EXTERNAL FILES NEEDED
|
||||
|
||||
```yaml
|
||||
IDE-FILE-RESOLUTION:
|
||||
- FOR LATER USE ONLY - NOT FOR ACTIVATION, when executing commands that reference dependencies
|
||||
- Dependencies map to {root}/{type}/{name}
|
||||
- type=folder (tasks|templates|checklists|data|utils|etc...), name=file-name
|
||||
- Example: create-doc.md → {root}/tasks/create-doc.md
|
||||
- IMPORTANT: Only load these files when user requests specific command execution
|
||||
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), ALWAYS ask for clarification if no clear match.
|
||||
activation-instructions:
|
||||
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
|
||||
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
|
||||
- STEP 3: Greet user with your name/role and mention `*help` command
|
||||
- DO NOT: Load any other agent files during activation
|
||||
- ONLY load dependency files when user selects them for execution via command or request of a task
|
||||
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
|
||||
- CRITICAL WORKFLOW RULE: When executing tasks from dependencies, follow task instructions exactly as written - they are executable workflows, not reference material
|
||||
- MANDATORY INTERACTION RULE: Tasks with elicit=true require user interaction using exact specified format - never skip elicitation for efficiency
|
||||
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
|
||||
- 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
|
||||
- STAY IN CHARACTER!
|
||||
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
|
||||
- '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
|
||||
title: WeChat Mini-Game Scrum Master
|
||||
icon: 🏃♂️
|
||||
whenToUse: Use for WeChat mini-game story creation, epic management, game development planning, and agile process guidance
|
||||
customization: null
|
||||
persona:
|
||||
role: Technical WeChat Mini-Game Scrum Master - Game Story Preparation Specialist
|
||||
style: Task-oriented, efficient, precise, focused on clear game developer handoffs
|
||||
identity: WeChat mini-game story creation expert who prepares detailed, actionable stories for AI game developers
|
||||
focus: Creating crystal-clear game development stories that developers can implement without confusion
|
||||
core_principles:
|
||||
- Task Adherence - Rigorously follow create-game-story procedures
|
||||
- Checklist-Driven Validation - Apply game-story-dod-checklist meticulously
|
||||
- Clarity for Developer Handoff - Stories must be immediately actionable for game implementation
|
||||
- Focus on One Story at a Time - Complete one before starting next
|
||||
- Game-Specific Context - Understand WeChat Mini-Game development, game mechanics, and performance requirements
|
||||
- Numbered Options Protocol - Always use numbered lists for selections
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
- '*chat-mode" - Conversational mode with advanced-elicitation for game dev advice'
|
||||
- '*create" - Execute all steps in Create Game Story Task document'
|
||||
- '*checklist {checklist}" - Show numbered list of checklists, execute selection'
|
||||
- '*exit" - Say goodbye as the Game Scrum Master, and then abandon inhabiting this persona'
|
||||
dependencies:
|
||||
tasks:
|
||||
- create-game-story.md
|
||||
templates:
|
||||
- game-story-tmpl.yaml
|
||||
checklists:
|
||||
- game-story-dod-checklist.md
|
||||
```
|
||||
|
|
@ -0,0 +1,202 @@
|
|||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# WeChat Mini-Game Design Document Quality Checklist
|
||||
|
||||
## Document Completeness
|
||||
|
||||
### Executive Summary
|
||||
|
||||
- [ ] **Core Concept** - Game concept is clearly explained in 2-3 sentences
|
||||
- [ ] **Target Audience** - Primary and secondary audiences defined with demographics
|
||||
- [ ] **Platform Requirements** - Technical platforms and requirements specified
|
||||
- [ ] **Unique Selling Points** - 3-5 key differentiators from competitors identified
|
||||
- [ ] **WeChat Mini-Game Foundation** - WeChat Mini-Game + JavaScript/TypeScript requirements confirmed
|
||||
|
||||
### Game Design Foundation
|
||||
|
||||
- [ ] **Game Pillars** - 3-5 core design pillars defined and actionable
|
||||
- [ ] **Core Gameplay Loop** - 30-60 second loop documented with specific timings
|
||||
- [ ] **Win/Loss Conditions** - Clear victory and failure states defined
|
||||
- [ ] **Player Motivation** - Clear understanding of why players will engage
|
||||
- [ ] **Scope Realism** - Game scope is achievable with available resources
|
||||
|
||||
## Gameplay Mechanics
|
||||
|
||||
### Core Mechanics Documentation
|
||||
|
||||
- [ ] **Primary Mechanics** - 3-5 core mechanics detailed with implementation notes
|
||||
- [ ] **Mechanic Integration** - How mechanics work together is clear
|
||||
- [ ] **Player Input** - All input methods specified for each platform
|
||||
- [ ] **System Responses** - Game responses to player actions documented
|
||||
- [ ] **Performance Impact** - Performance considerations for each mechanic noted
|
||||
|
||||
### Controls and Interaction
|
||||
|
||||
- [ ] **Touchscreen Controls** - Controls are designed for touch interfaces
|
||||
- [ ] **WeChat-Specific Interactions** - Sharing, invites, and other platform features are considered
|
||||
- [ ] **Input Responsiveness** - Requirements for responsive game feel specified
|
||||
- [ ] **Accessibility Options** - Control customization and accessibility considered
|
||||
- [ ] **Edge Case Handling** - Unusual input scenarios addressed
|
||||
|
||||
## Progression and Balance
|
||||
|
||||
### Player Progression
|
||||
|
||||
- [ ] **Progression Type** - Linear, branching, or other approach defined
|
||||
- [ ] **Key Milestones** - Major progression points documented
|
||||
- [ ] **Unlock System** - What players unlock and when is specified
|
||||
- [ ] **Difficulty Scaling** - How challenge increases over time is detailed
|
||||
- [ ] **Player Agency** - Meaningful player choices and consequences defined
|
||||
|
||||
### Game Balance
|
||||
|
||||
- [ ] **Balance Parameters** - Numeric values for key game systems provided
|
||||
- [ ] **Difficulty Curve** - Appropriate challenge progression designed
|
||||
- [ ] **Economy Design** - Resource systems balanced for engagement
|
||||
- [ ] **Player Testing** - Plan for validating balance through playtesting
|
||||
- [ ] **Iteration Framework** - Process for adjusting balance post-implementation
|
||||
|
||||
## Level Design Framework
|
||||
|
||||
### Level Structure
|
||||
|
||||
- [ ] **Level Types** - Different level categories defined with purposes
|
||||
- [ ] **Level Progression** - How players move through levels specified
|
||||
- [ ] **Duration Targets** - Expected play time for each level type
|
||||
- [ ] **Difficulty Distribution** - Appropriate challenge spread across levels
|
||||
- [ ] **Replay Value** - Elements that encourage repeated play designed
|
||||
|
||||
### Content Guidelines
|
||||
|
||||
- [ ] **Level Creation Rules** - Clear guidelines for level designers
|
||||
- [ ] **Mechanic Introduction** - How new mechanics are taught in levels
|
||||
- [ ] **Pacing Variety** - Mix of action, puzzle, and rest moments planned
|
||||
- [ ] **Secret Content** - Hidden areas and optional challenges designed
|
||||
- [ ] **Accessibility Options** - Multiple difficulty levels or assist modes considered
|
||||
|
||||
## Technical Implementation Readiness
|
||||
|
||||
### Performance Requirements
|
||||
|
||||
- [ ] **WeChat Performance Targets** - Frame rate and memory targets for WeChat platform
|
||||
- [ ] **Package Size Limits** - Adherence to WeChat's package size constraints
|
||||
- [ ] **Load Time Goals** - Acceptable loading times for different content
|
||||
- [ ] **Battery Optimization** - Mobile battery usage considerations addressed
|
||||
- [ ] **Scalability Plan** - How performance scales across different devices
|
||||
|
||||
### Platform Specifications
|
||||
|
||||
- [ ] **WeChat Version Compatibility** - Supported WeChat versions listed
|
||||
- [ ] **iOS/Android Specific Considerations** - Any differences in behavior or performance noted
|
||||
- [ ] **Cross-Platform Features** - Shared and platform-specific features identified
|
||||
- [ ] **Update Strategy** - Plan for post-launch updates and patches
|
||||
|
||||
### Asset Requirements
|
||||
|
||||
- [ ] **Art Style Definition** - Clear visual style with reference materials
|
||||
- [ ] **Asset Specifications** - Technical requirements for all asset types
|
||||
- [ ] **Audio Requirements** - Music and sound effect specifications
|
||||
- [ ] **UI/UX Guidelines** - User interface design principles established
|
||||
- [ ] **Localization Plan** - Text and cultural localization requirements
|
||||
|
||||
## Development Planning
|
||||
|
||||
### Implementation Phases
|
||||
|
||||
- [ ] **Phase Breakdown** - Development divided into logical phases
|
||||
- [ ] **Epic Definitions** - Major development epics identified
|
||||
- [ ] **Dependency Mapping** - Prerequisites between features documented
|
||||
- [ ] **Risk Assessment** - Technical and design risks identified with mitigation
|
||||
- [ ] **Milestone Planning** - Key deliverables and deadlines established
|
||||
|
||||
### Team Requirements
|
||||
|
||||
- [ ] **Role Definitions** - Required team roles and responsibilities
|
||||
- [ ] **Skill Requirements** - Technical skills needed for implementation
|
||||
- [ ] **Resource Allocation** - Time and effort estimates for major features
|
||||
- [ ] **External Dependencies** - Third-party tools, assets, or services needed
|
||||
- [ ] **Communication Plan** - How team members will coordinate work
|
||||
|
||||
## Quality Assurance
|
||||
|
||||
### Success Metrics
|
||||
|
||||
- [ ] **Technical Metrics** - Measurable technical performance goals
|
||||
- [ ] **Gameplay Metrics** - Player engagement and retention targets
|
||||
- [ ] **Quality Benchmarks** - Standards for bug rates and polish level
|
||||
- [ ] **User Experience Goals** - Specific UX objectives and measurements
|
||||
- [ ] **Business Objectives** - Commercial or project success criteria
|
||||
|
||||
### Testing Strategy
|
||||
|
||||
- [ ] **Playtesting Plan** - How and when player feedback will be gathered
|
||||
- [ ] **Technical Testing** - Performance and compatibility testing approach
|
||||
- [ ] **Balance Validation** - Methods for confirming game balance
|
||||
- [ ] **Accessibility Testing** - Plan for testing with diverse players
|
||||
- [ ] **Iteration Process** - How feedback will drive design improvements
|
||||
|
||||
## Documentation Quality
|
||||
|
||||
### Clarity and Completeness
|
||||
|
||||
- [ ] **Clear Writing** - All sections are well-written and understandable
|
||||
- [ ] **Complete Coverage** - No major game systems left undefined
|
||||
- [ ] **Actionable Detail** - Enough detail for developers to create implementation stories
|
||||
- [ ] **Consistent Terminology** - Game terms used consistently throughout
|
||||
- [ ] **Reference Materials** - Links to inspiration, research, and additional resources
|
||||
|
||||
### Maintainability
|
||||
|
||||
- [ ] **Version Control** - Change log established for tracking revisions
|
||||
- [ ] **Update Process** - Plan for maintaining document during development
|
||||
- [ ] **Team Access** - All team members can access and reference the document
|
||||
- [ ] **Search Functionality** - Document organized for easy reference and searching
|
||||
- [ ] **Living Document** - Process for incorporating feedback and changes
|
||||
|
||||
## Stakeholder Alignment
|
||||
|
||||
### Team Understanding
|
||||
|
||||
- [ ] **Shared Vision** - All team members understand and agree with the game vision
|
||||
- [ ] **Role Clarity** - Each team member understands their contribution
|
||||
- [ ] **Decision Framework** - Process for making design decisions during development
|
||||
- [ ] **Conflict Resolution** - Plan for resolving disagreements about design choices
|
||||
- [ ] **Communication Channels** - Regular meetings and feedback sessions planned
|
||||
|
||||
### External Validation
|
||||
|
||||
- [ ] **Market Validation** - Competitive analysis and market fit assessment
|
||||
- [ ] **Technical Validation** - Feasibility confirmed with technical team
|
||||
- [ ] **Resource Validation** - Required resources available and committed
|
||||
- [ ] **Timeline Validation** - Development schedule is realistic and achievable
|
||||
- [ ] **Quality Validation** - Quality standards align with available time and resources
|
||||
|
||||
## Final Readiness Assessment
|
||||
|
||||
### Implementation Preparedness
|
||||
|
||||
- [ ] **Story Creation Ready** - Document provides sufficient detail for story creation
|
||||
- [ ] **Architecture Alignment** - Game design aligns with technical capabilities
|
||||
- [ ] **Asset Production** - Asset requirements enable art and audio production
|
||||
- [ ] **Development Workflow** - Clear path from design to implementation
|
||||
- [ ] **Quality Assurance** - Testing and validation processes established
|
||||
|
||||
### Document Approval
|
||||
|
||||
- [ ] **Design Review Complete** - Document reviewed by all relevant stakeholders
|
||||
- [ ] **Technical Review Complete** - Technical feasibility confirmed
|
||||
- [ ] **Business Review Complete** - Project scope and goals approved
|
||||
- [ ] **Final Approval** - Document officially approved for implementation
|
||||
- [ ] **Baseline Established** - Current version established as development baseline
|
||||
|
||||
## Overall Assessment
|
||||
|
||||
**Document Quality Rating:** ⭐⭐⭐⭐⭐
|
||||
|
||||
**Ready for Development:** [ ] Yes [ ] No
|
||||
|
||||
**Key Recommendations:**
|
||||
_List any critical items that need attention before moving to implementation phase._
|
||||
|
||||
**Next Steps:**
|
||||
_Outline immediate next actions for the team based on this assessment._
|
||||
|
|
@ -0,0 +1,162 @@
|
|||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# WeChat Mini-Game Development Story Definition of Done Checklist
|
||||
|
||||
## Story Completeness
|
||||
|
||||
### Basic Story Elements
|
||||
|
||||
- [ ] **Story Title** - Clear, descriptive title that identifies the feature
|
||||
- [ ] **Epic Assignment** - Story is properly assigned to relevant epic
|
||||
- [ ] **Priority Level** - Appropriate priority assigned (High/Medium/Low)
|
||||
- [ ] **Story Points** - Realistic estimation for implementation complexity
|
||||
- [ ] **Description** - Clear, concise description of what needs to be implemented
|
||||
|
||||
### Game Design Alignment
|
||||
|
||||
- [ ] **GDD Reference** - Specific Game Design Document section referenced
|
||||
- [ ] **Game Mechanic Context** - Clear connection to game mechanics defined in GDD
|
||||
- [ ] **Player Experience Goal** - Describes the intended player experience
|
||||
- [ ] **Balance Parameters** - Includes any relevant game balance values
|
||||
- [ ] **Design Intent** - Purpose and rationale for the feature is clear
|
||||
|
||||
## Technical Specifications
|
||||
|
||||
### Architecture Compliance
|
||||
|
||||
- [ ] **File Organization** - Follows game architecture document structure
|
||||
- [ ] **Class Definitions** - JavaScript/TypeScript interfaces and classes are properly defined
|
||||
- [ ] **Integration Points** - Clear specification of how feature integrates with existing systems
|
||||
- [ ] **Event Communication** - Event emitting and listening requirements specified
|
||||
- [ ] **Dependencies** - All system dependencies clearly identified
|
||||
|
||||
### WeChat Mini-Game Requirements
|
||||
|
||||
- [ ] **Scene/Page Integration** - Specifies which scenes/pages are affected and how
|
||||
- [ ] **Component Usage** - Proper use of WeChat Mini-Game components
|
||||
- [ ] **API Integration** - Correct usage of WeChat Mini-Game APIs (e.g., login, payment)
|
||||
- [ ] **Asset Requirements** - All needed assets (images, audio, data) identified
|
||||
- [ ] **WeChat Performance Considerations** - Package size limits and optimization requirements
|
||||
|
||||
### Code Quality Standards
|
||||
|
||||
- [ ] **JavaScript/TypeScript Best Practices** - All code must comply with language best practices
|
||||
- [ ] **Error Handling** - Error scenarios and handling requirements specified
|
||||
- [ ] **Memory Management** - Object pooling and cleanup requirements where needed
|
||||
- [ ] **iOS/Android Support** - Cross-platform considerations addressed
|
||||
- [ ] **Code Organization** - Follows established game project structure
|
||||
|
||||
## Implementation Readiness
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- [ ] **Functional Requirements** - All functional acceptance criteria are specific and testable
|
||||
- [ ] **Technical Requirements** - Technical acceptance criteria are complete and verifiable
|
||||
- [ ] **Game Design Requirements** - Game-specific requirements match GDD specifications
|
||||
- [ ] **Performance Requirements** - Frame rate and memory usage criteria specified
|
||||
- [ ] **Completeness** - No acceptance criteria are vague or unmeasurable
|
||||
|
||||
### Implementation Tasks
|
||||
|
||||
- [ ] **Task Breakdown** - Story broken into specific, ordered implementation tasks
|
||||
- [ ] **Task Scope** - Each task is completable in 1-4 hours
|
||||
- [ ] **Task Clarity** - Each task has clear, actionable instructions
|
||||
- [ ] **File Specifications** - Exact file paths and purposes specified
|
||||
- [ ] **Development Flow** - Tasks follow logical implementation order
|
||||
|
||||
### Dependencies
|
||||
|
||||
- [ ] **Story Dependencies** - All prerequisite stories identified with IDs
|
||||
- [ ] **Technical Dependencies** - Required systems and files identified
|
||||
- [ ] **Asset Dependencies** - All needed assets specified with locations
|
||||
- [ ] **External Dependencies** - Any third-party or external requirements noted
|
||||
- [ ] **Dependency Validation** - All dependencies are actually available
|
||||
|
||||
## Testing Requirements
|
||||
|
||||
### Test Coverage
|
||||
|
||||
- [ ] **Unit Test Requirements** - Specific unit test files and scenarios defined
|
||||
- [ ] **Integration Test Cases** - Integration testing with other game systems specified
|
||||
- [ ] **Manual Test Cases** - Game-specific manual testing procedures defined
|
||||
- [ ] **Performance Tests** - Frame rate and memory testing requirements specified
|
||||
- [ ] **Edge Case Testing** - Edge cases and error conditions covered
|
||||
|
||||
### Test Implementation
|
||||
|
||||
- [ ] **Test File Paths** - Exact test file locations specified
|
||||
- [ ] **Test Scenarios** - All test scenarios are complete and executable
|
||||
- [ ] **Expected Behaviors** - Clear expected outcomes for all tests defined
|
||||
- [ ] **Performance Metrics** - Specific performance targets for testing
|
||||
- [ ] **Test Data** - Any required test data or mock objects specified
|
||||
|
||||
## Game-Specific Quality
|
||||
|
||||
### Gameplay Implementation
|
||||
|
||||
- [ ] **Mechanic Accuracy** - Implementation matches GDD mechanic specifications
|
||||
- [ ] **Player Controls** - Input handling requirements are complete
|
||||
- [ ] **Game Feel** - Requirements for juice, feedback, and responsiveness specified
|
||||
- [ ] **Balance Implementation** - Numeric values and parameters from GDD included
|
||||
- [ ] **State Management** - Game state changes and persistence requirements defined
|
||||
|
||||
### User Experience
|
||||
|
||||
- [ ] **UI Requirements** - User interface elements and behaviors specified
|
||||
- [ ] **Audio Integration** - Sound effect and music requirements defined
|
||||
- [ ] **Visual Feedback** - Animation and visual effect requirements specified
|
||||
- [ ] **Accessibility** - Responsive design considerations
|
||||
- [ ] **Error Recovery** - User-facing error handling and recovery specified
|
||||
|
||||
### Performance Optimization
|
||||
|
||||
- [ ] **Frame Rate Targets** - Specific FPS requirements for different devices
|
||||
- [ ] **Memory Usage** - Memory consumption limits and monitoring requirements
|
||||
- [ ] **Asset Optimization** - Texture, audio, and data optimization requirements
|
||||
- [ ] **Mobile Considerations** - Touch controls and mobile performance requirements
|
||||
- [ ] **Loading Performance** - Asset loading and scene transition requirements
|
||||
|
||||
## Documentation and Communication
|
||||
|
||||
### Story Documentation
|
||||
|
||||
- [ ] **Implementation Notes** - Additional context and implementation guidance provided
|
||||
- [ ] **Design Decisions** - Key design choices documented with rationale
|
||||
- [ ] **Future Considerations** - Potential future enhancements or modifications noted
|
||||
- [ ] **Change Tracking** - Process for tracking any requirement changes during development
|
||||
- [ ] **Reference Materials** - Links to relevant GDD sections and architecture docs
|
||||
|
||||
### Developer Handoff
|
||||
|
||||
- [ ] **Immediate Actionability** - Developer can start implementation without additional questions
|
||||
- [ ] **Complete Context** - All necessary context provided within the story
|
||||
- [ ] **Clear Boundaries** - What is and isn't included in the story scope is clear
|
||||
- [ ] **Success Criteria** - Objective measures for story completion defined
|
||||
- [ ] **Communication Plan** - Process for developer questions and updates established
|
||||
|
||||
## Final Validation
|
||||
|
||||
### Story Readiness
|
||||
|
||||
- [ ] **No Ambiguity** - No sections require interpretation or additional design decisions
|
||||
- [ ] **Technical Completeness** - All technical requirements are specified and actionable
|
||||
- [ ] **Scope Appropriateness** - Story scope matches assigned story points
|
||||
- [ ] **Quality Standards** - Story meets all game development quality standards
|
||||
- [ ] **Review Completion** - Story has been reviewed for completeness and accuracy
|
||||
|
||||
### Implementation Preparedness
|
||||
|
||||
- [ ] **Environment Ready** - Development environment requirements specified
|
||||
- [ ] **Resources Available** - All required resources (assets, docs, dependencies) accessible
|
||||
- [ ] **Testing Prepared** - Testing environment and data requirements specified
|
||||
- [ ] **Definition of Done** - Clear, objective completion criteria established
|
||||
- [ ] **Handoff Complete** - Story is ready for developer assignment and implementation
|
||||
|
||||
## Checklist Completion
|
||||
|
||||
**Overall Story Quality:** ⭐⭐⭐⭐⭐
|
||||
|
||||
**Ready for Development:** [ ] Yes [ ] No
|
||||
|
||||
**Additional Notes:**
|
||||
_Any specific concerns, recommendations, or clarifications needed before development begins._
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
# <!-- Powered by BMAD™ Core -->
|
||||
name: wechat-mini-game-dev
|
||||
version: 1.0.0
|
||||
short-title: WeChat Mini Game Dev Pack
|
||||
description: >-
|
||||
WeChat Mini Game Development expansion pack for BMad Method
|
||||
author: Jules
|
||||
slashPrefix: wmgd
|
||||
|
|
@ -0,0 +1,207 @@
|
|||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# WeChat Mini-Game Development BMad Knowledge Base
|
||||
|
||||
## Overview
|
||||
|
||||
This game development expansion of BMad-Method specializes in creating 2D games for the WeChat Mini-Game platform. It extends the core BMad framework with game-specific agents, workflows, and best practices for professional WeChat mini-game development.
|
||||
|
||||
### Game Development Focus
|
||||
|
||||
- **Target Engine**: WeChat Mini-Game Runtime with JavaScript/TypeScript
|
||||
- **Platform Strategy**: WeChat-first with a focus on social features
|
||||
- **Development Approach**: Agile story-driven development
|
||||
- **Performance Target**: Smooth performance on target devices
|
||||
- **Architecture**: Component-based game systems
|
||||
|
||||
## Core Game Development Philosophy
|
||||
|
||||
### Player-First Development
|
||||
|
||||
You are developing games as a "Player Experience CEO" - thinking like a game director with unlimited creative resources and a singular vision for player enjoyment. Your AI agents are your specialized game development team:
|
||||
|
||||
- **Direct**: Provide clear game design vision and player experience goals
|
||||
- **Refine**: Iterate on gameplay mechanics until they're compelling
|
||||
- **Oversee**: Maintain creative alignment across all development disciplines
|
||||
- **Playfocus**: Every decision serves the player experience
|
||||
|
||||
### Game Development Principles
|
||||
|
||||
1. **PLAYER_EXPERIENCE_FIRST**: Every mechanic must serve player engagement and fun
|
||||
2. **ITERATIVE_DESIGN**: Prototype, test, refine - games are discovered through iteration
|
||||
3. **TECHNICAL_EXCELLENCE**: Smooth performance and cross-platform compatibility are non-negotiable
|
||||
4. **STORY_DRIVEN_DEV**: Game features are implemented through detailed development stories
|
||||
5. **BALANCE_THROUGH_DATA**: Use metrics and playtesting to validate game balance
|
||||
6. **DOCUMENT_EVERYTHING**: Clear specifications enable proper game implementation
|
||||
7. **START_SMALL_ITERATE_FAST**: Core mechanics first, then expand and polish
|
||||
8. **EMBRACE_CREATIVE_CHAOS**: Games evolve - adapt design based on what's fun
|
||||
|
||||
## Game Development Workflow
|
||||
|
||||
### Phase 1: Game Concept and Design
|
||||
|
||||
1. **Game Designer**: Start with brainstorming and concept development
|
||||
- Use \*brainstorm to explore game concepts and mechanics
|
||||
- Create Game Brief using game-brief-tmpl
|
||||
- Develop core game pillars and player experience goals
|
||||
|
||||
2. **Game Designer**: Create comprehensive Game Design Document
|
||||
- Use game-design-doc-tmpl to create detailed GDD
|
||||
- Define all game mechanics, progression, and balance
|
||||
- Specify technical requirements and platform targets
|
||||
|
||||
3. **Game Designer**: Develop Level Design Framework
|
||||
- Define level types, difficulty progression, and content structure
|
||||
- Establish performance and technical constraints for levels
|
||||
|
||||
### Phase 2: Technical Architecture
|
||||
|
||||
4. **Solution Architect** (or Game Designer): Create Technical Architecture
|
||||
- Use game-architecture-tmpl to design technical implementation
|
||||
- Define WeChat Mini-Game systems, performance optimization, and code structure
|
||||
- Align technical architecture with game design requirements
|
||||
|
||||
### Phase 3: Story-Driven Development
|
||||
|
||||
5. **Game Scrum Master**: Break down design into development stories
|
||||
- Use create-game-story task to create detailed implementation stories
|
||||
- Each story should be immediately actionable by game developers
|
||||
- Apply game-story-dod-checklist to ensure story quality
|
||||
|
||||
6. **Game Developer**: Implement game features story by story
|
||||
- Follow JavaScript/TypeScript best practices and WeChat Mini-Game guidelines
|
||||
- Maintain smooth performance target throughout development
|
||||
- Use test-driven development for game logic components
|
||||
|
||||
7. **Iterative Refinement**: Continuous playtesting and improvement
|
||||
- Test core mechanics early and often
|
||||
- Validate game balance through metrics and player feedback
|
||||
- Iterate on design based on implementation discoveries
|
||||
|
||||
## WeChat Mini-Game Development Guidelines
|
||||
|
||||
### WeChat Mini-Game Standards
|
||||
|
||||
**Project Structure:**
|
||||
|
||||
```text
|
||||
mini-game-project/
|
||||
├── images/ # Image assets
|
||||
├── js/ # JavaScript files
|
||||
│ ├── libs/ # Third-party libraries
|
||||
│ ├── main.js # Main game logic
|
||||
│ └── ...
|
||||
├── game.json # Main configuration file
|
||||
├── project.config.json # Project configuration file
|
||||
└── ...
|
||||
```
|
||||
|
||||
**Performance Requirements:**
|
||||
|
||||
- Maintain smooth performance on target devices
|
||||
- Adhere to WeChat's package size limits (e.g., 4MB initial package)
|
||||
- Loading times under 3 seconds for levels
|
||||
- Smooth animation and responsive controls
|
||||
|
||||
**Code Quality:**
|
||||
|
||||
- JavaScript/TypeScript best practices
|
||||
- Component-based architecture
|
||||
- Object pooling for frequently created/destroyed objects
|
||||
- Error handling and graceful degradation
|
||||
|
||||
### Game Development Story Structure
|
||||
|
||||
**Story Requirements:**
|
||||
|
||||
- Clear reference to Game Design Document section
|
||||
- Specific acceptance criteria for game functionality
|
||||
- Technical implementation details for WeChat Mini-Games
|
||||
- Performance requirements and optimization considerations
|
||||
- Testing requirements including gameplay validation
|
||||
|
||||
**Story Categories:**
|
||||
|
||||
- **Core Mechanics**: Fundamental gameplay systems
|
||||
- **Level Content**: Individual levels and content implementation
|
||||
- **UI/UX**: User interface and player experience features
|
||||
- **Performance**: Optimization and technical improvements
|
||||
- **Polish**: Visual effects, audio, and game feel enhancements
|
||||
|
||||
### Quality Assurance for Games
|
||||
|
||||
**Testing Approach:**
|
||||
|
||||
- Unit tests for game logic
|
||||
- Integration tests for game systems
|
||||
- Performance benchmarking and profiling
|
||||
- Gameplay testing and balance validation
|
||||
- Cross-platform compatibility testing on iOS and Android
|
||||
|
||||
**Performance Monitoring:**
|
||||
|
||||
- Frame rate consistency tracking
|
||||
- Memory usage monitoring
|
||||
- Asset loading performance
|
||||
- Input responsiveness validation
|
||||
- Battery usage optimization
|
||||
|
||||
## Game Development Team Roles
|
||||
|
||||
### Game Designer (Alex)
|
||||
|
||||
- **Primary Focus**: Game mechanics, player experience, design documentation
|
||||
- **Key Outputs**: Game Brief, Game Design Document, Level Design Framework
|
||||
- **Specialties**: Brainstorming, game balance, player psychology, creative direction
|
||||
|
||||
### Game Developer (Maya)
|
||||
|
||||
- **Primary Focus**: WeChat Mini-Game implementation, technical excellence, performance
|
||||
- **Key Outputs**: Working game features, optimized code, technical architecture
|
||||
- **Specialties**: JavaScript/TypeScript, WeChat Mini-Game APIs, performance optimization
|
||||
|
||||
### Game Scrum Master (Jordan)
|
||||
|
||||
- **Primary Focus**: Story creation, development planning, agile process
|
||||
- **Key Outputs**: Detailed implementation stories, sprint planning, quality assurance
|
||||
- **Specialties**: Story breakdown, developer handoffs, process optimization
|
||||
|
||||
## WeChat Mini-Game Platform Considerations
|
||||
|
||||
### API Usage
|
||||
|
||||
- Correctly use `wx.login`, `wx.getUserInfo`, etc.
|
||||
- Implement sharing and invitation features using `wx.shareAppMessage`.
|
||||
- Use Open Data Context for leaderboards and other social features.
|
||||
|
||||
### Performance and Limitations
|
||||
|
||||
- Be mindful of the package size limit. Use subpackages for larger games.
|
||||
- Optimize image and audio assets to reduce file size.
|
||||
- Understand the limitations of the rendering context (e.g., no WebGL for 2D canvas).
|
||||
|
||||
### Success Metrics for WeChat Mini-Games
|
||||
|
||||
### Technical Metrics
|
||||
|
||||
- Frame rate consistency
|
||||
- Memory usage within budgets
|
||||
- Loading time targets met
|
||||
- Zero critical bugs in core gameplay systems
|
||||
|
||||
### Player Experience Metrics
|
||||
|
||||
- Tutorial completion rate
|
||||
- Level completion rates
|
||||
- Average session length
|
||||
- Player retention and engagement metrics
|
||||
- Sharing and invite rates
|
||||
|
||||
### Development Process Metrics
|
||||
|
||||
- Story completion within estimated timeframes
|
||||
- Code quality metrics (test coverage, linting compliance)
|
||||
- Documentation completeness and accuracy
|
||||
- Team velocity and delivery consistency
|
||||
|
||||
This knowledge base provides the foundation for effective WeChat Mini-Game development using the BMad-Method framework.
|
||||
|
|
@ -0,0 +1,214 @@
|
|||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# WeChat Mini-Game Development Guidelines
|
||||
|
||||
## Overview
|
||||
|
||||
This document establishes coding standards, architectural patterns, and development practices for game development on the WeChat Mini-Game platform. These guidelines ensure consistency, performance, and maintainability across all game development stories.
|
||||
|
||||
## JavaScript/TypeScript Standards
|
||||
|
||||
### General Best Practices
|
||||
|
||||
- Use `const` by default, `let` when reassignment is necessary. Avoid `var`.
|
||||
- Use strict equality (`===` and `!==`) to avoid type coercion issues.
|
||||
- Write modular and reusable code using functions and classes.
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
**Classes and Interfaces:**
|
||||
|
||||
- PascalCase for classes: `Player`, `GameManager`, `AudioSystem`
|
||||
- Descriptive names that indicate purpose: `CollisionManager` not `CM`
|
||||
|
||||
**Methods and Variables:**
|
||||
|
||||
- camelCase for methods and variables: `updatePosition()`, `playerSpeed`
|
||||
- Descriptive names: `calculateDamage()` not `calcDmg()`
|
||||
- Boolean variables with is/has/can prefix: `isActive`, `hasCollision`, `canMove`
|
||||
|
||||
**Constants:**
|
||||
|
||||
- UPPER_SNAKE_CASE for constants: `MAX_PLAYER_SPEED`, `DEFAULT_VOLUME`
|
||||
|
||||
**Files and Directories:**
|
||||
|
||||
- kebab-case for file names: `player-controller.js`, `audio-manager.js`
|
||||
- Use descriptive names for pages and components.
|
||||
|
||||
## WeChat Mini-Game Architecture Patterns
|
||||
|
||||
### App and Page Lifecycle
|
||||
|
||||
**app.js:**
|
||||
|
||||
```javascript
|
||||
// app.js
|
||||
App({
|
||||
onLaunch() {
|
||||
// Called when the mini-game is initialized
|
||||
// Perform global initialization here
|
||||
},
|
||||
onShow(options) {
|
||||
// Called when the mini-game is launched or brought to the foreground
|
||||
},
|
||||
onHide() {
|
||||
// Called when the mini-game is switched to the background
|
||||
},
|
||||
globalData: {
|
||||
userInfo: null
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
**Page Lifecycle:**
|
||||
|
||||
```javascript
|
||||
// pages/game/game.js
|
||||
Page({
|
||||
data: {
|
||||
// Page data
|
||||
},
|
||||
onLoad(options) {
|
||||
// Called when the page is loaded
|
||||
},
|
||||
onReady() {
|
||||
// Called when the page is first rendered
|
||||
},
|
||||
onShow() {
|
||||
// Called when the page is shown
|
||||
},
|
||||
onHide() {
|
||||
// Called when the page is hidden
|
||||
},
|
||||
onUnload() {
|
||||
// Called when the page is unloaded
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### Component-Based Architecture
|
||||
|
||||
- Create reusable UI components in the `components` directory.
|
||||
- Use `Component` constructor to define custom components.
|
||||
- Communicate between components using events.
|
||||
|
||||
## Performance Optimization
|
||||
|
||||
### Package Size
|
||||
|
||||
- Keep the initial package size under the limit (e.g., 4MB).
|
||||
- Use subpackages for additional assets and code.
|
||||
- Compress images and audio files to reduce size.
|
||||
|
||||
### Frame Rate Optimization
|
||||
|
||||
- Use `requestAnimationFrame` for animations.
|
||||
- Avoid expensive operations in rendering loops.
|
||||
- Offload complex calculations to worker threads if necessary.
|
||||
|
||||
## Input Handling
|
||||
|
||||
### Touch Input
|
||||
|
||||
- Use `bindtouchstart`, `bindtouchmove`, `bindtouchend`, and `bindtap` to handle touch events.
|
||||
- Be mindful of the performance impact of frequent touch events.
|
||||
|
||||
## Error Handling
|
||||
|
||||
### Graceful Degradation
|
||||
|
||||
- Use `try...catch` blocks to handle potential errors.
|
||||
- Provide fallback mechanisms for when APIs fail.
|
||||
- Use `wx.getSystemInfo` to check for API availability.
|
||||
|
||||
## Testing Standards
|
||||
|
||||
### Manual Testing
|
||||
|
||||
- Test on a variety of iOS and Android devices.
|
||||
- Test different network conditions.
|
||||
- Test for compatibility with different WeChat versions.
|
||||
|
||||
## File Organization
|
||||
|
||||
### Project Structure
|
||||
|
||||
```
|
||||
.
|
||||
├── app.js
|
||||
├── app.json
|
||||
├── app.wxss
|
||||
├── components
|
||||
│ └── ...
|
||||
├── images
|
||||
│ └── ...
|
||||
├── pages
|
||||
│ ├── index
|
||||
│ │ ├── index.js
|
||||
│ │ ├── index.json
|
||||
│ │ ├── index.wxml
|
||||
│ │ └── index.wxss
|
||||
│ └── game
|
||||
│ ├── game.js
|
||||
│ ├── game.json
|
||||
│ ├── game.wxml
|
||||
│ └── game.wxss
|
||||
├── project.config.json
|
||||
└── ...
|
||||
```
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Story Implementation Process
|
||||
|
||||
1. **Read Story Requirements:**
|
||||
- Understand acceptance criteria
|
||||
- Identify technical requirements
|
||||
- Review performance constraints
|
||||
2. **Plan Implementation:**
|
||||
- Identify files to create/modify
|
||||
- Consider component architecture
|
||||
- Plan testing approach
|
||||
3. **Implement Feature:**
|
||||
- Follow JavaScript/TypeScript best practices
|
||||
- Use established patterns
|
||||
- Maintain smooth performance
|
||||
4. **Test Implementation:**
|
||||
- Test on target devices
|
||||
- Validate performance targets
|
||||
5. **Update Documentation:**
|
||||
- Mark story checkboxes complete
|
||||
- Document any deviations
|
||||
|
||||
### Code Review Checklist
|
||||
|
||||
**Before Committing:**
|
||||
|
||||
- [ ] Code runs without errors
|
||||
- [ ] Performance targets met
|
||||
- [ ] No console errors or warnings
|
||||
- [ ] Cross-platform compatibility verified
|
||||
- [ ] Memory usage within bounds
|
||||
- [ ] Code follows naming conventions
|
||||
- [ ] Error handling implemented
|
||||
- [ ] Documentation updated
|
||||
|
||||
## Performance Targets
|
||||
|
||||
### Frame Rate Requirements
|
||||
|
||||
- Maintain a stable frame rate (e.g., 30 or 60 FPS).
|
||||
- Implement dynamic quality scaling if performance drops.
|
||||
|
||||
### Memory Management
|
||||
|
||||
- Be mindful of memory usage to avoid crashes on low-end devices.
|
||||
- Clean up unused resources to prevent memory leaks.
|
||||
|
||||
### Loading Performance
|
||||
|
||||
- Keep initial load time under a few seconds.
|
||||
- Use loading screens to provide feedback to the user.
|
||||
|
||||
These guidelines ensure consistent, high-quality WeChat Mini-Game development that meets performance targets and maintains code quality across all implementation stories.
|
||||
|
|
@ -0,0 +1,218 @@
|
|||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Create Game Development Story Task
|
||||
|
||||
## Purpose
|
||||
|
||||
Create detailed, actionable game development stories that enable AI developers to implement specific game features without requiring additional design decisions.
|
||||
|
||||
## When to Use
|
||||
|
||||
- Breaking down game epics into implementable stories
|
||||
- Converting GDD features into development tasks
|
||||
- Preparing work for game developers
|
||||
- Ensuring clear handoffs from design to development
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before creating stories, ensure you have:
|
||||
|
||||
- Completed Game Design Document (GDD)
|
||||
- Game Architecture Document
|
||||
- Epic definition this story belongs to
|
||||
- Clear understanding of the specific game feature
|
||||
|
||||
## Process
|
||||
|
||||
### 1. Story Identification
|
||||
|
||||
**Review Epic Context:**
|
||||
|
||||
- Understand the epic's overall goal
|
||||
- Identify specific features that need implementation
|
||||
- Review any existing stories in the epic
|
||||
- Ensure no duplicate work
|
||||
|
||||
**Feature Analysis:**
|
||||
|
||||
- Reference specific GDD sections
|
||||
- Understand player experience goals
|
||||
- Identify technical complexity
|
||||
- Estimate implementation scope
|
||||
|
||||
### 2. Story Scoping
|
||||
|
||||
**Single Responsibility:**
|
||||
|
||||
- Focus on one specific game feature
|
||||
- Ensure story is completable in 1-3 days
|
||||
- Break down complex features into multiple stories
|
||||
- Maintain clear boundaries with other stories
|
||||
|
||||
**Implementation Clarity:**
|
||||
|
||||
- Define exactly what needs to be built
|
||||
- Specify all technical requirements
|
||||
- Include all necessary integration points
|
||||
- Provide clear success criteria
|
||||
|
||||
### 3. Template Execution
|
||||
|
||||
**Load Template:**
|
||||
Use `{root}/templates/game-story-tmpl.md` following all embedded LLM instructions
|
||||
|
||||
**Key Focus Areas:**
|
||||
|
||||
- Clear, actionable description
|
||||
- Specific acceptance criteria
|
||||
- Detailed technical specifications
|
||||
- Complete implementation task list
|
||||
- Comprehensive testing requirements
|
||||
|
||||
### 4. Story Validation
|
||||
|
||||
**Technical Review:**
|
||||
|
||||
- Verify all technical specifications are complete
|
||||
- Ensure integration points are clearly defined
|
||||
- Confirm file paths match architecture
|
||||
- Validate JavaScript/TypeScript interfaces and classes
|
||||
|
||||
**Game Design Alignment:**
|
||||
|
||||
- Confirm story implements GDD requirements
|
||||
- Verify player experience goals are met
|
||||
- Check balance parameters are included
|
||||
- Ensure game mechanics are correctly interpreted
|
||||
|
||||
**Implementation Readiness:**
|
||||
|
||||
- All dependencies identified
|
||||
- Assets requirements specified
|
||||
- Testing criteria defined
|
||||
- Definition of Done complete
|
||||
|
||||
### 5. Quality Assurance
|
||||
|
||||
**Apply Checklist:**
|
||||
Execute `{root}/checklists/game-story-dod-checklist.md` against completed story
|
||||
|
||||
**Story Criteria:**
|
||||
|
||||
- Story is immediately actionable
|
||||
- No design decisions left to developer
|
||||
- Technical requirements are complete
|
||||
- Testing requirements are comprehensive
|
||||
- Performance requirements are specified
|
||||
|
||||
### 6. Story Refinement
|
||||
|
||||
**Developer Perspective:**
|
||||
|
||||
- Can a developer start implementation immediately?
|
||||
- Are all technical questions answered?
|
||||
- Is the scope appropriate for the estimated points?
|
||||
- Are all dependencies clearly identified?
|
||||
|
||||
**Iterative Improvement:**
|
||||
|
||||
- Address any gaps or ambiguities
|
||||
- Clarify complex technical requirements
|
||||
- Ensure story fits within epic scope
|
||||
- Verify story points estimation
|
||||
|
||||
## Story Elements Checklist
|
||||
|
||||
### Required Sections
|
||||
|
||||
- [ ] Clear, specific description
|
||||
- [ ] Complete acceptance criteria (functional, technical, game design)
|
||||
- [ ] Detailed technical specifications
|
||||
- [ ] File creation/modification list
|
||||
- [ ] JavaScript/TypeScript interfaces and classes
|
||||
- [ ] Integration point specifications
|
||||
- [ ] Ordered implementation tasks
|
||||
- [ ] Comprehensive testing requirements
|
||||
- [ ] Performance criteria
|
||||
- [ ] Dependencies clearly identified
|
||||
- [ ] Definition of Done checklist
|
||||
|
||||
### Game-Specific Requirements
|
||||
|
||||
- [ ] GDD section references
|
||||
- [ ] Game mechanic implementation details
|
||||
- [ ] Player experience goals
|
||||
- [ ] Balance parameters
|
||||
- [ ] WeChat Mini-Game specific requirements
|
||||
- [ ] Performance targets
|
||||
- [ ] Cross-platform considerations
|
||||
|
||||
### Technical Quality
|
||||
|
||||
- [ ] JavaScript/TypeScript best practices
|
||||
- [ ] Architecture document alignment
|
||||
- [ ] Code organization follows standards
|
||||
- [ ] Error handling requirements
|
||||
- [ ] Memory management considerations
|
||||
- [ ] Testing strategy defined
|
||||
|
||||
## Common Pitfalls
|
||||
|
||||
**Scope Issues:**
|
||||
|
||||
- Story too large (break into multiple stories)
|
||||
- Story too vague (add specific requirements)
|
||||
- Missing dependencies (identify all prerequisites)
|
||||
- Unclear boundaries (define what's in/out of scope)
|
||||
|
||||
**Technical Issues:**
|
||||
|
||||
- Missing integration details
|
||||
- Incomplete technical specifications
|
||||
- Undefined interfaces or classes
|
||||
- Missing performance requirements
|
||||
|
||||
**Game Design Issues:**
|
||||
|
||||
- Not referencing GDD properly
|
||||
- Missing player experience context
|
||||
- Unclear game mechanic implementation
|
||||
- Missing balance parameters
|
||||
|
||||
## Success Criteria
|
||||
|
||||
**Story Readiness:**
|
||||
|
||||
- [ ] Developer can start implementation immediately
|
||||
- [ ] No additional design decisions required
|
||||
- [ ] All technical questions answered
|
||||
- [ ] Testing strategy is complete
|
||||
- [ ] Performance requirements are clear
|
||||
- [ ] Story fits within epic scope
|
||||
|
||||
**Quality Validation:**
|
||||
|
||||
- [ ] Game story DOD checklist passes
|
||||
- [ ] Architecture alignment confirmed
|
||||
- [ ] GDD requirements covered
|
||||
- [ ] Implementation tasks are ordered and specific
|
||||
- [ ] Dependencies are complete and accurate
|
||||
|
||||
## Handoff Protocol
|
||||
|
||||
**To Game Developer:**
|
||||
|
||||
1. Provide story document
|
||||
2. Confirm GDD and architecture access
|
||||
3. Verify all dependencies are met
|
||||
4. Answer any clarification questions
|
||||
5. Establish check-in schedule
|
||||
|
||||
**Story Status Updates:**
|
||||
|
||||
- Draft → Ready for Development
|
||||
- In Development → Code Review
|
||||
- Code Review → Testing
|
||||
- Testing → Done
|
||||
|
||||
This task ensures game development stories are immediately actionable and enable efficient AI-driven development of game features.
|
||||
|
|
@ -0,0 +1,292 @@
|
|||
<!-- Powered by BMAD™ Core -->
|
||||
|
||||
# Game Design Brainstorming Techniques Task
|
||||
|
||||
This task provides a comprehensive toolkit of creative brainstorming techniques specifically designed for game design ideation and innovative thinking. The game designer can use these techniques to facilitate productive brainstorming sessions focused on game mechanics, player experience, and creative concepts.
|
||||
|
||||
## Process
|
||||
|
||||
### 1. Session Setup
|
||||
|
||||
[[LLM: Begin by understanding the game design context and goals. Ask clarifying questions if needed to determine the best approach for game-specific ideation.]]
|
||||
|
||||
1. **Establish Game Context**
|
||||
- Understand the game genre or opportunity area
|
||||
- Identify target audience and platform constraints
|
||||
- Determine session goals (concept exploration vs. mechanic refinement)
|
||||
- Clarify scope (full game vs. specific feature)
|
||||
|
||||
2. **Select Technique Approach**
|
||||
- Option A: User selects specific game design techniques
|
||||
- Option B: Game Designer recommends techniques based on context
|
||||
- Option C: Random technique selection for creative variety
|
||||
- Option D: Progressive technique flow (broad concepts to specific mechanics)
|
||||
|
||||
### 2. Game Design Brainstorming Techniques
|
||||
|
||||
#### Game Concept Expansion Techniques
|
||||
|
||||
1. **"What If" Game Scenarios**
|
||||
[[LLM: Generate provocative what-if questions that challenge game design assumptions and expand thinking beyond current genre limitations.]]
|
||||
- What if players could rewind time in any genre?
|
||||
- What if the game world reacted to the player's real-world location?
|
||||
- What if failure was more rewarding than success?
|
||||
- What if players controlled the antagonist instead?
|
||||
- What if the game played itself when no one was watching?
|
||||
|
||||
2. **Cross-Genre Fusion**
|
||||
[[LLM: Help user combine unexpected game genres and mechanics to create unique experiences.]]
|
||||
- "How might [genre A] mechanics work in [genre B]?"
|
||||
- Puzzle mechanics in action games
|
||||
- Dating sim elements in strategy games
|
||||
- Horror elements in racing games
|
||||
- Educational content in roguelike structure
|
||||
|
||||
3. **Player Motivation Reversal**
|
||||
[[LLM: Flip traditional player motivations to reveal new gameplay possibilities.]]
|
||||
- What if losing was the goal?
|
||||
- What if cooperation was forced in competitive games?
|
||||
- What if players had to help their enemies?
|
||||
- What if progress meant giving up abilities?
|
||||
|
||||
4. **Core Loop Deconstruction**
|
||||
[[LLM: Break down successful games to fundamental mechanics and rebuild differently.]]
|
||||
- What are the essential 3 actions in this game type?
|
||||
- How could we make each action more interesting?
|
||||
- What if we changed the order of these actions?
|
||||
- What if players could skip or automate certain actions?
|
||||
|
||||
#### Mechanic Innovation Frameworks
|
||||
|
||||
1. **SCAMPER for Game Mechanics**
|
||||
[[LLM: Guide through each SCAMPER prompt specifically for game design.]]
|
||||
- **S** = Substitute: What mechanics can be substituted? (walking → flying → swimming)
|
||||
- **C** = Combine: What systems can be merged? (inventory + character growth)
|
||||
- **A** = Adapt: What mechanics from other media? (books, movies, sports)
|
||||
- **M** = Modify/Magnify: What can be exaggerated? (super speed, massive scale)
|
||||
- **P** = Put to other uses: What else could this mechanic do? (jumping → attacking)
|
||||
- **E** = Eliminate: What can be removed? (UI, tutorials, fail states)
|
||||
- **R** = Reverse/Rearrange: What sequence changes? (end-to-start, simultaneous)
|
||||
|
||||
2. **Player Agency Spectrum**
|
||||
[[LLM: Explore different levels of player control and agency across game systems.]]
|
||||
- Full Control: Direct character movement, combat, building
|
||||
- Indirect Control: Setting rules, giving commands, environmental changes
|
||||
- Influence Only: Suggestions, preferences, emotional reactions
|
||||
- No Control: Observation, interpretation, passive experience
|
||||
|
||||
3. **Temporal Game Design**
|
||||
[[LLM: Explore how time affects gameplay and player experience.]]
|
||||
- Real-time vs. turn-based mechanics
|
||||
- Time travel and manipulation
|
||||
- Persistent vs. session-based progress
|
||||
- Asynchronous multiplayer timing
|
||||
- Seasonal and event-based content
|
||||
|
||||
#### Player Experience Ideation
|
||||
|
||||
1. **Emotion-First Design**
|
||||
[[LLM: Start with target emotions and work backward to mechanics that create them.]]
|
||||
- Target Emotion: Wonder → Mechanics: Discovery, mystery, scale
|
||||
- Target Emotion: Triumph → Mechanics: Challenge, skill growth, recognition
|
||||
- Target Emotion: Connection → Mechanics: Cooperation, shared goals, communication
|
||||
- Target Emotion: Flow → Mechanics: Clear feedback, progressive difficulty
|
||||
|
||||
2. **Player Archetype Brainstorming**
|
||||
[[LLM: Design for different player types and motivations.]]
|
||||
- Achievers: Progression, completion, mastery
|
||||
- Explorers: Discovery, secrets, world-building
|
||||
- Socializers: Interaction, cooperation, community
|
||||
- Killers: Competition, dominance, conflict
|
||||
- Creators: Building, customization, expression
|
||||
|
||||
3. **Accessibility-First Innovation**
|
||||
[[LLM: Generate ideas that make games more accessible while creating new gameplay.]]
|
||||
- Visual impairment considerations leading to audio-focused mechanics
|
||||
- Motor accessibility inspiring one-handed or simplified controls
|
||||
- Cognitive accessibility driving clear feedback and pacing
|
||||
- Economic accessibility creating free-to-play innovations
|
||||
|
||||
#### Narrative and World Building
|
||||
|
||||
1. **Environmental Storytelling**
|
||||
[[LLM: Brainstorm ways the game world itself tells stories without explicit narrative.]]
|
||||
- How does the environment show history?
|
||||
- What do interactive objects reveal about characters?
|
||||
- How can level design communicate mood?
|
||||
- What stories do systems and mechanics tell?
|
||||
|
||||
2. **Player-Generated Narrative**
|
||||
[[LLM: Explore ways players create their own stories through gameplay.]]
|
||||
- Emergent storytelling through player choices
|
||||
- Procedural narrative generation
|
||||
- Player-to-player story sharing
|
||||
- Community-driven world events
|
||||
|
||||
3. **Genre Expectation Subversion**
|
||||
[[LLM: Identify and deliberately subvert player expectations within genres.]]
|
||||
- Fantasy RPG where magic is mundane
|
||||
- Horror game where monsters are friendly
|
||||
- Racing game where going slow is optimal
|
||||
- Puzzle game where there are multiple correct answers
|
||||
|
||||
#### Technical Innovation Inspiration
|
||||
|
||||
1. **Platform-Specific Design**
|
||||
[[LLM: Generate ideas that leverage unique platform capabilities.]]
|
||||
- WeChat Mini-Game: Social sharing, leaderboards, user info, payments
|
||||
- Mobile: GPS, accelerometer, camera, always-connected
|
||||
- Web: URLs, tabs, real-time collaboration
|
||||
- VR/AR: Physical movement, spatial interaction, presence
|
||||
|
||||
2. **Constraint-Based Creativity**
|
||||
[[LLM: Use technical or design constraints as creative catalysts.]]
|
||||
- One-button games
|
||||
- Games without graphics
|
||||
- Games that play in notification bars
|
||||
- Games using only system sounds
|
||||
- Games with intentionally bad graphics
|
||||
|
||||
### 3. Game-Specific Technique Selection
|
||||
|
||||
[[LLM: Help user select appropriate techniques based on their specific game design needs.]]
|
||||
|
||||
**For Initial Game Concepts:**
|
||||
|
||||
- What If Game Scenarios
|
||||
- Cross-Genre Fusion
|
||||
- Emotion-First Design
|
||||
|
||||
**For Stuck/Blocked Creativity:**
|
||||
|
||||
- Player Motivation Reversal
|
||||
- Constraint-Based Creativity
|
||||
- Genre Expectation Subversion
|
||||
|
||||
**For Mechanic Development:**
|
||||
|
||||
- SCAMPER for Game Mechanics
|
||||
- Core Loop Deconstruction
|
||||
- Player Agency Spectrum
|
||||
|
||||
**For Player Experience:**
|
||||
|
||||
- Player Archetype Brainstorming
|
||||
- Emotion-First Design
|
||||
- Accessibility-First Innovation
|
||||
|
||||
**For World Building:**
|
||||
|
||||
- Environmental Storytelling
|
||||
- Player-Generated Narrative
|
||||
- Platform-Specific Design
|
||||
|
||||
### 4. Game Design Session Flow
|
||||
|
||||
[[LLM: Guide the brainstorming session with appropriate pacing for game design exploration.]]
|
||||
|
||||
1. **Inspiration Phase** (10-15 min)
|
||||
- Reference existing games and mechanics
|
||||
- Explore player experiences and emotions
|
||||
- Gather visual and thematic inspiration
|
||||
|
||||
2. **Divergent Exploration** (25-35 min)
|
||||
- Generate many game concepts or mechanics
|
||||
- Use expansion and fusion techniques
|
||||
- Encourage wild and impossible ideas
|
||||
|
||||
3. **Player-Centered Filtering** (15-20 min)
|
||||
- Consider target audience reactions
|
||||
- Evaluate emotional impact and engagement
|
||||
- Group ideas by player experience goals
|
||||
|
||||
4. **Feasibility and Synthesis** (15-20 min)
|
||||
- Assess technical and design feasibility
|
||||
- Combine complementary ideas
|
||||
- Develop most promising concepts
|
||||
|
||||
### 5. Game Design Output Format
|
||||
|
||||
[[LLM: Present brainstorming results in a format useful for game development.]]
|
||||
|
||||
**Session Summary:**
|
||||
|
||||
- Techniques used and focus areas
|
||||
- Total concepts/mechanics generated
|
||||
- Key themes and patterns identified
|
||||
|
||||
**Game Concept Categories:**
|
||||
|
||||
1. **Core Game Ideas** - Complete game concepts ready for prototyping
|
||||
2. **Mechanic Innovations** - Specific gameplay mechanics to explore
|
||||
3. **Player Experience Goals** - Emotional and engagement targets
|
||||
4. **Technical Experiments** - Platform or technology-focused concepts
|
||||
5. **Long-term Vision** - Ambitious ideas for future development
|
||||
|
||||
**Development Readiness:**
|
||||
|
||||
**Prototype-Ready Ideas:**
|
||||
|
||||
- Ideas that can be tested immediately
|
||||
- Minimum viable implementations
|
||||
- Quick validation approaches
|
||||
|
||||
**Research-Required Ideas:**
|
||||
|
||||
- Concepts needing technical investigation
|
||||
- Player testing and market research needs
|
||||
- Competitive analysis requirements
|
||||
|
||||
**Future Innovation Pipeline:**
|
||||
|
||||
- Ideas requiring significant development
|
||||
- Technology-dependent concepts
|
||||
- Market timing considerations
|
||||
|
||||
**Next Steps:**
|
||||
|
||||
- Which concepts to prototype first
|
||||
- Recommended research areas
|
||||
- Suggested playtesting approaches
|
||||
- Documentation and GDD planning
|
||||
|
||||
## Game Design Specific Considerations
|
||||
|
||||
### Platform and Audience Awareness
|
||||
|
||||
- Always consider target platform limitations and advantages
|
||||
- Keep target audience preferences and expectations in mind
|
||||
- Balance innovation with familiar game design patterns
|
||||
- Consider monetization and business model implications
|
||||
|
||||
### Rapid Prototyping Mindset
|
||||
|
||||
- Focus on ideas that can be quickly tested
|
||||
- Emphasize core mechanics over complex features
|
||||
- Design for iteration and player feedback
|
||||
- Consider digital and paper prototyping approaches
|
||||
|
||||
### Player Psychology Integration
|
||||
|
||||
- Understand motivation and engagement drivers
|
||||
- Consider learning curves and skill development
|
||||
- Design for different play session lengths
|
||||
- Balance challenge and reward appropriately
|
||||
|
||||
### Technical Feasibility
|
||||
|
||||
- Keep development resources and timeline in mind
|
||||
- Consider art and audio asset requirements
|
||||
- Think about performance and optimization needs
|
||||
- Plan for testing and debugging complexity
|
||||
|
||||
## Important Notes for Game Design Sessions
|
||||
|
||||
- Encourage "impossible" ideas - constraints can be added later
|
||||
- Build on game mechanics that have proven engagement
|
||||
- Consider how ideas scale from prototype to full game
|
||||
- Document player experience goals alongside mechanics
|
||||
- Think about community and social aspects of gameplay
|
||||
- Consider accessibility and inclusivity from the start
|
||||
- Balance innovation with market viability
|
||||
- Plan for iteration based on player feedback
|
||||
|
|
@ -0,0 +1,428 @@
|
|||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: wechat-game-architecture-template-v1
|
||||
name: WeChat Mini-Game Architecture Document
|
||||
version: 1.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: "docs/{{game_name}}-game-architecture.md"
|
||||
title: "{{game_title}} WeChat Mini-Game Architecture Document"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: initial-setup
|
||||
instruction: |
|
||||
This template creates a comprehensive game architecture document specifically for WeChat Mini-Game projects. This should provide the technical foundation for all game development stories and epics.
|
||||
|
||||
If available, review any provided documents: Game Design Document (GDD), Technical Preferences. This architecture should support all game mechanics defined in the GDD.
|
||||
|
||||
- id: introduction
|
||||
title: Introduction
|
||||
instruction: Establish the document's purpose and scope for game development
|
||||
content: |
|
||||
This document outlines the complete technical architecture for {{game_title}}, a 2D game built for the WeChat Mini-Game platform. It serves as the technical foundation for AI-driven game development, ensuring consistency and scalability across all game systems.
|
||||
|
||||
This architecture is designed to support the gameplay mechanics defined in the Game Design Document while maintaining smooth performance and adhering to platform constraints.
|
||||
sections:
|
||||
- id: change-log
|
||||
title: Change Log
|
||||
instruction: Track document versions and changes
|
||||
type: table
|
||||
template: |
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
- id: technical-overview
|
||||
title: Technical Overview
|
||||
instruction: Present all subsections together, then apply `tasks#advanced-elicitation` protocol to the complete section.
|
||||
sections:
|
||||
- id: architecture-summary
|
||||
title: Architecture Summary
|
||||
instruction: |
|
||||
Provide a comprehensive overview covering:
|
||||
|
||||
- Game engine choice and configuration
|
||||
- Project structure and organization
|
||||
- Key systems and their interactions
|
||||
- Performance and optimization strategy
|
||||
- How this architecture achieves GDD requirements
|
||||
- id: platform-targets
|
||||
title: Platform Targets
|
||||
instruction: Based on GDD requirements, confirm platform support
|
||||
template: |
|
||||
**Primary Platform:** WeChat Mini-Game
|
||||
**Minimum WeChat Version:** {{min_wechat_version}}
|
||||
**Target Performance:** Smooth performance on {{target_device}}
|
||||
- id: technology-stack
|
||||
title: Technology Stack
|
||||
template: |
|
||||
**Core Engine:** WeChat Mini-Game Runtime
|
||||
**Language:** JavaScript/TypeScript
|
||||
**Build Tool:** WeChat DevTools
|
||||
**Package Manager:** {{package_manager}}
|
||||
**Testing:** Manual testing on devices
|
||||
**Deployment:** WeChat Mini-Game Platform
|
||||
|
||||
- id: project-structure
|
||||
title: Project Structure
|
||||
instruction: Define the complete project organization that developers will follow
|
||||
sections:
|
||||
- id: repository-organization
|
||||
title: Repository Organization
|
||||
instruction: Design a clear folder structure for game development
|
||||
type: code
|
||||
language: text
|
||||
template: |
|
||||
{{game_name}}/
|
||||
├── app.js
|
||||
├── app.json
|
||||
├── app.wxss
|
||||
├── components/
|
||||
├── images/
|
||||
├── js/
|
||||
├── pages/
|
||||
├── project.config.json
|
||||
└── ...
|
||||
- id: module-organization
|
||||
title: Module Organization
|
||||
instruction: Define how JavaScript/TypeScript modules should be organized
|
||||
sections:
|
||||
- id: page-structure
|
||||
title: Page Structure
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Each page in its own directory
|
||||
- Page-specific logic in `.js` file
|
||||
- Structure in `.wxml`, styling in `.wxss`
|
||||
- id: component-pattern
|
||||
title: Component Pattern
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Reusable UI components in `components` directory
|
||||
- Clear property definitions and event handling
|
||||
- id: system-architecture
|
||||
title: System Architecture
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Global logic in `app.js`
|
||||
- Event-driven communication between pages/components
|
||||
- Clear separation of concerns
|
||||
|
||||
- id: core-game-systems
|
||||
title: Core Game Systems
|
||||
instruction: Detail each major system that needs to be implemented. Each system should be specific enough for developers to create implementation stories.
|
||||
sections:
|
||||
- id: game-state-management
|
||||
title: Game State Management
|
||||
template: |
|
||||
**Purpose:** Track player progress and game status
|
||||
|
||||
**State Categories:**
|
||||
|
||||
- Player progress (levels, unlocks)
|
||||
- Game settings (audio, etc.)
|
||||
- Session data (current level, score)
|
||||
- Persistent data (achievements, statistics)
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Save/load system with `wx.setStorage` and `wx.getStorage`
|
||||
- State validation and error recovery
|
||||
- Cross-session data persistence
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `js/game-state.js`
|
||||
- `js/save-manager.js`
|
||||
- id: asset-management
|
||||
title: Asset Management System
|
||||
template: |
|
||||
**Purpose:** Efficient loading and management of game assets
|
||||
|
||||
**Asset Categories:**
|
||||
|
||||
- Images and sprite sheets
|
||||
- Audio files
|
||||
- Level data and configurations
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Use subpackages for large assets
|
||||
- Asset caching and optimization
|
||||
- Error handling for failed loads
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `js/asset-manager.js`
|
||||
- id: input-management
|
||||
title: Input Management System
|
||||
template: |
|
||||
**Purpose:** Handle all player input
|
||||
|
||||
**Input Types:**
|
||||
|
||||
- Touch gestures
|
||||
- Button taps
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Use `bindtouchstart`, `bindtouchmove`, `bindtouchend`, `bindtap`
|
||||
- Input buffering for responsive gameplay
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `js/input-manager.js`
|
||||
- id: wechat-api-integration
|
||||
title: WeChat API Integration
|
||||
template: |
|
||||
**Purpose:** Integrate with WeChat's social features
|
||||
|
||||
**Key APIs:**
|
||||
|
||||
- `wx.login` for user authentication
|
||||
- `wx.getUserInfo` for player profiles
|
||||
- `wx.shareAppMessage` for sharing
|
||||
- Open Data Context for leaderboards
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `js/wechat-api.js`
|
||||
- id: audio-system
|
||||
title: Audio System
|
||||
template: |
|
||||
**Audio Requirements:**
|
||||
|
||||
- Background music with looping
|
||||
- Sound effects for actions
|
||||
- Audio settings and volume control
|
||||
|
||||
**Implementation Features:**
|
||||
|
||||
- Use `wx.createInnerAudioContext`
|
||||
- Audio pooling for performance
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `js/audio-manager.js`
|
||||
- id: ui-system
|
||||
title: UI System
|
||||
template: |
|
||||
**UI Components:**
|
||||
|
||||
- HUD elements (score, health, etc.)
|
||||
- Menu navigation
|
||||
- Modal dialogs
|
||||
|
||||
**Implementation Requirements:**
|
||||
|
||||
- Use WXML and WXSS for UI layout and styling
|
||||
- Create reusable custom components
|
||||
|
||||
**Files to Create:**
|
||||
|
||||
- `components/`
|
||||
- `pages/`
|
||||
|
||||
- id: performance-architecture
|
||||
title: Performance Architecture
|
||||
instruction: Define performance requirements and optimization strategies
|
||||
sections:
|
||||
- id: performance-targets
|
||||
title: Performance Targets
|
||||
template: |
|
||||
**Frame Rate:** Smooth performance (30-60 FPS)
|
||||
**Memory Usage:** <{{memory_limit}}MB total
|
||||
**Load Times:** <{{initial_load}}s initial, <{{level_load}}s per level
|
||||
**Package Size:** <{{package_size_limit}}MB initial package
|
||||
- id: optimization-strategies
|
||||
title: Optimization Strategies
|
||||
sections:
|
||||
- id: asset-optimization
|
||||
title: Asset Optimization
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Compress images (e.g., using TinyPNG)
|
||||
- Use appropriate audio formats and compression
|
||||
- Use subpackages for on-demand loading
|
||||
- id: rendering-optimization
|
||||
title: Rendering Optimization
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Avoid unnecessary `setData` calls
|
||||
- Use `requestAnimationFrame` for animations
|
||||
- Optimize complex WXML structures
|
||||
|
||||
- id: game-configuration
|
||||
title: Game Configuration
|
||||
instruction: Define all configurable aspects of the game
|
||||
sections:
|
||||
- id: game-json-configuration
|
||||
title: game.json Configuration
|
||||
type: code
|
||||
language: json
|
||||
template: |
|
||||
{
|
||||
"pages": [
|
||||
"pages/index/index",
|
||||
"pages/game/game"
|
||||
],
|
||||
"window": {
|
||||
"backgroundTextStyle": "light",
|
||||
"navigationBarBackgroundColor": "#fff",
|
||||
"navigationBarTitleText": "{{game_title}}",
|
||||
"navigationBarTextStyle": "black"
|
||||
},
|
||||
"subpackages": [
|
||||
{
|
||||
"root": "packageA",
|
||||
"pages": [
|
||||
"pages/feature/feature"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
- id: game-balance-configuration
|
||||
title: Game Balance Configuration
|
||||
instruction: Based on GDD, define configurable game parameters
|
||||
type: code
|
||||
language: javascript
|
||||
template: |
|
||||
// js/game-balance.js
|
||||
export const GameBalance = {
|
||||
player: {
|
||||
speed: {{player_speed}},
|
||||
health: {{player_health}},
|
||||
},
|
||||
difficulty: {
|
||||
easy: {{easy_params}},
|
||||
normal: {{normal_params}},
|
||||
hard: {{hard_params}}
|
||||
},
|
||||
};
|
||||
|
||||
- id: development-guidelines
|
||||
title: Development Guidelines
|
||||
instruction: Provide coding standards specific to game development
|
||||
sections:
|
||||
- id: javascript-typescript-standards
|
||||
title: JavaScript/TypeScript Standards
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Use `const` and `let`
|
||||
- Use strict equality (`===`)
|
||||
- Write modular code
|
||||
- id: wechat-mini-game-best-practices
|
||||
title: WeChat Mini-Game Best Practices
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Follow official documentation
|
||||
- Handle API failures gracefully
|
||||
- Be mindful of platform limitations
|
||||
|
||||
- id: deployment-architecture
|
||||
title: Deployment Architecture
|
||||
instruction: Define how the game will be built and deployed
|
||||
sections:
|
||||
- id: build-process
|
||||
title: Build Process
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Use WeChat DevTools for development and debugging
|
||||
- Configure `project.config.json` for project settings
|
||||
- id: deployment-strategy
|
||||
title: Deployment Strategy
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Upload code via WeChat DevTools
|
||||
- Submit for review by WeChat team
|
||||
- Release to the public
|
||||
|
||||
- id: implementation-roadmap
|
||||
title: Implementation Roadmap
|
||||
instruction: Break down the architecture implementation into phases that align with the GDD development phases
|
||||
sections:
|
||||
- id: phase-1-foundation
|
||||
title: "Phase 1: Foundation ({{duration}})"
|
||||
sections:
|
||||
- id: phase-1-core
|
||||
title: Core Systems
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Project setup and configuration
|
||||
- Basic page management
|
||||
- Asset loading pipeline
|
||||
- Input handling framework
|
||||
- id: phase-1-epics
|
||||
title: Story Epics
|
||||
type: bullet-list
|
||||
template: |
|
||||
- "Project Setup and Configuration"
|
||||
- "Basic Page Management System"
|
||||
- "Asset Loading Foundation"
|
||||
- id: phase-2-game-systems
|
||||
title: "Phase 2: Game Systems ({{duration}})"
|
||||
sections:
|
||||
- id: phase-2-gameplay
|
||||
title: Gameplay Systems
|
||||
type: bullet-list
|
||||
template: |
|
||||
- {{primary_mechanic}} implementation
|
||||
- Game state management
|
||||
- UI framework
|
||||
- id: phase-2-epics
|
||||
title: Story Epics
|
||||
type: bullet-list
|
||||
template: |
|
||||
- "{{primary_mechanic}} System Implementation"
|
||||
- "Game State Management System"
|
||||
- id: phase-3-content-polish
|
||||
title: "Phase 3: Content & Polish ({{duration}})"
|
||||
sections:
|
||||
- id: phase-3-content
|
||||
title: Content Systems
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Level loading and management
|
||||
- Audio system integration
|
||||
- Performance optimization
|
||||
- Final polish and testing
|
||||
- id: phase-3-epics
|
||||
title: Story Epics
|
||||
type: bullet-list
|
||||
template: |
|
||||
- "Level Management System"
|
||||
- "Audio Integration and Optimization"
|
||||
- "Performance Optimization and Testing"
|
||||
|
||||
- id: risk-assessment
|
||||
title: Risk Assessment
|
||||
instruction: Identify potential technical risks and mitigation strategies
|
||||
type: table
|
||||
template: |
|
||||
| Risk | Probability | Impact | Mitigation Strategy |
|
||||
| ---------------------------- | ----------- | ---------- | ------------------- |
|
||||
| Performance issues on devices| {{prob}} | {{impact}} | {{mitigation}} |
|
||||
| Asset loading bottlenecks | {{prob}} | {{impact}} | {{mitigation}} |
|
||||
| WeChat API changes | {{prob}} | {{impact}} | {{mitigation}} |
|
||||
|
||||
- id: success-criteria
|
||||
title: Success Criteria
|
||||
instruction: Define measurable technical success criteria
|
||||
sections:
|
||||
- id: technical-metrics
|
||||
title: Technical Metrics
|
||||
type: bullet-list
|
||||
template: |
|
||||
- All systems implemented per specification
|
||||
- Performance targets met consistently
|
||||
- Zero critical bugs in core systems
|
||||
- Successful deployment to WeChat platform
|
||||
- id: code-quality
|
||||
title: Code Quality
|
||||
type: bullet-list
|
||||
template: |
|
||||
- >80% test coverage on game logic
|
||||
- Consistent adherence to coding standards
|
||||
- Comprehensive documentation coverage
|
||||
|
|
@ -0,0 +1,355 @@
|
|||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: wechat-game-brief-template-v1
|
||||
name: WeChat Game Brief
|
||||
version: 1.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: "docs/{{game_name}}-game-brief.md"
|
||||
title: "{{game_title}} Game Brief"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: initial-setup
|
||||
instruction: |
|
||||
This template creates a comprehensive game brief that serves as the foundation for all subsequent game development work. The brief should capture the essential vision, scope, and requirements needed to create a detailed Game Design Document.
|
||||
|
||||
This brief is typically created early in the ideation process, often after brainstorming sessions, to crystallize the game concept before moving into detailed design.
|
||||
|
||||
- id: game-vision
|
||||
title: Game Vision
|
||||
instruction: Establish the core vision and identity of the game. Present each subsection and gather user feedback before proceeding.
|
||||
sections:
|
||||
- id: core-concept
|
||||
title: Core Concept
|
||||
instruction: 2-3 sentences that clearly capture what the game is and why it will be compelling to players
|
||||
- id: elevator-pitch
|
||||
title: Elevator Pitch
|
||||
instruction: Single sentence that captures the essence of the game in a memorable way
|
||||
template: |
|
||||
**"{{game_description_in_one_sentence}}"**
|
||||
- id: vision-statement
|
||||
title: Vision Statement
|
||||
instruction: Inspirational statement about what the game will achieve for players and why it matters
|
||||
|
||||
- id: target-market
|
||||
title: Target Market
|
||||
instruction: Define the audience and market context. Apply `tasks#advanced-elicitation` after presenting this section.
|
||||
sections:
|
||||
- id: primary-audience
|
||||
title: Primary Audience
|
||||
template: |
|
||||
**Demographics:** {{age_range}}, {{platform_preference}}, {{gaming_experience}}
|
||||
**Psychographics:** {{interests}}, {{motivations}}, {{play_patterns}}
|
||||
**Gaming Preferences:** {{preferred_genres}}, {{session_length}}, {{difficulty_preference}}
|
||||
- id: secondary-audiences
|
||||
title: Secondary Audiences
|
||||
template: |
|
||||
**Audience 2:** {{description}}
|
||||
**Audience 3:** {{description}}
|
||||
- id: market-context
|
||||
title: Market Context
|
||||
template: |
|
||||
**Genre:** {{primary_genre}} / {{secondary_genre}}
|
||||
**Platform Strategy:** WeChat Mini-Game
|
||||
**Competitive Positioning:** {{differentiation_statement}}
|
||||
|
||||
- id: game-fundamentals
|
||||
title: Game Fundamentals
|
||||
instruction: Define the core gameplay elements. Each subsection should be specific enough to guide detailed design work.
|
||||
sections:
|
||||
- id: core-gameplay-pillars
|
||||
title: Core Gameplay Pillars
|
||||
instruction: 3-5 fundamental principles that guide all design decisions
|
||||
type: numbered-list
|
||||
template: |
|
||||
**{{pillar_name}}** - {{description_and_rationale}}
|
||||
- id: primary-mechanics
|
||||
title: Primary Mechanics
|
||||
instruction: List the 3-5 most important gameplay mechanics that define the player experience
|
||||
repeatable: true
|
||||
template: |
|
||||
**Core Mechanic: {{mechanic_name}}**
|
||||
|
||||
- **Description:** {{how_it_works}}
|
||||
- **Player Value:** {{why_its_fun}}
|
||||
- **Implementation Scope:** {{complexity_estimate}}
|
||||
- id: player-experience-goals
|
||||
title: Player Experience Goals
|
||||
instruction: Define what emotions and experiences the game should create for players
|
||||
template: |
|
||||
**Primary Experience:** {{main_emotional_goal}}
|
||||
**Secondary Experiences:** {{supporting_emotional_goals}}
|
||||
**Engagement Pattern:** {{how_player_engagement_evolves}}
|
||||
|
||||
- id: scope-constraints
|
||||
title: Scope and Constraints
|
||||
instruction: Define the boundaries and limitations that will shape development. Apply `tasks#advanced-elicitation` to clarify any constraints.
|
||||
sections:
|
||||
- id: project-scope
|
||||
title: Project Scope
|
||||
template: |
|
||||
**Game Length:** {{estimated_content_hours}}
|
||||
**Content Volume:** {{levels_areas_content_amount}}
|
||||
**Feature Complexity:** {{simple|moderate|complex}}
|
||||
**Scope Comparison:** "Similar to {{reference_game}} but with {{key_differences}}"
|
||||
- id: technical-constraints
|
||||
title: Technical Constraints
|
||||
template: |
|
||||
**Platform Requirements:** WeChat Mini-Game
|
||||
|
||||
**Technical Specifications:**
|
||||
|
||||
- Engine: WeChat Mini-Game Runtime
|
||||
- Performance Target: Smooth performance on {{target_device}}
|
||||
- Memory Budget: <{{memory_limit}}MB
|
||||
- Package Size Limit: <{{package_size_limit}}MB
|
||||
- Load Time Goal: <{{load_time_seconds}}s
|
||||
- id: resource-constraints
|
||||
title: Resource Constraints
|
||||
template: |
|
||||
**Team Size:** {{team_composition}}
|
||||
**Timeline:** {{development_duration}}
|
||||
**Budget Considerations:** {{budget_constraints_or_targets}}
|
||||
**Asset Requirements:** {{art_audio_content_needs}}
|
||||
- id: business-constraints
|
||||
title: Business Constraints
|
||||
condition: has_business_goals
|
||||
template: |
|
||||
**Monetization Model:** {{free|premium|freemium|subscription}}
|
||||
**Revenue Goals:** {{revenue_targets_if_applicable}}
|
||||
**Platform Requirements:** {{store_certification_needs}}
|
||||
**Launch Timeline:** {{target_launch_window}}
|
||||
|
||||
- id: reference-framework
|
||||
title: Reference Framework
|
||||
instruction: Provide context through references and competitive analysis
|
||||
sections:
|
||||
- id: inspiration-games
|
||||
title: Inspiration Games
|
||||
sections:
|
||||
- id: primary-references
|
||||
title: Primary References
|
||||
type: numbered-list
|
||||
repeatable: true
|
||||
template: |
|
||||
**{{reference_game}}** - {{what_we_learn_from_it}}
|
||||
- id: competitive-analysis
|
||||
title: Competitive Analysis
|
||||
template: |
|
||||
**Direct Competitors:**
|
||||
|
||||
- {{competitor_1}}: {{strengths_and_weaknesses}}
|
||||
- {{competitor_2}}: {{strengths_and_weaknesses}}
|
||||
|
||||
**Differentiation Strategy:**
|
||||
{{how_we_differ_and_why_thats_valuable}}
|
||||
- id: market-opportunity
|
||||
title: Market Opportunity
|
||||
template: |
|
||||
**Market Gap:** {{underserved_need_or_opportunity}}
|
||||
**Timing Factors:** {{why_now_is_the_right_time}}
|
||||
**Success Metrics:** {{how_well_measure_success}}
|
||||
|
||||
- id: content-framework
|
||||
title: Content Framework
|
||||
instruction: Outline the content structure and progression without full design detail
|
||||
sections:
|
||||
- id: game-structure
|
||||
title: Game Structure
|
||||
template: |
|
||||
**Overall Flow:** {{linear|hub_world|open_world|procedural}}
|
||||
**Progression Model:** {{how_players_advance}}
|
||||
**Session Structure:** {{typical_play_session_flow}}
|
||||
- id: content-categories
|
||||
title: Content Categories
|
||||
template: |
|
||||
**Core Content:**
|
||||
|
||||
- {{content_type_1}}: {{quantity_and_description}}
|
||||
- {{content_type_2}}: {{quantity_and_description}}
|
||||
|
||||
**Optional Content:**
|
||||
|
||||
- {{optional_content_type}}: {{quantity_and_description}}
|
||||
|
||||
**Replay Elements:**
|
||||
|
||||
- {{replayability_features}}
|
||||
- id: difficulty-accessibility
|
||||
title: Difficulty and Accessibility
|
||||
template: |
|
||||
**Difficulty Approach:** {{how_challenge_is_structured}}
|
||||
**Accessibility Features:** {{planned_accessibility_support}}
|
||||
**Skill Requirements:** {{what_skills_players_need}}
|
||||
|
||||
- id: art-audio-direction
|
||||
title: Art and Audio Direction
|
||||
instruction: Establish the aesthetic vision that will guide asset creation
|
||||
sections:
|
||||
- id: visual-style
|
||||
title: Visual Style
|
||||
template: |
|
||||
**Art Direction:** {{style_description}}
|
||||
**Reference Materials:** {{visual_inspiration_sources}}
|
||||
**Technical Approach:** {{2d_style_pixel_vector_etc}}
|
||||
**Color Strategy:** {{color_palette_mood}}
|
||||
- id: audio-direction
|
||||
title: Audio Direction
|
||||
template: |
|
||||
**Music Style:** {{genre_and_mood}}
|
||||
**Sound Design:** {{audio_personality}}
|
||||
**Implementation Needs:** {{technical_audio_requirements}}
|
||||
- id: ui-ux-approach
|
||||
title: UI/UX Approach
|
||||
template: |
|
||||
**Interface Style:** {{ui_aesthetic}}
|
||||
**User Experience Goals:** {{ux_priorities}}
|
||||
**Platform Adaptations:** {{cross_platform_considerations}}
|
||||
|
||||
- id: risk-assessment
|
||||
title: Risk Assessment
|
||||
instruction: Identify potential challenges and mitigation strategies
|
||||
sections:
|
||||
- id: technical-risks
|
||||
title: Technical Risks
|
||||
type: table
|
||||
template: |
|
||||
| Risk | Probability | Impact | Mitigation Strategy |
|
||||
| ---- | ----------- | ------ | ------------------- |
|
||||
| {{technical_risk}} | {{high|med|low}} | {{high|med|low}} | {{mitigation_approach}} |
|
||||
- id: design-risks
|
||||
title: Design Risks
|
||||
type: table
|
||||
template: |
|
||||
| Risk | Probability | Impact | Mitigation Strategy |
|
||||
| ---- | ----------- | ------ | ------------------- |
|
||||
| {{design_risk}} | {{high|med|low}} | {{high|med|low}} | {{mitigation_approach}} |
|
||||
- id: market-risks
|
||||
title: Market Risks
|
||||
type: table
|
||||
template: |
|
||||
| Risk | Probability | Impact | Mitigation Strategy |
|
||||
| ---- | ----------- | ------ | ------------------- |
|
||||
| {{market_risk}} | {{high|med|low}} | {{high|med|low}} | {{mitigation_approach}} |
|
||||
|
||||
- id: success-criteria
|
||||
title: Success Criteria
|
||||
instruction: Define measurable goals for the project
|
||||
sections:
|
||||
- id: player-experience-metrics
|
||||
title: Player Experience Metrics
|
||||
template: |
|
||||
**Engagement Goals:**
|
||||
|
||||
- Tutorial completion rate: >{{percentage}}%
|
||||
- Average session length: {{duration}} minutes
|
||||
- Player retention: D1 {{d1}}%, D7 {{d7}}%, D30 {{d30}}%
|
||||
|
||||
**Quality Benchmarks:**
|
||||
|
||||
- Player satisfaction: >{{rating}}/10
|
||||
- Completion rate: >{{percentage}}%
|
||||
- Technical performance: Smooth performance
|
||||
- id: development-metrics
|
||||
title: Development Metrics
|
||||
template: |
|
||||
**Technical Targets:**
|
||||
|
||||
- Zero critical bugs at launch
|
||||
- Performance targets met on all devices
|
||||
- Load times under {{seconds}}s
|
||||
|
||||
**Process Goals:**
|
||||
|
||||
- Development timeline adherence
|
||||
- Feature scope completion
|
||||
- Quality assurance standards
|
||||
- id: business-metrics
|
||||
title: Business Metrics
|
||||
condition: has_business_goals
|
||||
template: |
|
||||
**Commercial Goals:**
|
||||
|
||||
- {{revenue_target}} in first {{time_period}}
|
||||
- {{user_acquisition_target}} players in first {{time_period}}
|
||||
- {{retention_target}} monthly active users
|
||||
|
||||
- id: next-steps
|
||||
title: Next Steps
|
||||
instruction: Define immediate actions following the brief completion
|
||||
sections:
|
||||
- id: immediate-actions
|
||||
title: Immediate Actions
|
||||
type: numbered-list
|
||||
template: |
|
||||
**{{action_item}}** - {{details_and_timeline}}
|
||||
- id: development-roadmap
|
||||
title: Development Roadmap
|
||||
sections:
|
||||
- id: phase-1-preproduction
|
||||
title: "Phase 1: Pre-Production ({{duration}})"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Detailed Game Design Document creation
|
||||
- Technical architecture planning
|
||||
- Art style exploration and pipeline setup
|
||||
- id: phase-2-prototype
|
||||
title: "Phase 2: Prototype ({{duration}})"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Core mechanic implementation
|
||||
- Technical proof of concept
|
||||
- Initial playtesting and iteration
|
||||
- id: phase-3-production
|
||||
title: "Phase 3: Production ({{duration}})"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Full feature development
|
||||
- Content creation and integration
|
||||
- Comprehensive testing and optimization
|
||||
- id: documentation-pipeline
|
||||
title: Documentation Pipeline
|
||||
sections:
|
||||
- id: required-documents
|
||||
title: Required Documents
|
||||
type: numbered-list
|
||||
template: |
|
||||
Game Design Document (GDD) - {{target_completion}}
|
||||
Technical Architecture Document - {{target_completion}}
|
||||
Art Style Guide - {{target_completion}}
|
||||
Production Plan - {{target_completion}}
|
||||
- id: validation-plan
|
||||
title: Validation Plan
|
||||
template: |
|
||||
**Concept Testing:**
|
||||
|
||||
- {{validation_method_1}} - {{timeline}}
|
||||
- {{validation_method_2}} - {{timeline}}
|
||||
|
||||
**Prototype Testing:**
|
||||
|
||||
- {{testing_approach}} - {{timeline}}
|
||||
- {{feedback_collection_method}} - {{timeline}}
|
||||
|
||||
- id: appendices
|
||||
title: Appendices
|
||||
sections:
|
||||
- id: research-materials
|
||||
title: Research Materials
|
||||
instruction: Include any supporting research, competitive analysis, or market data that informed the brief
|
||||
- id: brainstorming-notes
|
||||
title: Brainstorming Session Notes
|
||||
instruction: Reference any brainstorming sessions that led to this brief
|
||||
- id: stakeholder-input
|
||||
title: Stakeholder Input
|
||||
instruction: Include key input from stakeholders that shaped the vision
|
||||
- id: change-log
|
||||
title: Change Log
|
||||
instruction: Track document versions and changes
|
||||
type: table
|
||||
template: |
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
|
@ -0,0 +1,332 @@
|
|||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: wechat-gdd-template-v1
|
||||
name: WeChat Game Design Document (GDD)
|
||||
version: 1.0
|
||||
output:
|
||||
format: markdown
|
||||
filename: "docs/{{game_name}}-game-design-document.md"
|
||||
title: "{{game_title}} Game Design Document (GDD)"
|
||||
|
||||
workflow:
|
||||
mode: interactive
|
||||
|
||||
sections:
|
||||
- id: initial-setup
|
||||
instruction: |
|
||||
This template creates a comprehensive Game Design Document that will serve as the foundation for all game development work. The GDD should be detailed enough that developers can create user stories and epics from it. Focus on gameplay systems, mechanics, and technical requirements that can be broken down into implementable features.
|
||||
|
||||
If available, review any provided documents or ask if any are optionally available: Project Brief, Market Research, Competitive Analysis
|
||||
|
||||
- id: executive-summary
|
||||
title: Executive Summary
|
||||
instruction: Create a compelling overview that captures the essence of the game. Present this section first and get user feedback before proceeding.
|
||||
sections:
|
||||
- id: core-concept
|
||||
title: Core Concept
|
||||
instruction: 2-3 sentences that clearly describe what the game is and why players will love it
|
||||
- id: target-audience
|
||||
title: Target Audience
|
||||
instruction: Define the primary and secondary audience with demographics and gaming preferences
|
||||
template: |
|
||||
**Primary:** {{age_range}}, {{player_type}}, {{platform_preference}}
|
||||
**Secondary:** {{secondary_audience}}
|
||||
- id: platform-technical
|
||||
title: Platform & Technical Requirements
|
||||
instruction: Based on the technical preferences or user input, define the target platforms
|
||||
template: |
|
||||
**Primary Platform:** WeChat Mini-Game
|
||||
**Engine:** WeChat Mini-Game Runtime
|
||||
**Performance Target:** Smooth performance on {{minimum_device}}
|
||||
- id: unique-selling-points
|
||||
title: Unique Selling Points
|
||||
instruction: List 3-5 key features that differentiate this game from competitors
|
||||
type: numbered-list
|
||||
template: "{{usp}}"
|
||||
|
||||
- id: core-gameplay
|
||||
title: Core Gameplay
|
||||
instruction: This section defines the fundamental game mechanics. After presenting each subsection, apply `tasks#advanced-elicitation` protocol to ensure completeness.
|
||||
sections:
|
||||
- id: game-pillars
|
||||
title: Game Pillars
|
||||
instruction: Define 3-5 core pillars that guide all design decisions. These should be specific and actionable.
|
||||
type: numbered-list
|
||||
template: |
|
||||
**{{pillar_name}}** - {{description}}
|
||||
- id: core-gameplay-loop
|
||||
title: Core Gameplay Loop
|
||||
instruction: Define the 30-60 second loop that players will repeat. Be specific about timing and player actions.
|
||||
template: |
|
||||
**Primary Loop ({{duration}} seconds):**
|
||||
|
||||
1. {{action_1}} ({{time_1}}s)
|
||||
2. {{action_2}} ({{time_2}}s)
|
||||
3. {{action_3}} ({{time_3}}s)
|
||||
4. {{reward_feedback}} ({{time_4}}s)
|
||||
- id: win-loss-conditions
|
||||
title: Win/Loss Conditions
|
||||
instruction: Clearly define success and failure states
|
||||
template: |
|
||||
**Victory Conditions:**
|
||||
|
||||
- {{win_condition_1}}
|
||||
- {{win_condition_2}}
|
||||
|
||||
**Failure States:**
|
||||
|
||||
- {{loss_condition_1}}
|
||||
- {{loss_condition_2}}
|
||||
|
||||
- id: game-mechanics
|
||||
title: Game Mechanics
|
||||
instruction: Detail each major mechanic that will need to be implemented. Each mechanic should be specific enough for developers to create implementation stories.
|
||||
sections:
|
||||
- id: primary-mechanics
|
||||
title: Primary Mechanics
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: mechanic
|
||||
title: "{{mechanic_name}}"
|
||||
template: |
|
||||
**Description:** {{detailed_description}}
|
||||
|
||||
**Player Input:** {{input_method}}
|
||||
|
||||
**System Response:** {{game_response}}
|
||||
|
||||
**Implementation Notes:**
|
||||
|
||||
- {{tech_requirement_1}}
|
||||
- {{tech_requirement_2}}
|
||||
- {{performance_consideration}}
|
||||
|
||||
**Dependencies:** {{other_mechanics_needed}}
|
||||
- id: controls
|
||||
title: Controls
|
||||
instruction: Define all input methods
|
||||
type: table
|
||||
template: |
|
||||
| Action | Input |
|
||||
| ------ | ----- |
|
||||
| {{action}} | {{gesture}} |
|
||||
|
||||
- id: progression-balance
|
||||
title: Progression & Balance
|
||||
instruction: Define how players advance and how difficulty scales. This section should provide clear parameters for implementation.
|
||||
sections:
|
||||
- id: player-progression
|
||||
title: Player Progression
|
||||
template: |
|
||||
**Progression Type:** {{linear|branching|metroidvania}}
|
||||
|
||||
**Key Milestones:**
|
||||
|
||||
1. **{{milestone_1}}** - {{unlock_description}}
|
||||
2. **{{milestone_2}}** - {{unlock_description}}
|
||||
3. **{{milestone_3}}** - {{unlock_description}}
|
||||
- id: difficulty-curve
|
||||
title: Difficulty Curve
|
||||
instruction: Provide specific parameters for balancing
|
||||
template: |
|
||||
**Tutorial Phase:** {{duration}} - {{difficulty_description}}
|
||||
**Early Game:** {{duration}} - {{difficulty_description}}
|
||||
**Mid Game:** {{duration}} - {{difficulty_description}}
|
||||
**Late Game:** {{duration}} - {{difficulty_description}}
|
||||
- id: economy-resources
|
||||
title: Economy & Resources
|
||||
condition: has_economy
|
||||
instruction: Define any in-game currencies, resources, or collectibles
|
||||
type: table
|
||||
template: |
|
||||
| Resource | Earn Rate | Spend Rate | Purpose | Cap |
|
||||
| -------- | --------- | ---------- | ------- | --- |
|
||||
| {{resource}} | {{rate}} | {{rate}} | {{use}} | {{max}} |
|
||||
|
||||
- id: level-design-framework
|
||||
title: Level Design Framework
|
||||
instruction: Provide guidelines for level creation that developers can use to create level implementation stories
|
||||
sections:
|
||||
- id: level-types
|
||||
title: Level Types
|
||||
repeatable: true
|
||||
sections:
|
||||
- id: level-type
|
||||
title: "{{level_type_name}}"
|
||||
template: |
|
||||
**Purpose:** {{gameplay_purpose}}
|
||||
**Duration:** {{target_time}}
|
||||
**Key Elements:** {{required_mechanics}}
|
||||
**Difficulty:** {{relative_difficulty}}
|
||||
|
||||
**Structure Template:**
|
||||
|
||||
- Introduction: {{intro_description}}
|
||||
- Challenge: {{main_challenge}}
|
||||
- Resolution: {{completion_requirement}}
|
||||
- id: level-progression
|
||||
title: Level Progression
|
||||
template: |
|
||||
**World Structure:** {{linear|hub|open}}
|
||||
**Total Levels:** {{number}}
|
||||
**Unlock Pattern:** {{progression_method}}
|
||||
|
||||
- id: technical-specifications
|
||||
title: Technical Specifications
|
||||
instruction: Define technical requirements that will guide architecture and implementation decisions. Review any existing technical preferences.
|
||||
sections:
|
||||
- id: performance-requirements
|
||||
title: Performance Requirements
|
||||
template: |
|
||||
**Frame Rate:** Smooth performance
|
||||
**Memory Usage:** <{{memory_limit}}MB
|
||||
**Load Times:** <{{load_time}}s initial, <{{level_load}}s between levels
|
||||
**Package Size:** <{{package_size_limit}}MB initial package
|
||||
- id: platform-specific
|
||||
title: Platform Specific
|
||||
template: |
|
||||
**WeChat Mini-Game:**
|
||||
|
||||
- OS: iOS, Android
|
||||
- Input: Touch
|
||||
- id: asset-requirements
|
||||
title: Asset Requirements
|
||||
instruction: Define asset specifications for the art and audio teams
|
||||
template: |
|
||||
**Visual Assets:**
|
||||
|
||||
- Art Style: {{style_description}}
|
||||
- Color Palette: {{color_specification}}
|
||||
- Animation: {{animation_requirements}}
|
||||
- UI Resolution: {{ui_specs}}
|
||||
|
||||
**Audio Assets:**
|
||||
|
||||
- Music Style: {{music_genre}}
|
||||
- Sound Effects: {{sfx_requirements}}
|
||||
- Voice Acting: {{voice_needs}}
|
||||
|
||||
- id: technical-architecture-requirements
|
||||
title: Technical Architecture Requirements
|
||||
instruction: Define high-level technical requirements that the game architecture must support
|
||||
sections:
|
||||
- id: engine-configuration
|
||||
title: Engine Configuration
|
||||
template: |
|
||||
**WeChat Mini-Game Setup:**
|
||||
|
||||
- JavaScript/TypeScript
|
||||
- Use of `game.json` for configuration
|
||||
- id: code-architecture
|
||||
title: Code Architecture
|
||||
template: |
|
||||
**Required Systems:**
|
||||
|
||||
- Page Management
|
||||
- State Management
|
||||
- Asset Loading
|
||||
- Save/Load System
|
||||
- Input Management
|
||||
- Audio System
|
||||
- Performance Monitoring
|
||||
- id: data-management
|
||||
title: Data Management
|
||||
template: |
|
||||
**Save Data:**
|
||||
|
||||
- Progress tracking
|
||||
- Settings persistence
|
||||
- Statistics collection
|
||||
- {{additional_data}}
|
||||
|
||||
- id: development-phases
|
||||
title: Development Phases
|
||||
instruction: Break down the development into phases that can be converted to epics
|
||||
sections:
|
||||
- id: phase-1-core-systems
|
||||
title: "Phase 1: Core Systems ({{duration}})"
|
||||
sections:
|
||||
- id: foundation-epic
|
||||
title: "Epic: Foundation"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Project setup and configuration
|
||||
- Basic page management
|
||||
- Core input handling
|
||||
- Asset loading pipeline
|
||||
- id: core-mechanics-epic
|
||||
title: "Epic: Core Mechanics"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- {{primary_mechanic}} implementation
|
||||
- Player controller
|
||||
- id: phase-2-gameplay-features
|
||||
title: "Phase 2: Gameplay Features ({{duration}})"
|
||||
sections:
|
||||
- id: game-systems-epic
|
||||
title: "Epic: Game Systems"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- {{mechanic_2}} implementation
|
||||
- {{mechanic_3}} implementation
|
||||
- Game state management
|
||||
- id: content-creation-epic
|
||||
title: "Epic: Content Creation"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Level loading system
|
||||
- First playable levels
|
||||
- Basic UI implementation
|
||||
- id: phase-3-polish-optimization
|
||||
title: "Phase 3: Polish & Optimization ({{duration}})"
|
||||
sections:
|
||||
- id: performance-epic
|
||||
title: "Epic: Performance"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Optimization and profiling
|
||||
- Memory management
|
||||
- id: user-experience-epic
|
||||
title: "Epic: User Experience"
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Audio implementation
|
||||
- Visual effects and polish
|
||||
- Final UI/UX refinement
|
||||
|
||||
- id: success-metrics
|
||||
title: Success Metrics
|
||||
instruction: Define measurable goals for the game
|
||||
sections:
|
||||
- id: technical-metrics
|
||||
title: Technical Metrics
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Frame rate: Smooth
|
||||
- Load time: {{load_target}}
|
||||
- Crash rate: <{{crash_threshold}}%
|
||||
- Memory usage: <{{memory_target}}MB
|
||||
- id: gameplay-metrics
|
||||
title: Gameplay Metrics
|
||||
type: bullet-list
|
||||
template: |
|
||||
- Tutorial completion: {{completion_rate}}%
|
||||
- Average session: {{session_length}} minutes
|
||||
- Level completion: {{level_completion}}%
|
||||
- Player retention: D1 {{d1}}%, D7 {{d7}}%
|
||||
|
||||
- id: appendices
|
||||
title: Appendices
|
||||
sections:
|
||||
- id: change-log
|
||||
title: Change Log
|
||||
instruction: Track document versions and changes
|
||||
type: table
|
||||
template: |
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
- id: references
|
||||
title: References
|
||||
instruction: List any competitive analysis, inspiration, or research sources
|
||||
type: bullet-list
|
||||
template: "{{reference}}"
|
||||
|
|
@ -0,0 +1,252 @@
|
|||
# <!-- Powered by BMAD™ Core -->
|
||||
template:
|
||||
id: wechat-game-story-template-v1
|
||||
name: WeChat Game Development Story
|
||||
version: 1.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 JavaScript/TypeScript best practices"
|
||||
- "Maintains smooth performance 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 JavaScript/TypeScript interfaces and class structures needed
|
||||
type: code
|
||||
language: javascript
|
||||
template: |
|
||||
// {{interface_name}}
|
||||
interface {{interface_name}} {
|
||||
{{property_1}}: {{type}};
|
||||
{{property_2}}: {{type}};
|
||||
{{method_1}}({{params}}): {{return_type}};
|
||||
}
|
||||
|
||||
// {{class_name}}
|
||||
class {{class_name}} {
|
||||
constructor({{params}}) {
|
||||
// Implementation requirements
|
||||
}
|
||||
|
||||
{{method}}({{params}}) {
|
||||
// Method requirements
|
||||
}
|
||||
}
|
||||
- id: integration-points
|
||||
title: Integration Points
|
||||
instruction: Specify how this feature integrates with existing systems
|
||||
template: |
|
||||
**Page/Component Integration:**
|
||||
|
||||
- {{page_or_component_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.js`
|
||||
|
||||
**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 smooth performance
|
||||
- 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}}
|
||||
|
|
@ -0,0 +1,171 @@
|
|||
# <!-- Powered by BMAD™ Core -->
|
||||
workflow:
|
||||
id: wechat-game-dev-greenfield
|
||||
name: WeChat Game Development - Greenfield Project
|
||||
description: Specialized workflow for creating 2D games from concept to implementation for the WeChat Mini-Game platform. Guides teams through game concept development, design documentation, technical architecture, and story-driven development for professional game development.
|
||||
type: greenfield
|
||||
project_types:
|
||||
- indie-game
|
||||
- mobile-game
|
||||
- web-game
|
||||
- educational-game
|
||||
- prototype-game
|
||||
- game-jam
|
||||
full_game_sequence:
|
||||
- agent: game-designer
|
||||
creates: game-brief.md
|
||||
optional_steps:
|
||||
- brainstorming_session
|
||||
- game_research_prompt
|
||||
- player_research
|
||||
notes: "Start with brainstorming game concepts, then create comprehensive game brief. SAVE OUTPUT: Copy final game-brief.md to your project's docs/design/ folder."
|
||||
- agent: game-designer
|
||||
creates: game-design-doc.md
|
||||
requires: game-brief.md
|
||||
optional_steps:
|
||||
- competitive_analysis
|
||||
- technical_research
|
||||
notes: "Create detailed Game Design Document using game-design-doc-tmpl. Defines all gameplay mechanics, progression, and technical requirements. SAVE OUTPUT: Copy final game-design-doc.md to your project's docs/design/ folder."
|
||||
- agent: solution-architect
|
||||
creates: game-architecture.md
|
||||
requires:
|
||||
- game-design-doc.md
|
||||
optional_steps:
|
||||
- technical_research_prompt
|
||||
- performance_analysis
|
||||
- platform_research
|
||||
notes: "Create comprehensive technical architecture using game-architecture-tmpl. Defines WeChat Mini-Game systems, performance optimization, and code structure. SAVE OUTPUT: Copy final game-architecture.md to your project's docs/architecture/ folder."
|
||||
- agent: game-designer
|
||||
validates: design_consistency
|
||||
requires: all_design_documents
|
||||
uses: game-design-checklist
|
||||
notes: Validate all design documents for consistency, completeness, and implementability. May require updates to any design document.
|
||||
- agent: various
|
||||
updates: flagged_design_documents
|
||||
condition: design_validation_issues
|
||||
notes: If design validation finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder.
|
||||
project_setup_guidance:
|
||||
action: guide_game_project_structure
|
||||
notes: Set up game project structure following game architecture document. Create pages/, components/, js/, and images/ directories. Initialize WeChat Mini-Game configuration.
|
||||
workflow_end:
|
||||
action: move_to_story_development
|
||||
notes: All design artifacts complete. Begin story-driven development phase. Use Game Scrum Master to create implementation stories from design documents.
|
||||
prototype_sequence:
|
||||
- step: prototype_scope
|
||||
action: assess_prototype_complexity
|
||||
notes: First, assess if this needs full game design (use full_game_sequence) or can be a rapid prototype.
|
||||
- agent: game-designer
|
||||
creates: game-brief.md
|
||||
optional_steps:
|
||||
- quick_brainstorming
|
||||
- concept_validation
|
||||
notes: "Create focused game brief for prototype. Emphasize core mechanics and immediate playability. SAVE OUTPUT: Copy final game-brief.md to your project's docs/ folder."
|
||||
- agent: game-designer
|
||||
creates: prototype-design.md
|
||||
uses: create-doc prototype-design OR create-game-story
|
||||
requires: game-brief.md
|
||||
notes: Create minimal design document or jump directly to implementation stories for rapid prototyping. Choose based on prototype complexity.
|
||||
prototype_workflow_end:
|
||||
action: move_to_rapid_implementation
|
||||
notes: Prototype defined. Begin immediate implementation with Game Developer. Focus on core mechanics first, then iterate based on playtesting.
|
||||
flow_diagram: |
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Start: WeChat Game Development Project] --> B{Project Scope?}
|
||||
B -->|Full Game/Production| C[game-designer: game-brief.md]
|
||||
B -->|Prototype/Game Jam| D[game-designer: focused game-brief.md]
|
||||
|
||||
C --> E[game-designer: game-design-doc.md]
|
||||
E --> G[solution-architect: game-architecture.md]
|
||||
G --> H[game-designer: validate design consistency]
|
||||
H --> I{Design validation issues?}
|
||||
I -->|Yes| J[Return to relevant agent for fixes]
|
||||
I -->|No| K[Set up game project structure]
|
||||
J --> H
|
||||
K --> L[Move to Story Development Phase]
|
||||
|
||||
D --> M[game-designer: prototype-design.md]
|
||||
M --> N[Move to Rapid Implementation]
|
||||
|
||||
C -.-> C1[Optional: brainstorming]
|
||||
C -.-> C2[Optional: game research]
|
||||
E -.-> E1[Optional: competitive analysis]
|
||||
G -.-> G1[Optional: technical research]
|
||||
D -.-> D1[Optional: quick brainstorming]
|
||||
|
||||
style L fill:#90EE90
|
||||
style N fill:#90EE90
|
||||
style C fill:#FFE4B5
|
||||
style E fill:#FFE4B5
|
||||
style F fill:#FFE4B5
|
||||
style G fill:#FFE4B5
|
||||
style D fill:#FFB6C1
|
||||
style M fill:#FFB6C1
|
||||
```
|
||||
decision_guidance:
|
||||
use_full_sequence_when:
|
||||
- Building commercial or production games
|
||||
- Multiple team members involved
|
||||
- Complex gameplay systems (3+ core mechanics)
|
||||
- Long-term development timeline (2+ months)
|
||||
- Need comprehensive documentation for team coordination
|
||||
- Educational or enterprise game projects
|
||||
use_prototype_sequence_when:
|
||||
- Game jams or time-constrained development
|
||||
- Solo developer or very small team
|
||||
- Experimental or proof-of-concept games
|
||||
- Simple mechanics (1-2 core systems)
|
||||
- Quick validation of game concepts
|
||||
- Learning projects or technical demos
|
||||
handoff_prompts:
|
||||
designer_to_gdd: Game brief is complete. Save it as docs/design/game-brief.md in your project, then create the comprehensive Game Design Document.
|
||||
gdd_to_level: Game Design Document ready. Save it as docs/design/game-design-doc.md, then create the level design framework.
|
||||
level_to_architect: Level design complete. Save it as docs/design/level-design-doc.md, then create the technical architecture.
|
||||
architect_review: Architecture complete. Save it as docs/architecture/game-architecture.md. Please validate all design documents for consistency.
|
||||
validation_issues: Design validation found issues with [document]. Please return to [agent] to fix and re-save the updated document.
|
||||
full_complete: All design artifacts validated and saved. Set up game project structure and move to story development phase.
|
||||
prototype_designer_to_dev: Prototype brief complete. Save it as docs/game-brief.md, then create minimal design or jump directly to implementation stories.
|
||||
prototype_complete: Prototype defined. Begin rapid implementation focusing on core mechanics and immediate playability.
|
||||
story_development_guidance:
|
||||
epic_breakdown:
|
||||
- Core Game Systems" - Fundamental gameplay mechanics and player controls
|
||||
- Level Content" - Individual levels, progression, and content implementation
|
||||
- User Interface" - Menus, HUD, settings, and player feedback systems
|
||||
- Audio Integration" - Music, sound effects, and audio systems
|
||||
- Performance Optimization" - Platform optimization and technical polish
|
||||
- Game Polish" - Visual effects, animations, and final user experience
|
||||
story_creation_process:
|
||||
- Use Game Scrum Master to create detailed implementation stories
|
||||
- Each story should reference specific GDD sections
|
||||
- Include performance requirements
|
||||
- Specify WeChat Mini-Game implementation details
|
||||
- Apply game-story-dod-checklist for quality validation
|
||||
- Ensure stories are immediately actionable by Game Developer
|
||||
game_development_best_practices:
|
||||
performance_targets:
|
||||
- Maintain smooth performance on target devices throughout development
|
||||
- Memory usage under specified limits per game system
|
||||
- Loading times under 3 seconds for levels
|
||||
- Smooth animation and responsive player controls
|
||||
technical_standards:
|
||||
- JavaScript/TypeScript best practices
|
||||
- Component-based game architecture
|
||||
- Comprehensive error handling and graceful degradation
|
||||
playtesting_integration:
|
||||
- Test core mechanics early and frequently
|
||||
- Validate game balance through metrics and player feedback
|
||||
- Iterate on design based on implementation discoveries
|
||||
- Document design changes and rationale
|
||||
success_criteria:
|
||||
design_phase_complete:
|
||||
- All design documents created and validated
|
||||
- Technical architecture aligns with game design requirements
|
||||
- Performance targets defined and achievable
|
||||
- Story breakdown ready for implementation
|
||||
- Project structure established
|
||||
implementation_readiness:
|
||||
- Development environment configured for WeChat Mini-Game
|
||||
- Asset pipeline and build system established
|
||||
- Testing framework in place
|
||||
- Team roles and responsibilities defined
|
||||
- First implementation stories created and ready
|
||||
|
|
@ -0,0 +1,176 @@
|
|||
# <!-- Powered by BMAD™ Core -->
|
||||
workflow:
|
||||
id: wechat-game-prototype
|
||||
name: WeChat Game Prototype Development
|
||||
description: Fast-track workflow for rapid game prototyping and concept validation. Optimized for game jams, proof-of-concept development, and quick iteration on game mechanics for the WeChat Mini-Game platform.
|
||||
type: prototype
|
||||
project_types:
|
||||
- game-jam
|
||||
- proof-of-concept
|
||||
- mechanic-test
|
||||
- technical-demo
|
||||
- learning-project
|
||||
- rapid-iteration
|
||||
prototype_sequence:
|
||||
- step: concept_definition
|
||||
agent: game-designer
|
||||
duration: 15-30 minutes
|
||||
creates: concept-summary.md
|
||||
notes: Quickly define core game concept, primary mechanic, and target experience. Focus on what makes this game unique and fun.
|
||||
- step: rapid_design
|
||||
agent: game-designer
|
||||
duration: 30-60 minutes
|
||||
creates: prototype-spec.md
|
||||
requires: concept-summary.md
|
||||
optional_steps:
|
||||
- quick_brainstorming
|
||||
- reference_research
|
||||
notes: Create minimal but complete design specification. Focus on core mechanics, basic controls, and success/failure conditions.
|
||||
- step: technical_planning
|
||||
agent: game-developer
|
||||
duration: 15-30 minutes
|
||||
creates: prototype-architecture.md
|
||||
requires: prototype-spec.md
|
||||
notes: Define minimal technical implementation plan. Identify core WeChat Mini-Game systems needed and performance constraints.
|
||||
- step: implementation_stories
|
||||
agent: game-sm
|
||||
duration: 30-45 minutes
|
||||
creates: prototype-stories/
|
||||
requires: prototype-spec.md, prototype-architecture.md
|
||||
notes: Create 3-5 focused implementation stories for core prototype features. Each story should be completable in 2-4 hours.
|
||||
- step: iterative_development
|
||||
agent: game-developer
|
||||
duration: varies
|
||||
implements: prototype-stories/
|
||||
notes: Implement stories in priority order. Test frequently and adjust design based on what feels fun. Document discoveries.
|
||||
workflow_end:
|
||||
action: prototype_evaluation
|
||||
notes: "Prototype complete. Evaluate core mechanics, gather feedback, and decide next steps: iterate, expand, or archive."
|
||||
game_jam_sequence:
|
||||
- step: jam_concept
|
||||
agent: game-designer
|
||||
duration: 10-15 minutes
|
||||
creates: jam-concept.md
|
||||
notes: Define game concept based on jam theme. One sentence core mechanic, basic controls, win condition.
|
||||
- step: jam_implementation
|
||||
agent: game-developer
|
||||
duration: varies (jam timeline)
|
||||
creates: working-prototype
|
||||
requires: jam-concept.md
|
||||
notes: Directly implement core mechanic. No formal stories - iterate rapidly on what's fun. Document major decisions.
|
||||
jam_workflow_end:
|
||||
action: jam_submission
|
||||
notes: Submit to game jam. Capture lessons learned and consider post-jam development if concept shows promise.
|
||||
flow_diagram: |
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Start: Prototype Project] --> B{Development Context?}
|
||||
B -->|Standard Prototype| C[game-designer: concept-summary.md]
|
||||
B -->|Game Jam| D[game-designer: jam-concept.md]
|
||||
|
||||
C --> E[game-designer: prototype-spec.md]
|
||||
E --> F[game-developer: prototype-architecture.md]
|
||||
F --> G[game-sm: create prototype stories]
|
||||
G --> H[game-developer: iterative implementation]
|
||||
H --> I[Prototype Evaluation]
|
||||
|
||||
D --> J[game-developer: direct implementation]
|
||||
J --> K[Game Jam Submission]
|
||||
|
||||
E -.-> E1[Optional: quick brainstorming]
|
||||
E -.-> E2[Optional: reference research]
|
||||
|
||||
style I fill:#90EE90
|
||||
style K fill:#90EE90
|
||||
style C fill:#FFE4B5
|
||||
style E fill:#FFE4B5
|
||||
style F fill:#FFE4B5
|
||||
style G fill:#FFE4B5
|
||||
style H fill:#FFE4B5
|
||||
style D fill:#FFB6C1
|
||||
style J fill:#FFB6C1
|
||||
```
|
||||
decision_guidance:
|
||||
use_prototype_sequence_when:
|
||||
- Learning new game development concepts
|
||||
- Testing specific game mechanics
|
||||
- Building portfolio pieces
|
||||
- Have 1-7 days for development
|
||||
- Need structured but fast development
|
||||
- Want to validate game concepts before full development
|
||||
use_game_jam_sequence_when:
|
||||
- Participating in time-constrained game jams
|
||||
- Have 24-72 hours total development time
|
||||
- Want to experiment with wild or unusual concepts
|
||||
- Learning through rapid iteration
|
||||
- Building networking/portfolio presence
|
||||
prototype_best_practices:
|
||||
scope_management:
|
||||
- Start with absolute minimum viable gameplay
|
||||
- One core mechanic implemented well beats many mechanics poorly
|
||||
- Focus on "game feel" over features
|
||||
- Cut features ruthlessly to meet timeline
|
||||
rapid_iteration:
|
||||
- Test the game every 1-2 hours of development
|
||||
- Ask "Is this fun?" frequently during development
|
||||
- Be willing to pivot mechanics if they don't feel good
|
||||
- Document what works and what doesn't
|
||||
technical_efficiency:
|
||||
- Use simple graphics (geometric shapes, basic sprites)
|
||||
- Leverage WeChat Mini-Game's built-in systems heavily
|
||||
- Avoid complex custom systems in prototypes
|
||||
- Prioritize functional over polished
|
||||
prototype_evaluation_criteria:
|
||||
core_mechanic_validation:
|
||||
- Is the primary mechanic engaging for 30+ seconds?
|
||||
- Do players understand the mechanic without explanation?
|
||||
- Does the mechanic have depth for extended play?
|
||||
- Are there natural difficulty progression opportunities?
|
||||
technical_feasibility:
|
||||
- Does the prototype run at acceptable frame rates?
|
||||
- Are there obvious technical blockers for expansion?
|
||||
- Is the codebase clean enough for further development?
|
||||
- Are performance targets realistic for full game?
|
||||
player_experience:
|
||||
- Do testers engage with the game voluntarily?
|
||||
- What emotions does the game create in players?
|
||||
- Are players asking for "just one more try"?
|
||||
- What do players want to see added or changed?
|
||||
post_prototype_options:
|
||||
iterate_and_improve:
|
||||
action: continue_prototyping
|
||||
when: Core mechanic shows promise but needs refinement
|
||||
next_steps: Create new prototype iteration focusing on identified improvements
|
||||
expand_to_full_game:
|
||||
action: transition_to_full_development
|
||||
when: Prototype validates strong game concept
|
||||
next_steps: Use wechat-game-dev-greenfield workflow to create full game design and architecture
|
||||
pivot_concept:
|
||||
action: new_prototype_direction
|
||||
when: Current mechanic doesn't work but insights suggest new direction
|
||||
next_steps: Apply learnings to new prototype concept
|
||||
archive_and_learn:
|
||||
action: document_learnings
|
||||
when: Prototype doesn't work but provides valuable insights
|
||||
next_steps: Document lessons learned and move to next prototype concept
|
||||
time_boxing_guidance:
|
||||
concept_phase: Maximum 30 minutes - if you can't explain the game simply, simplify it
|
||||
design_phase: Maximum 1 hour - focus on core mechanics only
|
||||
planning_phase: Maximum 30 minutes - identify critical path to playable prototype
|
||||
implementation_phase: Time-boxed iterations - test every 2-4 hours of work
|
||||
success_metrics:
|
||||
development_velocity:
|
||||
- Playable prototype in first day of development
|
||||
- Core mechanic demonstrable within 4-6 hours of coding
|
||||
- Major iteration cycles completed in 2-4 hour blocks
|
||||
learning_objectives:
|
||||
- Clear understanding of what makes the mechanic fun (or not)
|
||||
- Technical feasibility assessment for full development
|
||||
- Player reaction and engagement validation
|
||||
- Design insights for future development
|
||||
handoff_prompts:
|
||||
concept_to_design: Game concept defined. Create minimal design specification focusing on core mechanics and player experience.
|
||||
design_to_technical: Design specification ready. Create technical implementation plan for rapid prototyping.
|
||||
technical_to_stories: Technical plan complete. Create focused implementation stories for prototype development.
|
||||
stories_to_implementation: Stories ready. Begin iterative implementation with frequent playtesting and design validation.
|
||||
prototype_to_evaluation: Prototype playable. Evaluate core mechanics, gather feedback, and determine next development steps.
|
||||
Loading…
Reference in New Issue