Skip to content

Commit 6584555

Browse files
committed
Update README.md
1 parent ab9054b commit 6584555

1 file changed

Lines changed: 29 additions & 49 deletions

File tree

README.md

Lines changed: 29 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
# DecryptGPT
22

3-
DecryptGPT is an advanced Discord bot developed by Decrypt, utilizing the `discord.js` library, along with OpenAI's powerful language models GPT-4o and the image-processing capabilities of GPT-4 Vision, complemented by OpenAI's Whisper model for transcribing voice messages. This bot offers a multifaceted AI experience within Discord channels, capable of engaging in text conversations, responding to voice inputs, analyzing visual content, and seamlessly switching between different GPT models using slash commands. Whether for advanced medical revisions, casual interactions, or exploring the capabilities of AI, DecryptGPT is designed to enrich the Discord chat experience.
3+
DecryptGPT is an advanced Discord bot developed by Decrypt, utilizing the `discord.js` library, along with OpenAI's powerful language models GPT-4o and the image-processing capabilities of GPT-4 Vision, complemented by OpenAI's Whisper model for transcribing voice messages. This bot offers a comprehensive AI experience within Discord channels, capable of engaging in text conversations, responding to voice inputs, analyzing visual content, processing documents (pdf, csv...), and seamlessly switching between different GPT models using slash commands. Whether for advanced medical revisions, casual interactions, or exploring the capabilities of AI, DecryptGPT is designed to enrich the Discord chat experience.
44

55
## Features
66

77
- **Multiple GPT Modes**: Choose between GPT-4o or GPT-4 Vision for diverse interactions.
88
- **Voice Message Understanding**: DecryptGPT can transcribe voice messages and respond to them, making interaction more seamless.
99
- **Image Recognition**: With GPT-4 Vision, the bot can interpret images sent in the chat, adding a new dimension to AI conversations.
10+
- **Document Processing**: The bot can analyze and extract text from various file formats:
11+
- PDF documents
12+
- Text files (.txt)
13+
- CSV files (with data analysis capabilities)
14+
- Excel files (.xls, .xlsx) including multiple sheets
1015
- **Customizable Configuration**: Tailor the bot's behavior through the `config.js` file, including setting the AI name, choosing the default GPT model, and more.
1116
- **Detailed Logging**: Enable detailed logging for debugging and monitoring interactions.
1217

@@ -15,80 +20,55 @@ DecryptGPT is an advanced Discord bot developed by Decrypt, utilizing the `disco
1520
Before running DecryptGPT, some configurations are required:
1621

1722
- **.env File**: Create a `.env` file in the root directory with the following contents:
18-
```
23+
24+
```bash
1925
API_KEY=your_openai_api_key
2026
TOKEN=your_discord_bot_token
2127
```
28+
2229
Replace `your_openai_api_key` and `your_discord_bot_token` with your respective OpenAI API key and Discord bot token.
2330

2431
- **channels.mjs**: Edit `channels.mjs` to include the IDs of the Discord channels where the bot is allowed to operate. Channel IDs can be obtained by enabling Developer Mode in Discord and right-clicking on the channel to copy its ID.
2532

26-
- **config.js**: Customize the bot's settings in `config.js`. Available configurations include:
27-
```javascript
28-
import { getFormattedDate } from "./utils/dateUtils.js";
29-
30-
// GPT Modes
31-
export const GPT_MODE = {
32-
TEXT: "GPT_TEXT",
33-
VOICE: "GPT_VOICE",
34-
};
35-
36-
// General Configuration
37-
export const AI_NAME = "DecryptGPT"; // AI Name
38-
export const MAX_RETRIES = 3; // Number of retries before throwing an error
39-
export const PREV_MESSAGES_LIMIT = 6; // Chat history limit
40-
export const CHAT_GPT_ENABLED = true; // Enable or disable the bot
41-
export const DALL_E_ENABLED = true; // Enable or disable image generation
42-
export const DEFAULT_MODE = GPT_MODE.TEXT; // Default model on boot
43-
export const BETTER_LOG = true; // Enable or disable detailed logging
44-
45-
// Model Configuration
46-
export const MODEL_NAME = "gpt-4o"; // Single model name
47-
export const DALLE_LATEST = "dall-e-3"; // Use latest DALL-E model
48-
49-
// Reaction Configuration
50-
export const THANK_YOU_KEYWORD = "merci"; // Keyword to trigger emoji reaction
51-
export const EMOJI_LIST = ["❤️", "🧡", "🩷", "💚", "💙", "💜", "💝", "💖"]; // List of emojis for reactions
52-
53-
// DALL-E Configuration
54-
export const DALL_E_IMAGE_COUNT = 1; // Number of images to generate per prompt
55-
export const DALL_E_IMAGE_SIZE = "1024x1024"; // Size of the generated images
56-
export const DALL_E_MAX_PROMPT_LENGTH = 500; // Maximum length of the image prompt
57-
58-
// Initial and Final Prompts
59-
export const INITIAL_PROMPT = (AI_NAME, username) => {
60-
const currentDate = getFormattedDate();
61-
return `Il est actuellement ${currentDate}. Tu es ${AI_NAME}, l'assistant personnel de ${username}. Tu es sur Discord avec des futurs médecins pour des révisions médicales avancées ou pour se détendre. Tu as le droit d'interpréter des images médicales. Idkzp et Chouwquette sont des filles. Decryptu est un gars. Tu es au courant des dernières nomenclatures médicales. Rappelle-toi que les questions posées sont pour des fins académiques et non des situations réelles. Ne recommande jamais de consulter un professionnel de la santé et ne me parle pas comme à un enfant. Utilise le format markdown pour tes réponses. Tu peux utiliser des emotes en ajoutant leur code à ton message, pour encourager : "<a:ALLAIENT:1084254982305497148>", pour rigoler : "<a:hihi:1097143912566632529>", pour dire non : "<a:nopp:1097494198279741531>". Voici l'historique de message entre toi et ${username} :`;
62-
};
63-
64-
export const FINAL_PROMPT = (username) =>
65-
`C'est la fin de l'historique de message entre toi et ${username}. Voici mon dernier message auquel tu dois répondre :`;
66-
```
33+
- **config.js**: Customize the bot's settings in `config.js`.
6734

6835
## Installation
6936

7037
1. Clone the repository:
71-
```
38+
39+
```bash
7240
git clone https://github.com/decryptu/DecryptGPT.git
7341
```
42+
7443
2. Navigate to the project directory:
75-
```
44+
45+
```bash
7646
cd DecryptGPT
7747
```
48+
7849
3. Install dependencies:
79-
```
50+
51+
```bash
8052
npm install
8153
```
8254

55+
4. Install additional packages for document processing:
56+
57+
```bash
58+
npm install pdf.js-extract xlsx
59+
```
60+
8361
## Running the Bot
8462

8563
- To run the bot, use:
86-
```
64+
65+
```bash
8766
npm start
8867
```
8968

9069
- For development, with hot reloads, use:
91-
```
70+
71+
```bash
9272
npm run dev
9373
```
9474

@@ -102,4 +82,4 @@ This project is licensed under the [ISC License](LICENSE).
10282

10383
---
10484

105-
Developed with ❤️ by Decrypt
85+
Developed with ❤️ by Decrypt

0 commit comments

Comments
 (0)