diff --git a/README.md b/README.md index a184d56..f93df02 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,23 @@ Two starter plugins are included: 1. `.cursor-plugin/marketplace.json`: set marketplace `name`, `owner`, and `metadata`. 2. `plugins/*/.cursor-plugin/plugin.json`: set `name` (lowercase kebab-case), `displayName`, `author`, `description`, `keywords`, `license`, and `version`. -3. Replace placeholder rules, skills, agents, commands, hooks, scripts, and logos. +3. Replace `assets/avatar.png` with your own plugin avatar (PNG, recommended 128x128 or larger). +4. Replace placeholder rules, skills, agents, commands, hooks, and scripts. To add more plugins, see `docs/add-a-plugin.md`. +## Plugin avatar + +Each plugin includes an `assets/avatar.png` that is displayed in the Cursor Marketplace. The `logo` field in `.cursor-plugin/plugin.json` points to this file: + +```json +{ + "logo": "assets/avatar.png" +} +``` + +Replace the default avatar with your own PNG image. Keep it square and at least 128x128 pixels for best results. + ## Single plugin vs multi-plugin This template defaults to **multi-plugin** (multiple plugins in one repo). @@ -29,6 +42,6 @@ For a **single plugin**, move your plugin folder contents to the repository root - Plugin names are unique, lowercase, and kebab-case. - `.cursor-plugin/marketplace.json` entries map to real plugin folders. - All frontmatter metadata is present in rule, skill, agent, and command files. -- Logos are committed and referenced with relative paths. +- Each plugin has an `assets/avatar.png` referenced by the `logo` field in its manifest. - `node scripts/validate-template.mjs` passes. - Repository link is ready for submission to the Cursor team (Slack or `kniparko@anysphere.com`). diff --git a/docs/add-a-plugin.md b/docs/add-a-plugin.md index b7b3414..585236e 100644 --- a/docs/add-a-plugin.md +++ b/docs/add-a-plugin.md @@ -27,7 +27,7 @@ Example manifest: "author": { "name": "Your Org" }, - "logo": "assets/logo.svg" + "logo": "assets/avatar.png" } ``` @@ -41,7 +41,7 @@ Add only the components you need: - `commands/*.(md|mdc|markdown|txt)` (frontmatter recommended) - `hooks/hooks.json` and `scripts/*` for automation hooks - `mcp.json` for MCP server definitions -- `assets/logo.svg` for marketplace display +- `assets/avatar.png` for marketplace display ## 3. Register in marketplace manifest diff --git a/plugins/starter-advanced/.cursor-plugin/plugin.json b/plugins/starter-advanced/.cursor-plugin/plugin.json index 6e41288..99ea043 100644 --- a/plugins/starter-advanced/.cursor-plugin/plugin.json +++ b/plugins/starter-advanced/.cursor-plugin/plugin.json @@ -8,6 +8,15 @@ "email": "plugins@example.com" }, "license": "MIT", - "keywords": ["cursor", "plugin", "rules", "skills", "agents", "commands", "hooks", "mcp"], - "logo": "assets/logo.svg" + "keywords": [ + "cursor", + "plugin", + "rules", + "skills", + "agents", + "commands", + "hooks", + "mcp" + ], + "logo": "assets/avatar.png" } diff --git a/plugins/starter-advanced/assets/avatar.png b/plugins/starter-advanced/assets/avatar.png new file mode 100644 index 0000000..03e7377 Binary files /dev/null and b/plugins/starter-advanced/assets/avatar.png differ diff --git a/plugins/starter-advanced/assets/logo.svg b/plugins/starter-advanced/assets/logo.svg deleted file mode 100644 index 078f604..0000000 --- a/plugins/starter-advanced/assets/logo.svg +++ /dev/null @@ -1,7 +0,0 @@ - - Starter Advanced Logo - Full-featured plugin logo with lightning and badge. - - - - diff --git a/plugins/starter-simple/.cursor-plugin/plugin.json b/plugins/starter-simple/.cursor-plugin/plugin.json index e28e8a7..abda249 100644 --- a/plugins/starter-simple/.cursor-plugin/plugin.json +++ b/plugins/starter-simple/.cursor-plugin/plugin.json @@ -8,6 +8,11 @@ "email": "plugins@example.com" }, "license": "MIT", - "keywords": ["cursor", "plugin", "rules", "skills"], - "logo": "assets/logo.svg" + "keywords": [ + "cursor", + "plugin", + "rules", + "skills" + ], + "logo": "assets/avatar.png" } diff --git a/plugins/starter-simple/assets/avatar.png b/plugins/starter-simple/assets/avatar.png new file mode 100644 index 0000000..03e7377 Binary files /dev/null and b/plugins/starter-simple/assets/avatar.png differ diff --git a/plugins/starter-simple/assets/logo.svg b/plugins/starter-simple/assets/logo.svg deleted file mode 100644 index b834618..0000000 --- a/plugins/starter-simple/assets/logo.svg +++ /dev/null @@ -1,7 +0,0 @@ - - Starter Simple Logo - Minimal geometric logo for the starter simple plugin. - - - -