Skip to content

Commit 48c6758

Browse files
2-A-M2-A-M
committed
Revamping PTBR Readme for clearer and updated instructions
Revamping README_PTBR.md for clearer and updated instructions Removed a redundancy on the README.md where it stated the supported models twice
1 parent 81d0273 commit 48c6758

File tree

2 files changed

+93
-153
lines changed

2 files changed

+93
-153
lines changed

‎README.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<div align="center">
88

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

1111
</div>
1212

@@ -16,33 +16,33 @@
1616

1717
## ✨ Features
1818

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!
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+
- 📦 Just works!
2726

2827
## Video Tutorials
28+
2929
[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
3030

3131
## 🎯 Use Cases
3232

33-
- 🤖 Chatbots
34-
- 🕵️ Autonomous Agents
35-
- 📈 Business Process Handling
36-
- 🎮 Video Game NPCs
37-
- 🧠 Trading
33+
- 🤖 Chatbots
34+
- 🕵️ Autonomous Agents
35+
- 📈 Business Process Handling
36+
- 🎮 Video Game NPCs
37+
- 🧠 Trading
3838

3939
## 🚀 Quick Start
4040

4141
### Prerequisites
4242

43-
- [Python 2.7+](https://www.python.org/downloads/)
44-
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
45-
- [pnpm](https://pnpm.io/installation)
43+
- [Python 2.7+](https://www.python.org/downloads/)
44+
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
45+
- [pnpm](https://pnpm.io/installation)
4646

4747
> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
4848
@@ -122,8 +122,8 @@ pnpm install --include=optional sharp
122122

123123
### Community & contact
124124

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

128128
## Contributors
129129

‎README_PTBR.md

+74-134
Original file line numberDiff line numberDiff line change
@@ -2,183 +2,123 @@
22

33
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
44

5-
## Funcionalidades
5+
## ✨ Features
66

7-
- 🛠 Conectores completos para Discord, Twitter e Telegram
8-
- 👥 Suporte a múltiplos agentes e salas
9-
- 📚 Ingestão e interação fácil com seus documentos
10-
- 💾 Memória recuperável e armazenamento de documentos
11-
- 🚀 Altamente extensível - crie suas próprias ações e clientes para estender as capacidades
12-
- ☁️ Suporta muitos modelos, incluindo Llama local, OpenAI, Anthropic, Groq e mais
13-
- 📦 Funciona perfeitamente!
7+
- 🛠️ Conexão completa para Discord, Twitter e Telegram
8+
- 🔗 Suporte para todos os modelos (Llama, Grok, OpenAI, Anthropic, etc.)
9+
- 👥 Suporte para multi-agente e salas
10+
- 📚 Fácil interação com seus documentos
11+
- 💾 Memória recuperável e armazenamento de documentos
12+
- 🚀 Altamente extensível - crie suas próprias ações e clientes
13+
- 📦 Simplesmente funciona!
1414

15-
## Para que posso usá-lo?
15+
## Tutoriais
1616

17-
- 🤖 Chatbots
18-
- 🕵️ Agentes autônomos
19-
- 📈 Gestão de processos empresariais
20-
- 🎮 NPCs em jogos de vídeo
17+
[Escola Dev para Agentes IA (conteúdo em inglês)](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
2118

22-
# Começando
19+
## 🎯 Em que posso usar?
2320

24-
**Pré-requisitos (OBRIGATÓRIO):**
21+
- 🤖 Chatbots
22+
- 🕵️ Agentes autônomos
23+
- 📈 Gestão de processos empresariais
24+
- 🎮 NPCs para o seus jogos
25+
- 🧠 Trading
2526

26-
- [Python 2.7+](https://www.python.org/downloads/)
27-
- [Node.js 23.3+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
28-
- [pnpm](https://pnpm.io/installation)
27+
## 🚀 Começando
2928

30-
### Edite o arquivo .env
31-
32-
- Copie .env.example para .env e preencha os valores apropriados
33-
- Edite as variáveis de ambiente do TWITTER para adicionar o nome de usuário e senha do seu bot
29+
### Pré-requisitos
3430

35-
### Edite o arquivo de personagem
31+
- [Python 2.7+](https://www.python.org/downloads/)
32+
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
33+
- [pnpm](https://pnpm.io/installation)
3634

37-
- Confira o arquivo `src/core/defaultCharacter.ts` - você pode modificá-lo
38-
- Você também pode carregar personagens com o comando `pnpm start --characters="path/to/your/character.json"` e executar múltiplos bots ao mesmo tempo.
35+
> **Nota para usuários de Windows:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) é obrigatório.
3936
40-
Após configurar o arquivo .env e o arquivo de personagem, você pode iniciar o bot com o seguinte comando:
37+
### Utilizando o Starter (Recomendado)
4138

42-
```
43-
pnpm i
44-
pnpm start
45-
```
46-
47-
# Personalizando Eliza
48-
49-
### Adicionando ações personalizadas
39+
```bash
40+
git clone https://github.com/ai16z/eliza-starter.git
5041

51-
Para evitar conflitos no diretório core, recomendamos adicionar ações personalizadas a um diretório `custom_actions` e depois adicioná-las ao arquivo `elizaConfig.yaml`. Veja o arquivo `elizaConfig.example.yaml` para um exemplo.
42+
cp .env.example .env
5243

53-
## Executando com diferentes modelos
44+
pnpm i && pnpm build && pnpm start
45+
```
5446

55-
### Executar com Llama
47+
Leia a [Documentação](https://ai16z.github.io/eliza/) para aprender como customizar a sua Eliza.
5648

57-
Você pode executar modelos Llama 70B ou 405B configurando a variável de ambiente `XAI_MODEL` para `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` ou `meta-llama/Meta-Llama-3.1-405B-Instruct`
49+
### Executando Eliza manualmente (Recomendado apenas se você souber o que está fazendo)
5850

59-
### Executar com Grok
51+
```bash
52+
# Clone o repositório
53+
git clone https://github.com/ai16z/eliza.git
6054

61-
Você pode executar modelos Grok configurando a variável de ambiente `XAI_MODEL` para `grok-beta`
55+
# Dê checkout no último release
56+
# O projeto está em constante e rápido desenvolvimento, então recomendamos que você cheque o último release
57+
git checkout $(git describe --tags --abbrev=0)
58+
```
6259

63-
### Executar com OpenAI
60+
### Execute Eliza com Gitpod
6461

65-
Você pode executar modelos OpenAI configurando a variável de ambiente `XAI_MODEL` para `gpt-4o-mini` ou `gpt-4o`
62+
[![Abrindo no Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ai16z/eliza/tree/main)
6663

67-
## Requisitos Adicionais
64+
### Edite o arquivo .env
6865

69-
Pode ser necessário instalar o Sharp. Se você encontrar um erro ao iniciar, tente instalá-lo com o seguinte comando:
66+
Copie .env.example para .env e preencha os valores apropriados.
7067

7168
```
72-
pnpm install --include=optional sharp
73-
```
74-
75-
# Configuração do Ambiente
76-
77-
Você precisará adicionar variáveis de ambiente ao seu arquivo .env para se conectar a várias plataformas:
78-
69+
cp .env.example .env
7970
```
80-
# Variáveis de ambiente obrigatórias
81-
DISCORD_APPLICATION_ID=
82-
DISCORD_API_TOKEN= # Token do bot
83-
OPENAI_API_KEY=sk-* # Chave API do OpenAI, começando com sk-
84-
ELEVENLABS_XI_API_KEY= # Chave API do elevenlabs
85-
GOOGLE_GENERATIVE_AI_API_KEY= # Chave API do Gemini
86-
87-
# CONFIGURAÇÕES DO ELEVENLABS
88-
ELEVENLABS_MODEL_ID=eleven_multilingual_v2
89-
ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM
90-
ELEVENLABS_VOICE_STABILITY=0.5
91-
ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9
92-
ELEVENLABS_VOICE_STYLE=0.66
93-
ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false
94-
ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4
95-
ELEVENLABS_OUTPUT_FORMAT=pcm_16000
96-
97-
TWITTER_DRY_RUN=false
98-
TWITTER_USERNAME= # Nome de usuário da conta
99-
TWITTER_PASSWORD= # Senha da conta
100-
TWITTER_EMAIL= # Email da conta
101-
TWITTER_COOKIES= # Cookies da conta
102-
103-
X_SERVER_URL=
104-
XAI_API_KEY=
105-
XAI_MODEL=
10671

72+
Nota: .env é opcional. Se você estiver planejando rodar múltiplos agentes distintos, você pode passar segredos pelo JSON do personagem
10773

108-
# Para perguntar coisas ao Claude
109-
ANTHROPIC_API_KEY=
74+
### Execute Eliza automaticamente
11075

111-
# EVM
112-
EVM_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
76+
Isso vai executar tudo que é necessário para configurar o projeto e começar o bot com o personagem padrão.
11377

114-
# Solana
115-
SOLANA_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
116-
SOLANA_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
78+
```bash
79+
sh scripts/start.sh
80+
```
11781

118-
# Fallback Wallet Configuration (deprecated)
119-
WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
120-
WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
82+
### Edite o arquivo do personagem
12183

122-
BIRDEYE_API_KEY=
84+
1. Abra `packages/core/src/defaultCharacter.ts` para modificar o personagem padrão. Descomente e edite.
12385

124-
SOL_ADDRESS=So11111111111111111111111111111111111111112
125-
SLIPPAGE=1
126-
RPC_URL=https://api.mainnet-beta.solana.com
127-
HELIUS_API_KEY=
86+
2. Para carregar personsagens customizáveis:
87+
- Use `pnpm start --characters="path/to/your/character.json"`
88+
- Múltiplos arquivos de personagem podem ser usados de forma simultânea
89+
3. Conectando com o X (Twitter)
90+
- mude `"clients": []` para `"clients": ["twitter"]` no arquivo do personagem para conectar com o X
12891

92+
### Executando Eliza manualmente
12993

130-
## Telegram
131-
TELEGRAM_BOT_TOKEN=
94+
```bash
95+
pnpm i
96+
pnpm build
97+
pnpm start
13298

133-
TOGETHER_API_KEY=
99+
# O projeto está iterando bem rápido. Se você estiver voltando depois de um tempo, talvez precise fazer uma limpeza
100+
pnpm clean
134101
```
135102

136-
# Configuração de Inferência Local
103+
#### Requerimentos adicionais
137104

138-
### Configuração CUDA
139-
140-
Se você tiver uma GPU NVIDIA, pode instalar o CUDA para acelerar dramaticamente a inferência local.
105+
Talvez você precise instalar o Sharp. Se na hora de começar estiver apresentando algum erro, tente instalar com o seguinte comando:
141106

142107
```
143-
pnpm install
144-
npx --no node-llama-cpp source download --gpu cuda
108+
pnpm install --include=optional sharp
145109
```
146110

147-
Certifique-se de ter instalado o CUDA Toolkit, incluindo cuDNN e cuBLAS.
148-
149-
### Executando localmente
150-
151-
Adicione XAI_MODEL e configure-o para uma das opções acima de [Executar com Llama](#executar-com-llama) - você pode deixar X_SERVER_URL e XAI_API_KEY em branco, ele baixa o modelo do huggingface e faz consultas localmente
152-
153-
# Clientes
111+
### Comunidade & contato
154112

155-
## Bot do Discord
113+
- [GitHub Issues](https://github.com/ai16z/eliza/issues). Melhor utilizado para: bugs que você encontrar utilizando a Eliza, e propostas de features.
114+
- [Discord](https://discord.gg/ai16z). Melhor para: compartilhar seus apps e se conectar com a comunidade.
156115

157-
Para ajuda com a configuração do seu Bot do Discord, confira aqui: https://discordjs.guide/preparations/setting-up-a-bot-application.html
158-
159-
# Desenvolvimento
160-
161-
## Testes
162-
163-
Para executar a suíte de testes:
164-
165-
```bash
166-
pnpm test # Executar testes uma vez
167-
pnpm test:watch # Executar testes no modo watch
168-
```
169-
170-
Para testes específicos de banco de dados:
171-
172-
```bash
173-
pnpm test:sqlite # Executar testes com SQLite
174-
pnpm test:sqljs # Executar testes com SQL.js
175-
```
116+
## Contribuidores
176117

177-
Os testes são escritos usando Jest e podem ser encontrados em arquivos `src/**/*.test.ts`. O ambiente de teste está configurado para:
118+
<a href="https://github.com/ai16z/eliza/graphs/contributors">
119+
<img src="https://contrib.rocks/image?repo=ai16z/eliza" />
120+
</a>
178121

179-
- Carregar variáveis de ambiente de `.env.test`
180-
- Usar um tempo limite de 2 minutos para testes de longa duração
181-
- Suportar módulos ESM
182-
- Executar testes em sequência (--runInBand)
122+
## Histórico de estrelas
183123

184-
Para criar novos testes, adicione um arquivo `.test.ts` adjacente ao código que você está testando.
124+
[![Gráfico do histórico de estrelas](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)

0 commit comments

Comments
 (0)