Merge pull request #7 from sweetmantech/sweets/pnpm

Sweets/pnpm

.env.example

@@ -239,6 +239,7 @@ LARGE_VOLENGINE_MODEL=          # Default: doubao-pro-256k
 VOLENGINE_EMBEDDING_MODEL=      # Default: doubao-embedding
 
 # DeepSeek Configuration
+DEEPSEEK_API_KEY=              #Your DeepSeek API key
 DEEPSEEK_API_URL=              # Default: https://api.deepseek.com
 SMALL_DEEPSEEK_MODEL=          # Default: deepseek-chat
 MEDIUM_DEEPSEEK_MODEL=         # Default: deepseek-chat
@@ -355,6 +356,13 @@ ZEROG_EVM_RPC=
 ZEROG_PRIVATE_KEY=
 ZEROG_FLOW_ADDRESS=
 
+# Squid Router
+SQUID_SDK_URL=https://apiplus.squidrouter.com # Default: https://apiplus.squidrouter.com
+SQUID_INTEGRATOR_ID= # get integrator id through https://docs.squidrouter.com/
+SQUID_EVM_ADDRESS=
+SQUID_EVM_PRIVATE_KEY=
+SQUID_API_THROTTLE_INTERVAL= # Default: 0; Used to throttle API calls to avoid rate limiting (in ms)
+
 # TEE Configuration
 # TEE_MODE options:
 # - LOCAL: Uses simulator at localhost:8090 (for local development)
@@ -364,6 +372,39 @@ ZEROG_FLOW_ADDRESS=
 TEE_MODE=OFF                    # LOCAL | DOCKER | PRODUCTION
 WALLET_SECRET_SALT=             # ONLY define if you want to use TEE Plugin, otherwise it will throw errors
 
+
+# TEE Verifiable Log Configuration
+VLOG=                          # true/false;  if you want to use TEE Verifiable Log, set this to "true"
+
+# Galadriel Configuration
+GALADRIEL_API_KEY=gal-*         # Get from https://dashboard.galadriel.com/
+
+# Venice Configuration
+VENICE_API_KEY=                 # generate from venice settings
+SMALL_VENICE_MODEL=             # Default: llama-3.3-70b
+MEDIUM_VENICE_MODEL=            # Default: llama-3.3-70b
+LARGE_VENICE_MODEL=             # Default: llama-3.1-405b
+IMAGE_VENICE_MODEL=             # Default: fluently-xl
+
+# Akash Chat API Configuration docs: https://chatapi.akash.network/documentation
+AKASH_CHAT_API_KEY= # Get from https://chatapi.akash.network/
+SMALL_AKASH_CHAT_API_MODEL=  # Default: Meta-Llama-3-2-3B-Instruct
+MEDIUM_AKASH_CHAT_API_MODEL= # Default: Meta-Llama-3-3-70B-Instruct
+LARGE_AKASH_CHAT_API_MODEL=  # Default: Meta-Llama-3-1-405B-Instruct-FP8
+
+# fal.ai Configuration
+FAL_API_KEY=
+FAL_AI_LORA_PATH=
+
+# Web search API Configuration
+TAVILY_API_KEY=
+
+# WhatsApp Cloud API Configuration
+WHATSAPP_ACCESS_TOKEN=          # Permanent access token from Facebook Developer Console
+WHATSAPP_PHONE_NUMBER_ID=       # Phone number ID from WhatsApp Business API
+WHATSAPP_BUSINESS_ACCOUNT_ID=   # Business Account ID from Facebook Business Manager
+WHATSAPP_WEBHOOK_VERIFY_TOKEN=  # Custom string for webhook verification
+WHATSAPP_API_VERSION=v17.0      # WhatsApp API version (default: v17.0)
 ENABLE_TEE_LOG=false            # Set to true to enable TEE logging, only available when running eliza in TEE
 
 # Flow Blockchain Configuration
@@ -464,7 +505,9 @@ GIPHY_API_KEY=
 # OpenWeather
 OPEN_WEATHER_API_KEY=           # OpenWeather API key
 
