Skip to content

Commit 10e59ce

Browse files
BugByClaudeBugByClaude
committed
Add Korean and French README
1 parent f11b9f8 commit 10e59ce

File tree

3 files changed

+345
-0
lines changed

3 files changed

+345
-0
lines changed

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
### [For Chinese Version: 中文说明](./README_CN.md)
66
### [For Japanese Version: 日本語の説明](./README_JA.md)
7+
### [For Korean Version: 한국어 설명](./README_KOR.md)
8+
### [For French Version: Instructions en français](./README_FR.md)
79

810
## Features
911

‎README_FR.md

+172
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
# Eliza
2+
3+
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
4+
5+
## la fonctionnalité
6+
7+
- 🛠 soutenir la connexion discord/ twitter /telegram
8+
- 👥 soutien aux agents multimodaux
9+
- 📚 simple à importer des documents et interagir avec les documents
10+
- mémoire et stockage des documents accessibles
11+
- 🚀 haute scalabilité, vous pouvez personnaliser les clients et les comportements pour une extension fonctionnelle
12+
- ☁ ️ plusieurs modèles, y compris Llama, OpenAI Grok Anthropic, etc.
13+
- 📦 simple et facile à utiliser
14+
15+
Que pouvez-vous faire avec Eliza?
16+
17+
- 🤖 le chatbot
18+
- 🕵 ️ Agents autonomes
19+
- 📈 processus métier pour automatiser le traitement
20+
- 🎮 jeux PNJ
21+
22+
# commencez à utiliser
23+
24+
**pré-requis (obligatoire) :**
25+
26+
- [Node.js 22+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
27+
- installation Nodejs
28+
- [pnpm](https://pnpm.io/installation)
29+
- travailler avec PNPM
30+
31+
### éditer le fichier.env
32+
33+
- copiez.env.example en.env et remplissez la valeur appropriée
34+
- modifier l’environnement twitter et entrer votre compte twitter et mot de passe
35+
36+
### modifier les fichiers de rôles
37+
38+
- voir le document ` src/core/defaultCharacter ts ` - vous pouvez le modifier
39+
- vous pouvez également utiliser `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json" ` et simultanément plusieurs robots.
40+
41+
Après avoir terminé la configuration des fichiers de compte et de rôle, lancez votre bot en tapant la ligne de commande suivante:
42+
43+
44+
```
45+
pnpm i
46+
pnpm start
47+
```
48+
49+
# personnalisez votre Eliza
50+
51+
### ajouter un comportement régulier
52+
53+
Pour éviter les conflits Git dans le répertoire core, nous vous recommandons d’ajouter les actions personnalisées dans le répertoire custom_actions et de les configurer dans le fichier elizaconfig.yaml. Vous pouvez consulter l’exemple dans le fichier elizaconfig.example.yaml.
54+
55+
## configurez différents grands modèles
56+
57+
### configurer Llama
58+
59+
Vous pouvez exécuter en définissant la variable d’environnement `XAI_MODEL` à `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` ou `meta-llama/Meta-Llama-3.1-405B-Instruct` Llama 70B ou 405B modèle
60+
61+
### configurer OpenAI
62+
63+
Vous pouvez exécuter le modèle OpenAI en définissant la variable d’environnement `XAI_MODEL` à `gpt-4o-mini` ou `gpt-4o`
64+
65+
## autres demandes
66+
67+
Vous devrez peut-être installer Sharp. Si vous voyez une erreur au démarrage, essayez d’installer avec la commande suivante:
68+
69+
```
70+
pnpm install --include=optional sharp
71+
```
72+
73+
# paramètres de l’environnement
74+
75+
Vous devez ajouter des variables d’environnement à votre fichier.env pour vous connecter à différentes plates-formes:
76+
77+
```
78+
# Required environment variables
79+
DISCORD_APPLICATION_ID=
80+
DISCORD_API_TOKEN= # Bot token
81+
OPENAI_API_KEY=sk-* # OpenAI API key, starting with sk-
82+
ELEVENLABS_XI_API_KEY= # API key from elevenlabs
83+
84+
# ELEVENLABS SETTINGS
85+
ELEVENLABS_MODEL_ID=eleven_multilingual_v2
86+
ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM
87+
ELEVENLABS_VOICE_STABILITY=0.5
88+
ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9
89+
ELEVENLABS_VOICE_STYLE=0.66
90+
ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false
91+
ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4
92+
ELEVENLABS_OUTPUT_FORMAT=pcm_16000
93+
94+
TWITTER_DRY_RUN=false
95+
TWITTER_USERNAME= # Account username
96+
TWITTER_PASSWORD= # Account password
97+
TWITTER_EMAIL= # Account email
98+
TWITTER_COOKIES= # Account cookies
99+
100+
X_SERVER_URL=
101+
XAI_API_KEY=
102+
XAI_MODEL=
103+
104+
105+
# For asking Claude stuff
106+
ANTHROPIC_API_KEY=
107+
108+
WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
109+
WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
110+
111+
BIRDEYE_API_KEY=
112+
113+
SOL_ADDRESS=So11111111111111111111111111111111111111112
114+
SLIPPAGE=1
115+
RPC_URL=https://api.mainnet-beta.solana.com
116+
HELIUS_API_KEY=
117+
118+
119+
## Telegram
120+
TELEGRAM_BOT_TOKEN=
121+
122+
TOGETHER_API_KEY=
123+
```
124+
125+
# paramètres locaux
126+
127+
### ensemble CUDA
128+
129+
Si vous avez une carte graphique nvidia haute performance, vous pouvez faire l’accélération locale avec la ligne de commande suivante CUDA
130+
131+
```
132+
pnpm install
133+
npx --no node-llama-cpp source download --gpu cuda
134+
```
135+
136+
Assurez-vous d’avoir le kit complet CUDA installé, y compris cuDNN et cuBLAS
137+
138+
### exécution locale
139+
140+
Ajoutez XAI_MODEL et définissez-le à l’une des options ci-dessus [use Llama run](#run-with-llama)
141+
Vous pouvez laisser X_SERVER_URL et XAI_API_KEY vides, qui téléchargera le modèle de huggingface et le consultera localement
142+
143+
# le client
144+
145+
Pour savoir comment configurer votre bot discord, vous pouvez consulter la documentation officielle de discord
146+
147+
# le développement
148+
149+
## le test
150+
151+
Ligne de commande pour plusieurs méthodes de test:
152+
153+
```bash
154+
pnpm test # Run tests once
155+
pnpm test:watch # Run tests in watch mode
156+
```
157+
158+
Pour les tests spécifiques à la base de données:
159+
160+
```bash
161+
pnpm test:sqlite # Run tests with SQLite
162+
pnpm test:sqljs # Run tests with SQL.js
163+
```
164+
165+
Les tests sont écrits en Jest et se trouvent dans le fichier SRC /\*_/_.test.ts. L’environnement de test est configuré comme suit:
166+
167+
- chargement des variables d’environnement de.env.test
168+
- utilisez un temps d’attente de 2 minutes pour exécuter des tests de longue durée
169+
- support du module ESM
170+
- exécuter les tests dans l’ordre (--runInBand)
171+
172+
Pour créer un nouveau test, ajoutez un fichier.test.ts à côté du code à tester.

‎README_KOR.md

+171
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
# Eliza
2+
3+
<img src="./docs/static/img/eliza_banner.jpg" alt="eliza banner" width="100%"/>
4+
5+
## 기능
6+
7+
- 🛠 지지 discord 트위터/telegram 연결
8+
- 👥 지지여 모드 agent
9+
- 📚 간단 한 문서를 가져오기와 문서를 번갈아
10+
- 💾 검색 할 수 있는 메모리와 문서 저장
11+
- 🚀 확장 가능 성이 높은, 사용자 정의 클라이언트와 행위를 확장 기능
12+
- ☁ ️여 모형 지지 llama · openai grok anthropic 등
13+
- 📦 간단 하기도 좋습니다.
14+
15+
eliza로 뭘 할 수 있나요?
16+
17+
- 🤖 챗 봇
18+
- 🕵 ️ 자주 agents
19+
- 📈 업무 처리 과정을 자동화
20+
- 🎮 게임 npc
21+
22+
# 사용시작
23+
24+
**전제 요구(필수):**
25+
26+
- [Node.js 22 +](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
27+
- Nodejs 설치
28+
- [pnpm](https://pnpm.io/installation)
29+
- pnpm을사용한다
30+
31+
## 편집.env 파일
32+
33+
- .env.example을.env로 복사하고 적절한 값을 입력한다
34+
- 트위터 환경을 편집하고, 트위터 계정과 비밀번호를 입력한다
35+
36+
## 캐릭터 파일 편집
37+
38+
- 파일 `src/core/defaultcharacter.ts ` - 그것을 수정 할 수 있다
39+
- 사용하셔도됩니다 `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json"` 여러 로봇을 동시에 실행하여 캐릭터를 불러옵니다.
40+
41+
아이디와 캐릭터 파일 설정이 완료되었다면, 다음 명령줄을 입력하여 로봇을 실행시키십시오:
42+
43+
```
44+
pnpm i
45+
pnpm start
46+
```
47+
48+
# 사용자 정의 Eliza
49+
50+
### 일반 행동을 추가한다
51+
52+
커널 디렉터리에서 git 충돌을 방지하기 위해 custom_actions 디렉터리에 사용자 정의 동작을 추가하고 elizaconfig.yaml 파일에서 동작을 설정할 것을 제안한다.elizaconfig.example.yaml 파일의 예제는 참조할 수 있다.
53+
54+
다른 대형 모델들을 배치한다
55+
56+
### 프로필Llama
57+
58+
`XAI_MODEL`환경 변수를`meta-llama/meta-llam-3.1-70b-instruct-turbo`또는`meta-llama/meta-llam-3.1-405b-instruct`로 설정하여 실행할 수 있다라마 70b 405b 모델
59+
60+
## openai 설정
61+
62+
`XAI_MODEL`환경 변수를`gpt-4o-mini`또는`gpt-4o`로 설정하여 OpenAI 모델을 실행할 수 있다
63+
64+
## 기타 요구 사항
65+
66+
Sharp를 설치해야 할 수도 있습니다.시작시 오류가 발견되면 다음 명령으로 설치하십시오:
67+
68+
```
69+
pnpm install-include=optional sharp
70+
```
71+
72+
# 환경 설정
73+
74+
다양한 플랫폼에 연결하기 위해서는.env 파일에서 환경 변수를 추가해야 합니다:
75+
76+
```
77+
# Required environment variables
78+
DISCORD_APPLICATION_ID=
79+
DISCORD_API_TOKEN= # Bot token
80+
OPENAI_API_KEY=sk-* # OpenAI API key, starting with sk-
81+
ELEVENLABS_XI_API_KEY= # API key from elevenlabs
82+
83+
# ELEVENLABS SETTINGS
84+
ELEVENLABS_MODEL_ID=eleven_multilingual_v2
85+
ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM
86+
ELEVENLABS_VOICE_STABILITY=0.5
87+
ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9
88+
ELEVENLABS_VOICE_STYLE=0.66
89+
ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false
90+
ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4
91+
ELEVENLABS_OUTPUT_FORMAT=pcm_16000
92+
93+
TWITTER_DRY_RUN=false
94+
TWITTER_USERNAME= # Account username
95+
TWITTER_PASSWORD= # Account password
96+
TWITTER_EMAIL= # Account email
97+
TWITTER_COOKIES= # Account cookies
98+
99+
X_SERVER_URL=
100+
XAI_API_KEY=
101+
XAI_MODEL=
102+
103+
104+
# For asking Claude stuff
105+
ANTHROPIC_API_KEY=
106+
107+
WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
108+
WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
109+
110+
BIRDEYE_API_KEY=
111+
112+
SOL_ADDRESS=So11111111111111111111111111111111111111112
113+
SLIPPAGE=1
114+
RPC_URL=https://api.mainnet-beta.solana.com
115+
HELIUS_API_KEY=
116+
117+
118+
## Telegram
119+
TELEGRAM_BOT_TOKEN=
120+
121+
TOGETHER_API_KEY=
122+
```
123+
124+
# 로컬 설정
125+
126+
### cuda 설정
127+
128+
고성능 엔비디아 그래픽을 가지고 있다면 다음 명령줄에서 cuda를 사용하여 로컬 가속을 할 수 있다
129+
130+
```
131+
pnpm install
132+
npx --no node-llama-cpp source download --gpu cuda
133+
```
134+
135+
cuDNN과 cuBLAS를 포함한 완전한 cuda 키트를 설치했는지 확인하세요
136+
137+
### 로컬 실행
138+
139+
위의 [Llama로 실행](#run-with-llama) 옵션 중 하나로 XAI_MODEL을 추가한다
140+
X_SERVER_URL과 xai_api_key를 공백으로 두면 huggingface에서 모델을 다운로드하고 현지에서 쿼리한다
141+
142+
# 클라이언트
143+
144+
discord bot을 설정하는 방법에 대해 discord의 공식 문서를 볼 수 있습니까
145+
146+
# 개발
147+
148+
## 테스트
149+
150+
여러 테스트 방법을 위한 명령줄:
151+
152+
```bash
153+
pnpm test # Run tests once
154+
pnpm test:watch # Run tests in watch mode
155+
```
156+
157+
데이터베이스에 특화된 테스트:
158+
159+
```bash
160+
pnpm test:sqlite # Run tests with SQLite
161+
pnpm test:sqljs # Run tests with SQL.js
162+
```
163+
164+
테스트는 src/\*_/_.test.ts 파일에 있는 Jest로 작성된다.테스트 환경 설정은 다음과 같습니다:
165+
166+
- .env.test에서 환경 변수를 불러온다
167+
- 장기 실행 테스트를 실행하기 위해 2분 제한 시간을 사용합니다
168+
- esm 모듈을 지원한다
169+
- 테스트 실행 순서 (--runInBand)
170+
171+
새 테스트를 만들려면, 테스트할 코드 옆에.test.ts 파일을 추가하세요.

0 commit comments

Comments
 (0)