NCLS Bot is an open source Discord bot created to assist you in your daily tasks using the OpenAI GPT-3 model.
Current features of NCLS Bot include:
help
: Displays the list of available commandsgpthelp
: Provides help from the OpenAI GPT-3 modelGpthelp forgetAll
Forgets all the messages before the command was sentping
: Displays the bot's latencyinfo
: Displays information about the botcreatechannel
: Creates a private channel for the user and the bot
The bot also has an automated response module that sends a predefined response when a specific keyword is used in the chat room. To use this feature, you can modify the config.ts
file and add entries to the messagesInResponse array, following the format of the existing entries. The bot will then automatically respond with the message in key-word to the messages in the array as values.
Clone the repository: git clone https://github.com/ncls-p/discord-ncls-bot
go to the project directory: cd discord-ncls-bot
Install dependencies: yarn
Copy the .env.example file to .env: cp .env.example .env
Set up environment variables in the .env
file at the root of the project
Start the bot: yarn start
NCLS Bot uses a configuration stored in a .env file at the root of the project. Here are the required environment variables to make the bot work:
TOKEN
: Your Discord bot tokenPREFIX
: The prefix used for all bot commandsCREATOR
: Your usernameVERSION
: The current version of the botOPENAI_API_KEY
: Your OpenAI API key
Contributions are welcome! Feel free to create an issue or a pull request if you have any suggestions for improvement or new features to add.
This project is licensed under the MIT License. See the LICENSE file for more information.