-
+#GITCOIN Passport
+PASSPORT_API_KEY= #Gitcoin Passport key
+PASSPORT_SCORER= #Scorer number
 
 # EchoChambers Configuration
 ECHOCHAMBERS_API_URL=http://127.0.0.1:3333
@@ -478,6 +521,9 @@ ECHOCHAMBERS_MAX_MESSAGES=10
 ALLORA_API_KEY=                 # Allora API key, format: UP-f8db7d6558ab432ca0d92716
 ALLORA_CHAIN_SLUG=              # must be one of mainnet, testnet. If not specified, it will use testnet by default
 
+# B2 Network
+B2_PRIVATE_KEY= # Private key of the B2 Network account to use for the agent
+
 # Opacity zkTLS
 OPACITY_TEAM_ID=f309ac8ae8a9a14a7e62cd1a521b1c5f
 OPACITY_CLOUDFLARE_NAME=eigen-test
@@ -493,9 +539,6 @@ AWS_S3_UPLOAD_PATH=
 # Deepgram
 DEEPGRAM_API_KEY=
 
-# Web search API Configuration
-TAVILY_API_KEY=
-
 # Verifiable Inference Configuration
 VERIFIABLE_INFERENCE_ENABLED=false # Set to false to disable verifiable inference
 VERIFIABLE_INFERENCE_PROVIDER=opacity # Options: opacity

.github/workflows/greetings.yml

@@ -12,5 +12,5 @@ jobs:
             - uses: actions/first-interaction@v1
               with:
                   repo-token: ${{ secrets.GITHUB_TOKEN }}
-                  issue-message: "Hello @${{ github.actor }}! Welcome to the ai16z community. Thank you for opening your first issue; we appreciate your contribution. You are now a ai16z contributor!"
-                  pr-message: "Hi @${{ github.actor }}! Welcome to the ai16z community. Thanks for submitting your first pull request; your efforts are helping us accelerate towards AGI. We'll review it shortly. You are now a ai16z contributor!"
+                  issue-message: "Hello @${{ github.actor }}! Welcome to the elizaOS community. Thank you for opening your first issue; we appreciate your contribution. You are now an elizaOS contributor!"
+                  pr-message: "Hi @${{ github.actor }}! Welcome to the elizaOS community. Thanks for submitting your first pull request; your efforts are helping us accelerate towards AGI. We'll review it shortly. You are now an elizaOS contributor!"

.gitignore

@@ -61,4 +61,4 @@ agent/content
 
 eliza.manifest
 eliza.manifest.sgx
-eliza.sig
+eliza.sig

CHANGELOG.md

