-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from elizaintern/docs/README
More quick start instructions
- Loading branch information
Showing
2 changed files
with
434 additions
and
3 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,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 | ||
|
Oops, something went wrong.