docs: update readme.md for the custom plugins how-to (elizaOS#3736)

* Update plugins.md * Update README.md for custom plugins
IkigaiLabsETH · Mar 1, 2025 · 3be70e4 · 3be70e4
1 parent da6d60c
commit 3be70e4
Show file tree

Hide file tree

Showing 2 changed files with 82 additions and 0 deletions.
diff --git 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
@@ -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?