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
Copy file name to clipboardExpand all lines: README.md
+6-11Lines changed: 6 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ Training will also take a while, especially if you've given it a lot of data. Fo
46
46
47
47
### Bucket will want to say slurs after a while. There's a filter in place which should block most if not all of them, and a well crafted system prompt will prevent some as well. We will need a better solution for "ignoring" them from OpenAI's data.
48
48
49
-
1. Rename `config.sample.json` to `config.json`, and get ready to enter a lot of settings:
49
+
1. Rename `frontend/config.sample.json` to `config.json`, and get ready to enter a lot of settings:
50
50
51
51
- discordToken: your discord api key you got from the developer's portal
52
52
- allowedChannelId: the channel you want the bot to look at for pings (can be a thread)
@@ -72,6 +72,8 @@ Training will also take a while, especially if you've given it a lot of data. Fo
72
72
73
73
- systemPrompt: your system prompt that the ai will use
74
74
75
+
- allowedUserTag: a discord user id for a user who can use the bot in any channel
76
+
75
77
> **A note on system prompts**
76
78
>
77
79
> While you're in `config.json`, you need to add a system prompt. This sets the guidelines and "boundaries" that the AI *mostly* follows. You can use the same system prompt that was used in `jsoncleaner.py`, but now would be the best time to mess around and see what gives you the best results.
@@ -82,18 +84,11 @@ Training will also take a while, especially if you've given it a lot of data. Fo
82
84
83
85
2. Open a terminal/command prompt in the `bot` folder, then run `npm install` to grab all the dependencies
84
86
85
-
3. Once that's done, run `node bucket2.mjs` or just `node .` to start the bot
86
-
87
-
Bucket will log responses, and who triggered the bot in the `/bot/logs/` folder.
87
+
3. Once that's done, run `npm install`, then `npm start` to run the bot
88
88
89
-
## Frontend
90
-
I'm working on a better frontend for Bucket. If you'd like to test it, go ahead and
91
-
- copy config.json from `bot` to `frontend`
92
-
- open cmd/terminal in the `frontend` folder
93
-
- run `npm install`
94
-
- once that's done, run `npm start`
89
+
After first launch, you will just have to run `npm start` to run the bot from now on
95
90
96
-
Bucket's frontend is experimental, and not finished. Please let me know if there's something I should add to it.
91
+
Bucket will log responses, and who triggered the bot in the `/bot/logs/` folder.
97
92
98
93
## Contributing
99
94
Feel Free! If you want to change something just open a PR.
0 commit comments