Skip to content

Commit 3be70e4

Browse files
authored
docs: update readme.md for the custom plugins how-to (elizaOS#3736)
* Update plugins.md * Update README.md for custom plugins
1 parent da6d60c commit 3be70e4

File tree

2 files changed

+82
-0
lines changed

2 files changed

+82
-0
lines changed

README.md

+42
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,48 @@ pnpm install --include=optional sharp
159159

160160
---
161161

162+
## Using Your Custom Plugins
163+
Plugins that are not in the official registry for ElizaOS can be used as well. Here's how:
164+
165+
### Installation
166+
167+
1. Upload the custom plugin to the packages folder:
168+
169+
```
170+
packages/
171+
├─plugin-example/
172+
├── package.json
173+
├── tsconfig.json
174+
├── src/
175+
│ ├── index.ts # Main plugin entry
176+
│ ├── actions/ # Custom actions
177+
│ ├── providers/ # Data providers
178+
│ ├── types.ts # Type definitions
179+
│ └── environment.ts # Configuration
180+
├── README.md
181+
└── LICENSE
182+
```
183+
184+
2. Add the custom plugin to your project's dependencies in the agent's package.json:
185+
186+
```json
187+
{
188+
"dependencies": {
189+
"@elizaos/plugin-example": "workspace:*"
190+
}
191+
}
192+
```
193+
194+
3. Import the custom plugin to your agent's character.json
195+
196+
```json
197+
"plugins": [
198+
"@elizaos/plugin-example",
199+
],
200+
```
201+
202+
---
203+
162204
### Start Eliza with Gitpod
163205

164206
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)

docs/docs/core/plugins.md

+40
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,46 @@ packages/
302302
],
303303
```
304304

305+
## Using Your Custom Plugins
306+
Plugins that are not in the official registry for ElizaOS can be used as well. Here's how:
307+
308+
### Installation
309+
310+
1. Upload the custom plugin to the packages folder:
311+
312+
```
313+
packages/
314+
├─plugin-example/
315+
├── package.json
316+
├── tsconfig.json
317+
├── src/
318+
│ ├── index.ts # Main plugin entry
319+
│ ├── actions/ # Custom actions
320+
│ ├── providers/ # Data providers
321+
│ ├── types.ts # Type definitions
322+
│ └── environment.ts # Configuration
323+
├── README.md
324+
└── LICENSE
325+
```
326+
327+
2. Add the custom plugin to your project's dependencies in the agent's package.json:
328+
329+
```json
330+
{
331+
"dependencies": {
332+
"@elizaos/plugin-example": "workspace:*"
333+
}
334+
}
335+
```
336+
337+
3. Import the custom plugin to your agent's character.json
338+
339+
```json
340+
"plugins": [
341+
"@elizaos/plugin-example",
342+
],
343+
```
344+
305345
## FAQ
306346

307347
### What exactly is a plugin in ElizaOS?

0 commit comments

Comments
 (0)