File tree 2 files changed +82
-0
lines changed
2 files changed +82
-0
lines changed Original file line number Diff line number Diff line change @@ -159,6 +159,48 @@ pnpm install --include=optional sharp
159
159
160
160
---
161
161
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
+
162
204
### Start Eliza with Gitpod
163
205
164
206
[ ![ Open in Gitpod] ( https://gitpod.io/button/open-in-gitpod.svg )] ( https://gitpod.io/#https://github.com/elizaos/eliza/tree/main )
Original file line number Diff line number Diff line change @@ -302,6 +302,46 @@ packages/
302
302
],
303
303
```
304
304
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
+
305
345
## FAQ
306
346
307
347
### What exactly is a plugin in ElizaOS?
You can’t perform that action at this time.
0 commit comments