Plugin Metadata Guidelines
FreshPlugin Name
Requirements:
- Unique name (verified on Marketplace)
- Accurately reflects plugin functionality
- No copyright/trademark infringement
- No derogatory language
Best Practices:
- Keep descriptive and concise (e.g., "Volume Controller", "Screen Capture")
- Make it memorable and pronounceable
- Omit organization names from the title
Author Field
Use your Marketplace organization name, company name, real name, or online alias. Avoid copyright/trademark violations.
UUIDs
Requirements:
- Include author and plugin name:
com.elgato.volume-controller - Prefix action UUIDs with plugin UUID:
com.elgato.volume-controller.mute-audio-device - Never change UUIDs after publishing
DANGER
UUIDs cannot be changed once published on Marketplace. This would break all user configurations.
Recommended format: Reverse DNS: {DOMAIN}.{PRODUCT}
Actions
Requirements:
- Specify the
categoryfield - Use matching or similar values for plugin name and category
- Exclude author names from categories
Best Practices:
- Include tooltips for each action
- Use descriptive, concise names (~30 characters max)
- One action per discrete function
Examples of good names:
- "Twitch Mod Controls" (descriptive, concise)
Examples of bad names:
- "Moderator Controls for Streaming" (too vague, too long)
- "Toggle Chat Mode And Send Message" (should be two actions)
- "Elgato Wave Link" (don't repeat org name if you're the author)
Grouping Actions
- Consolidate actions that share common settings
- Provide 2-30 actions per plugin
- Avoid static, non-configurable actions
Splitting Large Plugins
When exceeding 30 actions, split into focused plugins:
Smaller, focused plugins improve Marketplace discoverability.