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
discord-ai is a super smart and versatile AI assistant for Discord communities!
41
+
Discord-AI is a super smart and versatile AI assistant for Discord communities!
42
42
43
-
Its primary objective is to serve the specific needs of the discord-ai Discord community. This version you see here is the open-source adaptation, allowing anyone to benefit from its awesome features!
43
+
Its primary objective is to serve the specific needs of the GPT Engineer Discord community. This version you see here is the open-source adaptation, allowing anyone to benefit from its awesome features!
44
44
45
-
Whether you need information, want to chat, interact with documents, code, explore websites, or enjoy some cool Discord-only features, discord-ai has got your back. It's designed to be user-friendly, customizable, and open source – just the way you like it!
45
+
Whether you need information, want to chat, interact with documents, code, explore websites, or enjoy some cool Discord-only features, Discord-AI has got your back. It's designed to be user-friendly, customizable, and open source – just the way you like it!
46
46
47
-
We're all about community here! Join us in making discord-ai even better. Your ideas and contributions are always welcome.
47
+
We're all about community here! Join us in making our idea even better. Your thoughts and contributions are always welcome.
48
48
49
-
Let's level up your Discord experience with discord-ai, the friendly AI chatbot for everyone! 🤖💬
49
+
Let's level up your Discord experience with Discord-AI, the friendly AI chatbot for everyone! 🤖💬
50
50
51
51
<br>
52
52
53
53
## Prerequisites
54
54
55
55
Before you begin, ensure you have met the following requirements:
1.**Sign up at OpenAI**: Visit the [OpenAI website](https://www.openai.com/) and sign up for an account.
66
-
2.**Obtain your API key**: Click your profile icon and select "**View API keys**" from the dropdown menu. Then, click the "**Create new secret key**" button to generate a new API key.
65
+
1.**Sign up at OpenAI**: Visit the [OpenAI website](https://www.openai.com/) and sign up for an account.
66
+
2.**Obtain your API key**: Click your profile icon and select "**View API keys**" from the dropdown menu. Then, click the "**Create new secret key**" button to generate a new API key.
67
67
68
68
<br>
69
69
70
70
### Pinecone DB
71
71
72
-
1.**Sign up for Pinecone**: Visit the [Pinecone website](https://www.pinecone.io/) and sign up for an account.
73
-
2.**Get your Pinecone API key**: After signing up, navigate to your dashboard and obtain your **Pinecone API key, index, and environment**. Watch this [Video Tutorial](https://youtu.be/dnEfQhjZgw0?t=328) for assistance.
72
+
1.**Sign up for Pinecone**: Visit the [Pinecone website](https://www.pinecone.io/) and sign up for an account.
73
+
2.**Get your Pinecone API key**: After signing up, navigate to your dashboard and obtain your **Pinecone API key, index, and environment**. Watch this [Video Tutorial](https://youtu.be/dnEfQhjZgw0?t=328) for assistance.
74
74
75
75
<br>
76
76
77
77
### MongoDB
78
78
79
-
1.**Sign up for Railway**: Visit the [Railway.app website](https://railway.app/) and sign up for an account.
80
-
2.**Create a new project**: Follow the [official Railway documentation](https://docs.railway.app/getting-started#create-a-project) to create a new project.
81
-
3.**Add MongoDB plugin**: In your Railway project, add the MongoDB plugin by following the [official Railway documentation](https://docs.railway.app/getting-started).
82
-
4.**Get your MongoDB URI**: After adding the MongoDB plugin, navigate to the plugin settings and obtain your **MongoDB URI**. Watch this [Video Tutorial](https://www.youtube.com/watch?v=tp0bQNDtLPc&t=88s) for assistance.
79
+
1.**Sign up for Railway**: Visit the [Railway.app website](https://railway.app/) and sign up for an account.
80
+
2.**Create a new project**: Follow the [official Railway documentation](https://docs.railway.app/getting-started#create-a-project) to create a new project.
81
+
3.**Add MongoDB plugin**: In your Railway project, add the MongoDB plugin by following the [official Railway documentation](https://docs.railway.app/getting-started).
82
+
4.**Get your MongoDB URI**: After adding the MongoDB plugin, navigate to the plugin settings and obtain your **MongoDB URI**. Watch this [Video Tutorial](https://www.youtube.com/watch?v=tp0bQNDtLPc&t=88s) for assistance.
83
83
84
84
<br>
85
85
86
86
## Installation
87
87
88
-
To install discord-ai, follow these steps:
88
+
To install Discord-AI, follow these steps:
89
89
90
90
<br>
91
91
@@ -143,37 +143,35 @@ To install discord-ai, follow these steps:
143
143
144
144
2.`configs\config.json`:
145
145
146
-
- You will be prompted to fill out the required parts of this during setup automatically.
147
-
- You may directly edit this file to change anything as well.
148
-
- If you change something that should be updated with the Discord servers, change `update_bot` to true.
149
-
- You can also edit most of the config values via the bot terminal.
146
+
- You will be prompted to fill out the required parts of this during setup automatically.
147
+
- You may directly edit this file to change anything as well.
148
+
- If you change something that should be updated with the Discord servers, change `update_bot` to true.
149
+
- You can also edit most of the config values via the bot terminal.
150
150
151
151
<br>
152
152
153
153
3.`configs\preprompts`:
154
154
155
-
<br>
156
-
157
-
- This is a small preprompt that is injected before chat interactions.
158
-
- It maintains small details such as the bot's name and personality.
159
-
- You may directly edit this to fit your needs.
155
+
- This is a small preprompt that is injected before chat interactions.
156
+
- It maintains small details such as the bot's name and personality.
157
+
- You may directly edit this to fit your needs.
160
158
161
159
<br>
162
160
163
161
4.`TMUX (Optional)`:
164
162
165
-
- This is used to run the bot like a service in a separate terminal.
166
-
- You can install it by running `sudo apt install tmux` on Linux.
167
-
- Feel free to use other methods of running the bot in the background.
After installation and configuration, the bot will run automatically.
175
-
It uses the GPT model to interact with users in the specified Discord channel.
176
-
Currently, it can ingest ReadTheDocs URLs and provide help using it as context.
172
+
After installation and configuration, the bot will run automatically.<br>
173
+
It uses the GPT model to interact with users in the specified Discord channel.<br>
174
+
Currently, it can ingest ReadTheDocs URLs and provide help using it as context.<br>
177
175
178
176
<br>
179
177
@@ -182,71 +180,75 @@ Here is a step-by-step guide on how to use the bot:
182
180
<br>
183
181
184
182
1.**Channel Setup**:
185
-
- The bot can be set up in any channel of your Discord server. This is an example of a proper setup. Copy the category ID and paste it in the `.env` file.
186
-
- You do not need to have the same names or exact setup. This is just recommended. Just make certain you use the correct channel IDs.
187
183
188
-
184
+
- The bot can be set up in any channel of your Discord server.
185
+
- This is an example of a proper setup. Copy the category ID and paste it in the `.env` file.
186
+
- Yours does not need to be the same. Just make certain you use the correct channel IDs.
187
+
188
+
189
189
190
190
<br>
191
191
192
192
2.**Thread Listing**:
193
-
- This is an example of the thread listing within the threads section that is to be used for generic agent interaction.
194
-
- Copy the thread channel ID and paste it in the `.env` file.
0 commit comments