Skip to content

Commit b2d5dec

Browse files
GottliebFreudenreichGottliebFreudenreich
authored
Add files via upload
1 parent 3afd61c commit b2d5dec

File tree

2 files changed

+261
-133
lines changed

2 files changed

+261
-133
lines changed

‎README.md

+133-133
Original file line numberDiff line numberDiff line change
@@ -1,133 +1,133 @@
1-
# Eliza 🤖
2-
3-
<div align="center">
4-
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
5-
</div>
6-
7-
<div align="center">
8-
9-
📖 [Documentation](https://ai16z.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)
10-
11-
</div>
12-
13-
## 🌍 README Translations
14-
15-
[中文说明](./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)
16-
17-
## ✨ Features
18-
19-
- 🛠️ Full-featured Discord, Twitter and Telegram connectors
20-
- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
21-
- 👥 Multi-agent and room support
22-
- 📚 Easily ingest and interact with your documents
23-
- 💾 Retrievable memory and document store
24-
- 🚀 Highly extensible - create your own actions and clients
25-
- ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
26-
- 📦 Just works!
27-
28-
## 🎯 Use Cases
29-
30-
- 🤖 Chatbots
31-
- 🕵️ Autonomous Agents
32-
- 📈 Business Process Handling
33-
- 🎮 Video Game NPCs
34-
- 🧠 Trading
35-
36-
## 🚀 Quick Start
37-
38-
### Prerequisites
39-
40-
- [Python 2.7+](https://www.python.org/downloads/)
41-
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
42-
- [pnpm](https://pnpm.io/installation)
43-
44-
> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
45-
46-
### Use the Starter (Recommended)
47-
48-
```bash
49-
git clone https://github.com/ai16z/eliza-starter.git
50-
51-
cp .env.example .env
52-
53-
pnpm i && pnpm start
54-
```
55-
56-
Then read the [Documentation](https://ai16z.github.io/eliza/) to learn how to customize your Eliza.
57-
58-
### Manually Start Eliza (Only recommended if you know what you are doing)
59-
60-
```bash
61-
# Clone the repository
62-
git clone https://github.com/ai16z/eliza.git
63-
64-
# Checkout the latest release
65-
# This project iterates fast, so we recommend checking out the latest release
66-
git checkout $(git describe --tags --abbrev=0)
67-
```
68-
69-
### Start Eliza with Gitpod
70-
71-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ai16z/eliza/tree/main)
72-
73-
### Edit the .env file
74-
75-
Copy .env.example to .env and fill in the appropriate values.
76-
77-
```
78-
cp .env.example .env
79-
```
80-
81-
Note: .env is optional. If your planning to run multiple distinct agents, you can pass secrets through the character JSON
82-
83-
### Automatically Start Eliza
84-
85-
This will run everything to setup the project and start the bot with the default character.
86-
87-
```bash
88-
sh scripts/start.sh
89-
```
90-
91-
### Edit the character file
92-
93-
1. Open `agent/src/character.ts` to modify the default character. Uncomment and edit.
94-
95-
2. To load custom characters:
96-
- Use `pnpm start --characters="path/to/your/character.json"`
97-
- Multiple character files can be loaded simultaneously
98-
3. Connect with X (Twitter)
99-
- change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
100-
101-
### Manually Start Eliza
102-
103-
```bash
104-
pnpm i
105-
pnpm build
106-
pnpm start
107-
108-
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
109-
pnpm clean
110-
```
111-
112-
#### Additional Requirements
113-
114-
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
115-
116-
```
117-
pnpm install --include=optional sharp
118-
```
119-
120-
### Community & contact
121-
122-
- [GitHub Issues](https://github.com/ai16z/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
123-
- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
124-
125-
## Contributors
126-
127-
<a href="https://github.com/ai16z/eliza/graphs/contributors">
128-
<img src="https://contrib.rocks/image?repo=ai16z/eliza" />
129-
</a>
130-
131-
## Star History
132-
133-
[![Star History Chart](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)
1+
# Eliza 🤖
2+
3+
<div align="center">
4+
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
5+
</div>
6+
7+
<div align="center">
8+
9+
📖 [Documentation](https://ai16z.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)
10+
11+
</div>
12+
13+
## 🌍 README Translations
14+
15+
[中文说明](./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)
16+
17+
## ✨ Features
18+
19+
- 🛠️ Full-featured Discord, Twitter and Telegram connectors
20+
- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
21+
- 👥 Multi-agent and room support
22+
- 📚 Easily ingest and interact with your documents
23+
- 💾 Retrievable memory and document store
24+
- 🚀 Highly extensible - create your own actions and clients
25+
- ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
26+
- 📦 Just works!
27+
28+
## 🎯 Use Cases
29+
30+
- 🤖 Chatbots
31+
- 🕵️ Autonomous Agents
32+
- 📈 Business Process Handling
33+
- 🎮 Video Game NPCs
34+
- 🧠 Trading
35+
36+
## 🚀 Quick Start
37+
38+
### Prerequisites
39+
40+
- [Python 2.7+](https://www.python.org/downloads/)
41+
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
42+
- [pnpm](https://pnpm.io/installation)
43+
44+
> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
45+
46+
### Use the Starter (Recommended)
47+
48+
```bash
49+
git clone https://github.com/ai16z/eliza-starter.git
50+
51+
cp .env.example .env
52+
53+
pnpm i && pnpm start
54+
```
55+
56+
Then read the [Documentation](https://ai16z.github.io/eliza/) to learn how to customize your Eliza.
57+
58+
### Manually Start Eliza (Only recommended if you know what you are doing)
59+
60+
```bash
61+
# Clone the repository
62+
git clone https://github.com/ai16z/eliza.git
63+
64+
# Checkout the latest release
65+
# This project iterates fast, so we recommend checking out the latest release
66+
git checkout $(git describe --tags --abbrev=0)
67+
```
68+
69+
### Start Eliza with Gitpod
70+
71+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ai16z/eliza/tree/main)
72+
73+
### Edit the .env file
74+
75+
Copy .env.example to .env and fill in the appropriate values.
76+
77+
```
78+
cp .env.example .env
79+
```
80+
81+
Note: .env is optional. If your planning to run multiple distinct agents, you can pass secrets through the character JSON
82+
83+
### Automatically Start Eliza
84+
85+
This will run everything to setup the project and start the bot with the default character.
86+
87+
```bash
88+
sh scripts/start.sh
89+
```
90+
91+
### Edit the character file
92+
93+
1. Open `agent/src/character.ts` to modify the default character. Uncomment and edit.
94+
95+
2. To load custom characters:
96+
- Use `pnpm start --characters="path/to/your/character.json"`
97+
- Multiple character files can be loaded simultaneously
98+
3. Connect with X (Twitter)
99+
- change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
100+
101+
### Manually Start Eliza
102+
103+
```bash
104+
pnpm i
105+
pnpm build
106+
pnpm start
107+
108+
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
109+
pnpm clean
110+
```
111+
112+
#### Additional Requirements
113+
114+
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
115+
116+
```
117+
pnpm install --include=optional sharp
118+
```
119+
120+
### Community & contact
121+
122+
- [GitHub Issues](https://github.com/ai16z/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
123+
- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
124+
125+
## Contributors
126+
127+
<a href="https://github.com/ai16z/eliza/graphs/contributors">
128+
<img src="https://contrib.rocks/image?repo=ai16z/eliza" />
129+
</a>
130+
131+
## Star History
132+
133+
[![Star History Chart](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)

‎README_DE.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Eliza 🤖
2+
3+
<div align="center">
4+
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
5+
</div>
6+
7+
<div align="center">
8+
9+
📖 [Dokumentation](https://ai16z.github.io/eliza/) | 🎯 [Beispiele](https://github.com/thejoven/awesome-eliza)
10+
11+
</div>
12+
13+
## ✨ Funktionen
14+
15+
- 🛠️ Voll ausgestattete Konnektoren für Discord, Twitter und Telegram
16+
- 👥 Multi-Agenten- und Raumunterstützung
17+
- 📚 Einfache Verarbeitung und Interaktion mit deinen Dokumenten
18+
- 💾 Abrufbarer Speicher und Dokumentenspeicher
19+
- 🚀 Hochgradig erweiterbar – erstelle deine eigenen Aktionen und Clients
20+
- ☁️ Unterstützt viele Modelle (lokales Llama, OpenAI, Anthropic, Groq usw.)
21+
- 📦 Einfach funktionsfähig!
22+
23+
## 🎯 Anwendungsfälle
24+
25+
- 🤖 Chatbots
26+
- 🕵️ Autonome Agenten
27+
- 📈 Geschäftsprozessmanagement
28+
- 🎮 NPCs in Videospielen
29+
- 🧠 Handel
30+
31+
## 🚀 Schnelleinstieg
32+
33+
### Voraussetzungen
34+
35+
- [Python 2.7+](https://www.python.org/downloads/)
36+
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
37+
- [pnpm](https://pnpm.io/installation)
38+
39+
> **Hinweis für Windows-Benutzer:** [WSL 2](https://learn.microsoft.com/de-de/windows/wsl/install-manual) ist erforderlich.
40+
41+
### Nutzung des Starters (Empfohlen)
42+
43+
```bash
44+
git clone https://github.com/ai16z/eliza-starter.git
45+
46+
cp .env.example .env
47+
48+
pnpm i && pnpm start
49+
```
50+
51+
Lies dann die [Dokumentation](https://ai16z.github.io/eliza/), um zu erfahren, wie du Eliza anpassen kannst.
52+
53+
### Manuelles Starten von Eliza (Nur empfohlen, wenn du genau weißt, was du tust)
54+
55+
```bash
56+
# Repository klonen
57+
git clone https://github.com/ai16z/eliza.git
58+
59+
# Wechsle zur neuesten Version
60+
# Dieses Projekt entwickelt sich schnell weiter, daher empfehlen wir, die neueste Version zu verwenden
61+
git checkout $(git describe --tags --abbrev=0)
62+
```
63+
64+
### Eliza mit Gitpod starten
65+
66+
[![In Gitpod öffnen](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ai16z/eliza/tree/main)
67+
68+
### Bearbeite die .env-Datei
69+
70+
Kopiere .env.example nach .env und fülle die entsprechenden Werte aus.
71+
72+
```
73+
cp .env.example .env
74+
```
75+
76+
Hinweis: .env ist optional. Wenn du vorhast, mehrere unterschiedliche Agenten auszuführen, kannst du Geheimnisse über die Charakter-JSON übergeben.
77+
78+
### Eliza automatisch starten
79+
80+
Dies führt alle notwendigen Schritte aus, um das Projekt einzurichten und den Bot mit dem Standardcharakter zu starten.
81+
82+
```bash
83+
sh scripts/start.sh
84+
```
85+
86+
### Charakterdatei bearbeiten
87+
88+
1. Öffne `agent/src/character.ts`, um den Standardcharakter zu bearbeiten. Kommentiere und bearbeite ihn.
89+
90+
2. Um benutzerdefinierte Charaktere zu laden:
91+
- Verwende `pnpm start --characters="path/to/your/character.json"`
92+
- Mehrere Charakterdateien können gleichzeitig geladen werden.
93+
3. Verbinde mit X (Twitter)
94+
- Ändere `"clients": []` zu `"clients": ["twitter"]` in der Charakterdatei, um eine Verbindung mit X herzustellen.
95+
96+
### Eliza manuell starten
97+
98+
```bash
99+
pnpm i
100+
pnpm build
101+
pnpm start
102+
103+
# Das Projekt entwickelt sich schnell weiter. Manchmal musst du das Projekt bereinigen, wenn du es nach einiger Zeit erneut aufrufst.
104+
pnpm clean
105+
```
106+
107+
#### Zusätzliche Anforderungen
108+
109+
Möglicherweise musst du Sharp installieren. Wenn beim Starten ein Fehler auftritt, versuche es mit folgendem Befehl:
110+
111+
```
112+
pnpm install --include=optional sharp
113+
```
114+
115+
### Community & Kontakt
116+
117+
- [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.
118+
- [Discord](https://discord.gg/ai16z). Am besten geeignet für: das Teilen deiner Anwendungen und den Austausch mit der Community.
119+
120+
## Contributors
121+
122+
<a href="https://github.com/ai16z/eliza/graphs/contributors">
123+
<img src="https://contrib.rocks/image?repo=ai16z/eliza" />
124+
</a>
125+
126+
## Star History
127+
128+
[![Star History Chart](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)

0 commit comments

Comments
 (0)