|
12 | 12 |
|
13 | 13 | ## 🌍 README Translations |
14 | 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) | [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) |
16 | | - |
17 | | -## 🚩 Overview |
18 | | - |
19 | | -<div align="center"> |
20 | | - <img src="./docs/static/img/eliza_diagram.jpg" alt="Eliza Diagram" width="100%" /> |
21 | | -</div> |
22 | | - |
23 | | -## ✨ Features |
24 | | - |
25 | | -- 🛠️ Full-featured Discord, Twitter and Telegram connectors |
26 | | -- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.) |
27 | | -- 👥 Multi-agent and room support |
28 | | -- 📚 Easily ingest and interact with your documents |
29 | | -- 💾 Retrievable memory and document store |
30 | | -- 🚀 Highly extensible - create your own actions and clients |
31 | | -- ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.) |
32 | | -- 📦 Just works! |
33 | | - |
34 | | -## Video Tutorials |
35 | | - |
36 | | -[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL) |
37 | | - |
38 | | -## 🎯 Use Cases |
39 | | - |
40 | | -- 🤖 Chatbots |
41 | | -- 🕵️ Autonomous Agents |
42 | | -- 📈 Business Process Handling |
43 | | -- 🎮 Video Game NPCs |
44 | | -- 🧠 Trading |
45 | | - |
46 | | -## 💰 If you plan to launch a token |
47 | | - |
48 | | -This framework is the number one open source project on github, we are enabling the next generation of human-machine interface but we still need your help to ensure the code is of the utmost quality with response rapid to critical issues that will affect our builder community at large. |
49 | | - |
50 | | -To ensure sustainable development and continued innovation, we ask contributions of 5-10% of initial token distributions from successful launches. |
51 | | - |
52 | | -All contributions are publicly tracked on-chain and used exclusively for ecosystem development. |
53 | | - |
54 | | -### ⚠️ Don't forget to tip the big guy 10%: ⚠️ |
55 | | -[AM84n1iLdxgVTAyENBcLdjXoyvjentTbu5Q6EpKV1PeG](https://solscan.io/account/AM84n1iLdxgVTAyENBcLdjXoyvjentTbu5Q6EpKV1PeG) |
56 | | - |
57 | | -## 🚀 Quick Start |
58 | | - |
59 | | -### Prerequisites |
60 | | - |
61 | | -- [Python 2.7+](https://www.python.org/downloads/) |
62 | | -- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) |
63 | | -- [pnpm](https://pnpm.io/installation) |
64 | | - |
65 | | -> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required. |
66 | | -
|
67 | | -### Use the Starter (Recommended) |
68 | | - |
69 | | -```bash |
70 | | -git clone https://github.com/elizaos/eliza-starter.git |
71 | | -cd eliza-starter |
72 | | -cp .env.example .env |
73 | | -pnpm i && pnpm build && pnpm start |
74 | | -``` |
75 | | - |
76 | | -Once the agent is running, you should see the message to run "pnpm start:client" at the end. |
77 | | -Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent. |
78 | | - |
79 | | -```bash |
80 | | -pnpm start:client |
81 | | -``` |
82 | | - |
83 | | -Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza. |
84 | | - |
85 | | -### Manually Start Eliza (Only recommended if you know what you are doing) |
86 | | - |
87 | | -```bash |
88 | | -# Clone the repository |
89 | | -git clone https://github.com/elizaos/eliza.git |
90 | | - |
91 | | -# Checkout the latest release |
92 | | -# This project iterates fast, so we recommend checking out the latest release |
93 | | -git checkout $(git describe --tags --abbrev=0) |
94 | | -``` |
95 | | - |
96 | | -### Start Eliza with Gitpod |
97 | | - |
98 | | -[](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main) |
99 | | - |
100 | | -### Edit the .env file |
101 | | - |
102 | | -Copy .env.example to .env and fill in the appropriate values. |
103 | | - |
104 | | -``` |
105 | | -cp .env.example .env |
106 | | -``` |
107 | | - |
108 | | -Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON |
109 | | -Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON |
110 | | - |
111 | | -### Automatically Start Eliza |
112 | | - |
113 | | -This will run everything to set up the project and start the bot with the default character. |
114 | | - |
115 | | -```bash |
116 | | -sh scripts/start.sh |
117 | | -``` |
118 | | - |
119 | | -### Edit the character file |
120 | | - |
121 | | -1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit. |
122 | | - |
123 | | -2. To load custom characters: |
124 | | - - Use `pnpm start --characters="path/to/your/character.json"` |
125 | | - - Multiple character files can be loaded simultaneously |
126 | | -3. Connect with X (Twitter) |
127 | | - - change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X |
128 | | - |
129 | | -### Manually Start Eliza |
130 | | - |
131 | | -```bash |
132 | | -pnpm i |
133 | | -pnpm build |
134 | | -pnpm start |
135 | | - |
136 | | -# The project iterates fast, sometimes you need to clean the project if you are coming back to the project |
137 | | -pnpm clean |
138 | | -``` |
139 | | - |
140 | | -#### Additional Requirements |
141 | | - |
142 | | -You may need to install Sharp. If you see an error when starting up, try installing it with the following command: |
143 | | - |
144 | | -``` |
145 | | -pnpm install --include=optional sharp |
146 | | -``` |
147 | | - |
148 | | -### Community & contact |
149 | | - |
150 | | -- [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals. |
151 | | -- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community. |
152 | | -- [Developer Discord](https://discord.gg/3f67SH4rXT). Best for: getting help and plugin development. |
153 | | - |
154 | | -## Contributors |
155 | | - |
156 | | -<a href="https://github.com/elizaos/eliza/graphs/contributors"> |
157 | | - <img src="https://contrib.rocks/image?repo=elizaos/eliza" /> |
158 | | -</a> |
159 | | - |
160 | | -## Star History |
161 | | - |
162 | | -[](https://star-history.com/#elizaos/eliza&Date) |
163 | | -======= |
164 | | -# Eliza 🤖 |
165 | | - |
166 | | -<div align="center"> |
167 | | - <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" /> |
168 | | -</div> |
169 | | - |
170 | | -<div align="center"> |
171 | | - |
172 | | -📖 [Documentation](https://elizaos.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza) |
173 | | - |
174 | | -</div> |
175 | | - |
176 | | -## 🌍 README Translations |
177 | | - |
178 | | -[中文说明](./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) |
| 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) | [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) |
179 | 16 |
|
180 | 17 | ## 🚩 Overview |
181 | 18 |
|
|
0 commit comments