8.0 KiB
OpenAI Discord
A very simple Discord Bot that integrates the OpenAI library to make use of ChatGPT
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
About The Project
Formally called 'Aurora GPT', it is a very simple Discord chatbot that was built using discord.js and the GPT-3.5-Turbo of OpenAI.
Built With
Packages
Getting Started
Installation
- Get a neccesary API Keys
- Clone the repo
git clone https://github.com/KrozT/openai-discord.git - Install packages
yarn install - Add the API Keys to your environment variables
DISCORD_API_KEY='YOUR DISCORD API KEY' OPENAI_API_KEY='YOUR OPENAI API KEY' - Build project
yarn run build - Start binaries
yarn run start
Usage
Once you have the project initialized just add the chat bot to your server and enjoy.
Commands
| Command | Description |
|---|---|
/ping |
Ping the bot to check if it is online |
/chat |
Chat with the bot |
/clear |
Clear the chat history with the bot |
Roadmap
- Discord Integration
- OpenAI Integration
- Context-based usability
- Single user
- Multiple users
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE for more information.