@@ -1312,7 +1312,7 @@
 - Add OLLAMA as Model Provider  [\#221](https://github.com/elizaOS/eliza/pull/221) ([o-on-x](https://github.com/o-on-x))
 - lazy load llama [\#220](https://github.com/elizaOS/eliza/pull/220) ([lalalune](https://github.com/lalalune))
 - Implement grok beta [\#216](https://github.com/elizaOS/eliza/pull/216) ([MeDott29](https://github.com/MeDott29))
-- Abstracts Eliza into a Package to enble publishing onto NPM along with plugin system [\#214](https://github.com/elizaOS/eliza/pull/214) ([ponderingdemocritus](https://github.com/ponderingdemocritus))
+- Abstracts Eliza into a Package to enable publishing onto NPM along with plugin system [\#214](https://github.com/elizaOS/eliza/pull/214) ([ponderingdemocritus](https://github.com/ponderingdemocritus))
 - add the template overrides [\#207](https://github.com/elizaOS/eliza/pull/207) ([lalalune](https://github.com/lalalune))
 - Shaw fix characters paths, .ts requirement and missings args [\#204](https://github.com/elizaOS/eliza/pull/204) ([lalalune](https://github.com/lalalune))
 - Fix Discord Voice and DMs [\#203](https://github.com/elizaOS/eliza/pull/203) ([lalalune](https://github.com/lalalune))

README.md

@@ -12,7 +12,7 @@
 
 ## 🌍 README Translations
 
-[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Persian](./README_FA.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) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md) | [Tiếng Việt](./README_VI.md) | [עִברִית](https://github.com/elizaos/Elisa/blob/main/README_HE.md) | [Tagalog](./README_TG.md) | [Polski](./README_PL.md) | [Arabic](./README_AR.md) | [Hungarian](./README_HU.md) | [Srpski](./README_RS.md) | [Română](./README_RO.md) | [Nederlands](./README_NL.md)
+[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Persian](./README_FA.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) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md) | [Tiếng Việt](./README_VI.md) | [עִברִית](https://github.com/elizaos/Elisa/blob/main/README_HE.md) | [Tagalog](./README_TG.md) | [Polski](./README_PL.md) | [Arabic](./README_AR.md) | [Hungarian](./README_HU.md) | [Srpski](./README_RS.md) | [Română](./README_RO.md) | [Nederlands](./README_NL.md) | [Ελληνικά](./README_GR.md)
 
 ## 🚩 Overview
 
@@ -100,12 +100,16 @@ Note: .env is optional. If you're planning to run multiple distinct agents, you
 
 ### Automatically Start Eliza
 
-This will run everything to set up the project and start the bot with the default character.
+The start script provides an automated way to set up and run Eliza:
 
 ```bash
 sh scripts/start.sh
 ```
 
+For detailed instructions on using the start script, including character management and troubleshooting, see our [Start Script Guide](./docs/docs/guides/start-script.md).
+
+> **Note**: The start script handles all dependencies, environment setup, and character management automatically.
+
 ### Edit the character file
 
 1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit.

README_FARSI.md

@@ -0,0 +1,153 @@
+<div dir="rtl">
+
+# الیزا 🤖
+
+<div align="center">
+  <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+</div>
+
+<div align="center">
+
+📖 [Documnet](https://elizaos.github.io/eliza/) | 🎯 [نمونه‌ها](https://github.com/thejoven/awesome-eliza)
+
+</div>
+
+## 🌍 ترجمه‌های README
+
+[中文说明](./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) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md) | [Tiếng Việt](./README_VI.md) | [עִברִית](https://github.com/elizaos/Elisa/blob/main/README_HE.md) | [Tagalog](./README_TG.md) | [Polski](./README_PL.md) | [Arabic](./README_AR.md) | [Hungarian](./README_HU.md) | [Srpski](./README_RS.md)| [Persian](./README_FARSI.md)
+
+## 🚩 نمای کلی
+
+<div align="center">
+  <img src="./docs/static/img/eliza_diagram.jpg" alt="Eliza Diagram" width="100%" />
+</div>
+
+## ✨ ویژگی‌ها
+
+- 🛠️ رابط‌های کامل برای دیسکورد، توییتر و تلگرام
+- 🔗 پشتیبانی از تمام مدل‌ها (Llama, Grok, OpenAI, Anthropic و غیره)
+- 👥 پشتیبانی از چند Agent و Room
+- 📚 وارد کردن و تعامل آسان با Document شما
+- 💾 حافظه و ذخیره‌سازی اسناد قابل بازیابی
+- 🚀 بسیار قابل گسترش - ایجاد اقدامات و مشتریان خود
+- ☁️ پشتیبانی از مدل‌های متعدد (Llama local، OpenAI، Anthropic، Groq و غیره)
+- 📦 به سادگی کار می‌کند!
+
+
+## ویدیوهای آموزشی
+
+[مدرسه توسعه عامل هوش مصنوعی](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
+
+## 🎯 موارد استفاده
+
+- 🤖 ربات‌های چت
+- 🕵️ Agentهای خودکار
+- 📈 مدیریت فرآیندهای تجاری
+- 🎮 NPC در بازی‌های ویدیویی
+- 🧠 معامله‌گری
+
+## 🚀 شروع سریع
+
+### پیش‌نیازها
+
+- [پایتون ۲.۷+](https://www.python.org/downloads/)
+- [نود جی‌اس ۲۳+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+- [pnpm](https://pnpm.io/installation)
+
+> **نکته برای کاربران ویندوز:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) مورد نیاز است.
+
+### استفاده از Starter (توصیه شده)
+
+```bash
+git clone https://github.com/elizaos/eliza-starter.git
+cd eliza-starter
+cp .env.example .env
+pnpm i && pnpm build && pnpm start
+```
+
+پس از اجرای Agent، باید پیامی برای اجرای "pnpm start:client" در انتها مشاهده کنید.
+یک ترمینال دیگر باز کنید و به همان دایرکتوری بروید و سپس دستور زیر را اجرا کنید و URL را دنبال کنید تا با Agent خود چت کنید.
+
+```bash
+pnpm start:client
+```
+
+سپس [Document](https://elizaos.github.io/eliza/) را بخوانید تا یاد بگیرید چگونه الیزای خود را سفارشی کنید.
+
+### راه‌اندازی دستی الیزا (فقط برای برنامه نویسان توصیه می‌شود)
+
+```bash
+# کلون کردن مخزن
+git clone https://github.com/elizaos/eliza.git
+
+# چک‌اوت آخرین نسخه
+# این پروژه به سرعت به‌روز می‌شود، بنابراین توصیه می‌کنیم آخرین نسخه را چک‌اوت کنید
+git checkout $(git describe --tags --abbrev=0)
+```
+
+### شروع الیزا با Gitpod
+
+[![باز کردن در Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
+
+### ویرایش فایل .env
+
+فایل .env.example را به .env کپی کنید و مقادیر مناسب را پر کنید.
+
+```
+cp .env.example .env
+```
+
+نکته: .env اختیاری است. اگر قصد اجرای چندین عامل متمایز را دارید، می‌توانید رمزها را از طریق JSON کاراکتر منتقل کنید.
+
+### راه‌اندازی خودکار الیزا
+
+این Script همه چیز را برای راه‌اندازی پروژه و شروع ربات با کاراکتر پیش‌فرض اجرا می‌کند.
+
+```bash
+sh scripts/start.sh
+```
+
+### ویرایش فایل شخصیت
+
+۱. `packages/core/src/defaultCharacter.ts` را برای تغییر شخصیت پیش‌فرض باز کنید. توضیحات را حذف و ویرایش کنید.
+
+۲. برای بارگذاری شخصیت‌های سفارشی: - از `pnpm start --characters="path/to/your/character.json"`
+استفاده کنید - چندین فایل شخصیت می‌توانند همزمان بارگذاری شوند
+
+۳.اتصال به X (توییتر) - `"clients": []` را به `"clients": ["twitter"]` در فایل شخصیت تغییر دهید تا به X متصل شوید
+
+### راه‌اندازی دستی الیزا
+
+```bash
+pnpm i
+pnpm build
+pnpm start
+
+# پروژه به سرعت به‌روز می‌شود، گاهی اوقات اگر به پروژه برمی‌گردید نیاز به پاک‌سازی پروژه دارید
+pnpm clean
+```
+
+#### نیازمندی‌های اضافی
+
+ممکن است نیاز به نصب Sharp داشته باشید. اگر هنگام راه‌اندازی خطایی مشاهده کردید، سعی کنید آن را با دستور زیر نصب کنید:
+
+```
+pnpm install --include=optional sharp
+```
+
+### Community و Contact
+
+- [GitHub Issues](https://github.com/elizaos/eliza/issues). بهترین گزینه برای: باگ‌هایی که در استفاده از الیزا با آن‌ها مواجه می‌شوید و پیشنهادات ویژگی‌ها.
+- [Discord](https://discord.gg/ai16z). بهترین گزینه برای: به اشتراک‌گذاری برنامه‌های خود و گذراندن وقت با کامیونیتی.
+
+## مشارکت‌کنندگان
+
+<a href="https://github.com/elizaos/eliza/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=elizaos/eliza" />
+</a>
+
+## تاریخچه Star
+
+[![نمودار تاریخچه ستاره‌ها](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)
+
+</div>