update docs

Author: tcm390

docs/README.md

@@ -1,16 +1,16 @@
 # Eliza - Multi-agent simulation framework
 
-# https://github.com/ai16z/eliza
+# https://github.com/elizaOS/eliza
 
 # Visit https://eliza.builders for support
 
 ## 🌍 README Translations
 
-[中文说明](./README_CN.md) | [Français](./README_FR.md) | [ไทย](./README_TH.md)
+[中文说明](./README_CN.md) | [Deutsch](./README_DE.md) | [Français](./README_FR.md) | [ไทย](./README_TH.md) | [Español](README_ES.md)
 
 # dev branch
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+<img src="static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
 
 _As seen powering [@DegenSpartanAI](https://x.com/degenspartanai) and [@MarcAIndreessen](https://x.com/pmairca)_
 
@@ -59,15 +59,15 @@ To avoid git clashes in the core directory, we recommend adding custom actions t
 
 ### Run with Llama
 
-You can run Llama 70B or 405B models by setting the `XAI_MODEL` environment variable to `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` or `meta-llama/Meta-Llama-3.1-405B-Instruct`
+You can run Llama 70B or 405B models by setting the environment variable for a provider that supports these models. Llama is also supported locally if no other provider is set.
 
 ### Run with Grok
 
-You can run Grok models by setting the `XAI_MODEL` environment variable to `grok-beta`
+You can run Grok models by setting the `GROK_API_KEY` environment variable to your Grok API key and setting grok as the model provider in your character file.
 
 ### Run with OpenAI
 
-You can run OpenAI models by setting the `XAI_MODEL` environment variable to `gpt-4o-mini` or `gpt-4o`
+You can run OpenAI models by setting the `OPENAI_API_KEY` environment variable to your OpenAI API key and setting openai as the model provider in your character file.
 
 ## Additional Requirements
 
@@ -102,11 +102,6 @@ TWITTER_DRY_RUN=false
 TWITTER_USERNAME= # Account username
 TWITTER_PASSWORD= # Account password
 TWITTER_EMAIL= # Account email
-TWITTER_COOKIES= # Account cookies
-
-X_SERVER_URL=
-XAI_API_KEY=
-XAI_MODEL=
 
 
 # For asking Claude stuff
@@ -119,7 +114,7 @@ BIRDEYE_API_KEY=
 
 SOL_ADDRESS=So11111111111111111111111111111111111111112
 SLIPPAGE=1
-RPC_URL=https://api.mainnet-beta.solana.com
+SOLANA_RPC_URL=https://api.mainnet-beta.solana.com
 HELIUS_API_KEY=
 
 
@@ -144,9 +139,7 @@ Make sure that you've installed the CUDA Toolkit, including cuDNN and cuBLAS.
 
 ### Running locally
 
-Add XAI_MODEL and set it to one of the above options from [Run with
-Llama](#run-with-llama) - you can leave X_SERVER_URL and XAI_API_KEY blank, it
-downloads the model from huggingface and queries it locally
+By default, the bot will download and use a local model. You can change this by setting the environment variables for the model you want to use.
 
 # Clients
 
@@ -180,3 +173,13 @@ Tests are written using Jest and can be found in `src/**/*.test.ts` files. The t
 - Run tests in sequence (--runInBand)
 
 To create new tests, add a `.test.ts` file adjacent to the code you're testing.
+
+## Docs Updates
+
+Please make sure to verify if the documentation provided is correct. In order to do so, please run the docs service.
+
+```console
+docker compose -f docker-compose-docs.yaml up --build
+```
+
+The docusaurus server will get started and you can verify it locally at https://localhost:3000/eliza.

docs/README_CN.md

@@ -30,7 +30,7 @@
 
 ### 编辑.env文件
 
-- - 将 .env.example 复制为 .env 并填写适当的值
+-   - 将 .env.example 复制为 .env 并填写适当的值
 - 编辑推特环境并输入你的推特账号和密码
 
 ### 编辑角色文件
@@ -94,9 +94,7 @@ TWITTER_DRY_RUN=false
 TWITTER_USERNAME= # Account username
 TWITTER_PASSWORD= # Account password
 TWITTER_EMAIL= # Account email
-TWITTER_COOKIES= # Account cookies
 
-X_SERVER_URL=
 XAI_API_KEY=
 XAI_MODEL=
 
@@ -119,7 +117,7 @@ BIRDEYE_API_KEY=
 
 SOL_ADDRESS=So11111111111111111111111111111111111111112
 SLIPPAGE=1
-RPC_URL=https://api.mainnet-beta.solana.com
+SOLANA_RPC_URL=https://api.mainnet-beta.solana.com
 HELIUS_API_KEY=
 
 

docs/README_DE.md

@@ -0,0 +1,174 @@
+# Eliza - Multi-Agent-Simulationsframework
+
+# https://github.com/elizaos/eliza
+
+# Besuchen Sie https://eliza.builders für Support
+
+# dev branch
+
+<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+
+_Wie gesehen bei [@DegenSpartanAI](https://x.com/degenspartanai) und [@MarcAIndreessen](https://x.com/pmairca)_
+
+- Multi-Agent-Simulationsframework
+- Fügen Sie beliebig viele einzigartige Charaktere mit [characterfile](https://github.com/lalalune/characterfile/) hinzu
+- Vollständige Discord- und Twitter-Anbindungen, mit Unterstützung für Discord-Sprachkanäle
+- Vollständiges Konversations- und Dokument-RAG-Gedächtnis
+- Kann Links und PDFs lesen, Audio und Videos transkribieren, Gespräche zusammenfassen und mehr
+- Hochgradig erweiterbar - erstellen Sie eigene Aktionen und Clients zur Erweiterung von Elizas Fähigkeiten
+- Unterstützt Open-Source- und lokale Modelle (standardmäßig konfiguriert mit Nous Hermes Llama 3.1B)
+- Unterstützt OpenAI für Cloud-Inferenz auf ressourcenschonenden Geräten
+- "Ask Claude"-Modus für komplexere Anfragen an Claude
+- 100% Typescript
+
+# Erste Schritte
+
+**Voraussetzungen (ERFORDERLICH):**
+
+- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+- [pnpm](https://pnpm.io/installation)
+
+### .env-Datei bearbeiten
+
+- Kopieren Sie .env.example zu .env und füllen Sie die entsprechenden Werte aus
+- Bearbeiten Sie die TWITTER-Umgebungsvariablen, um Benutzernamen und Passwort Ihres Bots hinzuzufügen
+
+### Charakterdatei bearbeiten
+
+- Überprüfen Sie die Datei `src/core/defaultCharacter.ts` - Sie können diese modifizieren
+- Sie können auch Charaktere mit dem Befehl `pnpm start --characters="path/to/your/character.json"` laden und mehrere Bots gleichzeitig ausführen
+
+Nach dem Einrichten der .env-Datei und der Charakterdatei können Sie den Bot mit folgendem Befehl starten:
+
+```
+pnpm i
+pnpm start
+```
+
+# Eliza anpassen
+
+### Benutzerdefinierte Aktionen hinzufügen
+
+Um Git-Konflikte im Core-Verzeichnis zu vermeiden, empfehlen wir, benutzerdefinierte Aktionen zu einem `custom_actions` -Verzeichnis hinzuzufügen und sie dann in der `elizaConfig.yaml`-Datei zu konfigurieren. Siehe `elizaConfig.example.yaml` als Beispiel.
+
+## Mit verschiedenen Modellen ausführen
+
+### Mit Llama ausführen
+
+Sie können Llama 70B oder 405B Modelle verwenden, indem Sie die `XAI_MODEL`-Umgebungsvariable auf `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` oder `meta-llama/Meta-Llama-3.1-405B-Instruct` setzen.
+
+### Mit Grok ausführen
+
+Sie können Grok-Modelle verwenden, indem Sie die `XAI_MODEL` Umgebungsvariable auf `grok-beta` setzen
+
+### Mit OpenAI ausführen
+
+Sie können OpenAI-Modelle verwenden, indem Sie die `XAI_MODEL` Umgebungsvariable auf `gpt-4o-mini` oder `gpt-4o` setzen
+
+## Zusätzliche Anforderungen
+
+Möglicherweise müssen Sie Sharp installieren. Wenn Sie beim Start einen Fehler sehen, versuchen Sie es mit folgendem Befehl zu installieren:
+
+```
+pnpm install --include=optional sharp
+```
+
+# Umgebungseinrichtung
+
+Sie müssen Umgebungsvariablen in Ihrer .env-Datei hinzufügen, um sich mit verschiedenen Plattformen zu verbinden:
+
+```
+# Erforderliche Umgebungsvariablen
+DISCORD_APPLICATION_ID=
+DISCORD_API_TOKEN= # Bot-Token
+OPENAI_API_KEY=sk-* # OpenAI API-Schlüssel, beginnt mit sk-
+ELEVENLABS_XI_API_KEY= # API-Schlüssel von Elevenlabs
+
+# ELEVENLABS EINSTELLUNGEN
+ELEVENLABS_MODEL_ID=eleven_multilingual_v2
+ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM
+ELEVENLABS_VOICE_STABILITY=0.5
+ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9
+ELEVENLABS_VOICE_STYLE=0.66
+ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false
+ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4
+ELEVENLABS_OUTPUT_FORMAT=pcm_16000
+
+TWITTER_DRY_RUN=false
+TWITTER_USERNAME= # Kontoname
+TWITTER_PASSWORD= # Kontopasswort
+TWITTER_EMAIL= # Konto-E-Mail
+TWITTER_COOKIES= # Konto-Cookies
+
+X_SERVER_URL=
+XAI_API_KEY=
+XAI_MODEL=
+
+# Für Anfragen an Claude
+ANTHROPIC_API_KEY=
+
+WALLET_SECRET_KEY=EXAMPLE_WALLET_SECRET_KEY
+WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
+
+BIRDEYE_API_KEY=
+
+SOL_ADDRESS=So11111111111111111111111111111111111111112
+SLIPPAGE=1
+SOLANA_RPC_URL=https://api.mainnet-beta.solana.com
+HELIUS_API_KEY=
+
+## Telegram
+TELEGRAM_BOT_TOKEN=
+
+TOGETHER_API_KEY=
+```
+
+# Lokale Inferenz-Einrichtung
+
+### CUDA-Einrichtung
+
+Wenn Sie eine NVIDIA-GPU haben, können Sie CUDA installieren, um die lokale Inferenz drastisch zu beschleunigen.
+
+```
+pnpm install
+npx --no node-llama-cpp source download --gpu cuda
+```
+
+Stellen Sie sicher, dass Sie das CUDA Toolkit einschließlich cuDNN und cuBLAS installiert haben.
+
+### Lokal ausführen
+
+Fügen Sie XAI_MODEL und setzen Sie es auf eine der oben genannten Optionen aus [Mit Llama ausführen](#run-with-llama) - Sie können X_SERVER_URL und XAI_API_KEY leer lassen, es lädt das Modell von Huggingface herunter und fragt es lokal ab.
+
+# Clients
+
+## Discord Bot
+
+Hilfe beim Einrichten Ihres Discord-Bots finden Sie hier: https://discordjs.guide/preparations/setting-up-a-bot-application.html
+
+# Entwicklung
+
+## Tests
+
+Um die Testsuite auszuführen:
+
+```bash
+pnpm test           # Tests einmal ausführen
+pnpm test:watch    # Tests im Watch-Modus ausführen
+```
+
+Für datenbankspezifische Tests:
+
+```bash
+pnpm test:sqlite   # Tests mit SQLite ausführen
+pnpm test:sqljs    # Tests mit SQL.js ausführen
+```
+
+Tests werden mit Jest geschrieben und befinden sich in `src/**/*.test.ts`-Dateien. Die Testumgebung ist konfiguriert für:
+
+- Laden von Umgebungsvariablen aus `.env.test`
+- 2-Minuten-Timeout für länger laufende Tests
+- Unterstützung von ESM-Modulen
+- Sequentielle Testausführung (--runInBand)
+
+Um neue Tests zu erstellen, fügen Sie eine `.test.ts`-Datei neben dem zu testenden Code hinzu.