Skip to content

Commit

Permalink
Update README.md and logo upload
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdeploy committed May 9, 2023
1 parent e1e41df commit 5baf545
Show file tree
Hide file tree
Showing 2 changed files with 154 additions and 7 deletions.
121 changes: 114 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,125 @@
# discord-gpt
<p align="center">
<img src="./avatar-blue.svg" width="100px" />
</p>

<h1 align="center">DiscordGPT</h1>

<div align="center">

![discord.js version](https://img.shields.io/badge/discord.js-v14.10.2-5865F2?style=flat&logo=discord) ![openai version](https://img.shields.io/badge/openai-v3.2.1-222222?style=flat&logo=openai) ![npm version](https://img.shields.io/badge/npm-v18.14.1-brightgreen) ![license](https://img.shields.io/badge/license-MIT-green)

</div>

Discord GPT: A chatbot powered by OpenAI's GPT-3 for Discord, with natural language processing capabilities and advanced conversational AI. Built with Discord.js and easy to use for developers and users alike.
Discord GPT is a useful bot powered by <a>OpenAI's GPT-3.5</a> for Discord, with natural language processing capabilities and advanced conversational AI. Built with <a href="https://github.com/discordjs/discord.js" >Discord.js</a> and easy to use for developers and users alike.

## ⚠️ PAY ATTENTION ⚠️
- [User Guide](#👤-user-guide)
- [Developer Guide](#developer-guide)
- [Limitations of usage](#limitations-of-usage)
- [Contributions](#contributing)

✅ This project has just started development.
## 👤 User guide

**discord-gpt 1.0.0** will be available on May 7th, 2023.
### Inviting the bot to the server

✅ If you're interested in this project, I recommend that you give it a [⭐ star](https://github.com/alexdeploy/discord-gpt) or [👉 follow me](https://github.com/alexdeploy/follow) to stay updated on future updates and potential contributions.
To invite DiscordGPT to your Discord server, follow these steps:

1. Invite DiscordGPT to your server [here]().
2. Select the server you want to invite the bot to from the dropdown list.

⚠️ Make sure your user has the permissions to invite on the server.

3. Click "Authorize".

### 🔓 Required permissions

The bot needs the following permissions to function properly:

- Read messages
- Send messages
- Attach files

Make sure to grant it these permissions when inviting the bot to your server.

### 🤖 Using DiscordGPT

To use the bot, simply mention the bot with @D-GPT followed by the prompt you want to use. For example, to generate text from the prompt "Hello, how are you?", type the following in a text channel on your server:

````
@D-GPT Hello, how are you?
````

The bot will respond with text generated by GPT-3 based on the prompt you provided.

## Developer guide

### 🛠 Installing the project

To install and set up DiscordGPT on your own machine, follow these steps:

Clone the repository:

````bash
git clone https://github.com/alexdeploy/discord-gpt.git
````

Navigate to project directory

````bash
cd discord-gpt/client
````

Install the dependencies:

````bash
npm install
````

### 🔒 Configuring tokens

The bot needs the following tokens to function properly:

- A Discord token to authenticate the bot on your Discord server. You can generate a Discord token on the settings page of your application in the Discord Developer Console.

- An OpenAI token to authenticate requests to the GPT-3 model. You can get an OpenAI token on the settings page of your account on the OpenAI homepage.

Rename the `.env.example` file in the /client directory just to `.env` and set your tokens inside:

````
BOT_TOKEN="DISCORD_BOT_TOKEN_HERE"
CLIENT_ID="BOT_ID"
OPENAI_KEY="OPENAI_TOKEN_HERE"
````

Replace the values inside "" with Discord and OpenAI tokens you have generated. These tokens will be used for identify your bot and developer accounts.

👉 How to generate Bot token.

👉 How to generate OpenAI API Key.

👉 How to get the Client ID.


### 🚀 Starting the bot

To start the bot, run the following command from the `discord-gpt/client` directory of the project:

````bash
npm start
````

or development mode (auto-reload):

````bash
npm run dev
````

The bot will automatically connect to Discord and be ready for use.

## Limitations of usage.

Soon...

## Contributing

Soon...

Thank you for your patience and support! 🖖
40 changes: 40 additions & 0 deletions avatar-blue.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5baf545

Please sign in to comment.