[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url]

Logo

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
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgments
## 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.

(back to top)

### Built With * [![TypeScript][TypeScript-shield]][TypeScript-url] ### Packages - [discord.js](https://github.com/discordjs/discord.js) - [winston](https://github.com/winstonjs/winston) - [openai-node](https://github.com/openai/openai-node)

(back to top)

## Getting Started ### Installation 1. Get a neccesary API Keys - [OpenAI](https://platform.openai.com/account/api-keys) - [Discord](https://platform.openai.com/account/api-keys)
2. Clone the repo ```sh git clone https://github.com/KrozT/openai-discord.git ``` 3. Install packages ```sh yarn install ``` 4. Add the API Keys to your environment variables ```sh DISCORD_API_KEY='YOUR DISCORD API KEY' OPENAI_API_KEY='YOUR OPENAI API KEY' ``` 5. Build project ```sh yarn run build ``` 6. Start binaries ```sh yarn run start ```

(back to top)

## 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 |

(back to top)

## Roadmap - [x] Discord Integration - [x] OpenAI Integration - [x] Context-based usability - [x] Single user - [ ] Multiple users See the [open issues](https://github.com/KrozT/openai-discord/issues) for a full list of proposed features (and known issues).

(back to top)

## 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! 1. Fork the Project 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request

(back to top)

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

(back to top)

## Acknowledgments * [Othneil Drew](https://github.com/othneildrew/)

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/KrozT/openai-discord.svg?style=for-the-badge [contributors-url]: https://github.com/KrozT/openai-discord/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/KrozT/openai-discord.svg?style=for-the-badge [forks-url]: https://github.com/KrozT/openai-discord/network/members [stars-shield]: https://img.shields.io/github/stars/KrozT/openai-discord.svg?style=for-the-badge [stars-url]: https://github.com/KrozT/openai-discord/stargazers [issues-shield]: https://img.shields.io/github/issues/KrozT/openai-discord.svg?style=for-the-badge [issues-url]: https://github.com/KrozT/openai-discord/issues [license-shield]: https://img.shields.io/github/license/KrozT/openai-discord.svg?style=for-the-badge [license-url]: https://github.com/KrozT/openai-discord/blob/master/LICENSE [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 [linkedin-url]: https://www.linkedin.com/in/matias-espinoza-bustos/ [product-screenshot]: images/screenshot.png [Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white [Next-url]: https://nextjs.org/ [React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB [React-url]: https://reactjs.org/ [Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D [Vue-url]: https://vuejs.org/ [Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white [Angular-url]: https://angular.io/ [Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00 [Svelte-url]: https://svelte.dev/ [Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white [Laravel-url]: https://laravel.com [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white [Bootstrap-url]: https://getbootstrap.com [JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white [JQuery-url]: https://jquery.com [TypeScript-url]: https://www.typescriptlang.org [TypeScript-shield]: https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white