Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
kwanRoshi authored Jan 11, 2025
1 parent 68a8054 commit 297dda6
Show file tree
Hide file tree
Showing 18 changed files with 2,573 additions and 0 deletions.
150 changes: 150 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
# Eliza 🤖

<div align="center">
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
</div>

<div align="center">

📖 [Documentation](https://elizaos.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)

</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) | [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)

## 🚩 Overview

<div align="center">
<img src="./docs/static/img/eliza_diagram.jpg" alt="Eliza Diagram" width="100%" />
</div>

## ✨ Features

- 🛠️ Full-featured Discord, Twitter and Telegram connectors
- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, 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

[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)

## 🎯 Use Cases

- 🤖 Chatbots
- 🕵️ Autonomous Agents
- 📈 Business Process Handling
- 🎮 Video Game NPCs
- 🧠 Trading

## 🚀 Quick Start

### Prerequisites

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

> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
### Use the Starter (Recommended)

```bash
git clone https://github.com/elizaos/eliza-starter.git
cd eliza-starter
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)

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

### 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

Copy .env.example to .env and fill in the appropriate values.

```
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
Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON

### Automatically Start Eliza

This will run everything to set up the project and start the bot with the default character.

```bash
sh scripts/start.sh
```

### Edit the character file

1. Open `packages/core/src/defaultCharacter.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
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

You may need to install Sharp. If you see an error when starting up, try installing it with the following command:

```
pnpm install --include=optional sharp
```

### Community & contact

- [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.

## Contributors

<a href="https://github.com/elizaos/eliza/graphs/contributors">
<img src="https://contrib.rocks/image?repo=elizaos/eliza" />
</a>

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)
133 changes: 133 additions & 0 deletions README_AR.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Eliza 🤖

<div align="center">
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
</div>

<div align="center">

📖 [التعليمات](https://elizaos.github.io/eliza/) | 🎯 [الأمثلة](https://github.com/thejoven/awesome-eliza)

</div>

## ✨ ما هي الميزات؟

- 🛠️ اتصالات مجهزة بالكامل لديسكورد، تويتر، وتيليغرام.
- 👥 دعم متعدد للوكلاء والغرف.
- 📚 التفاعل بإتقان مع المستندات كما يمكن فحصها بسهولة.
- 💾 ذاكرة قوية قابلة لاسترجاع ما فاتك! وكذلك مساحة كافية للتخزين
- 🚀 سريعة الانتشار بشكل غير مسبوق، هيّا! تفاعل واصنع عملاء خاصين بك.
- ☁️ تدعم العديد من النماذج مثل:-
- لاما (نموذج مفتوح المصدر للذكاء الاصطناعي Llama).
- جروك (نظام ذكاء اصطناعي متقدم Grok).
- أوبن إيه آي (OpenAI نماذج ذكاء اصطناعي مثل ChatGPT).
- أنثروبيك Anthropic وغيرها من النماذج الأخرى!
- 📦 جاهزة للعمل أي وقت وبسهولة!

## 🎯 كيف ستفيدني؟

- 🤖 روبوتات الدردشة.
- 🕵️ وكلاء مستقلون.
- 📈 إدارة الأعمال.
- 🎮 في الجيميز NPCs أو الشخصيات التي يتحكم بها الحاسوب فقط وليس اللاعب.
- 🧠 التداول.

## 🚀 ابدأ الآن!

### ماذا عن المتطلبات الأساسية؟

- [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/de-de/windows/wsl/install-manual).
### استخدام النسخة المبدئية (موصى به)

```bash
git clone https://github.com/elizaos/eliza-starter.git

cp .env.example .env

pnpm i && pnpm start
```

تعلم أكثر عن كيفية تخصيص إليزا من هنا [التعليمات](https://elizaos.github.io/eliza/)

### إذا كان لديك خبرة بالفعل، يُمكنك تشغيل إليزا يدويًا.

```bash
# انشئ نسخة
git clone https://github.com/elizaos/eliza.git

# ألق نظرة على آخر تحديث
# هذا المشروع يتطور بسرعة، لذا، أوصيك باستخدام أحدث إصدار
git checkout $(git describe --tags --abbrev=0)
```

### تشغل إليزا مع Gitpod

[![In Gitpod öffnen](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)

### عدّل ملف .env-Datei

انسخ ملف .env.example إلى .env واملأ القيم المناسبة.

```
cp .env.example .env
```

ضع في الإعتبار أن ملف .env اختياري. إذا كنت تخطط لتشغيل عدة وكلاء مختلفين، ابعت الـsecrets من خلال ملف JSON الخاص بالشخصية.

### تشغيل إليزا تلقائيًا

هذا الكود لتنفيذ جميع الخطوات اللازمة لإعداد المشروع وكذلك تشغيل الروبوت مع الشخصية الافتراضية.

```bash
sh scripts/start.sh
```

### لتعديل ملف الشخصية

افتح ملف agent/src/character.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
```

### المجتمع والدعم

- في حال إذا واجهت أي مشاكل تتعلق باستخدام إليزا ولتقديم المقترحات [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 History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)
Loading

0 comments on commit 297dda6

Please sign in to comment.