Merge branch 'develop' into ng/moving-readmes

Author: 0xnogo

.env.example

@@ -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!"

.github/workflows/greetings.yml

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

.gitignore

@@ -43,5 +43,16 @@
     },
     "[shellscript]": {
         "editor.defaultFormatter": "foxundermoon.shell-format"
+    },
+    "explorer.fileNesting.enabled": true,
+    "explorer.fileNesting.patterns": {
+        "*.ts": "${capture}.js",
+        "*.js": "${capture}.js.map, ${capture}.min.js, ${capture}.d.ts",
+        "*.jsx": "${capture}.js",
+        "*.tsx": "${capture}.ts",
+        "tsconfig.json": "tsconfig.*.json",
+        "package.json": "package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lockb,pnpm-workspace.yaml",
+        "README.md": "*.md",
+        "Dockerfile": "docker-compose-docs.yaml,docker-compose.yaml,Dockerfile.docs"
     }
 }

.vscode/settings.json

@@ -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))

CHANGELOG.md

@@ -12,7 +12,7 @@
 
 ## 🌍 README Translations
 
-[中文说明](i18n/readme/README_CN.md) | [日本語の説明](i18n/readme/README_JA.md) | [한국어 설명](i18n/readme/README_KOR.md) | [Français](i18n/readme/README_FR.md) | [Português](i18n/readme/README_PTBR.md) | [Türkçe](i18n/readme/README_TR.md) | [Русский](i18n/readme/README_RU.md) | [Español](i18n/readme/README_ES.md) | [Italiano](i18n/readme/README_IT.md) | [ไทย](i18n/readme/README_TH.md) | [Deutsch](i18n/readme/README_DE.md) | [Tiếng Việt](i18n/readme/README_VI.md) | [עִברִית](i18n/readme/README_HE.md) | [Tagalog](i18n/readme/README_TG.md) | [Polski](i18n/readme/README_PL.md) | [Arabic](i18n/readme/README_AR.md) | [Hungarian](i18n/readme/README_HU.md) | [Srpski](i18n/readme/README_RS.md) | [Română](i18n/readme/README_RO.md) | [Nederlands](i18n/readme/README_NL.md)
+[中文说明](i18n/readme/README_CN.md) | [日本語の説明](i18n/readme/README_JA.md) | [한국어 설명](i18n/readme/README_KOR.md) | [Persian](i18n/readme/README_FA.md) | [Français](i18n/readme/README_FR.md) | [Português](i18n/readme/README_PTBR.md) | [Türkçe](i18n/readme/README_TR.md) | [Русский](i18n/readme/README_RU.md) | [Español](i18n/readme/README_ES.md) | [Italiano](i18n/readme/README_IT.md) | [ไทย](i18n/readme/README_TH.md) | [Deutsch](i18n/readme/README_DE.md) | [Tiếng Việt](i18n/readme/README_VI.md) | [עִברִית](i18n/readme/README_HE.md) | [Tagalog](i18n/readme/README_TG.md) | [Polski](i18n/readme/README_PL.md) | [Arabic](i18n/readme/README_AR.md) | [Hungarian](i18n/readme/README_HU.md) | [Srpski](i18n/readme/README_RS.md) | [Română](i18n/readme/README_RO.md) | [Nederlands](i18n/readme/README_NL.md) | [Ελληνικά](i18n/readme/README_GR.md)
 
 ## 🚩 Overview
 
@@ -23,12 +23,11 @@
 ## ✨ Features
 
 - 🛠️ Full-featured Discord, Twitter and Telegram connectors
-- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
+- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, Gemini, etc.)
 - 👥 Multi-agent and room support
 - 📚 Easily ingest and interact with your documents
 - 💾 Retrievable memory and document store
 - 🚀 Highly extensible - create your own actions and clients
-- ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
 - 📦 Just works!
 
 ## Video Tutorials
@@ -62,31 +61,21 @@ cp .env.example .env
 pnpm i && pnpm build && pnpm start
 ```
 
-Once the agent is running, you should see the message to run "pnpm start:client" at the end.
-Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent.
-
-```bash
-pnpm start:client
-```
-
-Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
-
 ### Manually Start Eliza (Only recommended if you know what you are doing)
 
+#### Checkout the latest release
+
 ```bash
 # Clone the repository
 git clone https://github.com/elizaos/eliza.git
 
-# Checkout the latest release
 # This project iterates fast, so we recommend checking out the latest release
 git checkout $(git describe --tags --abbrev=0)
+# If the above doesn't checkout the latest release, this should work:
+# git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
 ```
 
-### Start Eliza with Gitpod
-
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
-
-### Edit the .env file
+#### Edit the .env file
 
 Copy .env.example to .env and fill in the appropriate values.
 
@@ -96,15 +85,46 @@ cp .env.example .env
 
 Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
 
+#### Start Eliza
+
+```bash
+pnpm i
+pnpm build
+pnpm start
+
+# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
+pnpm clean
+```
+
+### Interact via Browser
+
+````
+Once the agent is running, you should see the message to run "pnpm start:client" at the end.
+Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent.
+
+```bash
+pnpm start:client
+````
+
+Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
+
+---
+
 ### 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
 ```
 
-### Edit the character file
+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.
+
+---
+
+### Modify Character
 
 1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit.
 
@@ -114,16 +134,7 @@ sh scripts/start.sh
 3. Connect with X (Twitter)
     - change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
 
-### Manually Start Eliza
-
-```bash
-pnpm i
-pnpm build
-pnpm start
-
-# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
-pnpm clean
-```
+---
 
 #### Additional Requirements
 
@@ -133,6 +144,14 @@ You may need to install Sharp. If you see an error when starting up, try install
 pnpm install --include=optional sharp
 ```
 
