Skip to content

About

Marketplace for Octop.

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

9 Commits

Folders and files

Repository files navigation

Octop Marketplace

中文版

Community catalog of experts and plugins for Octop.

Octop installs experts, skills, and plugins from this catalog. The Octop wheel does not ship these packages, and Octop does not read this tree at startup.

experts/    one directory per expert; skills live in skills/<name>/
plugins/    one directory per plugin (plugin.yaml + main.py)

There is no separate skill directory. A skill is the skills/<name>/SKILL.md package inside its expert.

Add an expert

experts/<id>/
├── manifest.json    # id matches the directory name; label and description in zh and en
├── SOUL.md
├── avatar.png       # or avatar.jpg
└── skills/<name>/
    └── SKILL.md

Put the portrait in that expert directory and name it avatar.png or avatar.jpg. If manifest.json has icon_url, set it to that same filename. The publisher copies this file next to the expert zip.

  • Draw it at 128×128.
  • Use PNG for a flat illustration and JPG for a photo-like portrait.
  • JPG and PNG only. Do not commit SVG, AVIF, WebP, or a remote image URL.
  • Do not put the portrait in assets/avatars/ or .octop/.

Add a plugin

plugins/<id>/
├── plugin.yaml      # id matches the directory name
├── main.py
└── icon.svg         # optional

plugin.yaml needs id, version, name, description, entry, and kind.

Contributing

Pull requests are welcome. Experts, plugins, skills, translations, and fixes all belong here.

  1. Fork this repository and branch from main.
  2. Add or update one expert or one plugin. Keep the directory name equal to its id.
  3. Write user-facing copy in both Chinese and English when the format has zh and en fields.
  4. Leave secrets, tokens, and private data out. Keep a license file inside a package when you are not the one who can relicense it.
  5. Open a pull request against main and say what the package does and how you checked it.

Review looks at whether the package matches the layout above, whether the description matches what it actually does, and whether the diff stays limited to that package.

Publish

A merge into master or main builds octop/market/, uploads it to COS, then refreshes the CDN directories with PurgePathCache. Zip files, icons, and meta.json go up before the two index.json files. Secrets are listed in .github/workflows/publish-market.yml.

About

Marketplace for Octop.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages