Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ponderingdemocritus committed Nov 18, 2024
1 parent 232c164 commit aa536f7
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 9 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Copy .env.example to .env and fill in the appropriate values
cp .env.example .env
```

### Start Eliza
### Automatically Start Eliza

This will run everything to setup the project and start the bot with the default character.

Expand All @@ -70,15 +70,13 @@ sh scripts/start.sh

### Edit the character file

1. Open `src/core/defaultCharacter.ts` to modify the default character
1. Open `packages/agent/src/character.ts` to modify the default character. Uncomment and edit.

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

### Start Eliza

After setting up the .env file and character file, you can start the bot with the following command:
### Manually Start Eliza

```bash
pnpm i
Expand Down
3 changes: 2 additions & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@
"tinyld": "1.3.4",
"together-ai": "^0.7.0",
"unique-names-generator": "4.7.1",
"uuid": "11.0.2"
"uuid": "11.0.2",
"zod": "^3.23.8"
}
}
10 changes: 7 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit aa536f7

Please sign in to comment.