|
2 | 2 | title: "Custom Content" |
3 | 3 | --- |
4 | 4 |
|
5 | | -BMad supports several categories of custom content that extend the platform's capabilities — from simple personal agents to full-featured professional modules. |
| 5 | +BMad supports several categories of custom content that extend the platform's capabilities. This ranges from simple personal agents to full-featured professional modules. |
6 | 6 |
|
7 | | -:::tip[Recommended Approach] |
8 | | -Use the BMad Builder (BoMB) Module for guided workflows and expertise when creating custom content. |
9 | | -::: |
| 7 | +## Overview |
10 | 8 |
|
11 | | -This flexibility enables: |
| 9 | +This flexibility lets you: |
12 | 10 |
|
13 | | -- Extensions and add-ons for existing modules (BMad Method, Creative Intelligence Suite) |
| 11 | +- Extensions and add-ons for existing modules |
14 | 12 | - Completely new modules, workflows, templates, and agents outside software engineering |
15 | 13 | - Professional services tools |
16 | | -- Entertainment and educational content |
17 | | -- Science and engineering workflows |
18 | | -- Productivity and self-help solutions |
19 | 14 | - Role-specific augmentation for virtually any profession |
20 | 15 |
|
21 | | -## Categories |
| 16 | +:::tip[Recommended Approach] |
| 17 | +Use the BMad Builder (BoMB) Module for guided workflows and expertise when creating custom content. |
| 18 | +::: |
| 19 | + |
| 20 | +## Module Categories |
22 | 21 |
|
23 | | -- [Categories](#categories) |
24 | | -- [Custom Stand-Alone Modules](#custom-stand-alone-modules) |
25 | | -- [Custom Add-On Modules](#custom-add-on-modules) |
26 | | -- [Custom Global Modules](#custom-global-modules) |
27 | | -- [Custom Agents](#custom-agents) |
28 | | - - [BMad Tiny Agents](#bmad-tiny-agents) |
29 | | - - [Simple and Expert Agents](#simple-and-expert-agents) |
30 | | -- [Custom Workflows](#custom-workflows) |
| 22 | +BMad supports three types of custom modules, plus standalone agents and workflows: |
31 | 23 |
|
32 | | -## Custom Stand-Alone Modules |
| 24 | +- **Custom Stand-Alone Modules**: Independent systems that work on their own |
| 25 | +- **Custom Add-On Modules**: Extensions that enhance another module |
| 26 | +- **Custom Global Modules**: Cross-cutting functionality for all installed content |
33 | 27 |
|
34 | | -Custom modules range from simple collections of related agents, workflows, and tools designed to work independently, to complex, expansive systems like the BMad Method or even larger applications. |
| 28 | +### Custom Stand-Alone Modules |
35 | 29 |
|
36 | | -Custom modules are [installable](/docs/how-to/installation/install-custom-modules.md) using the standard BMad method and support advanced features: |
| 30 | +Custom modules range from simple collections of related agents, workflows, and tools to complex systems like the BMad Method or even larger applications. |
37 | 31 |
|
38 | | -- Optional user information collection during installation/updates |
| 32 | +Custom modules are [installable](/docs/how-to/install-custom-modules.md) using the standard BMad method and support advanced features: |
| 33 | + |
| 34 | +- Optional user information collection during installation and updates |
39 | 35 | - Versioning and upgrade paths |
40 | 36 | - Custom installer functions with IDE-specific post-installation handling (custom hooks, subagents, or vendor-specific tools) |
41 | 37 | - Ability to bundle specific tools such as MCP, skills, execution libraries, and code |
42 | 38 |
|
43 | | -## Custom Add-On Modules |
44 | | - |
45 | | -Custom Add-On Modules contain specific agents, tools, or workflows that expand, modify, or customize another module but cannot exist or install independently. These add-ons provide enhanced functionality while leveraging the base module's existing capabilities. |
| 39 | +### Custom Add-On Modules |
46 | 40 |
|
47 | | -Examples include: |
| 41 | +Custom add-on modules contain specific agents, tools, or workflows that expand, modify, or customize another module. They cannot be installed or used independently. These add-ons provide enhanced functionality by using the base module's existing capabilities. |
48 | 42 |
|
49 | | -- Alternative implementation workflows for BMad Method agents |
50 | | -- Framework-specific support for particular use cases |
51 | | -- Game development expansions that add new genre-specific capabilities without reinventing existing functionality |
| 43 | +Examples include the core module, which is always installed and provides all agents with party mode and advanced elicitation capabilities. |
52 | 44 |
|
53 | 45 | Add-on modules can include: |
54 | 46 |
|
55 | 47 | - Custom agents with awareness of the target module |
56 | 48 | - Access to existing module workflows |
57 | | -- Tool-specific features such as rulesets, hooks, subprocess prompts, subagents, and more |
58 | | - |
59 | | -## Custom Global Modules |
60 | | - |
61 | | -Similar to Custom Stand-Alone Modules, but designed to add functionality that applies across all installed content. These modules provide cross-cutting capabilities that enhance the entire BMad ecosystem. |
62 | | - |
63 | | -Examples include: |
64 | | - |
65 | | -- The core module, which is always installed and provides all agents with party mode and advanced elicitation capabilities |
66 | | -- Installation and update tools that work with any BMad method configuration |
| 49 | +- Tool-specific features such as rulesets, hooks, subprocess prompts, and subagents |
67 | 50 |
|
68 | | -Upcoming standards will document best practices for building global content that affects installed modules through: |
| 51 | +### Custom Global Modules |
69 | 52 |
|
70 | | -- Custom content injections |
71 | | -- Agent customization auto-injection |
72 | | -- Tooling installers |
| 53 | +Global modules are similar to stand-alone modules, but they add functionality that applies across all installed content. These modules provide cross-cutting capabilities that enhance the entire BMad ecosystem. |
73 | 54 |
|
74 | | -## Custom Agents |
| 55 | +Examples include installation and update tools that work with any BMad method configuration. |
75 | 56 |
|
76 | | -Custom Agents can be designed and built for various use cases, from one-off specialized agents to more generic standalone solutions. |
| 57 | +## Building Blocks |
77 | 58 |
|
78 | | -### BMad Tiny Agents |
| 59 | +### Custom Agents |
79 | 60 |
|
80 | | -Personal agents designed for highly specific needs that may not be suitable for sharing. For example, a team management agent living in an Obsidian vault that helps with: |
81 | | - |
82 | | -- Team coordination and management |
83 | | -- Understanding team details and requirements |
84 | | -- Tracking specific tasks with designated tools |
85 | | - |
86 | | -These are simple, standalone files that can be scoped to focus on specific data or paths when integrated into an information vault or repository. |
87 | | - |
88 | | -### Simple and Expert Agents |
89 | | - |
90 | | -The distinction between simple and expert agents lies in their structure: |
91 | | - |
92 | | -**Simple Agent:** |
93 | | - |
94 | | -- Single file containing all prompts and configuration |
95 | | -- Self-contained and straightforward |
96 | | - |
97 | | -**Expert Agent:** |
98 | | - |
99 | | -- Similar to simple agents but includes a sidecar folder |
100 | | -- Sidecar folder contains additional resources: custom prompt files, scripts, templates, and memory files |
101 | | -- When installed, the sidecar folder (`[agentname]-sidecar`) is placed in the user memory location |
102 | | -- has metadata type: expert |
103 | | - |
104 | | -:::note[Key Distinction] |
105 | | -The key distinction is the presence of a sidecar folder. As web and consumer agent tools evolve to support common memory mechanisms, storage formats, and MCP, the writable memory files will adapt to support these evolving standards. |
106 | | -::: |
107 | | - |
108 | | -Custom agents can be: |
| 61 | +Custom agents can be designed and built for various use cases, from one-off specialized agents to more generic standalone solutions. Custom agents can be: |
109 | 62 |
|
110 | 63 | - Used within custom modules |
111 | 64 | - Designed as standalone tools |
112 | | -- Integrated with existing workflows and systems, if this is to be the case, should also include a module: <module name> if a specific module is intended for it to require working with |
| 65 | +- Integrated with existing workflows and modules |
113 | 66 |
|
114 | | -## Custom Workflows |
| 67 | +### Custom Workflows |
115 | 68 |
|
116 | | -Workflows are powerful, progressively loading sequence engines capable of performing tasks ranging from simple to complex, including: |
| 69 | +Workflows range from simple single-file prompts to progressively loading sequence engines that can perform tasks including: |
117 | 70 |
|
118 | | -- User engagements |
| 71 | +- User facilitation and engagement |
119 | 72 | - Business processes |
120 | 73 | - Content generation (code, documentation, or other output formats) |
| 74 | +- Utility functions and processes |
121 | 75 |
|
122 | | -A custom workflow created outside of a larger module can still be distributed and used without associated agents through: |
123 | | - |
124 | | -- Slash commands |
125 | | -- Manual command/prompt execution when supported by tools |
| 76 | +A custom workflow created outside of a larger module can still be distributed and used without associated agents through slash commands. |
126 | 77 |
|
127 | 78 | :::tip[Core Concept] |
128 | | -At its core, a custom workflow is a single or series of prompts designed to achieve a specific outcome. |
| 79 | +At its core, a custom workflow is a single prompt or series of prompts made to achieve a specific outcome. It is installed as a command or a skill. |
129 | 80 | ::: |
0 commit comments