Merge pull request #29 from ai16z/main

merge from main

Author: MarcoMandar

README.md

@@ -10,6 +10,9 @@
 
 </div>
 
+## 🌍 README Translations
+[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md)
+
 ## ✨ Features
 
 -   🛠️ Full-featured Discord, Twitter and Telegram connectors
@@ -29,19 +32,6 @@
 -   🎮 Video Game NPCs
 -   🧠 Trading
 
-## 🌍 Translations
-
-<details>
-<summary>Available Languages</summary>
-
--   [中文说明](./README_CN.md)
--   [日本語の説明](./README_JA.md)
--   [한국어 설명](./README_KOR.md)
--   [Instructions en français](./README_FR.md)
--   [Instruções em português](./README_PTBR.md)
-
-</details>
-
 ## 🚀 Quick Start
 
 ### Prerequisites
@@ -60,17 +50,23 @@ Copy .env.example to .env and fill in the appropriate values
 cp .env.example .env
 ```
 
+### Automatically Start Eliza
+
+This will run everything to setup the project and start the bot with the default character.
+
+```bash
+sh scripts/start.sh
+```
+
 ### Edit the character file
 
-1. Open `src/core/defaultCharacter.ts` to modify the default character
+1. Open `packages/agent/src/character.ts` to modify the default character. Uncomment and edit.
 
 2. To load custom characters:
     - Use `pnpm start --characters="path/to/your/character.json"`
     - Multiple character files can be loaded simultaneously
 
-### Start Eliza
-
-After setting up the .env file and character file, you can start the bot with the following command:
+### Manually Start Eliza
 
 ```bash
 pnpm i

README_ES.md

