Merge branch 'develop'

Author: SumeetChougule

.github/workflows/integrationTests.yaml

@@ -3,7 +3,7 @@ on:
     push:
         branches:
             - "*"
-    pull_request_target:
+    pull_request:
         branches:
             - "*"
 jobs:

.gitpod.yml

@@ -3,5 +3,6 @@ tasks:
   - name: "init eliza env"
     init: |
       nvm install v23.3.0
+      git fetch --tags
       git checkout $(git describe --tags --abbrev=0)
     command: pnpm install && pnpm run build

Dockerfile

@@ -52,4 +52,4 @@ COPY --from=builder /app/scripts ./scripts
 COPY --from=builder /app/characters ./characters
 
 # Set the command to run the application
-CMD ["pnpm", "start", "--non-interactive"]
+CMD ["pnpm", "start"]

README.md

@@ -50,9 +50,8 @@
 
 ```bash
 git clone https://github.com/ai16z/eliza-starter.git
-
+cd eliza-starter
 cp .env.example .env
-
 pnpm i && pnpm build && pnpm start
 ```
 

README_CN.md

@@ -21,30 +21,81 @@
 
 # 开始使用
 
-**前置要求（必须）:**
+**前置要求(必须):**
 
+-   [Python 2.7+](https://www.python.org/downloads/)
 -   [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
--   Nodejs安装
 -   [pnpm](https://pnpm.io/installation)
--   使用pnpm
 
-### 编辑.env文件
+以下是两种基础的Eliza下载方案, 请根据情况自行选择。
 
--   -   将 .env.example 复制为 .env 并填写适当的值
+## (A) 使用启动器(Starter): 推荐
+
+```
+git clone https://github.com/ai16z/eliza-starter.git
+cd eliza-starter
+cp .env.example .env
+```
+
+## (B) 手动启动Eliza: 仅在您知道自己在做什么时才推荐
+
+```
+git clone https://github.com/ai16z/eliza.git
+cd eliza
+# 切换最新发布的版本(Checkout the latest release)
+# Eliza的迭代速度非常快, 所以我们建议经常性的切换到最新的发布版本以免出现问题(This project iterates fast, so we recommend checking out the latest release)
+git checkout $(git describe --tags --abbrev=0)
+```
+
+在将代码下载到本地后, 我们要做两件事:
+
+### 1. 编辑.env文件(环境变量)
+
+-   将 `.env.example` 复制为 `.env` 并在其中填写适当的值
 -   编辑推特环境并输入你的推特账号和密码
 
-### 编辑角色文件
+**最简化配置方案**: 
+```
+OPENAI_API_KEY=sk-xxx # 配置OpenAI 的API, sk-开头, 注意, 目前不支持AzureOpenAI!
 
--   查看文件 `src/core/defaultCharacter.ts` - 您可以修改它
+## 如配置Twitter/X, 则需配置
+# Twitter/X Configuration
+TWITTER_DRY_RUN=false
+TWITTER_USERNAME=abc         # Your Twitter/X account username
+TWITTER_PASSWORD=abc         # Your Twitter/X account password
+TWITTER_EMAIL= xxx@gmail.com # Your Twitter/X account email
+TWITTER_COOKIES= ''          # Your Twitter/X cookies, copy from broswer
+TWITTER_2FA_SECRET=          # Two-factor authentication
+```
+
+### 2. 编辑角色文件
+
+-   标准的角色个性定义在文件 `characters/*.character.json`中, 您可以修改它或者直接使用它。
 -   您也可以使用 `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json"` 加载角色并同时运行多个机器人。
+-   需要说明的是, 在`characters/*.character.json`中, `clients字段对应**服务**, 默认可选`"twitter", "discord", "telegram"`等, 如果在`clients`中填入了如"twitter"等内容, 则需要在
+    上面的`env`配置对应的环境变量。对`discord`和`telegram`同理。
+
+```
+{
+    "name": "trump",
+    "clients": ["twitter"], 
+    "modelProvider": "openai",
+```
 
-在完成账号和角色文件的配置后，输入以下命令行启动你的bot：
+在完成环境变量和角色文件的配置后，输入以下命令行启动你的bot：
 
 ```
+(A) 使用启动器(Starter)
+sh scripts/start.sh
+
+
+(B) 手动启动Eliza
 pnpm i
+pnpm build
 pnpm start
 ```
 
+
 # 自定义Eliza
 
 ### 添加常规行为

agent/src/index.ts

@@ -70,7 +70,8 @@ export const wait = (minTime: number = 1000, maxTime: number = 3000) => {
 
 const logFetch = async (url: string, options: any) => {
     elizaLogger.debug(`Fetching ${url}`);
-    elizaLogger.debug(JSON.stringify(options, null, 2));
+    // Disabled to avoid disclosure of sensitive information such as API keys
+    // elizaLogger.debug(JSON.stringify(options, null, 2));
     return fetch(url, options);
 };
 
@@ -651,14 +652,15 @@ const startAgents = async () => {
     }
 
     // upload some agent functionality into directClient
-    directClient.startAgent = async character => {
-      // wrap it so we don't have to inject directClient later
-      return startAgent(character, directClient)
+    directClient.startAgent = async (character) => {
+        // wrap it so we don't have to inject directClient later
+        return startAgent(character, directClient);
     };
     directClient.start(serverPort);
 
-    elizaLogger.log("Visit the following URL to chat with your agents:");
-    elizaLogger.log(`http://localhost:5173`);
+    elizaLogger.log(
+        "Run `pnpm start:client` to start the client and visit the outputted URL (http://localhost:5173) to chat with your agents"
+    );
 };
 
 startAgents().catch((error) => {