Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add proof of agent plugin #84

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

chzyer
Copy link
Contributor

@chzyer chzyer commented Feb 26, 2025

Registry Update Checklist

Registry:

  • I've made the organization @eliza-plugins
  • I've used github not github.com
  • There is no .git extension
  • It's placed it alphabetically in the list
  • I've dealt with commas properly so the list is still valid JSON

If not an eliza-plugins official repo, i.e. new plugin:

The plugin repo has:

  • is publically accessible (not a private repo)
  • uses main as it's default branch
  • I have include elizaos-plugins in the topics in the GitHub repo settings. If the plugin is related to AI or crypto, please add those as topics as well.
  • add simple description in github repo
  • follows this convention
plugin-name/
├── images/
│   ├── logo.jpg        # Plugin branding logo
│   ├── banner.jpg      # Plugin banner image
├── src/
│   ├── index.ts        # Main plugin entry point
│   ├── actions/        # Plugin-specific actions
│   ├── clients/        # Client implementations
│   ├── adapters/       # Adapter implementations
│   └── types.ts        # Type definitions
│   └── environment.ts  # runtime.getSetting, zod validation
├── package.json        # Plugin dependencies
└── README.md          # Plugin documentation
  • an images/banner.jpg and images/logo.jpg and they
    • Use clear, high-resolution images
    • Keep file sizes optimized (< 500KB for logos, < 1MB for banners)
    • Follow the elizaOS Brand Guidelines
    • Include alt text for accessibility
  • package.json has a agentConfig like the following
{
  "name": "@elizaos/plugin-example",
  "version": "1.0.0",
  "agentConfig": {
    "pluginType": "elizaos:plugin:1.0.0",
    "pluginParameters": {
      "API_KEY": {
        "type": "string",
        "description": "API key for the service"
      }
    }
  }
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant