You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We use pnpm to manage our dependencies. It is faster and more efficient than npm, and it supports workspaces.
27
-
https://pnpm.io/installation
28
-
29
-
## Edit the .env file
25
+
### Edit the .env file
30
26
31
27
- Copy .env.example to .env and fill in the appropriate values
32
28
- Edit the TWITTER environment variables to add your bot's username and password
33
29
34
-
## Edit the character file
30
+
###Edit the character file
35
31
36
32
- Check out the file `src/core/defaultCharacter.ts` - you can modify this
37
-
- You can also load characters with the `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json"` and run multiple bots at the same time.
33
+
- You can also load characters with the `pnpm start --characters="path/to/your/character.json"` and run multiple bots at the same time.
34
+
35
+
After setting up the .env file and character file, you can start the bot with the following command:
36
+
37
+
```
38
+
pnpm i
39
+
pnpm start
40
+
```
41
+
42
+
# Customising Eliza
43
+
44
+
### Adding custom actions
45
+
46
+
To avoid git clashes in the core directory, we recommend adding custom actions to a `custom_actions` directory and then adding them to the `elizaConfig.yaml` file. See the `elizaConfig.example.yaml` file for an example.
47
+
48
+
## Running with different models
38
49
39
50
### Run with Llama
40
51
@@ -48,10 +59,6 @@ You can run Grok models by setting the `XAI_MODEL` environment variable to `grok
48
59
49
60
You can run OpenAI models by setting the `XAI_MODEL` environment variable to `gpt-4o-mini` or `gpt-4o`
50
61
51
-
# Requires Node 20+
52
-
53
-
If you are getting strange issues when starting up, make sure you're using Node 20+. Some APIs are not compatible with previous versions. You can check your node version with `node -v`. If you need to install a new version of node, we recommend using [nvm](https://github.com/nvm-sh/nvm).
54
-
55
62
## Additional Requirements
56
63
57
64
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
@@ -66,20 +73,55 @@ You will need to add environment variables to your .env file to connect to vario
66
73
67
74
```
68
75
# Required environment variables
69
-
# Start Discord
70
76
DISCORD_APPLICATION_ID=
71
77
DISCORD_API_TOKEN= # Bot token
78
+
OPENAI_API_KEY=sk-* # OpenAI API key, starting with sk-
0 commit comments