/chatgpt-bot

A discord bot powered by the OpenAI chatGPT model.

Primary LanguagePythonMIT LicenseMIT

Chatgpt Bot · GitHub license Test Action

Installation

The first step will be to clone the repo

git clone https://github.com/rmenai/chatGPT-bot.git

For development

The requirements are:

  1. Install the dependencies
    poetry install

For production

Using Docker is generally recommended (but not strictly required) because it abstracts away some additional set up work.

The requirements for Docker are:

  • Docker CE
  • Docker Compose
    • pip install docker-compose
    • This is only a required step for linux. Docker comes bundled with docker-compose on Mac OS and Windows.

Environment Variables

To run this project, you will need to add the following environment variables.

Variable Description Default
BOT_NAME The name of the bot "Bot"
BOT_TOKEN The token of the bot * Required
CHANNEL_DEVLOG The devlog channel id 0
DEBUG Toggles debug mode False
DEV_GUILD_IDS The dev servers of the bot []
GUILD_IDS The servers of the bot * Required
ROLE_ADMIN The admin role name "Admin"
ROLE_EVERYONE The everyone role name "@everyone"

Usage

Now you are done! You can run the project using

poetry run task start

or test the project using

poetry run task test

License

Distributed under the MIT License. See LICENSE for more information.