bmad-method 5.0.0-beta.2 → 5.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/ISSUE_TEMPLATE/bug_report.md +3 -3
- package/.github/ISSUE_TEMPLATE/feature_request.md +3 -3
- package/.github/workflows/discord.yaml +11 -2
- package/.github/workflows/format-check.yaml +42 -0
- package/.github/workflows/manual-release.yaml +173 -0
- package/.husky/pre-commit +3 -0
- package/.vscode/settings.json +26 -1
- package/CHANGELOG.md +0 -11
- package/README.md +2 -0
- package/bmad-core/agent-teams/team-all.yaml +1 -1
- package/bmad-core/agents/bmad-orchestrator.md +1 -1
- package/bmad-core/agents/dev.md +4 -4
- package/bmad-core/data/bmad-kb.md +1 -1
- package/bmad-core/data/test-levels-framework.md +12 -12
- package/bmad-core/tasks/facilitate-brainstorming-session.md +1 -1
- package/bmad-core/tasks/nfr-assess.md +10 -10
- package/bmad-core/tasks/qa-gate.md +23 -23
- package/bmad-core/tasks/review-story.md +18 -18
- package/bmad-core/tasks/risk-profile.md +25 -25
- package/bmad-core/tasks/test-design.md +9 -9
- package/bmad-core/tasks/trace-requirements.md +21 -21
- package/bmad-core/templates/architecture-tmpl.yaml +49 -49
- package/bmad-core/templates/brainstorming-output-tmpl.yaml +5 -5
- package/bmad-core/templates/brownfield-architecture-tmpl.yaml +31 -31
- package/bmad-core/templates/brownfield-prd-tmpl.yaml +13 -13
- package/bmad-core/templates/competitor-analysis-tmpl.yaml +19 -6
- package/bmad-core/templates/front-end-architecture-tmpl.yaml +21 -9
- package/bmad-core/templates/front-end-spec-tmpl.yaml +24 -24
- package/bmad-core/templates/fullstack-architecture-tmpl.yaml +122 -104
- package/bmad-core/templates/market-research-tmpl.yaml +2 -2
- package/bmad-core/templates/prd-tmpl.yaml +9 -9
- package/bmad-core/templates/project-brief-tmpl.yaml +4 -4
- package/bmad-core/templates/qa-gate-tmpl.yaml +9 -9
- package/bmad-core/templates/story-tmpl.yaml +12 -12
- package/bmad-core/workflows/brownfield-fullstack.yaml +9 -9
- package/bmad-core/workflows/brownfield-service.yaml +1 -1
- package/bmad-core/workflows/brownfield-ui.yaml +1 -1
- package/bmad-core/workflows/greenfield-fullstack.yaml +1 -1
- package/bmad-core/workflows/greenfield-service.yaml +1 -1
- package/bmad-core/workflows/greenfield-ui.yaml +1 -1
- package/common/utils/bmad-doc-template.md +5 -5
- package/dist/agents/analyst.txt +28 -15
- package/dist/agents/architect.txt +220 -190
- package/dist/agents/bmad-master.txt +298 -255
- package/dist/agents/bmad-orchestrator.txt +1 -1
- package/dist/agents/pm.txt +20 -20
- package/dist/agents/po.txt +11 -11
- package/dist/agents/qa.txt +275 -618
- package/dist/agents/sm.txt +11 -11
- package/dist/agents/ux-expert.txt +23 -23
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +109 -109
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +75 -77
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +41 -41
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +483 -474
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +1 -1
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +149 -149
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +20 -20
- package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +371 -358
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +25 -25
- package/dist/teams/team-all.txt +581 -881
- package/dist/teams/team-fullstack.txt +316 -273
- package/dist/teams/team-ide-minimal.txt +276 -619
- package/dist/teams/team-no-ui.txt +281 -238
- package/docs/versioning-and-releases.md +114 -44
- package/eslint.config.mjs +119 -0
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.4 Deployment Configuration/1.4.2 - cloudbuild.yaml +26 -26
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +4 -4
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +1 -1
- package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +26 -28
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +50 -50
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +23 -23
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +24 -24
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +42 -42
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +65 -65
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +5 -5
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +1 -1
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +3 -3
- package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +1 -1
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +23 -23
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +63 -63
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +20 -20
- package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +65 -65
- package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-dev-greenfield.yaml +5 -5
- package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-prototype.yaml +1 -1
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +20 -20
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +7 -7
- package/package.json +62 -39
- package/prettier.config.mjs +32 -0
- package/release_notes.md +30 -0
- package/tools/bmad-npx-wrapper.js +10 -10
- package/tools/builders/web-builder.js +124 -130
- package/tools/bump-all-versions.js +42 -33
- package/tools/bump-expansion-version.js +23 -16
- package/tools/cli.js +10 -12
- package/tools/flattener/aggregate.js +10 -10
- package/tools/flattener/binary.js +44 -17
- package/tools/flattener/discovery.js +19 -18
- package/tools/flattener/files.js +6 -6
- package/tools/flattener/ignoreRules.js +125 -125
- package/tools/flattener/main.js +201 -304
- package/tools/flattener/projectRoot.js +75 -73
- package/tools/flattener/prompts.js +9 -9
- package/tools/flattener/stats.helpers.js +131 -67
- package/tools/flattener/stats.js +3 -3
- package/tools/flattener/test-matrix.js +201 -193
- package/tools/flattener/xml.js +33 -31
- package/tools/installer/bin/bmad.js +130 -89
- package/tools/installer/config/ide-agent-config.yaml +1 -1
- package/tools/installer/config/install.config.yaml +2 -2
- package/tools/installer/lib/config-loader.js +46 -42
- package/tools/installer/lib/file-manager.js +91 -113
- package/tools/installer/lib/ide-base-setup.js +57 -56
- package/tools/installer/lib/ide-setup.js +375 -343
- package/tools/installer/lib/installer.js +875 -714
- package/tools/installer/lib/memory-profiler.js +54 -53
- package/tools/installer/lib/module-manager.js +19 -15
- package/tools/installer/lib/resource-locator.js +26 -28
- package/tools/installer/package.json +19 -19
- package/tools/lib/dependency-resolver.js +26 -30
- package/tools/lib/yaml-utils.js +7 -7
- package/tools/preview-release-notes.js +66 -0
- package/tools/shared/bannerArt.js +3 -3
- package/tools/sync-installer-version.js +7 -9
- package/tools/update-expansion-version.js +14 -15
- package/tools/upgraders/v3-to-v4-upgrader.js +203 -294
- package/tools/version-bump.js +41 -26
- package/tools/yaml-format.js +56 -43
- package/.github/workflows/promote-to-stable.yml +0 -144
- package/.github/workflows/release.yaml +0 -60
- package/.releaserc.json +0 -21
- package/tools/semantic-release-sync-installer.js +0 -30
|
@@ -14,7 +14,7 @@ sections:
|
|
|
14
14
|
- id: initial-setup
|
|
15
15
|
instruction: |
|
|
16
16
|
This template creates a comprehensive game architecture document specifically for Phaser 3 + TypeScript projects. This should provide the technical foundation for all game development stories and epics.
|
|
17
|
-
|
|
17
|
+
|
|
18
18
|
If available, review any provided documents: Game Design Document (GDD), Technical Preferences. This architecture should support all game mechanics defined in the GDD.
|
|
19
19
|
|
|
20
20
|
- id: introduction
|
|
@@ -22,7 +22,7 @@ sections:
|
|
|
22
22
|
instruction: Establish the document's purpose and scope for game development
|
|
23
23
|
content: |
|
|
24
24
|
This document outlines the complete technical architecture for {{game_title}}, a 2D game built with Phaser 3 and TypeScript. It serves as the technical foundation for AI-driven game development, ensuring consistency and scalability across all game systems.
|
|
25
|
-
|
|
25
|
+
|
|
26
26
|
This architecture is designed to support the gameplay mechanics defined in the Game Design Document while maintaining 60 FPS performance and cross-platform compatibility.
|
|
27
27
|
sections:
|
|
28
28
|
- id: change-log
|
|
@@ -41,7 +41,7 @@ sections:
|
|
|
41
41
|
title: Architecture Summary
|
|
42
42
|
instruction: |
|
|
43
43
|
Provide a comprehensive overview covering:
|
|
44
|
-
|
|
44
|
+
|
|
45
45
|
- Game engine choice and configuration
|
|
46
46
|
- Project structure and organization
|
|
47
47
|
- Key systems and their interactions
|
|
@@ -129,23 +129,23 @@ sections:
|
|
|
129
129
|
title: Scene Management System
|
|
130
130
|
template: |
|
|
131
131
|
**Purpose:** Handle game flow and scene transitions
|
|
132
|
-
|
|
132
|
+
|
|
133
133
|
**Key Components:**
|
|
134
|
-
|
|
134
|
+
|
|
135
135
|
- Scene loading and unloading
|
|
136
136
|
- Data passing between scenes
|
|
137
137
|
- Transition effects
|
|
138
138
|
- Memory management
|
|
139
|
-
|
|
139
|
+
|
|
140
140
|
**Implementation Requirements:**
|
|
141
|
-
|
|
141
|
+
|
|
142
142
|
- Preload scene for asset loading
|
|
143
143
|
- Menu system with navigation
|
|
144
144
|
- Gameplay scenes with state management
|
|
145
145
|
- Pause/resume functionality
|
|
146
|
-
|
|
146
|
+
|
|
147
147
|
**Files to Create:**
|
|
148
|
-
|
|
148
|
+
|
|
149
149
|
- `src/scenes/BootScene.ts`
|
|
150
150
|
- `src/scenes/PreloadScene.ts`
|
|
151
151
|
- `src/scenes/MenuScene.ts`
|
|
@@ -155,23 +155,23 @@ sections:
|
|
|
155
155
|
title: Game State Management
|
|
156
156
|
template: |
|
|
157
157
|
**Purpose:** Track player progress and game status
|
|
158
|
-
|
|
158
|
+
|
|
159
159
|
**State Categories:**
|
|
160
|
-
|
|
160
|
+
|
|
161
161
|
- Player progress (levels, unlocks)
|
|
162
162
|
- Game settings (audio, controls)
|
|
163
163
|
- Session data (current level, score)
|
|
164
164
|
- Persistent data (achievements, statistics)
|
|
165
|
-
|
|
165
|
+
|
|
166
166
|
**Implementation Requirements:**
|
|
167
|
-
|
|
167
|
+
|
|
168
168
|
- Save/load system with localStorage
|
|
169
169
|
- State validation and error recovery
|
|
170
170
|
- Cross-session data persistence
|
|
171
171
|
- Settings management
|
|
172
|
-
|
|
172
|
+
|
|
173
173
|
**Files to Create:**
|
|
174
|
-
|
|
174
|
+
|
|
175
175
|
- `src/systems/GameState.ts`
|
|
176
176
|
- `src/systems/SaveManager.ts`
|
|
177
177
|
- `src/types/GameData.ts`
|
|
@@ -179,23 +179,23 @@ sections:
|
|
|
179
179
|
title: Asset Management System
|
|
180
180
|
template: |
|
|
181
181
|
**Purpose:** Efficient loading and management of game assets
|
|
182
|
-
|
|
182
|
+
|
|
183
183
|
**Asset Categories:**
|
|
184
|
-
|
|
184
|
+
|
|
185
185
|
- Sprite sheets and animations
|
|
186
186
|
- Audio files and music
|
|
187
187
|
- Level data and configurations
|
|
188
188
|
- UI assets and fonts
|
|
189
|
-
|
|
189
|
+
|
|
190
190
|
**Implementation Requirements:**
|
|
191
|
-
|
|
191
|
+
|
|
192
192
|
- Progressive loading strategy
|
|
193
193
|
- Asset caching and optimization
|
|
194
194
|
- Error handling for failed loads
|
|
195
195
|
- Memory management for large assets
|
|
196
|
-
|
|
196
|
+
|
|
197
197
|
**Files to Create:**
|
|
198
|
-
|
|
198
|
+
|
|
199
199
|
- `src/systems/AssetManager.ts`
|
|
200
200
|
- `src/config/AssetConfig.ts`
|
|
201
201
|
- `src/utils/AssetLoader.ts`
|
|
@@ -203,23 +203,23 @@ sections:
|
|
|
203
203
|
title: Input Management System
|
|
204
204
|
template: |
|
|
205
205
|
**Purpose:** Handle all player input across platforms
|
|
206
|
-
|
|
206
|
+
|
|
207
207
|
**Input Types:**
|
|
208
|
-
|
|
208
|
+
|
|
209
209
|
- Keyboard controls
|
|
210
210
|
- Mouse/pointer interaction
|
|
211
211
|
- Touch gestures (mobile)
|
|
212
212
|
- Gamepad support (optional)
|
|
213
|
-
|
|
213
|
+
|
|
214
214
|
**Implementation Requirements:**
|
|
215
|
-
|
|
215
|
+
|
|
216
216
|
- Input mapping and configuration
|
|
217
217
|
- Touch-friendly mobile controls
|
|
218
218
|
- Input buffering for responsive gameplay
|
|
219
219
|
- Customizable control schemes
|
|
220
|
-
|
|
220
|
+
|
|
221
221
|
**Files to Create:**
|
|
222
|
-
|
|
222
|
+
|
|
223
223
|
- `src/systems/InputManager.ts`
|
|
224
224
|
- `src/utils/TouchControls.ts`
|
|
225
225
|
- `src/types/InputTypes.ts`
|
|
@@ -232,19 +232,19 @@ sections:
|
|
|
232
232
|
title: "{{mechanic_name}} System"
|
|
233
233
|
template: |
|
|
234
234
|
**Purpose:** {{system_purpose}}
|
|
235
|
-
|
|
235
|
+
|
|
236
236
|
**Core Functionality:**
|
|
237
|
-
|
|
237
|
+
|
|
238
238
|
- {{feature_1}}
|
|
239
239
|
- {{feature_2}}
|
|
240
240
|
- {{feature_3}}
|
|
241
|
-
|
|
241
|
+
|
|
242
242
|
**Dependencies:** {{required_systems}}
|
|
243
|
-
|
|
243
|
+
|
|
244
244
|
**Performance Considerations:** {{optimization_notes}}
|
|
245
|
-
|
|
245
|
+
|
|
246
246
|
**Files to Create:**
|
|
247
|
-
|
|
247
|
+
|
|
248
248
|
- `src/systems/{{system_name}}.ts`
|
|
249
249
|
- `src/gameObjects/{{related_object}}.ts`
|
|
250
250
|
- `src/types/{{system_types}}.ts`
|
|
@@ -252,65 +252,65 @@ sections:
|
|
|
252
252
|
title: Physics & Collision System
|
|
253
253
|
template: |
|
|
254
254
|
**Physics Engine:** {{physics_choice}} (Arcade Physics/Matter.js)
|
|
255
|
-
|
|
255
|
+
|
|
256
256
|
**Collision Categories:**
|
|
257
|
-
|
|
257
|
+
|
|
258
258
|
- Player collision
|
|
259
259
|
- Enemy interactions
|
|
260
260
|
- Environmental objects
|
|
261
261
|
- Collectibles and items
|
|
262
|
-
|
|
262
|
+
|
|
263
263
|
**Implementation Requirements:**
|
|
264
|
-
|
|
264
|
+
|
|
265
265
|
- Optimized collision detection
|
|
266
266
|
- Physics body management
|
|
267
267
|
- Collision callbacks and events
|
|
268
268
|
- Performance monitoring
|
|
269
|
-
|
|
269
|
+
|
|
270
270
|
**Files to Create:**
|
|
271
|
-
|
|
271
|
+
|
|
272
272
|
- `src/systems/PhysicsManager.ts`
|
|
273
273
|
- `src/utils/CollisionGroups.ts`
|
|
274
274
|
- id: audio-system
|
|
275
275
|
title: Audio System
|
|
276
276
|
template: |
|
|
277
277
|
**Audio Requirements:**
|
|
278
|
-
|
|
278
|
+
|
|
279
279
|
- Background music with looping
|
|
280
280
|
- Sound effects for actions
|
|
281
281
|
- Audio settings and volume control
|
|
282
282
|
- Mobile audio optimization
|
|
283
|
-
|
|
283
|
+
|
|
284
284
|
**Implementation Features:**
|
|
285
|
-
|
|
285
|
+
|
|
286
286
|
- Audio sprite management
|
|
287
287
|
- Dynamic music system
|
|
288
288
|
- Spatial audio (if applicable)
|
|
289
289
|
- Audio pooling for performance
|
|
290
|
-
|
|
290
|
+
|
|
291
291
|
**Files to Create:**
|
|
292
|
-
|
|
292
|
+
|
|
293
293
|
- `src/systems/AudioManager.ts`
|
|
294
294
|
- `src/config/AudioConfig.ts`
|
|
295
295
|
- id: ui-system
|
|
296
296
|
title: UI System
|
|
297
297
|
template: |
|
|
298
298
|
**UI Components:**
|
|
299
|
-
|
|
299
|
+
|
|
300
300
|
- HUD elements (score, health, etc.)
|
|
301
301
|
- Menu navigation
|
|
302
302
|
- Modal dialogs
|
|
303
303
|
- Settings screens
|
|
304
|
-
|
|
304
|
+
|
|
305
305
|
**Implementation Requirements:**
|
|
306
|
-
|
|
306
|
+
|
|
307
307
|
- Responsive layout system
|
|
308
308
|
- Touch-friendly interface
|
|
309
309
|
- Keyboard navigation support
|
|
310
310
|
- Animation and transitions
|
|
311
|
-
|
|
311
|
+
|
|
312
312
|
**Files to Create:**
|
|
313
|
-
|
|
313
|
+
|
|
314
314
|
- `src/systems/UIManager.ts`
|
|
315
315
|
- `src/gameObjects/UI/`
|
|
316
316
|
- `src/types/UITypes.ts`
|
|
@@ -610,4 +610,4 @@ sections:
|
|
|
610
610
|
- 90%+ test coverage on game logic
|
|
611
611
|
- Zero TypeScript errors in strict mode
|
|
612
612
|
- Consistent adherence to coding standards
|
|
613
|
-
- Comprehensive documentation coverage
|
|
613
|
+
- Comprehensive documentation coverage
|
|
@@ -14,7 +14,7 @@ sections:
|
|
|
14
14
|
- id: initial-setup
|
|
15
15
|
instruction: |
|
|
16
16
|
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.
|
|
17
|
-
|
|
17
|
+
|
|
18
18
|
This brief is typically created early in the ideation process, often after brainstorming sessions, to crystallize the game concept before moving into detailed design.
|
|
19
19
|
|
|
20
20
|
- id: game-vision
|
|
@@ -71,7 +71,7 @@ sections:
|
|
|
71
71
|
repeatable: true
|
|
72
72
|
template: |
|
|
73
73
|
**Core Mechanic: {{mechanic_name}}**
|
|
74
|
-
|
|
74
|
+
|
|
75
75
|
- **Description:** {{how_it_works}}
|
|
76
76
|
- **Player Value:** {{why_its_fun}}
|
|
77
77
|
- **Implementation Scope:** {{complexity_estimate}}
|
|
@@ -98,12 +98,12 @@ sections:
|
|
|
98
98
|
title: Technical Constraints
|
|
99
99
|
template: |
|
|
100
100
|
**Platform Requirements:**
|
|
101
|
-
|
|
101
|
+
|
|
102
102
|
- Primary: {{platform_1}} - {{requirements}}
|
|
103
103
|
- Secondary: {{platform_2}} - {{requirements}}
|
|
104
|
-
|
|
104
|
+
|
|
105
105
|
**Technical Specifications:**
|
|
106
|
-
|
|
106
|
+
|
|
107
107
|
- Engine: Phaser 3 + TypeScript
|
|
108
108
|
- Performance Target: {{fps_target}} FPS on {{target_device}}
|
|
109
109
|
- Memory Budget: <{{memory_limit}}MB
|
|
@@ -141,10 +141,10 @@ sections:
|
|
|
141
141
|
title: Competitive Analysis
|
|
142
142
|
template: |
|
|
143
143
|
**Direct Competitors:**
|
|
144
|
-
|
|
144
|
+
|
|
145
145
|
- {{competitor_1}}: {{strengths_and_weaknesses}}
|
|
146
146
|
- {{competitor_2}}: {{strengths_and_weaknesses}}
|
|
147
|
-
|
|
147
|
+
|
|
148
148
|
**Differentiation Strategy:**
|
|
149
149
|
{{how_we_differ_and_why_thats_valuable}}
|
|
150
150
|
- id: market-opportunity
|
|
@@ -168,16 +168,16 @@ sections:
|
|
|
168
168
|
title: Content Categories
|
|
169
169
|
template: |
|
|
170
170
|
**Core Content:**
|
|
171
|
-
|
|
171
|
+
|
|
172
172
|
- {{content_type_1}}: {{quantity_and_description}}
|
|
173
173
|
- {{content_type_2}}: {{quantity_and_description}}
|
|
174
|
-
|
|
174
|
+
|
|
175
175
|
**Optional Content:**
|
|
176
|
-
|
|
176
|
+
|
|
177
177
|
- {{optional_content_type}}: {{quantity_and_description}}
|
|
178
|
-
|
|
178
|
+
|
|
179
179
|
**Replay Elements:**
|
|
180
|
-
|
|
180
|
+
|
|
181
181
|
- {{replayability_features}}
|
|
182
182
|
- id: difficulty-accessibility
|
|
183
183
|
title: Difficulty and Accessibility
|
|
@@ -244,13 +244,13 @@ sections:
|
|
|
244
244
|
title: Player Experience Metrics
|
|
245
245
|
template: |
|
|
246
246
|
**Engagement Goals:**
|
|
247
|
-
|
|
247
|
+
|
|
248
248
|
- Tutorial completion rate: >{{percentage}}%
|
|
249
249
|
- Average session length: {{duration}} minutes
|
|
250
250
|
- Player retention: D1 {{d1}}%, D7 {{d7}}%, D30 {{d30}}%
|
|
251
|
-
|
|
251
|
+
|
|
252
252
|
**Quality Benchmarks:**
|
|
253
|
-
|
|
253
|
+
|
|
254
254
|
- Player satisfaction: >{{rating}}/10
|
|
255
255
|
- Completion rate: >{{percentage}}%
|
|
256
256
|
- Technical performance: {{fps_target}} FPS consistent
|
|
@@ -258,13 +258,13 @@ sections:
|
|
|
258
258
|
title: Development Metrics
|
|
259
259
|
template: |
|
|
260
260
|
**Technical Targets:**
|
|
261
|
-
|
|
261
|
+
|
|
262
262
|
- Zero critical bugs at launch
|
|
263
263
|
- Performance targets met on all platforms
|
|
264
264
|
- Load times under {{seconds}}s
|
|
265
|
-
|
|
265
|
+
|
|
266
266
|
**Process Goals:**
|
|
267
|
-
|
|
267
|
+
|
|
268
268
|
- Development timeline adherence
|
|
269
269
|
- Feature scope completion
|
|
270
270
|
- Quality assurance standards
|
|
@@ -273,7 +273,7 @@ sections:
|
|
|
273
273
|
condition: has_business_goals
|
|
274
274
|
template: |
|
|
275
275
|
**Commercial Goals:**
|
|
276
|
-
|
|
276
|
+
|
|
277
277
|
- {{revenue_target}} in first {{time_period}}
|
|
278
278
|
- {{user_acquisition_target}} players in first {{time_period}}
|
|
279
279
|
- {{retention_target}} monthly active users
|
|
@@ -326,12 +326,12 @@ sections:
|
|
|
326
326
|
title: Validation Plan
|
|
327
327
|
template: |
|
|
328
328
|
**Concept Testing:**
|
|
329
|
-
|
|
329
|
+
|
|
330
330
|
- {{validation_method_1}} - {{timeline}}
|
|
331
331
|
- {{validation_method_2}} - {{timeline}}
|
|
332
|
-
|
|
332
|
+
|
|
333
333
|
**Prototype Testing:**
|
|
334
|
-
|
|
334
|
+
|
|
335
335
|
- {{testing_approach}} - {{timeline}}
|
|
336
336
|
- {{feedback_collection_method}} - {{timeline}}
|
|
337
337
|
|
|
@@ -353,4 +353,4 @@ sections:
|
|
|
353
353
|
type: table
|
|
354
354
|
template: |
|
|
355
355
|
| Date | Version | Description | Author |
|
|
356
|
-
| :--- | :------ | :---------- | :----- |
|
|
356
|
+
| :--- | :------ | :---------- | :----- |
|
|
@@ -14,7 +14,7 @@ sections:
|
|
|
14
14
|
- id: initial-setup
|
|
15
15
|
instruction: |
|
|
16
16
|
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.
|
|
17
|
-
|
|
17
|
+
|
|
18
18
|
If available, review any provided documents or ask if any are optionally available: Project Brief, Market Research, Competitive Analysis
|
|
19
19
|
|
|
20
20
|
- id: executive-summary
|
|
@@ -59,7 +59,7 @@ sections:
|
|
|
59
59
|
instruction: Define the 30-60 second loop that players will repeat. Be specific about timing and player actions.
|
|
60
60
|
template: |
|
|
61
61
|
**Primary Loop ({{duration}} seconds):**
|
|
62
|
-
|
|
62
|
+
|
|
63
63
|
1. {{action_1}} ({{time_1}}s)
|
|
64
64
|
2. {{action_2}} ({{time_2}}s)
|
|
65
65
|
3. {{action_3}} ({{time_3}}s)
|
|
@@ -69,12 +69,12 @@ sections:
|
|
|
69
69
|
instruction: Clearly define success and failure states
|
|
70
70
|
template: |
|
|
71
71
|
**Victory Conditions:**
|
|
72
|
-
|
|
72
|
+
|
|
73
73
|
- {{win_condition_1}}
|
|
74
74
|
- {{win_condition_2}}
|
|
75
|
-
|
|
75
|
+
|
|
76
76
|
**Failure States:**
|
|
77
|
-
|
|
77
|
+
|
|
78
78
|
- {{loss_condition_1}}
|
|
79
79
|
- {{loss_condition_2}}
|
|
80
80
|
|
|
@@ -90,17 +90,17 @@ sections:
|
|
|
90
90
|
title: "{{mechanic_name}}"
|
|
91
91
|
template: |
|
|
92
92
|
**Description:** {{detailed_description}}
|
|
93
|
-
|
|
93
|
+
|
|
94
94
|
**Player Input:** {{input_method}}
|
|
95
|
-
|
|
95
|
+
|
|
96
96
|
**System Response:** {{game_response}}
|
|
97
|
-
|
|
97
|
+
|
|
98
98
|
**Implementation Notes:**
|
|
99
|
-
|
|
99
|
+
|
|
100
100
|
- {{tech_requirement_1}}
|
|
101
101
|
- {{tech_requirement_2}}
|
|
102
102
|
- {{performance_consideration}}
|
|
103
|
-
|
|
103
|
+
|
|
104
104
|
**Dependencies:** {{other_mechanics_needed}}
|
|
105
105
|
- id: controls
|
|
106
106
|
title: Controls
|
|
@@ -119,9 +119,9 @@ sections:
|
|
|
119
119
|
title: Player Progression
|
|
120
120
|
template: |
|
|
121
121
|
**Progression Type:** {{linear|branching|metroidvania}}
|
|
122
|
-
|
|
122
|
+
|
|
123
123
|
**Key Milestones:**
|
|
124
|
-
|
|
124
|
+
|
|
125
125
|
1. **{{milestone_1}}** - {{unlock_description}}
|
|
126
126
|
2. **{{milestone_2}}** - {{unlock_description}}
|
|
127
127
|
3. **{{milestone_3}}** - {{unlock_description}}
|
|
@@ -158,9 +158,9 @@ sections:
|
|
|
158
158
|
**Duration:** {{target_time}}
|
|
159
159
|
**Key Elements:** {{required_mechanics}}
|
|
160
160
|
**Difficulty:** {{relative_difficulty}}
|
|
161
|
-
|
|
161
|
+
|
|
162
162
|
**Structure Template:**
|
|
163
|
-
|
|
163
|
+
|
|
164
164
|
- Introduction: {{intro_description}}
|
|
165
165
|
- Challenge: {{main_challenge}}
|
|
166
166
|
- Resolution: {{completion_requirement}}
|
|
@@ -186,13 +186,13 @@ sections:
|
|
|
186
186
|
title: Platform Specific
|
|
187
187
|
template: |
|
|
188
188
|
**Desktop:**
|
|
189
|
-
|
|
189
|
+
|
|
190
190
|
- Resolution: {{min_resolution}} - {{max_resolution}}
|
|
191
191
|
- Input: Keyboard, Mouse, Gamepad
|
|
192
192
|
- Browser: Chrome 80+, Firefox 75+, Safari 13+
|
|
193
|
-
|
|
193
|
+
|
|
194
194
|
**Mobile:**
|
|
195
|
-
|
|
195
|
+
|
|
196
196
|
- Resolution: {{mobile_min}} - {{mobile_max}}
|
|
197
197
|
- Input: Touch, Tilt (optional)
|
|
198
198
|
- OS: iOS 13+, Android 8+
|
|
@@ -201,14 +201,14 @@ sections:
|
|
|
201
201
|
instruction: Define asset specifications for the art and audio teams
|
|
202
202
|
template: |
|
|
203
203
|
**Visual Assets:**
|
|
204
|
-
|
|
204
|
+
|
|
205
205
|
- Art Style: {{style_description}}
|
|
206
206
|
- Color Palette: {{color_specification}}
|
|
207
207
|
- Animation: {{animation_requirements}}
|
|
208
208
|
- UI Resolution: {{ui_specs}}
|
|
209
|
-
|
|
209
|
+
|
|
210
210
|
**Audio Assets:**
|
|
211
|
-
|
|
211
|
+
|
|
212
212
|
- Music Style: {{music_genre}}
|
|
213
213
|
- Sound Effects: {{sfx_requirements}}
|
|
214
214
|
- Voice Acting: {{voice_needs}}
|
|
@@ -221,7 +221,7 @@ sections:
|
|
|
221
221
|
title: Engine Configuration
|
|
222
222
|
template: |
|
|
223
223
|
**Phaser 3 Setup:**
|
|
224
|
-
|
|
224
|
+
|
|
225
225
|
- TypeScript: Strict mode enabled
|
|
226
226
|
- Physics: {{physics_system}} (Arcade/Matter)
|
|
227
227
|
- Renderer: WebGL with Canvas fallback
|
|
@@ -230,7 +230,7 @@ sections:
|
|
|
230
230
|
title: Code Architecture
|
|
231
231
|
template: |
|
|
232
232
|
**Required Systems:**
|
|
233
|
-
|
|
233
|
+
|
|
234
234
|
- Scene Management
|
|
235
235
|
- State Management
|
|
236
236
|
- Asset Loading
|
|
@@ -242,7 +242,7 @@ sections:
|
|
|
242
242
|
title: Data Management
|
|
243
243
|
template: |
|
|
244
244
|
**Save Data:**
|
|
245
|
-
|
|
245
|
+
|
|
246
246
|
- Progress tracking
|
|
247
247
|
- Settings persistence
|
|
248
248
|
- Statistics collection
|
|
@@ -340,4 +340,4 @@ sections:
|
|
|
340
340
|
title: References
|
|
341
341
|
instruction: List any competitive analysis, inspiration, or research sources
|
|
342
342
|
type: bullet-list
|
|
343
|
-
template: "{{reference}}"
|
|
343
|
+
template: "{{reference}}"
|