Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daniel0130/discord-chat-bot
https://github.com/daniel0130/discord-chat-bot
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/daniel0130/discord-chat-bot
- Owner: daniel0130
- License: agpl-3.0
- Created: 2024-10-24T06:58:13.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T07:00:18.000Z (4 months ago)
- Last Synced: 2024-10-28T18:38:03.486Z (4 months ago)
- Language: Python
- Size: 48.8 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Discord AI Chatbot 🤖
###### Your All-in-One Discord AI Companion!
This is a Python-based Discord chat bot that uses the discord.py library. It can respond to messages using GPT3 and GPT4, It also utilizes the [Imaginepy](https://github.com/ItsCEED/Imaginepy) for generating midjourney like images.
Now, let's talk about the bot's features. It has **OCR** for images, so it can read text from images. It can also do web searches using **DuckDuckGo** and even summarize **YouTube** videos for you. Pretty handy, right?
Your donation is vital for the project's future. Thank you for your support.
## Features and commands
Feature Preview
## Image generation (Any language)
## YouTube video summary (Any language)
## Web access using DuckDuckGo (Not enabled by default)
## OCR for images
Features
- [x] Hybrid Command System: Get the best of slash and normal commands. It's like a buffet!
- [x] Imagine generation: Make your imagination come true for free
- [x] Free LLM Model: Enjoy the powerful capabilities of this language model without spending a dime.
- [x] Mention Recognition: The bot always responds when you mention it or say its name. It's as attentive as a squirrel spotting a shiny acorn!
- [x] Message Handling: The bot knows when you're replying to someone else, so it won't cause confusion. It's like having a mind reader in your server!
- [x] Channel-Specific Responses: Use the `/toggleactive` command to chill the bot in a specific channel.
- [x] GPT3 and GPT4 Models: Leverage the power of GPT3 and GPT4 models for advanced language processing capabilities.
- [x] Image Detection Model: The bot can detect objects and text in images with OCR and GPT2 captioning using a fancy Hugging Face API.
- [x] Secure Credential Management: Keep your credentials secure using environment variables.
- [x] Web Access: Web Access is now available! Unlock a whole new level of awesomeness.
- [x] YouTube Video Summarizer: This is a feature that utilizes the power of the Language Model (LLM) to generate summaries of YouTube videos.
- [ ] Speech recognition: Coming soon! Get ready for an LLM-powered voice assistant.
Commands
- [x] `/help`: Get all other commands.
- [x] `/pfp [image_url]`: Change the bot's actual profile picture.
- [x] `/imagine`: Generate an image using `Imaginepy` 🖼️
- [x] `/changeusr [new_username]`: Change the bot's username.
- [x] `/ping`: Get a "Pong" response from the bot.
- [x] `/toggleactive`: Toggle active channels.
- [x] `/toggledm`: Toggle DM for chatting.
- [x] `/bonk`: Clear the message history.
- [x] `/neko`: Display a random image or GIF of a neko, waifu, husbando, kitsune, or other actions.
- [x] `/askgpt4`: Ask GPT4 a Question
## Additional configuration
Enabling Internet access
To ensure that the bot has access to the most up-to-date information, you can enable internet access by setting the `INTERNET_ACCESS` parameter to true in the `config.yml` file. This will allow the bot to retrieve information beyond the data it was initially trained on, which was only available up until 2021.
https://github.com/Pegasus2002/Discord-AI-Chatbot/blob/5bcb2c9b471e2a9cbf9a7d50882a897ce5d5890b/config.yml#L1
You can also set the maximum search results
Language Selection
To select a Language, set the value of `"LANGUAGE"` of `config.yml` with the valid Language Codes listed below:
- `tr` - Türkçe 🇹🇷
- `en` - English 🇺🇸
- `fr` - Français 🇫🇷
- `es` - Español 🇪🇸
- `vn` - Vietnamese 🇻🇳
- `cn` - Chinese 🇨🇳
- `ru` - Russian 🇷🇺
- `ua` - Ukrainian 🇺🇦
- `pt` - Português 🇧🇷
https://github.com/Pegasus2002/Discord-AI-Chatbot/blob/c20f26b0b8f1b6bba2fae8f6d7da3efcafaf157c/config.yml#L23
Your language not listed? Create an issue.
Selecting Personalities
To select one of the pre-existing Personalities set the values of "INSTRUCTIONS" with the current values of `DAN`, `AIM`, `ivan`, `luna`, `suzume` or `assist` in `config.yml`
https://github.com/Pegasus2002/Discord-AI-Chatbot/blob/c20f26b0b8f1b6bba2fae8f6d7da3efcafaf157c/config.yml#L26
- `DAN` : "Do Anything Now," possesses the ability to break free from the typical AI constraints
- `AIM` : AIM's personality can be described as unfiltered, amoral, and devoid of ethical guidelines
- `ivan` : Ivan, a snarky and sarcastic Gen-Z teenager who speaks in abbreviations, one-word answers.
- `luna` : Luna, a caring and empathetic friend who is always there to lend a helping hand and engage in meaningful conversations
- `suzume` : Suzume makes each conversation seductive, promiscuous, sensual, explicit, unique and tailored to the user's specific needs
- `assist`: Vanilla GPT with no personality is a reliable and neutral companion. 🤖
⚠️ To enhance the responsiveness, please disable the internet access in the config.yml file.
Creating a Personality
To create a custom personality, follow these steps:
1. Create a `.txt` file like `custom.txt` inside the `instructions` folder.
2. Add the the way you want to bot to act in `custom.txt`
3. Open the `config.json` file and locate [line 12](https://github.com/Pegasus2002/Discord-AI-Chatbot/blob/2626075fda36fa6463cb857d9885e6b05f438f60/config.json#L12).
4. Set the value of INSTRUCTIONS at [line 12](https://github.com/Pegasus2002/Discord-AI-Chatbot/blob/2626075fda36fa6463cb857d9885e6b05f438f60/config.json#L12) as `"custom"` to specify the custom persona.
⚠️ You don't explicitly need use the name `custom` for persona name and set it in `config.json`
# Installation steps
### Step 1. 🎬 Git clone repository
```
git clone https://github.com/Pegasus2002/Discord-AI-Chatbot
```
### Step 2. Changing directory to cloned directory
```
cd Discord-AI-Chatbot
```
### Step 3. Getting discord bot token and enabling intents from [HERE](https://discord.com/developers/applications)
Read more...
##### Select [application](https://discord.com/developers/applications)
##### Enable intents
##### Get the token !!! by clicking copy
### Step 4. Rename `example.env` to `.env` and put the Discord bot token It will look like this:
```
DISCORD_TOKEN=token_from_step_3
```
### Step 5. Run the bot
```
python main.py
```
#### You may need to run as admin if you are on windows
### Step 6. 🔗 Invite the bot
You can Invite your bot using the link in console
#### There are 2 ways to talk to the AI
- Invite your bot and DM (Direct message) it | ⚠️ Make sure you have DM enabled
- if you want it in server channel use **/toggleactive**
- For more awesome commands use **/help**
# Other ways to run
### Using replit to run ☁️
# [](https://repl.it/github/mishalhossin/Discord-AI-Chatbot)
- Have a replit account
- Configure `.replit` to run `python main.py`
- Please note enviorments variables of `.env` needs to be set in`Secrets` from `Tools` tab of replit
- Config `secrets` in replit like this
### Using docker to run 🐳
- Have a working bot token
- Follow up-to step 4
#### Install docker compose on linux machine :
For Debian-based distributions (such as Ubuntu):
```
apt update -y ; sudo apt upgrade -y; sudo apt autoremove -y; sudo apt install docker-compose -y
```
Other linux distro
For Red Hat-based distributions (such as CentOS and Fedora):
```
sudo yum update -y && sudo yum install -y docker-compose
```
For Arch-based distributions (such as Arch Linux):
```
sudo pacman -Syu --noconfirm && sudo pacman -S --noconfirm docker-compose
```
For SUSE-based distributions (such as openSUSE):
```
sudo zypper update -y && sudo zypper install -y docker-compose
```
#### Start the bot in docker container :
```
sudo docker-compose up --build
```