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
|
@@ -991,7 +991,7 @@ sections:
|
|
|
991
991
|
- id: initial-setup
|
|
992
992
|
instruction: |
|
|
993
993
|
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.
|
|
994
|
-
|
|
994
|
+
|
|
995
995
|
If available, review any provided documents or ask if any are optionally available: Project Brief, Market Research, Competitive Analysis
|
|
996
996
|
|
|
997
997
|
- id: executive-summary
|
|
@@ -1036,7 +1036,7 @@ sections:
|
|
|
1036
1036
|
instruction: Define the 30-60 second loop that players will repeat. Be specific about timing and player actions.
|
|
1037
1037
|
template: |
|
|
1038
1038
|
**Primary Loop ({{duration}} seconds):**
|
|
1039
|
-
|
|
1039
|
+
|
|
1040
1040
|
1. {{action_1}} ({{time_1}}s)
|
|
1041
1041
|
2. {{action_2}} ({{time_2}}s)
|
|
1042
1042
|
3. {{action_3}} ({{time_3}}s)
|
|
@@ -1046,12 +1046,12 @@ sections:
|
|
|
1046
1046
|
instruction: Clearly define success and failure states
|
|
1047
1047
|
template: |
|
|
1048
1048
|
**Victory Conditions:**
|
|
1049
|
-
|
|
1049
|
+
|
|
1050
1050
|
- {{win_condition_1}}
|
|
1051
1051
|
- {{win_condition_2}}
|
|
1052
|
-
|
|
1052
|
+
|
|
1053
1053
|
**Failure States:**
|
|
1054
|
-
|
|
1054
|
+
|
|
1055
1055
|
- {{loss_condition_1}}
|
|
1056
1056
|
- {{loss_condition_2}}
|
|
1057
1057
|
|
|
@@ -1067,17 +1067,17 @@ sections:
|
|
|
1067
1067
|
title: "{{mechanic_name}}"
|
|
1068
1068
|
template: |
|
|
1069
1069
|
**Description:** {{detailed_description}}
|
|
1070
|
-
|
|
1070
|
+
|
|
1071
1071
|
**Player Input:** {{input_method}}
|
|
1072
|
-
|
|
1072
|
+
|
|
1073
1073
|
**System Response:** {{game_response}}
|
|
1074
|
-
|
|
1074
|
+
|
|
1075
1075
|
**Implementation Notes:**
|
|
1076
|
-
|
|
1076
|
+
|
|
1077
1077
|
- {{tech_requirement_1}}
|
|
1078
1078
|
- {{tech_requirement_2}}
|
|
1079
1079
|
- {{performance_consideration}}
|
|
1080
|
-
|
|
1080
|
+
|
|
1081
1081
|
**Dependencies:** {{other_mechanics_needed}}
|
|
1082
1082
|
- id: controls
|
|
1083
1083
|
title: Controls
|
|
@@ -1096,9 +1096,9 @@ sections:
|
|
|
1096
1096
|
title: Player Progression
|
|
1097
1097
|
template: |
|
|
1098
1098
|
**Progression Type:** {{linear|branching|metroidvania}}
|
|
1099
|
-
|
|
1099
|
+
|
|
1100
1100
|
**Key Milestones:**
|
|
1101
|
-
|
|
1101
|
+
|
|
1102
1102
|
1. **{{milestone_1}}** - {{unlock_description}}
|
|
1103
1103
|
2. **{{milestone_2}}** - {{unlock_description}}
|
|
1104
1104
|
3. **{{milestone_3}}** - {{unlock_description}}
|
|
@@ -1135,9 +1135,9 @@ sections:
|
|
|
1135
1135
|
**Duration:** {{target_time}}
|
|
1136
1136
|
**Key Elements:** {{required_mechanics}}
|
|
1137
1137
|
**Difficulty:** {{relative_difficulty}}
|
|
1138
|
-
|
|
1138
|
+
|
|
1139
1139
|
**Structure Template:**
|
|
1140
|
-
|
|
1140
|
+
|
|
1141
1141
|
- Introduction: {{intro_description}}
|
|
1142
1142
|
- Challenge: {{main_challenge}}
|
|
1143
1143
|
- Resolution: {{completion_requirement}}
|
|
@@ -1163,13 +1163,13 @@ sections:
|
|
|
1163
1163
|
title: Platform Specific
|
|
1164
1164
|
template: |
|
|
1165
1165
|
**Desktop:**
|
|
1166
|
-
|
|
1166
|
+
|
|
1167
1167
|
- Resolution: {{min_resolution}} - {{max_resolution}}
|
|
1168
1168
|
- Input: Keyboard, Mouse, Gamepad
|
|
1169
1169
|
- Browser: Chrome 80+, Firefox 75+, Safari 13+
|
|
1170
|
-
|
|
1170
|
+
|
|
1171
1171
|
**Mobile:**
|
|
1172
|
-
|
|
1172
|
+
|
|
1173
1173
|
- Resolution: {{mobile_min}} - {{mobile_max}}
|
|
1174
1174
|
- Input: Touch, Tilt (optional)
|
|
1175
1175
|
- OS: iOS 13+, Android 8+
|
|
@@ -1178,14 +1178,14 @@ sections:
|
|
|
1178
1178
|
instruction: Define asset specifications for the art and audio teams
|
|
1179
1179
|
template: |
|
|
1180
1180
|
**Visual Assets:**
|
|
1181
|
-
|
|
1181
|
+
|
|
1182
1182
|
- Art Style: {{style_description}}
|
|
1183
1183
|
- Color Palette: {{color_specification}}
|
|
1184
1184
|
- Animation: {{animation_requirements}}
|
|
1185
1185
|
- UI Resolution: {{ui_specs}}
|
|
1186
|
-
|
|
1186
|
+
|
|
1187
1187
|
**Audio Assets:**
|
|
1188
|
-
|
|
1188
|
+
|
|
1189
1189
|
- Music Style: {{music_genre}}
|
|
1190
1190
|
- Sound Effects: {{sfx_requirements}}
|
|
1191
1191
|
- Voice Acting: {{voice_needs}}
|
|
@@ -1198,7 +1198,7 @@ sections:
|
|
|
1198
1198
|
title: Engine Configuration
|
|
1199
1199
|
template: |
|
|
1200
1200
|
**Phaser 3 Setup:**
|
|
1201
|
-
|
|
1201
|
+
|
|
1202
1202
|
- TypeScript: Strict mode enabled
|
|
1203
1203
|
- Physics: {{physics_system}} (Arcade/Matter)
|
|
1204
1204
|
- Renderer: WebGL with Canvas fallback
|
|
@@ -1207,7 +1207,7 @@ sections:
|
|
|
1207
1207
|
title: Code Architecture
|
|
1208
1208
|
template: |
|
|
1209
1209
|
**Required Systems:**
|
|
1210
|
-
|
|
1210
|
+
|
|
1211
1211
|
- Scene Management
|
|
1212
1212
|
- State Management
|
|
1213
1213
|
- Asset Loading
|
|
@@ -1219,7 +1219,7 @@ sections:
|
|
|
1219
1219
|
title: Data Management
|
|
1220
1220
|
template: |
|
|
1221
1221
|
**Save Data:**
|
|
1222
|
-
|
|
1222
|
+
|
|
1223
1223
|
- Progress tracking
|
|
1224
1224
|
- Settings persistence
|
|
1225
1225
|
- Statistics collection
|
|
@@ -1337,7 +1337,7 @@ sections:
|
|
|
1337
1337
|
- id: initial-setup
|
|
1338
1338
|
instruction: |
|
|
1339
1339
|
This template creates comprehensive level design documentation that guides both content creation and technical implementation. This document should provide enough detail for developers to create level loading systems and for designers to create specific levels.
|
|
1340
|
-
|
|
1340
|
+
|
|
1341
1341
|
If available, review: Game Design Document (GDD), Game Architecture Document. This document should align with the game mechanics and technical systems defined in those documents.
|
|
1342
1342
|
|
|
1343
1343
|
- id: introduction
|
|
@@ -1345,7 +1345,7 @@ sections:
|
|
|
1345
1345
|
instruction: Establish the purpose and scope of level design for this game
|
|
1346
1346
|
content: |
|
|
1347
1347
|
This document defines the level design framework for {{game_title}}, providing guidelines for creating engaging, balanced levels that support the core gameplay mechanics defined in the Game Design Document.
|
|
1348
|
-
|
|
1348
|
+
|
|
1349
1349
|
This framework ensures consistency across all levels while providing flexibility for creative level design within established technical and design constraints.
|
|
1350
1350
|
sections:
|
|
1351
1351
|
- id: change-log
|
|
@@ -1392,29 +1392,29 @@ sections:
|
|
|
1392
1392
|
title: "{{category_name}} Levels"
|
|
1393
1393
|
template: |
|
|
1394
1394
|
**Purpose:** {{gameplay_purpose}}
|
|
1395
|
-
|
|
1395
|
+
|
|
1396
1396
|
**Target Duration:** {{min_time}} - {{max_time}} minutes
|
|
1397
|
-
|
|
1397
|
+
|
|
1398
1398
|
**Difficulty Range:** {{difficulty_scale}}
|
|
1399
|
-
|
|
1399
|
+
|
|
1400
1400
|
**Key Mechanics Featured:**
|
|
1401
|
-
|
|
1401
|
+
|
|
1402
1402
|
- {{mechanic_1}} - {{usage_description}}
|
|
1403
1403
|
- {{mechanic_2}} - {{usage_description}}
|
|
1404
|
-
|
|
1404
|
+
|
|
1405
1405
|
**Player Objectives:**
|
|
1406
|
-
|
|
1406
|
+
|
|
1407
1407
|
- Primary: {{primary_objective}}
|
|
1408
1408
|
- Secondary: {{secondary_objective}}
|
|
1409
1409
|
- Hidden: {{secret_objective}}
|
|
1410
|
-
|
|
1410
|
+
|
|
1411
1411
|
**Success Criteria:**
|
|
1412
|
-
|
|
1412
|
+
|
|
1413
1413
|
- {{completion_requirement_1}}
|
|
1414
1414
|
- {{completion_requirement_2}}
|
|
1415
|
-
|
|
1415
|
+
|
|
1416
1416
|
**Technical Requirements:**
|
|
1417
|
-
|
|
1417
|
+
|
|
1418
1418
|
- Maximum entities: {{entity_limit}}
|
|
1419
1419
|
- Performance target: {{fps_target}} FPS
|
|
1420
1420
|
- Memory budget: {{memory_limit}}MB
|
|
@@ -1429,11 +1429,11 @@ sections:
|
|
|
1429
1429
|
instruction: Based on GDD requirements, define the overall level organization
|
|
1430
1430
|
template: |
|
|
1431
1431
|
**Organization Type:** {{linear|hub_world|open_world}}
|
|
1432
|
-
|
|
1432
|
+
|
|
1433
1433
|
**Total Level Count:** {{number}}
|
|
1434
|
-
|
|
1434
|
+
|
|
1435
1435
|
**World Breakdown:**
|
|
1436
|
-
|
|
1436
|
+
|
|
1437
1437
|
- World 1: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
|
1438
1438
|
- World 2: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
|
1439
1439
|
- World 3: {{level_count}} levels - {{theme}} - {{difficulty_range}}
|
|
@@ -1468,7 +1468,7 @@ sections:
|
|
|
1468
1468
|
instruction: Define how players access new levels
|
|
1469
1469
|
template: |
|
|
1470
1470
|
**Progression Gates:**
|
|
1471
|
-
|
|
1471
|
+
|
|
1472
1472
|
- Linear progression: Complete previous level
|
|
1473
1473
|
- Star requirements: {{star_count}} stars to unlock
|
|
1474
1474
|
- Skill gates: Demonstrate {{skill_requirement}}
|
|
@@ -1483,17 +1483,17 @@ sections:
|
|
|
1483
1483
|
instruction: Define all environmental components that can be used in levels
|
|
1484
1484
|
template: |
|
|
1485
1485
|
**Terrain Types:**
|
|
1486
|
-
|
|
1486
|
+
|
|
1487
1487
|
- {{terrain_1}}: {{properties_and_usage}}
|
|
1488
1488
|
- {{terrain_2}}: {{properties_and_usage}}
|
|
1489
|
-
|
|
1489
|
+
|
|
1490
1490
|
**Interactive Objects:**
|
|
1491
|
-
|
|
1491
|
+
|
|
1492
1492
|
- {{object_1}}: {{behavior_and_purpose}}
|
|
1493
1493
|
- {{object_2}}: {{behavior_and_purpose}}
|
|
1494
|
-
|
|
1494
|
+
|
|
1495
1495
|
**Hazards and Obstacles:**
|
|
1496
|
-
|
|
1496
|
+
|
|
1497
1497
|
- {{hazard_1}}: {{damage_and_behavior}}
|
|
1498
1498
|
- {{hazard_2}}: {{damage_and_behavior}}
|
|
1499
1499
|
- id: collectibles-rewards
|
|
@@ -1501,18 +1501,18 @@ sections:
|
|
|
1501
1501
|
instruction: Define all collectible items and their placement rules
|
|
1502
1502
|
template: |
|
|
1503
1503
|
**Collectible Types:**
|
|
1504
|
-
|
|
1504
|
+
|
|
1505
1505
|
- {{collectible_1}}: {{value_and_purpose}}
|
|
1506
1506
|
- {{collectible_2}}: {{value_and_purpose}}
|
|
1507
|
-
|
|
1507
|
+
|
|
1508
1508
|
**Placement Guidelines:**
|
|
1509
|
-
|
|
1509
|
+
|
|
1510
1510
|
- Mandatory collectibles: {{placement_rules}}
|
|
1511
1511
|
- Optional collectibles: {{placement_rules}}
|
|
1512
1512
|
- Secret collectibles: {{placement_rules}}
|
|
1513
|
-
|
|
1513
|
+
|
|
1514
1514
|
**Reward Distribution:**
|
|
1515
|
-
|
|
1515
|
+
|
|
1516
1516
|
- Easy to find: {{percentage}}%
|
|
1517
1517
|
- Moderate challenge: {{percentage}}%
|
|
1518
1518
|
- High skill required: {{percentage}}%
|
|
@@ -1521,18 +1521,18 @@ sections:
|
|
|
1521
1521
|
instruction: Define how enemies should be placed and balanced in levels
|
|
1522
1522
|
template: |
|
|
1523
1523
|
**Enemy Categories:**
|
|
1524
|
-
|
|
1524
|
+
|
|
1525
1525
|
- {{enemy_type_1}}: {{behavior_and_usage}}
|
|
1526
1526
|
- {{enemy_type_2}}: {{behavior_and_usage}}
|
|
1527
|
-
|
|
1527
|
+
|
|
1528
1528
|
**Placement Principles:**
|
|
1529
|
-
|
|
1529
|
+
|
|
1530
1530
|
- Introduction encounters: {{guideline}}
|
|
1531
1531
|
- Standard encounters: {{guideline}}
|
|
1532
1532
|
- Challenge encounters: {{guideline}}
|
|
1533
|
-
|
|
1533
|
+
|
|
1534
1534
|
**Difficulty Scaling:**
|
|
1535
|
-
|
|
1535
|
+
|
|
1536
1536
|
- Enemy count progression: {{scaling_rule}}
|
|
1537
1537
|
- Enemy type introduction: {{pacing_rule}}
|
|
1538
1538
|
- Encounter complexity: {{complexity_rule}}
|
|
@@ -1545,14 +1545,14 @@ sections:
|
|
|
1545
1545
|
title: Level Layout Principles
|
|
1546
1546
|
template: |
|
|
1547
1547
|
**Spatial Design:**
|
|
1548
|
-
|
|
1548
|
+
|
|
1549
1549
|
- Grid size: {{grid_dimensions}}
|
|
1550
1550
|
- Minimum path width: {{width_units}}
|
|
1551
1551
|
- Maximum vertical distance: {{height_units}}
|
|
1552
1552
|
- Safe zones placement: {{safety_guidelines}}
|
|
1553
|
-
|
|
1553
|
+
|
|
1554
1554
|
**Navigation Design:**
|
|
1555
|
-
|
|
1555
|
+
|
|
1556
1556
|
- Clear path indication: {{visual_cues}}
|
|
1557
1557
|
- Landmark placement: {{landmark_rules}}
|
|
1558
1558
|
- Dead end avoidance: {{dead_end_policy}}
|
|
@@ -1562,13 +1562,13 @@ sections:
|
|
|
1562
1562
|
instruction: Define how to control the rhythm and pace of gameplay within levels
|
|
1563
1563
|
template: |
|
|
1564
1564
|
**Action Sequences:**
|
|
1565
|
-
|
|
1565
|
+
|
|
1566
1566
|
- High intensity duration: {{max_duration}}
|
|
1567
1567
|
- Rest period requirement: {{min_rest_time}}
|
|
1568
1568
|
- Intensity variation: {{pacing_pattern}}
|
|
1569
|
-
|
|
1569
|
+
|
|
1570
1570
|
**Learning Sequences:**
|
|
1571
|
-
|
|
1571
|
+
|
|
1572
1572
|
- New mechanic introduction: {{teaching_method}}
|
|
1573
1573
|
- Practice opportunity: {{practice_duration}}
|
|
1574
1574
|
- Skill application: {{application_context}}
|
|
@@ -1577,14 +1577,14 @@ sections:
|
|
|
1577
1577
|
instruction: Define how to create appropriate challenges for each level type
|
|
1578
1578
|
template: |
|
|
1579
1579
|
**Challenge Types:**
|
|
1580
|
-
|
|
1580
|
+
|
|
1581
1581
|
- Execution challenges: {{skill_requirements}}
|
|
1582
1582
|
- Puzzle challenges: {{complexity_guidelines}}
|
|
1583
1583
|
- Time challenges: {{time_pressure_rules}}
|
|
1584
1584
|
- Resource challenges: {{resource_management}}
|
|
1585
|
-
|
|
1585
|
+
|
|
1586
1586
|
**Difficulty Calibration:**
|
|
1587
|
-
|
|
1587
|
+
|
|
1588
1588
|
- Skill check frequency: {{frequency_guidelines}}
|
|
1589
1589
|
- Failure recovery: {{retry_mechanics}}
|
|
1590
1590
|
- Hint system integration: {{help_system}}
|
|
@@ -1598,7 +1598,7 @@ sections:
|
|
|
1598
1598
|
instruction: Define how level data should be structured for implementation
|
|
1599
1599
|
template: |
|
|
1600
1600
|
**Level File Format:**
|
|
1601
|
-
|
|
1601
|
+
|
|
1602
1602
|
- Data format: {{json|yaml|custom}}
|
|
1603
1603
|
- File naming: `level_{{world}}_{{number}}.{{extension}}`
|
|
1604
1604
|
- Data organization: {{structure_description}}
|
|
@@ -1636,14 +1636,14 @@ sections:
|
|
|
1636
1636
|
instruction: Define how level assets are organized and loaded
|
|
1637
1637
|
template: |
|
|
1638
1638
|
**Tilemap Requirements:**
|
|
1639
|
-
|
|
1639
|
+
|
|
1640
1640
|
- Tile size: {{tile_dimensions}}px
|
|
1641
1641
|
- Tileset organization: {{tileset_structure}}
|
|
1642
1642
|
- Layer organization: {{layer_system}}
|
|
1643
1643
|
- Collision data: {{collision_format}}
|
|
1644
|
-
|
|
1644
|
+
|
|
1645
1645
|
**Audio Integration:**
|
|
1646
|
-
|
|
1646
|
+
|
|
1647
1647
|
- Background music: {{music_requirements}}
|
|
1648
1648
|
- Ambient sounds: {{ambient_system}}
|
|
1649
1649
|
- Dynamic audio: {{dynamic_audio_rules}}
|
|
@@ -1652,19 +1652,19 @@ sections:
|
|
|
1652
1652
|
instruction: Define performance requirements for level systems
|
|
1653
1653
|
template: |
|
|
1654
1654
|
**Entity Limits:**
|
|
1655
|
-
|
|
1655
|
+
|
|
1656
1656
|
- Maximum active entities: {{entity_limit}}
|
|
1657
1657
|
- Maximum particles: {{particle_limit}}
|
|
1658
1658
|
- Maximum audio sources: {{audio_limit}}
|
|
1659
|
-
|
|
1659
|
+
|
|
1660
1660
|
**Memory Management:**
|
|
1661
|
-
|
|
1661
|
+
|
|
1662
1662
|
- Texture memory budget: {{texture_memory}}MB
|
|
1663
1663
|
- Audio memory budget: {{audio_memory}}MB
|
|
1664
1664
|
- Level loading time: <{{load_time}}s
|
|
1665
|
-
|
|
1665
|
+
|
|
1666
1666
|
**Culling and LOD:**
|
|
1667
|
-
|
|
1667
|
+
|
|
1668
1668
|
- Off-screen culling: {{culling_distance}}
|
|
1669
1669
|
- Level-of-detail rules: {{lod_system}}
|
|
1670
1670
|
- Asset streaming: {{streaming_requirements}}
|
|
@@ -1677,13 +1677,13 @@ sections:
|
|
|
1677
1677
|
title: Automated Testing
|
|
1678
1678
|
template: |
|
|
1679
1679
|
**Performance Testing:**
|
|
1680
|
-
|
|
1680
|
+
|
|
1681
1681
|
- Frame rate validation: Maintain {{fps_target}} FPS
|
|
1682
1682
|
- Memory usage monitoring: Stay under {{memory_limit}}MB
|
|
1683
1683
|
- Loading time verification: Complete in <{{load_time}}s
|
|
1684
|
-
|
|
1684
|
+
|
|
1685
1685
|
**Gameplay Testing:**
|
|
1686
|
-
|
|
1686
|
+
|
|
1687
1687
|
- Completion path validation: All objectives achievable
|
|
1688
1688
|
- Collectible accessibility: All items reachable
|
|
1689
1689
|
- Softlock prevention: No unwinnable states
|
|
@@ -1711,14 +1711,14 @@ sections:
|
|
|
1711
1711
|
title: Balance Validation
|
|
1712
1712
|
template: |
|
|
1713
1713
|
**Metrics Collection:**
|
|
1714
|
-
|
|
1714
|
+
|
|
1715
1715
|
- Completion rate: Target {{completion_percentage}}%
|
|
1716
1716
|
- Average completion time: {{target_time}} ± {{variance}}
|
|
1717
1717
|
- Death count per level: <{{max_deaths}}
|
|
1718
1718
|
- Collectible discovery rate: {{discovery_percentage}}%
|
|
1719
|
-
|
|
1719
|
+
|
|
1720
1720
|
**Iteration Guidelines:**
|
|
1721
|
-
|
|
1721
|
+
|
|
1722
1722
|
- Adjustment criteria: {{criteria_for_changes}}
|
|
1723
1723
|
- Testing sample size: {{minimum_testers}}
|
|
1724
1724
|
- Validation period: {{testing_duration}}
|
|
@@ -1731,14 +1731,14 @@ sections:
|
|
|
1731
1731
|
title: Design Phase
|
|
1732
1732
|
template: |
|
|
1733
1733
|
**Concept Development:**
|
|
1734
|
-
|
|
1734
|
+
|
|
1735
1735
|
1. Define level purpose and goals
|
|
1736
1736
|
2. Create rough layout sketch
|
|
1737
1737
|
3. Identify key mechanics and challenges
|
|
1738
1738
|
4. Estimate difficulty and duration
|
|
1739
|
-
|
|
1739
|
+
|
|
1740
1740
|
**Documentation Requirements:**
|
|
1741
|
-
|
|
1741
|
+
|
|
1742
1742
|
- Level design brief
|
|
1743
1743
|
- Layout diagrams
|
|
1744
1744
|
- Mechanic integration notes
|
|
@@ -1747,15 +1747,15 @@ sections:
|
|
|
1747
1747
|
title: Implementation Phase
|
|
1748
1748
|
template: |
|
|
1749
1749
|
**Technical Implementation:**
|
|
1750
|
-
|
|
1750
|
+
|
|
1751
1751
|
1. Create level data file
|
|
1752
1752
|
2. Build tilemap and layout
|
|
1753
1753
|
3. Place entities and objects
|
|
1754
1754
|
4. Configure level logic and triggers
|
|
1755
1755
|
5. Integrate audio and visual effects
|
|
1756
|
-
|
|
1756
|
+
|
|
1757
1757
|
**Quality Assurance:**
|
|
1758
|
-
|
|
1758
|
+
|
|
1759
1759
|
1. Automated testing execution
|
|
1760
1760
|
2. Internal playtesting
|
|
1761
1761
|
3. Performance validation
|
|
@@ -1764,14 +1764,14 @@ sections:
|
|
|
1764
1764
|
title: Integration Phase
|
|
1765
1765
|
template: |
|
|
1766
1766
|
**Game Integration:**
|
|
1767
|
-
|
|
1767
|
+
|
|
1768
1768
|
1. Level progression integration
|
|
1769
1769
|
2. Save system compatibility
|
|
1770
1770
|
3. Analytics integration
|
|
1771
1771
|
4. Achievement system integration
|
|
1772
|
-
|
|
1772
|
+
|
|
1773
1773
|
**Final Validation:**
|
|
1774
|
-
|
|
1774
|
+
|
|
1775
1775
|
1. Full game context testing
|
|
1776
1776
|
2. Performance regression testing
|
|
1777
1777
|
3. Platform compatibility verification
|
|
@@ -1824,7 +1824,7 @@ sections:
|
|
|
1824
1824
|
- id: initial-setup
|
|
1825
1825
|
instruction: |
|
|
1826
1826
|
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.
|
|
1827
|
-
|
|
1827
|
+
|
|
1828
1828
|
This brief is typically created early in the ideation process, often after brainstorming sessions, to crystallize the game concept before moving into detailed design.
|
|
1829
1829
|
|
|
1830
1830
|
- id: game-vision
|
|
@@ -1881,7 +1881,7 @@ sections:
|
|
|
1881
1881
|
repeatable: true
|
|
1882
1882
|
template: |
|
|
1883
1883
|
**Core Mechanic: {{mechanic_name}}**
|
|
1884
|
-
|
|
1884
|
+
|
|
1885
1885
|
- **Description:** {{how_it_works}}
|
|
1886
1886
|
- **Player Value:** {{why_its_fun}}
|
|
1887
1887
|
- **Implementation Scope:** {{complexity_estimate}}
|
|
@@ -1908,12 +1908,12 @@ sections:
|
|
|
1908
1908
|
title: Technical Constraints
|
|
1909
1909
|
template: |
|
|
1910
1910
|
**Platform Requirements:**
|
|
1911
|
-
|
|
1911
|
+
|
|
1912
1912
|
- Primary: {{platform_1}} - {{requirements}}
|
|
1913
1913
|
- Secondary: {{platform_2}} - {{requirements}}
|
|
1914
|
-
|
|
1914
|
+
|
|
1915
1915
|
**Technical Specifications:**
|
|
1916
|
-
|
|
1916
|
+
|
|
1917
1917
|
- Engine: Phaser 3 + TypeScript
|
|
1918
1918
|
- Performance Target: {{fps_target}} FPS on {{target_device}}
|
|
1919
1919
|
- Memory Budget: <{{memory_limit}}MB
|
|
@@ -1951,10 +1951,10 @@ sections:
|
|
|
1951
1951
|
title: Competitive Analysis
|
|
1952
1952
|
template: |
|
|
1953
1953
|
**Direct Competitors:**
|
|
1954
|
-
|
|
1954
|
+
|
|
1955
1955
|
- {{competitor_1}}: {{strengths_and_weaknesses}}
|
|
1956
1956
|
- {{competitor_2}}: {{strengths_and_weaknesses}}
|
|
1957
|
-
|
|
1957
|
+
|
|
1958
1958
|
**Differentiation Strategy:**
|
|
1959
1959
|
{{how_we_differ_and_why_thats_valuable}}
|
|
1960
1960
|
- id: market-opportunity
|
|
@@ -1978,16 +1978,16 @@ sections:
|
|
|
1978
1978
|
title: Content Categories
|
|
1979
1979
|
template: |
|
|
1980
1980
|
**Core Content:**
|
|
1981
|
-
|
|
1981
|
+
|
|
1982
1982
|
- {{content_type_1}}: {{quantity_and_description}}
|
|
1983
1983
|
- {{content_type_2}}: {{quantity_and_description}}
|
|
1984
|
-
|
|
1984
|
+
|
|
1985
1985
|
**Optional Content:**
|
|
1986
|
-
|
|
1986
|
+
|
|
1987
1987
|
- {{optional_content_type}}: {{quantity_and_description}}
|
|
1988
|
-
|
|
1988
|
+
|
|
1989
1989
|
**Replay Elements:**
|
|
1990
|
-
|
|
1990
|
+
|
|
1991
1991
|
- {{replayability_features}}
|
|
1992
1992
|
- id: difficulty-accessibility
|
|
1993
1993
|
title: Difficulty and Accessibility
|
|
@@ -2054,13 +2054,13 @@ sections:
|
|
|
2054
2054
|
title: Player Experience Metrics
|
|
2055
2055
|
template: |
|
|
2056
2056
|
**Engagement Goals:**
|
|
2057
|
-
|
|
2057
|
+
|
|
2058
2058
|
- Tutorial completion rate: >{{percentage}}%
|
|
2059
2059
|
- Average session length: {{duration}} minutes
|
|
2060
2060
|
- Player retention: D1 {{d1}}%, D7 {{d7}}%, D30 {{d30}}%
|
|
2061
|
-
|
|
2061
|
+
|
|
2062
2062
|
**Quality Benchmarks:**
|
|
2063
|
-
|
|
2063
|
+
|
|
2064
2064
|
- Player satisfaction: >{{rating}}/10
|
|
2065
2065
|
- Completion rate: >{{percentage}}%
|
|
2066
2066
|
- Technical performance: {{fps_target}} FPS consistent
|
|
@@ -2068,13 +2068,13 @@ sections:
|
|
|
2068
2068
|
title: Development Metrics
|
|
2069
2069
|
template: |
|
|
2070
2070
|
**Technical Targets:**
|
|
2071
|
-
|
|
2071
|
+
|
|
2072
2072
|
- Zero critical bugs at launch
|
|
2073
2073
|
- Performance targets met on all platforms
|
|
2074
2074
|
- Load times under {{seconds}}s
|
|
2075
|
-
|
|
2075
|
+
|
|
2076
2076
|
**Process Goals:**
|
|
2077
|
-
|
|
2077
|
+
|
|
2078
2078
|
- Development timeline adherence
|
|
2079
2079
|
- Feature scope completion
|
|
2080
2080
|
- Quality assurance standards
|
|
@@ -2083,7 +2083,7 @@ sections:
|
|
|
2083
2083
|
condition: has_business_goals
|
|
2084
2084
|
template: |
|
|
2085
2085
|
**Commercial Goals:**
|
|
2086
|
-
|
|
2086
|
+
|
|
2087
2087
|
- {{revenue_target}} in first {{time_period}}
|
|
2088
2088
|
- {{user_acquisition_target}} players in first {{time_period}}
|
|
2089
2089
|
- {{retention_target}} monthly active users
|
|
@@ -2136,12 +2136,12 @@ sections:
|
|
|
2136
2136
|
title: Validation Plan
|
|
2137
2137
|
template: |
|
|
2138
2138
|
**Concept Testing:**
|
|
2139
|
-
|
|
2139
|
+
|
|
2140
2140
|
- {{validation_method_1}} - {{timeline}}
|
|
2141
2141
|
- {{validation_method_2}} - {{timeline}}
|
|
2142
|
-
|
|
2142
|
+
|
|
2143
2143
|
**Prototype Testing:**
|
|
2144
|
-
|
|
2144
|
+
|
|
2145
2145
|
- {{testing_approach}} - {{timeline}}
|
|
2146
2146
|
- {{feedback_collection_method}} - {{timeline}}
|
|
2147
2147
|
|