Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/johndotpub/discordianai

A ChatGPT based Discord bot that uses OpenAI models to provide chat-based interactions with users in Discord channels and via DMs.
https://github.com/johndotpub/discordianai

bots chatgpt discord openai python

Last synced: 23 days ago
JSON representation

A ChatGPT based Discord bot that uses OpenAI models to provide chat-based interactions with users in Discord channels and via DMs.

Awesome Lists containing this project

README 

        
[![Flake8 and Pytest](https://github.com/johndotpub/DiscordianAI/actions/workflows/flake8-pytest.yml/badge.svg?branch=main)](https://github.com/johndotpub/DiscordianAI/actions/workflows/flake8-pytest.yml) [![CodeQL](https://github.com/johndotpub/DiscordianAI/actions/workflows/github-code-scanning/codeql/badge.svg?branch=main)](https://github.com/johndotpub/DiscordianAI/actions/workflows/github-code-scanning/codeql) [![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](http://unlicense.org/)



# Description



This is a Python script for a Discord bot that uses either OpenAI's GPT API, or any compatible API such as Perplexity to generate responses to user messages. The bot can be configured to listen to specific channels and respond to direct messages. The bot also has a rate limit to prevent spamming and can maintain a per user conversational history to improve response quality which is only limited by the `GPT_TOKENS` value.



# Requirements



- Bash

- Python 3.12 or Higher

- Python Modules

  - discord.py

  - openai



### Features



- Strict error checking: The control script exits on any error and recognizes failures in pipelines.

- Customizable configurations: The control script allows for different modes of operation and configurations.

- Error Handling: The control script logs errors and exits on failure.

- Process Handling: The control script terminates existing instances of the bot before starting a new one.

- Logging: The app logs events with timestamps for better tracking.

- Rate Limiting: Implements rate limiting to prevent users from spamming commands.

- Conversation History: Maintains conversation history for each user to provide context-aware responses.

- Activity Status: Configurable activity status to display what the bot is doing.

- Direct Message Handling: Processes direct messages separately from channel messages.

- Channel Message Handling: Processes messages in specific channels where the bot is mentioned.

- Automatic Message Splitting: Automatically splits long messages to fit within Discord's message length limits.

- Global Exception Handling: Catches and logs unhandled exceptions to prevent crashes.

- Shard Support: Supports sharding for better scalability and performance.



# Installation



1. Clone the repository to your local machine.

2. Install the required packages using pip: `pip install -r requirements.txt`

3. Rename `config.ini.example` to `config.ini` and fill in the required configuration details.



# Configuration



The `config.ini` file contains the following configuration sections:



### Discord



- `DISCORD_TOKEN`: The Discord bot token.

- `ALLOWED_CHANNELS`: A comma-separated list of channel names that the bot is allowed to listen to.

- `BOT_PRESENCE`: The presence of the bot (e.g. online, offline, idle).

- `ACTIVITY_TYPE`: The type of activity for the bot (e.g. playing, streaming, listening, watching, custom, competing).

- `ACTIVITY_STATUS`: The activity status of the bot (e.g. Humans).



### Default Configs



- `API_URL`: The backend API URL. (default: `https://api.openai.com/v1/`)

- `API_KEY`: The API key for your backend. (default: `None`)

- `GPT_MODEL`: The GPT model to use (default: `gpt-4o-mini`)

- `INPUT_TOKENS`: Your response input size. (default: `120000`)

- `OUTPUT_TOKENS`: The maximum number of tokens to generate in the GPT response (default: `8000`)

- `CONTEXT_WINDOW`: The maximum number of tokens to keep in the context window. (default: `128000`)

- `SYSTEM_MESSAGE`: The message to send to the GPT model before the user's message.



### Limits



- `RATE_LIMIT`: The number of messages a user can send within `RATE_LIMIT_PER` seconds (default: `2`).

- `RATE_LIMIT_PER`: The time period in seconds for the rate limit (default: `10`).



### Logging



- `LOG_FILE`: The path to the log file (default: bot.log).



Here is an example `config.ini` file:



```ini

[Discord]

DISCORD_TOKEN = 

ALLOWED_CHANNELS = , , ...

BOT_PRESENCE = online

# ACTIVITY_TYPE Options

# playing, streaming, listening, watching, custom, competing

ACTIVITY_TYPE=listening

ACTIVITY_STATUS=Humans



[Default]

API_URL=https://api.openai.com/v1/

API_KEY = 

GPT_MODEL=gpt-4o-mini

INPUT_TOKENS=120000

OUTPUT_TOKENS=8000

CONTEXT_WINDOW=128000

SYSTEM_MESSAGE = You are a helpful AI assistant.



[Limits]

RATE_LIMIT = 2

RATE_LIMIT_PER = 10



[Logging]

LOG_FILE = bot.log

```



# Discord Bot Setup



To use this bot, you will need to create a Discord bot and invite it to your server. Here are the steps to do so:



1. Go to the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application.

2. Click on the "Bot" tab and then click "Add Bot".

3. Copy the bot token and paste it into the `DISCORD_TOKEN` field in the `config.ini` file.

4. Under the "OAuth2" tab, select the "bot" scope and then select the permissions you want the bot to have.

5. Copy the generated OAuth2 URL and paste it into your web browser. This will allow you to invite the bot to your server.



# Usage



To start the bot, run the following command:



```bash

python bot.py --conf config.ini

```



The bot will log in to Discord and start listening for messages in the configured channels. When a message is received, the bot will send the message to the OpenAI API and wait for a response. The response will be sent back to the user who sent the message.



# Run in container



To run the bot in a container, you will need to check out this repository, rename the `config.ini.example` to `config.ini` and fill it in appropriately.

Then, run the following commands:



```bash

docker build . -t discordianai:latest

docker run --restart always -v $(pwd)/config.ini:/app/config.ini discordianai:latest

```

This will execute forever, unless manually stopped. The `-v` option is used to mount the `config.ini` file from your current directory on the host machine to the `/app/config.ini` file in the Docker container. Replace `$(pwd)/config.ini` with the actual path to your `config.ini` file if it’s not in your current directory. Remember to include the trailing slash in the path. This ensures that Docker treats this as a file and not as a directory.



# Daemon Control Script



`discordian.sh` is a bash script for launching a DiscordianAI bot with customizable configurations. It is suitable for both manual execution and running via crontab.



### Usage



The script accepts the following command line arguments:



- `-d` or `--daemon`: Runs the bot in daemon mode with no output to the terminal.

- `-c` or `--config`: Allows the use of a custom configuration file. The next argument should be the path to the configuration file.

- `-f` or `--folder`: Allows the use of a base folder. The next argument should be the path to the base folder.



### Daemon Example



```bash

./discordian.sh -d -c /path/to/config.ini -f /path/to/base/folder

```



This command will run the bot in daemon mode, using the configuration file at `/path/to/config.ini` and the base folder at `/path/to/base/folder`.



# Contributing



Contributions are welcome! Please open an issue or pull request on the GitHub repository.



# Contact



If you have any questions or concerns, please contact [email protected]



# License



This project is licensed under the Unlicense - see the [LICENSE](LICENSE) file for details.