Skip to content

Commit 1c3da82

Browse files
eltociearwtfsayo
andauthored
docs: add docs/README_JA.md (elizaOS#2515)
Co-authored-by: Sayo <hi@sayo.wtf>
1 parent 631cd6d commit 1c3da82

File tree

1 file changed

+180
-0
lines changed

1 file changed

+180
-0
lines changed

docs/README_JA.md

+180
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
# Eliza
2+
3+
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
4+
5+
## 機能
6+
7+
- 🛠 Discord、Twitter、Telegramのフル機能コネクタ
8+
- 👥 マルチエージェントおよびルームサポート
9+
- 📚 ドキュメントの簡単な取り込みと対話
10+
- 💾 検索可能なメモリおよびドキュメントストア
11+
- 🚀 高い拡張性 - 機能を拡張するための独自のアクションとクライアントを作成可能
12+
- ☁️ Llama、OpenAI、Anthropic、Groqなど、多くのモデルをサポート
13+
- 📦 すぐに使える!
14+
15+
## 何に使えるのか?
16+
17+
- 🤖 チャットボット
18+
- 🕵️ 自律エージェント
19+
- 📈 ビジネスプロセスの処理
20+
- 🎮 ビデオゲームのNPC
21+
22+
# 始め方
23+
24+
**必須条件:**
25+
26+
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
27+
- [pnpm](https://pnpm.io/installation)
28+
29+
### .envファイルの編集
30+
31+
- .env.exampleを.envにコピーし、適切な値を入力
32+
- TWITTER環境変数を編集して、ボットのユーザー名とパスワードを追加
33+
34+
### キャラクターファイルの編集
35+
36+
- `src/core/defaultCharacter.ts`ファイルを確認 - これを変更可能
37+
- `pnpm start --characters="path/to/your/character.json"`を使用してキャラクターをロードし、複数のボットを同時に実行可能
38+
39+
.envファイルとキャラクターファイルを設定した後、以下のコマンドでボットを起動可能:
40+
41+
```
42+
pnpm i
43+
pnpm start
44+
```
45+
46+
# Elizaのカスタマイズ
47+
48+
### カスタムアクションの追加
49+
50+
コアディレクトリでのGitの競合を避けるために、カスタムアクションを`custom_actions`ディレクトリに追加し、それを`elizaConfig.yaml`ファイルに追加することをお勧めします。例については`elizaConfig.example.yaml`ファイルを参照してください。
51+
52+
## 異なるモデルでの実行
53+
54+
### Llamaでの実行
55+
56+
`XAI_MODEL`環境変数を`meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo`または`meta-llama/Meta-Llama-3.1-405B-Instruct`に設定することで、Llama 70Bまたは405Bモデルを実行可能
57+
58+
### Grokでの実行
59+
60+
`XAI_MODEL`環境変数を`grok-beta`に設定することで、Grokモデルを実行可能
61+
62+
### OpenAIでの実行
63+
64+
`XAI_MODEL`環境変数を`gpt-4o-mini`または`gpt-4o`に設定することで、OpenAIモデルを実行可能
65+
66+
## 追加の要件
67+
68+
Sharpをインストールする必要があるかもしれません。起動時にエラーが表示された場合は、以下のコマンドでインストールを試みてください:
69+
70+
```
71+
pnpm install --include=optional sharp
72+
```
73+
74+
# 環境設定
75+
76+
さまざまなプラットフォームに接続するために、.envファイルに環境変数を追加する必要があります:
77+
78+
```
79+
# 必須環境変数
80+
DISCORD_APPLICATION_ID=
81+
DISCORD_API_TOKEN= # ボットトークン
82+
OPENAI_API_KEY=sk-* # OpenAI APIキー、sk-で始まる
83+
ELEVENLABS_XI_API_KEY= # elevenlabsからのAPIキー
84+
85+
# ELEVENLABS設定
86+
ELEVENLABS_MODEL_ID=eleven_multilingual_v2
87+
ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM
88+
ELEVENLABS_VOICE_STABILITY=0.5
89+
ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9
90+
ELEVENLABS_VOICE_STYLE=0.66
91+
ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false
92+
ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4
93+
ELEVENLABS_OUTPUT_FORMAT=pcm_16000
94+
95+
TWITTER_DRY_RUN=false
96+
TWITTER_USERNAME= # アカウントのユーザー名
97+
TWITTER_PASSWORD= # アカウントのパスワード
98+
TWITTER_EMAIL= # アカウントのメール
99+
100+
XAI_API_KEY=
101+
XAI_MODEL=
102+
103+
104+
# Claudeに質問するため
105+
ANTHROPIC_API_KEY=
106+
107+
# EVM
108+
EVM_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
109+
110+
# Solana
111+
SOLANA_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
112+
SOLANA_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
113+
114+
# Fallback Wallet Configuration (deprecated)
115+
WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
116+
WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
117+
118+
BIRDEYE_API_KEY=
119+
120+
SOL_ADDRESS=So11111111111111111111111111111111111111112
121+
SLIPPAGE=1
122+
SOLANA_RPC_URL=https://api.mainnet-beta.solana.com
123+
HELIUS_API_KEY=
124+
125+
126+
## Telegram
127+
TELEGRAM_BOT_TOKEN=
128+
129+
TOGETHER_API_KEY=
130+
```
131+
132+
# ローカル推論設定
133+
134+
### CUDA設定
135+
136+
NVIDIA GPUを持っている場合、CUDAをインストールしてローカル推論を大幅に高速化可能
137+
138+
```
139+
pnpm install
140+
npx --no node-llama-cpp source download --gpu cuda
141+
```
142+
143+
CUDA Toolkit、cuDNN、cuBLASをインストールしていることを確認してください。
144+
145+
### ローカルでの実行
146+
147+
XAI_MODELを追加し、[Llamaでの実行](#run-with-llama)のオプションのいずれかに設定 - XAI_API_KEYを空白のままにしておくと、huggingfaceからモデルをダウンロードし、ローカルでクエリを実行します。
148+
149+
# クライアント
150+
151+
## Discordボット
152+
153+
Discordボットの設定に関するヘルプについては、こちらを参照してください: https://discordjs.guide/preparations/setting-up-a-bot-application.html
154+
155+
# 開発
156+
157+
## テスト
158+
159+
テストスイートを実行するには:
160+
161+
```bash
162+
pnpm test # テストを一度実行
163+
pnpm test:watch # ウォッチモードでテストを実行
164+
```
165+
166+
データベース固有のテストの場合:
167+
168+
```bash
169+
pnpm test:sqlite # SQLiteでテストを実行
170+
pnpm test:sqljs # SQL.jsでテストを実行
171+
```
172+
173+
テストはJestを使用して記述されており、`src/**/*.test.ts`ファイルにあります。テスト環境は次のように構成されています:
174+
175+
- `.env.test`から環境変数をロード
176+
- 長時間実行されるテストのために2分のタイムアウトを使用
177+
- ESMモジュールをサポート
178+
- テストを順番に実行 (--runInBand)
179+
180+
新しいテストを作成するには、テストするコードの隣に`.test.ts`ファイルを追加します。

0 commit comments

Comments
 (0)