@@ -0,0 +1,174 @@
+# Eliza
+
+<img src="./docs/static/img/eliza_banner.jpg" alt="Banner de Eliza" width="100%" />
+
+## Funcionalidades
+
+-   🛠 Conectores completos para Discord, Twitter y Telegram
+-   👥 Soporte para múltiples agentes y salas
+-   📚 Ingestión e interacción sencilla con documentos
+-   💾 Memoria recuperable y almacenamiento de documentos
+-   🚀 Altamente extensible - cree sus propias acciones y clientes para expandir capacidades
+-   ☁️ Soporta múltiples modelos, incluyendo Llama local, OpenAI, Anthropic, Groq y más
+-   📦 Funciona perfectamente
+
+## Usos
+
+-   🤖 Chatbots
+-   🕵️ Agentes autónomos
+-   📈 Gestión de procesos empresariales
+-   🎮 NPCs en videojuegos
+
+# Primeros Pasos
+
+**Requisitos (OBLIGATORIOS):**
+
+-   [Python 2.7+](https://www.python.org/downloads/)
+-   [Node.js 23.1+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+-   [pnpm](https://pnpm.io/installation)
+
+### Edite el archivo .env
+
+-   Copie .env.example a .env y complete los valores apropiados
+-   Edite las variables de ambiente de TWITTER para agregar nombre de usuario y contraseña del bot
+
+### Edite el archivo de personaje
+
+-   Revise el archivo `src/core/defaultCharacter.ts` - puede modificarlo
+-   También puede cargar personajes con el comando `pnpm start --characters="path/to/your/character.json"` y ejecutar múltiples bots simultáneamente.
+
+Después de configurar el archivo .env y el archivo de personaje, puede iniciar el bot con:
+
+```
+pnpm i
+pnpm start
+```
+
+# Personalizando a Eliza
+
+### Agregando acciones personalizadas
+
+Para evitar conflictos en el directorio central, se recomienda agregar acciones personalizadas a un directorio `custom_actions` y luego agregarlas al archivo `elizaConfig.yaml`. Consulte el archivo `elizaConfig.example.yaml` para un ejemplo.
+
+## Ejecución con Diferentes Modelos
+
+### Ejecutar con Llama
+
+Puede ejecutar modelos Llama 70B o 405B configurando la variable de ambiente `XAI_MODEL` en `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` o `meta-llama/Meta-Llama-3.1-405B-Instruct`
+
+### Ejecutar con Grok
+
+Puede ejecutar modelos Grok configurando la variable de ambiente `XAI_MODEL` en `grok-beta`
+
+### Ejecutar con OpenAI
+
+Puede ejecutar modelos OpenAI configurando la variable de ambiente `XAI_MODEL` en `gpt-4o-mini` o `gpt-4o`
+
+## Requisitos Adicionales
+
+Puede ser necesario instalar Sharp. Si encuentra un error al iniciar, intente instalarlo con:
+
+```
+pnpm install --include=optional sharp
+```
+
+# Configuración del Entorno
+
+Deberá agregar variables de ambiente a su archivo .env para conectarse a varias plataformas:
+
+```
+# Variables de ambiente obligatorias
+DISCORD_APPLICATION_ID=
+DISCORD_API_TOKEN= # Token del bot
+OPENAI_API_KEY=sk-* # Clave API de OpenAI, comenzando con sk-
+ELEVENLABS_XI_API_KEY= # Clave API de ElevenLabs
+GOOGLE_GENERATIVE_AI_API_KEY= # Clave API de Gemini
+
+# CONFIGURACIONES DE ELEVENLABS
+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= # Nombre de usuario de la cuenta
+TWITTER_PASSWORD= # Contraseña de la cuenta
+TWITTER_EMAIL= # Correo electrónico de la cuenta
+TWITTER_COOKIES= # Cookies de la cuenta
+
+X_SERVER_URL=
+XAI_API_KEY=
+XAI_MODEL=
+
+# Para consultar a Claude
+ANTHROPIC_API_KEY=
+
+WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
+WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
+
+BIRDEYE_API_KEY=
+
+SOL_ADDRESS=So11111111111111111111111111111111111111112
+SLIPPAGE=1
+RPC_URL=https://api.mainnet-beta.solana.com
+HELIUS_API_KEY=
+
+## Telegram
+TELEGRAM_BOT_TOKEN=
+
+TOGETHER_API_KEY=
+```
+
+# Configuración de Inferencia Local
+
+### Configuración CUDA
+
+Si tiene una GPU NVIDIA, puede instalar CUDA para acelerar significativamente la inferencia local.
+
+```
+pnpm install
+npx --no node-llama-cpp source download --gpu cuda
+```
+
+Asegúrese de tener instalado el CUDA Toolkit, incluyendo cuDNN y cuBLAS.
+
+### Ejecución local
+
+Agregue XAI_MODEL y configúrelo con una de las opciones de [Ejecutar con Llama](#ejecutar-con-llama) - puede dejar X_SERVER_URL y XAI_API_KEY en blanco, descargará el modelo de HuggingFace y realizará consultas localmente
+
+# Clientes
+
+## Bot de Discord
+
+Para ayuda con la configuración de su Bot de Discord, consulte: https://discordjs.guide/preparations/setting-up-a-bot-application.html
+
+# Desarrollo
+
+## Pruebas
+
+Para ejecutar la suite de pruebas:
+
+```bash
+pnpm test           # Ejecutar pruebas una vez
+pnpm test:watch    # Ejecutar pruebas en modo observación
+```
+
+Para pruebas específicas de base de datos:
+
+```bash
+pnpm test:sqlite   # Ejecutar pruebas con SQLite
+pnpm test:sqljs    # Ejecutar pruebas con SQL.js
+```
+
+Las pruebas están escritas con Jest y se pueden encontrar en archivos `src/**/*.test.ts`. El entorno de pruebas está configurado para:
+
+-   Cargar variables de ambiente desde `.env.test`
+-   Usar un límite de 2 minutos para pruebas de larga duración
+-   Soportar módulos ESM
+-   Ejecutar pruebas en secuencia (--runInBand)
+
+Para crear nuevas pruebas, agregue un archivo `.test.ts` junto al código que está probando.