ElizaOS Plugin

This is an ElizaOS plugin built with the official plugin starter template.

Development

# Start development with hot-reloading
npm run dev

# Build the plugin
npm run build

# Test the plugin
npm run test

Publishing

Before publishing your plugin to the ElizaOS registry, ensure you meet these requirements:

1. GitHub Repository

   • Create a public GitHub repository for this plugin
   • Add the 'elizaos-plugins' topic to the repository
   • Use 'main' as the default branch

2. Required Assets

   • Add images to the images/ directory:
     • logo.jpg (400x400px square, <500KB)
     • banner.jpg (1280x640px, <1MB)

3. Publishing Process

   # Check if your plugin meets all registry requirements
   npx elizaos plugin publish --test
   
   # Publish to the registry
   npx elizaos plugin publish

After publishing, your plugin will be submitted as a pull request to the ElizaOS registry for review.

Configuration

The agentConfig section in package.json defines the parameters your plugin requires:

"agentConfig": {
  "pluginType": "elizaos:plugin:1.0.0",
  "pluginParameters": {
    "API_KEY": {
      "type": "string",
      "description": "API key for the service"
    }
  }
}

Customize this section to match your plugin's requirements.

Documentation

Provide clear documentation about:

• What your plugin does
• How to use it
• Required API keys or credentials
• Example usage