|
21 | 21 |
|
22 | 22 | # 开始使用
|
23 | 23 |
|
24 |
| -**前置要求(必须):** |
| 24 | +**前置要求(必须):** |
25 | 25 |
|
26 | 26 | - [Python 2.7+](https://www.python.org/downloads/)
|
27 | 27 | - [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
|
28 | 28 | - [pnpm](https://pnpm.io/installation)
|
29 | 29 |
|
30 |
| -### 编辑.env文件 |
| 30 | +以下是两种基础的Eliza下载方案, 请根据情况自行选择。 |
31 | 31 |
|
32 |
| -- 将 .env.example 复制为 .env 并填写适当的值 |
| 32 | +## (A) 使用启动器(Starter): 推荐 |
| 33 | + |
| 34 | +``` |
| 35 | +git clone https://github.com/ai16z/eliza-starter.git |
| 36 | +cd eliza-starter |
| 37 | +cp .env.example .env |
| 38 | +``` |
| 39 | + |
| 40 | +## (B) 手动启动Eliza: 仅在您知道自己在做什么时才推荐 |
| 41 | + |
| 42 | +``` |
| 43 | +git clone https://github.com/ai16z/eliza.git |
| 44 | +cd eliza |
| 45 | +# 切换最新发布的版本(Checkout the latest release) |
| 46 | +# Eliza的迭代速度非常快, 所以我们建议经常性的切换到最新的发布版本以免出现问题(This project iterates fast, so we recommend checking out the latest release) |
| 47 | +git checkout $(git describe --tags --abbrev=0) |
| 48 | +``` |
| 49 | + |
| 50 | +在将代码下载到本地后, 我们要做两件事: |
| 51 | + |
| 52 | +### 1. 编辑.env文件(环境变量) |
| 53 | + |
| 54 | +- 将 `.env.example` 复制为 `.env` 并在其中填写适当的值 |
33 | 55 | - 编辑推特环境并输入你的推特账号和密码
|
34 | 56 |
|
35 |
| -### 编辑角色文件 |
| 57 | +**最简化配置方案**: |
| 58 | +``` |
| 59 | +OPENAI_API_KEY=sk-xxx # 配置OpenAI 的API, sk-开头, 注意, 目前不支持AzureOpenAI! |
36 | 60 |
|
37 |
| -- 查看文件 `src/core/defaultCharacter.ts` - 您可以修改它 |
| 61 | +## 如配置Twitter/X, 则需配置 |
| 62 | +# Twitter/X Configuration |
| 63 | +TWITTER_DRY_RUN=false |
| 64 | +TWITTER_USERNAME=abc # Your Twitter/X account username |
| 65 | +TWITTER_PASSWORD=abc # Your Twitter/X account password |
| 66 | +TWITTER_EMAIL= xxx@gmail.com # Your Twitter/X account email |
| 67 | +TWITTER_COOKIES= '' # Your Twitter/X cookies, copy from broswer |
| 68 | +TWITTER_2FA_SECRET= # Two-factor authentication |
| 69 | +``` |
| 70 | + |
| 71 | +### 2. 编辑角色文件 |
| 72 | + |
| 73 | +- 标准的角色个性定义在文件 `characters/*.character.json`中, 您可以修改它或者直接使用它。 |
38 | 74 | - 您也可以使用 `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json"` 加载角色并同时运行多个机器人。
|
| 75 | +- 需要说明的是, 在`characters/*.character.json`中, `clients字段对应**服务**, 默认可选`"twitter", "discord", "telegram"`等, 如果在`clients`中填入了如"twitter"等内容, 则需要在 |
| 76 | + 上面的`env`配置对应的环境变量。对`discord`和`telegram`同理。 |
| 77 | + |
| 78 | +``` |
| 79 | +{ |
| 80 | + "name": "trump", |
| 81 | + "clients": ["twitter"], |
| 82 | + "modelProvider": "openai", |
| 83 | +``` |
39 | 84 |
|
40 |
| -在完成账号和角色文件的配置后,输入以下命令行启动你的bot: |
| 85 | +在完成环境变量和角色文件的配置后,输入以下命令行启动你的bot: |
41 | 86 |
|
42 | 87 | ```
|
| 88 | +(A) 使用启动器(Starter) |
| 89 | +sh scripts/start.sh |
| 90 | +
|
| 91 | +
|
| 92 | +(B) 手动启动Eliza |
43 | 93 | pnpm i
|
| 94 | +pnpm build |
44 | 95 | pnpm start
|
45 | 96 | ```
|
46 | 97 |
|
| 98 | + |
47 | 99 | # 自定义Eliza
|
48 | 100 |
|
49 | 101 | ### 添加常规行为
|
|
0 commit comments