Skip to content

Commit

Permalink
Merge pull request #5 from elizaintern/docs/README
Browse files Browse the repository at this point in the history
More quick start instructions
  • Loading branch information
lalalune authored Nov 27, 2024
2 parents 7933c19 + f7be3ca commit f7e0490
Show file tree
Hide file tree
Showing 2 changed files with 434 additions and 3 deletions.
42 changes: 39 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,50 @@
# Eliza

1. Copy .env
## Edit the character files

Open `agent/src/character.ts` to modify the default character. Uncomment and edit.

### Custom characters

To load custom characters instead:
- Use `pnpm start --characters="path/to/your/character.json"`
- Multiple character files can be loaded simultaneously

### Add clients

```diff
- clients: [],
+ clients: ["twitter", "discord"],
```

## Duplicate the .env.example template

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

Fill out the .env file with your own values.
\* Fill out the .env file with your own values.

### Add login credentials and keys to .env

```diff
-DISCORD_APPLICATION_ID=
-DISCORD_API_TOKEN= # Bot token
+DISCORD_APPLICATION_ID="000000772361146438"
+DISCORD_API_TOKEN="OTk1MTU1NzcyMzYxMT000000.000000.00000000000000000000000000000000"
...
-OPENROUTER_API_KEY=
+OPENROUTER_API_KEY="sk-xx-xx-xxx"
...
-TWITTER_USERNAME= # Account username
-TWITTER_PASSWORD= # Account password
-TWITTER_EMAIL= # Account email
+TWITTER_USERNAME="username"
+TWITTER_PASSWORD="password"
+TWITTER_EMAIL="[email protected]"
```

2. Install dependencies
## Install dependencies and start your agent

```bash
pnpm i && pnpm start
Expand Down
Loading

0 comments on commit f7e0490

Please sign in to comment.