MrTuxedo/openai-discord
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
forked from https://github.com/KrozT/openai-discord
9 Commits 1 Branch 0 Tags 98 KiB
TypeScript 96.6%
Dockerfile 3.4%
8fa0606322
Go to file
Matias Espinoza 8fa0606322 Update commands description
2023-03-20 16:41:12 -03:00
src Update commands description 2023-03-20 16:41:12 -03:00
.editorconfig Initial upload of the project in its first usable version 2023-03-13 05:41:45 -03:00
.eslintignore Update ESLint configuration from JS to JSON format 2023-03-13 11:46:57 -03:00
.eslintrc.json Update ESLint configuration from JS to JSON format 2023-03-13 11:46:57 -03:00
.gitignore Initial upload of the project in its first usable version 2023-03-13 05:41:45 -03:00
LICENSE Initial upload of the project in its first usable version 2023-03-13 05:41:45 -03:00
package.json Initial upload of the project in its first usable version 2023-03-13 05:41:45 -03:00
README.md Update commands description 2023-03-20 16:41:12 -03:00
tsconfig.eslint.json Initial upload of the project in its first usable version 2023-03-13 05:41:45 -03:00
tsconfig.json Initial upload of the project in its first usable version 2023-03-13 05:41:45 -03:00
yarn.lock Initial upload of the project in its first usable version 2023-03-13 05:41:45 -03:00

README.md

Contributors Forks Stargazers Issues MIT License LinkedIn


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

Packages

(back to top)

Getting Started

Installation

  1. Get a neccesary API Keys
  1. Clone the repo 
    git clone https://github.com/KrozT/openai-discord.git
  2. Install packages 
    yarn install
  3. Add the API Keys to your environment variables 
    DISCORD_API_KEY='YOUR DISCORD API KEY'
OPENAI_API_KEY='YOUR OPENAI API KEY'
  4. Build project 
    yarn run build
  5. Start binaries 
    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

  • Discord Integration
  • OpenAI Integration
  • Context-based single-user usability
  • Simultaneous context-based multi-user usability
  • Client-based multi-language UI support

See the open 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

(back to top)