forked from elizaOS/eliza
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3afd61c
commit b2d5dec
Showing
2 changed files
with
261 additions
and
133 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,133 +1,133 @@ | ||
| # Eliza 🤖 | ||
|
|
||
| <div align="center"> | ||
| <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" /> | ||
| </div> | ||
|
|
||
| <div align="center"> | ||
|
|
||
| 📖 [Documentation](https://ai16z.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) | ||
|
|
||
| ## ✨ 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! | ||
|
|
||
| ## 🎯 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/ai16z/eliza-starter.git | ||
|
|
||
| cp .env.example .env | ||
|
|
||
| pnpm i && pnpm start | ||
| ``` | ||
|
|
||
| Then read the [Documentation](https://ai16z.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/ai16z/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 | ||
|
|
||
| [](https://gitpod.io/#https://github.com/ai16z/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 your planning to run multiple distinct agents, you can pass secrets through the character JSON | ||
|
|
||
| ### 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 `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 | ||
| 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/ai16z/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/ai16z/eliza/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=ai16z/eliza" /> | ||
| </a> | ||
|
|
||
| ## Star History | ||
|
|
||
| [](https://star-history.com/#ai16z/eliza&Date) | ||
| # Eliza 🤖 | ||
|
|
||
| <div align="center"> | ||
| <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" /> | ||
| </div> | ||
|
|
||
| <div align="center"> | ||
|
|
||
| 📖 [Documentation](https://ai16z.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) | ||
|
|
||
| ## ✨ 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! | ||
|
|
||
| ## 🎯 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/ai16z/eliza-starter.git | ||
|
|
||
| cp .env.example .env | ||
|
|
||
| pnpm i && pnpm start | ||
| ``` | ||
|
|
||
| Then read the [Documentation](https://ai16z.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/ai16z/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 | ||
|
|
||
| [](https://gitpod.io/#https://github.com/ai16z/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 your planning to run multiple distinct agents, you can pass secrets through the character JSON | ||
|
|
||
| ### 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 `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 | ||
| 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/ai16z/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/ai16z/eliza/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=ai16z/eliza" /> | ||
| </a> | ||
|
|
||
| ## Star History | ||
|
|
||
| [](https://star-history.com/#ai16z/eliza&Date) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| # Eliza 🤖 | ||
|
|
||
| <div align="center"> | ||
| <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" /> | ||
| </div> | ||
|
|
||
| <div align="center"> | ||
|
|
||
| 📖 [Dokumentation](https://ai16z.github.io/eliza/) | 🎯 [Beispiele](https://github.com/thejoven/awesome-eliza) | ||
|
|
||
| </div> | ||
|
|
||
| ## ✨ Funktionen | ||
|
|
||
| - 🛠️ Voll ausgestattete Konnektoren für Discord, Twitter und Telegram | ||
| - 👥 Multi-Agenten- und Raumunterstützung | ||
| - 📚 Einfache Verarbeitung und Interaktion mit deinen Dokumenten | ||
| - 💾 Abrufbarer Speicher und Dokumentenspeicher | ||
| - 🚀 Hochgradig erweiterbar – erstelle deine eigenen Aktionen und Clients | ||
| - ☁️ Unterstützt viele Modelle (lokales Llama, OpenAI, Anthropic, Groq usw.) | ||
| - 📦 Einfach funktionsfähig! | ||
|
|
||
| ## 🎯 Anwendungsfälle | ||
|
|
||
| - 🤖 Chatbots | ||
| - 🕵️ Autonome Agenten | ||
| - 📈 Geschäftsprozessmanagement | ||
| - 🎮 NPCs in Videospielen | ||
| - 🧠 Handel | ||
|
|
||
| ## 🚀 Schnelleinstieg | ||
|
|
||
| ### Voraussetzungen | ||
|
|
||
| - [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) | ||
|
|
||
| > **Hinweis für Windows-Benutzer:** [WSL 2](https://learn.microsoft.com/de-de/windows/wsl/install-manual) ist erforderlich. | ||
| ### Nutzung des Starters (Empfohlen) | ||
|
|
||
| ```bash | ||
| git clone https://github.com/ai16z/eliza-starter.git | ||
|
|
||
| cp .env.example .env | ||
|
|
||
| pnpm i && pnpm start | ||
| ``` | ||
|
|
||
| Lies dann die [Dokumentation](https://ai16z.github.io/eliza/), um zu erfahren, wie du Eliza anpassen kannst. | ||
|
|
||
| ### Manuelles Starten von Eliza (Nur empfohlen, wenn du genau weißt, was du tust) | ||
|
|
||
| ```bash | ||
| # Repository klonen | ||
| git clone https://github.com/ai16z/eliza.git | ||
|
|
||
| # Wechsle zur neuesten Version | ||
| # Dieses Projekt entwickelt sich schnell weiter, daher empfehlen wir, die neueste Version zu verwenden | ||
| git checkout $(git describe --tags --abbrev=0) | ||
| ``` | ||
|
|
||
| ### Eliza mit Gitpod starten | ||
|
|
||
| [](https://gitpod.io/#https://github.com/ai16z/eliza/tree/main) | ||
|
|
||
| ### Bearbeite die .env-Datei | ||
|
|
||
| Kopiere .env.example nach .env und fülle die entsprechenden Werte aus. | ||
|
|
||
| ``` | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| Hinweis: .env ist optional. Wenn du vorhast, mehrere unterschiedliche Agenten auszuführen, kannst du Geheimnisse über die Charakter-JSON übergeben. | ||
|
|
||
| ### Eliza automatisch starten | ||
|
|
||
| Dies führt alle notwendigen Schritte aus, um das Projekt einzurichten und den Bot mit dem Standardcharakter zu starten. | ||
|
|
||
| ```bash | ||
| sh scripts/start.sh | ||
| ``` | ||
|
|
||
| ### Charakterdatei bearbeiten | ||
|
|
||
| 1. Öffne `agent/src/character.ts`, um den Standardcharakter zu bearbeiten. Kommentiere und bearbeite ihn. | ||
|
|
||
| 2. Um benutzerdefinierte Charaktere zu laden: | ||
| - Verwende `pnpm start --characters="path/to/your/character.json"` | ||
| - Mehrere Charakterdateien können gleichzeitig geladen werden. | ||
| 3. Verbinde mit X (Twitter) | ||
| - Ändere `"clients": []` zu `"clients": ["twitter"]` in der Charakterdatei, um eine Verbindung mit X herzustellen. | ||
|
|
||
| ### Eliza manuell starten | ||
|
|
||
| ```bash | ||
| pnpm i | ||
| pnpm build | ||
| pnpm start | ||
|
|
||
| # Das Projekt entwickelt sich schnell weiter. Manchmal musst du das Projekt bereinigen, wenn du es nach einiger Zeit erneut aufrufst. | ||
| pnpm clean | ||
| ``` | ||
|
|
||
| #### Zusätzliche Anforderungen | ||
|
|
||
| Möglicherweise musst du Sharp installieren. Wenn beim Starten ein Fehler auftritt, versuche es mit folgendem Befehl: | ||
|
|
||
| ``` | ||
| pnpm install --include=optional sharp | ||
| ``` | ||
|
|
||
| ### Community & Kontakt | ||
|
|
||
| - [GitHub Issues](https://github.com/ai16z/eliza/issues). Am besten geeignet für: Bugs, die du bei der Nutzung von Eliza findest, und Feature-Vorschläge. | ||
| - [Discord](https://discord.gg/ai16z). Am besten geeignet für: das Teilen deiner Anwendungen und den Austausch mit der Community. | ||
|
|
||
| ## Contributors | ||
|
|
||
| <a href="https://github.com/ai16z/eliza/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=ai16z/eliza" /> | ||
| </a> | ||
|
|
||
| ## Star History | ||
|
|
||
| [](https://star-history.com/#ai16z/eliza&Date) |