Paillat-dev/Botator
1
0
Fork 0
mirror of https://github.com/Paillat-dev/Botator.git synced 2026-01-02 01:06:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Paillat
2023-03-16 15:12:56 +01:00
parent 864728577f
commit 0c3665f153
1 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -1,19 +1,24 @@
# Botator # Botator
Botator is a discord bot that binds [@openai](https://github.com/openai) 's gpt3 AI with [@discord](https://github.com/discord). You will be able to take the conversation with the AI into a specific channel that you created, or by pinging/replying to a bot's message. He can also AI moderate the chat. Botator is a discord bot that binds [@openai](https://github.com/openai) 's chat-GPT AI with [@discord](https://github.com/discord). It also has images recognition and moderation features!
![discord com_channels_1021872219888033903_1046119234033434734](https://user-images.githubusercontent.com/75439456/204105583-2abb2d77-9404-4558-bd3e-c1a70b939758.png) ![discord com_channels_1021872219888033903_1046119234033434734](https://user-images.githubusercontent.com/75439456/204105583-2abb2d77-9404-4558-bd3e-c1a70b939758.png)
# Adding the bot to your discord server # Adding the bot to your discord server
In order to add the bot to your discord server, you will need an OpenAI API key. You can create an account and take one [here](https://beta.openai.com/account/api-keys). **Please note that you'll have 18$ free credits (it's really enough if you don't use the bot contineousely) when creating your account. They will be slowly used, and will expire 3 months after you created your accound, and when they have all been used or expired, you'll need to buy new tokens. You can check your tokens usage [here](https://beta.openai.com/account/usage).** In order to add the bot to your discord server, you will need an OpenAI API key. You can create an account and take one [here](https://beta.openai.com/account/api-keys). **Please note that you'll have 5$ free credits (it's really a lot) when creating your account. They will be slowly used, and will expire 3 months after you created your accound, and when they have all been used or expired, you'll need to buy new tokens. You can check your tokens usage [here](https://beta.openai.com/account/usage).**
When adding the bot to your server you agree to our [privacy policy](https://github.com/Paillat-dev/Botator/blob/main/privacypolicy.md) and our [terms of service](https://github.com/Paillat-dev/Botator/blob/main/tos.md) When adding the bot to your server you agree to our [privacy policy](https://github.com/Paillat-dev/Botator/blob/main/privacypolicy.md) and our [terms of service](https://github.com/Paillat-dev/Botator/blob/main/tos.md)
You can add the bot to your server by clicking [**here**](https://discord.com/api/oauth2/authorize?client_id=1046051875755134996&permissions=2214808576&scope=applications.commands%20bot). **PLEASE NOTE THAT WE ARE NOT RESPONSIBLE FOR ANY MISUSE YOU'LL DO WITH THE BOT..** You can add the bot to your server by clicking [**here**](https://discord.com/api/oauth2/authorize?client_id=1046051875755134996&permissions=2214808576&scope=applications.commands%20bot). **PLEASE NOTE THAT WE ARE NOT RESPONSIBLE FOR ANY MISUSE YOU'LL DO WITH THE BOT..**
Then, run the following commands to set your bot up: # Setting up the bot
Run the following commands to set your bot up:
First **/setup**, define the channel you want the bot to talk into and your OPENAI api key. First **/setup**, define the channel you want the bot to talk into and your OPENAI api key.
Then, if you want, **/advanced** to define some more advanced parameters..) Then, **/enable** to enable the bot.
Then, if you want, **/advanced** to define some more advanced parameters, and if you want to enable image recognition, **/images** to enable it. You can also enable the moderation feature by doing **/moderation**.
You can always disable the bot by doing **/disable** and delete your api key from our server by doing **/delete**.
Please note that we can possibly log the messages that are sent for **no more than 24h**, and that we will store your openai API key. You can always delete your API key from our servers by doing **/delete**. Please note that this action is irreversible. Please note that we can possibly log the messages that are sent for **no more than 24h**, and that we will store your openai API key. You can always delete your API key from our servers by doing **/delete**. Please note that this action is irreversible.
@@ -22,6 +27,7 @@ You can now enable your bot by doing **/enable**.
You can always disable the bot by doing **/disable** and delete your api key from our server by doing **/delete**. You can always disable the bot by doing **/disable** and delete your api key from our server by doing **/delete**.
# Commands reference # Commands reference
*/setup* - Setup the bot */setup* - Setup the bot
*/enable* - Enable the bot */enable* - Enable the bot
@@ -50,6 +56,8 @@ You can always disable the bot by doing **/disable** and delete your api key fro
*/get_toxicity* - Get the toxicity that the AI would have given to a given message */get_toxicity* - Get the toxicity that the AI would have given to a given message
*/images* - Set the AI image recognition settings
# Support me # Support me
You can support me by getting Botator premium, or donating [here](https://www.buymeacoffee.com/paillat). More informations about botator premium here below: You can support me by getting Botator premium, or donating [here](https://www.buymeacoffee.com/paillat). More informations about botator premium here below:
@@ -59,7 +67,7 @@ At the beginning, Botator was just a project between friends, but now many peopl
Not at all! You can still continue using botator for free, but in order to limit our servers overload, we limit your requests at 500 per server per day. Not at all! You can still continue using botator for free, but in order to limit our servers overload, we limit your requests at 500 per server per day.
### What are my advantages with premium? ### What are my advantages with premium?
With premium, we will increase the maximal number of requests to 5000 for the server of your choice. You will also have access to exclusive Discord channels and get help if you want to self-host Botator. Discord server self promote and "support us" messages will not be shown on this server With premium, we will increase the maximal number of requests to 5000 for the server of your choice. You will also have access to exclusive Discord channels and get help if you want to self-host Botator. You will also be able to use the image recognition feature.
### Am I going to have unlimited tokens with premium? ### Am I going to have unlimited tokens with premium?
No! With premium, Botator will still use tokens from YOUR OpenAI account, but you will be able to use it 5000 times per day instead of 500. No! With premium, Botator will still use tokens from YOUR OpenAI account, but you will be able to use it 5000 times per day instead of 500.
@@ -69,6 +77,7 @@ Premium subscription costs 1$ per month.
### How can I get premium? ### How can I get premium?
First join our discord server [here](https://discord.gg/pB6hXtUeDv). First join our discord server [here](https://discord.gg/pB6hXtUeDv).
Then subscribe to botator premium by clicking here: Then subscribe to botator premium by clicking here:
<a href="https://www.buymeacoffee.com/paillat"><img src="https://img.buymeacoffee.com/button-api/?text=Get botator premium&emoji=&slug=paillat&button_colour=5F7FFF&font_colour=ffffff&font_family=Inter&outline_colour=000000&coffee_colour=FFDD00" /></a> <a href="https://www.buymeacoffee.com/paillat"><img src="https://img.buymeacoffee.com/button-api/?text=Get botator premium&emoji=&slug=paillat&button_colour=5F7FFF&font_colour=ffffff&font_family=Inter&outline_colour=000000&coffee_colour=FFDD00" /></a>
@@ -77,7 +86,7 @@ Then, link your discord account to BuyMeACoffe by following [these instructions]
After that you will normally be able to access some new channels in our discord server. In the Verify Premium channel, run the /premium_activate command and give your server's ID. You can learn about how to get your server's ID by clicking [here](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-). If you have any question, you can ask here: [help-getting-premium](https://discord.com/channels/1050769643180146749/1050828186159685743). After that you will normally be able to access some new channels in our discord server. In the Verify Premium channel, run the /premium_activate command and give your server's ID. You can learn about how to get your server's ID by clicking [here](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-). If you have any question, you can ask here: [help-getting-premium](https://discord.com/channels/1050769643180146749/1050828186159685743).
# ToDo # ToDo
- [ ] add image recognition - [x] add image recognition
- [x] When chatgpt API is released, add that api instead of davinci-003 - [x] When chatgpt API is released, add that api instead of davinci-003
- [ ] Publish a GOOD docker image on dockerhub and add some more instructions about how to selfhost - [ ] Publish a GOOD docker image on dockerhub and add some more instructions about how to selfhost
- [x] Add a log and updates channel option and a way for devs to send messages to that channel on all servers. - [x] Add a log and updates channel option and a way for devs to send messages to that channel on all servers.