diff --git a/README.md b/README.md index bb21f8b7fc..e010c99132 100644 --- a/README.md +++ b/README.md @@ -159,6 +159,48 @@ pnpm install --include=optional sharp --- +## Using Your Custom Plugins +Plugins that are not in the official registry for ElizaOS can be used as well. Here's how: + +### Installation + +1. Upload the custom plugin to the packages folder: + +``` +packages/ +├─plugin-example/ +├── package.json +├── tsconfig.json +├── src/ +│ ├── index.ts # Main plugin entry +│ ├── actions/ # Custom actions +│ ├── providers/ # Data providers +│ ├── types.ts # Type definitions +│ └── environment.ts # Configuration +├── README.md +└── LICENSE +``` + +2. Add the custom plugin to your project's dependencies in the agent's package.json: + +```json +{ + "dependencies": { + "@elizaos/plugin-example": "workspace:*" + } +} +``` + +3. Import the custom plugin to your agent's character.json + +```json + "plugins": [ + "@elizaos/plugin-example", + ], +``` + +--- + ### Start Eliza with Gitpod [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main) diff --git a/docs/docs/core/plugins.md b/docs/docs/core/plugins.md index 2d51414606..90f2b6dac6 100644 --- a/docs/docs/core/plugins.md +++ b/docs/docs/core/plugins.md @@ -302,6 +302,46 @@ packages/ ], ``` +## Using Your Custom Plugins +Plugins that are not in the official registry for ElizaOS can be used as well. Here's how: + +### Installation + +1. Upload the custom plugin to the packages folder: + +``` +packages/ +├─plugin-example/ +├── package.json +├── tsconfig.json +├── src/ +│ ├── index.ts # Main plugin entry +│ ├── actions/ # Custom actions +│ ├── providers/ # Data providers +│ ├── types.ts # Type definitions +│ └── environment.ts # Configuration +├── README.md +└── LICENSE +``` + +2. Add the custom plugin to your project's dependencies in the agent's package.json: + +```json +{ + "dependencies": { + "@elizaos/plugin-example": "workspace:*" + } +} +``` + +3. Import the custom plugin to your agent's character.json + +```json + "plugins": [ + "@elizaos/plugin-example", + ], +``` + ## FAQ ### What exactly is a plugin in ElizaOS?