Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/02loveslollipop/discordgptchatbot

A Python based Discord chat bot that uses the OpenAI GPT API with a custom role
https://github.com/02loveslollipop/discordgptchatbot

ai chatbot chatgpt discord discord-py gpt-35-turbo python

Last synced: 2 months ago
JSON representation

A Python based Discord chat bot that uses the OpenAI GPT API with a custom role

Host: GitHub
URL: https://github.com/02loveslollipop/discordgptchatbot
Owner: 02loveslollipop
License: mit
Created: 2023-03-13T02:13:48.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-02-12T20:32:55.000Z (12 months ago)
Last Synced: 2024-02-12T21:34:48.781Z (12 months ago)
Topics: ai, chatbot, chatgpt, discord, discord-py, gpt-35-turbo, python
Language: Python
Homepage:
Size: 35.7 MB
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Discord GPT Chat Bot

> A Python based Discord chat bot that uses the OpenAI GPT API with a custom role
>
[![DownloadAMD64](https://img.shields.io/docker/image-size/02loveslollipop/discordgptchatbot/1.0.0amd64?label=AMD64&logo=docker&style=for-the-badge)](https://hub.docker.com/layers/02loveslollipop/discordgptchatbot/1.0.0amd64/images/sha256-c68b237e7b0340fc5eab7a1f016f8de3b650458e38f95e74e2af2638a3897c87)
[![DownloadARM64](https://img.shields.io/docker/image-size/02loveslollipop/discordgptchatbot/1.0.0arm64?label=ARM64&logo=docker&style=for-the-badge)](https://hub.docker.com/layers/02loveslollipop/discordgptchatbot/1.0.0arm64/images/sha256-391617d8318032a290c6ad942fb6819b96146297e61ad09186200958bb17b18c)
[![Replit](https://img.shields.io/badge/Run%20it%20on-Replit-orange?style=for-the-badge&logo=replit)](https://replit.com/@02loveslollipop/DiscordGPTChatBot)

## Intro
OpenAI GPT3.5 model allow to change it behavior using custom training and using system role messages, this repository allows to create a Discord Bot using the GPT 3.5 model with a custom role allowing to change the behavior of the answers of the bot.

## Requirements

1. You must a have a valid OpenAI API key to use it services (Currently using **GPT-3.5-turbo**).
2. You need a valid Discord bot Token.
3. A Python environment to run the repo.
4. If you want to use voice related commands you need FFmpeg on the device that will run the bot

# Quick Setup

Full setup guide available at [Setup guide](https://github.com/02loveslollipop/DiscordGPTChatBot/wiki/Setup-guide)

1. Install Python 3.9 in your device.

2. Clone the repository:

```bash
git clone https://github.com/02loveslollipop/DiscordGPTChatBot.git
```

3. Install FFmpeg on your device, FFmpeg can be install [here](https://ffmpeg.org/)

4. Create a copy of ``example_config.yml`` and rename it as ``config.yml``, then open it and paste your Discord and OpenAI keys and change the role of the chat bot (Full description of [config.yml](https://github.com/02loveslollipop/DiscordGPTChatBot/wiki/Structure-of-config.yml)):

```yaml
bot:
token: "YOUR_DISCORD_KEY" # Paste here the token you got from Discord Developer Portal

open_ai:
token: "YOUR_OPEN_AI_KEY" # Paste here the OpenAI secret key you got from OpenAI platform
role: "You are a helpful assistant." # Change here chatbot's role, this will change it's behavior answering questions
```

5. Install requirements:

```bash
pip -r /path/to/your/repo/requirements.txt
```

6. Run the bot:

```bash
python main.py
```

# Discord Commands
[Full list of commands here](https://github.com/02loveslollipop/DiscordGPTChatBot/wiki/Discord-commands)

# Configuration of config.yml
[Config.yml configuration guide](https://github.com/02loveslollipop/DiscordGPTChatBot/wiki/Structure-of-config.yml)