Skip to content

Latest commit

 

History

History
91 lines (75 loc) · 5.36 KB

README.md

File metadata and controls

91 lines (75 loc) · 5.36 KB
Raw

ChatGPT Discord Bot

A ChatGPT powered Discord chatbot built with NodeJS.

Public Discord

You can join the public Discord to try the bot or communicate with me or other users here: https://discord.gg/wMtMXDVhn2

Features

  • Multiple Personality Support: Add multiple personalities and depending on how you call the bot, it will respond differently.
  • Enable/Disable/Reset commands for admins.
  • Memory: Bot will remember conversations until restarted or reset.
  • Message splitter for longer messages that exceed 2000 characters.
  • Threads support: Bot will auto reply to messages in joined threads.
  • Easily change between configuration files.
  • Token limiter: Ability to limit amount of tokens being used in a span of time (configurable).
  • Conversation history truncator: Cuts down conversation history to save tokens (configurable).

Dependencies

Setup/Installation

  1. Create an OpenAI API Key. Copy the key somewhere for usage later.
  2. Create a Discord Application Bot. You can follow this tutorial. Make sure to enable the "Message Content Intent" under the "Priveralged Gateway Intents" section in the "Bot" tab. Copy the bot token somewhere for usage later.
  3. Invite the bot to your server. You can follow this tutorial.
  4. Install NodeJS for your system. Refer to Google for installation based on OS.
  5. Download Source Code from releases or download this zip for the dev version. Note that while the dev version has the latest features, it has undergone little testing. Bugs should be expected here and there. You can also clone the GitHub repository.
  6. If you downloaded a release or dev zip, extract the zip and open the extracted zip folder in a terminal. If you cloned repo, open the repo directory in a terminal.
  7. Run npm ci to install NPM dependencies.
  8. Copy .env.example to .env and add your bot token and insert your API key and token into .env. Add 1 or more personalities. Change other options to your liking.
    • OPTIONAL You can copy .env.example to other files that end in .env if you want to have multiple different configuration files. See step 10 for how to use custom named *.env files.
  9. Run node deploy-commands.js to deploy the bot's slash commands to discord. See below for additional details.
  10. Finally, run npm start or node index.js to start the bot.
    • You can use npm start NAME.env or node index.js NAME.env to run using a custom named *.env file.
  11. OPTIONAL Install PM2 if you want to keep your bot active. Run pm2 start index.js --watch to start it.

Updating

If you downloaded a zip, download the latest zip (release or dev) and extract it to the bot directory. If you cloned the repo, open the repo directory and run git pull. Update .env if needed. Then restart the bot.

Usage

Once the bot is started, simply send a message containing the personality name you put in the *.env file or reply to a message from the bot and the bot will respond!

Commands

  • /enable: Enables the bot.
  • /disable: Disables the bot.
  • /reset: Resets the memory of all personalities or a single personality. If personality is ephemeral, sets its prompt to undefined.
    • Usage: /reset <personality_name>
  • /personalities: Lists available personalities and their prompts.
  • /add-personality: Adds an ephemeral personality to the bot, it will be lost when the bot restarts. Can also update undefined prompts.
    • Usage: /add-personality <name> <prompt>
  • /token-reset: Resets the current token count.
  • /token-count: Shows the number of total tokens used since the bot was started OR since the first time the bot was used in the month if the bot is on for multiple months.

Deploying Commands

Click to expand To use the deploy/delete script, run `node deploy-commands.js` followed by one or more arguments. The available arguments are:
  • [env] (optional): the name of the .env file to use. If not specified, the script will use .env by default.
  • -d [command] (optional): the name of the command to delete. If specified, the script will delete the command with the given id.
  • -x [file] (optional): the name of a command file(s) to ignore. If specified, the script will not deploy the command(s) with the given file name(s).

To deploy all commands using the default .env file, run:

node deploy-commands.js

To deploy all commands using a custom named *.env file, use:

node deploy-commands.js NAME.env

To delete a command, find its command id, then run:

node deploy-commands.js -d COMMAND_ID

To deploy all commands except the commands in ignore.js and test.js, run:

node deploy-commands.js -x ignore.js,test.js

Contributing

Feel free to fork this repo and submit pull requests for different features, fixes, and changes.