+---
+
+### Start Eliza with Gitpod
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
+
+---
+
 ### Community & contact
 
 - [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.

README.md

@@ -0,0 +1,147 @@
+# الیزا 🤖
+
+<div align="center">
+  <img src="./docs/static/img/eliza_banner.jpg" alt="الیزا بنر" width="100%" />
+</div>
+
+<div align="center">
+
+📖 [مستندات](https://elizaos.github.io/eliza/) | 🎯 [نمونه‌ها](https://github.com/thejoven/awesome-eliza)
+
+</div>
+
+## 🚩 معرفی کلی
+
+<div align="center">
+  <img src="./docs/static/img/eliza_diagram.png" alt="نمودار الیزا" width="100%" />
+</div>
+
+## ✨ ویژگی‌ها
+
+- 🛠️ پشتیبانی کامل از اتصال به دیسکورد، توییتر و تلگرام
+- 🔗 سازگاری با همه مدل‌ها (Llama، Grok، OpenAI، Anthropic و غیره)
+- 👥 پشتیبانی از چند عامل و چند اتاق
+- 📚 مدیریت و تعامل آسان با اسناد شما
+- 💾 حافظه و ذخیره‌سازی اسناد قابل بازیابی
+- 🚀 بسیار قابل گسترش - امکان ایجاد اکشن‌ها و کلاینت‌های سفارشی
+- ☁️ پشتیبانی از مدل‌های مختلف (local Llama, OpenAI، Anthropic, etc. )
+- 📦 به سادگی کار می‌کند!
+
+## آموزش‌های ویدیویی
+
+[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
+
+## 🎯 موارد استفاده
+
+- 🤖 چت‌بات‌ها
+- 🕵️ عوامل خودکار
+- 📈 مدیریت فرآیندهای کسب‌وکار
+- 🎮 کاراکترهای بازی‌های ویدیویی
+- 🧠 معاملات تجاری
+
+## 🚀 شروع سریع
+
+### پیش‌نیازها
+
+- [Python 2.7+](https://www.python.org/downloads/)
+- [Node.js 23+](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) لازم است.
+
+### استفاده از پروژه آغازین (توصیه‌شده)
+
+```bash
+git clone https://github.com/elizaos/eliza-starter.git
+cd eliza-starter
+cp .env.example .env
+pnpm i && pnpm build && pnpm start
+```
+
+پس از اجرای عامل، باید پیامی برای اجرای "pnpm start:client" دریافت کنید.
+یک ترمینال جدید باز کنید و به همان دایرکتوری رفته و دستور زیر را اجرا کنید تا با عامل خود گفتگو کنید:
+
+```bash
+pnpm start:client
+```
+
+سپس [مستندات](https://elizaos.github.io/eliza/) را مطالعه کنید تا بیاموزید چگونه الیزا را سفارشی کنید.
+
+### اجرای دستی الیزا (فقط در صورتی که تخصص دارید توصیه می‌شود)
+
+```bash
+# کلون کردن مخزن
+git clone https://github.com/elizaos/eliza.git
+
+# انتخاب آخرین نسخه پایدار
+# این پروژه سریع به‌روزرسانی می‌شود، پیشنهاد می‌کنیم آخرین نسخه پایدار را انتخاب کنید
+git checkout $(git describe --tags --abbrev=0)
+# اگر دستور بالا آخرین نسخه را انتخاب نکرد، این دستور را امتحان کنید:
+# git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
+```
+
+### اجرای الیزا با Gitpod
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
+
+### ویرایش فایل .env
+
+یک کپی از .env.example بگیرید و مقادیر مناسب را وارد کنید:
+
+```
+cp .env.example .env
+```
+
+توجه: فایل .env اختیاری است. اگر قصد دارید چندین عامل متمایز اجرا کنید، می‌توانید اطلاعات محرمانه را از طریق فایل JSON شخصیت انتقال دهید.
+
+### شروع خودکار الیزا
+
+این دستور همه مراحل راه‌اندازی پروژه را انجام داده و بات را با شخصیت پیش‌فرض اجرا می‌کند:
+
+```bash
+sh scripts/start.sh
+```
+
+### ویرایش فایل شخصیت
+
+1. فایل `packages/core/src/defaultCharacter.ts` را باز کنید تا شخصیت پیش‌فرض را تغییر دهید. تغییرات لازم را انجام دهید.
+2. برای بارگذاری شخصیت‌های سفارشی:
+    - از دستور `pnpm start --characters="path/to/your/character.json"` استفاده کنید.
+    - چندین فایل شخصیت می‌توانند همزمان بارگذاری شوند.
+3. اتصال به توییتر (X):
+    - مقدار `"clients": []` را به `"clients": ["twitter"]` در فایل شخصیت تغییر دهید.
+
+### اجرای دستی الیزا
+
+```bash
+pnpm i
+pnpm build
+pnpm start
+
+# اگر پروژه به دلیل تغییرات سریع نیاز به پاکسازی داشت، دستور زیر را اجرا کنید:
+pnpm clean
+```
+
+#### نیازمندی‌های اضافی
+
+ممکن است نیاز به نصب Sharp باشد. اگر هنگام راه‌اندازی خطایی دیدید، دستور زیر را اجرا کنید:
+
+```
+pnpm install --include=optional sharp
+```
+
+### انجمن و تماس
+
+- [مشکلات در GitHub](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 History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)
+