Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Little touches to README.md #2

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Little touches to README.md #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ffca9af
Update README.md
KylePrograms2by2 Mar 14, 2023
ede1f94
README.md
KylePrograms2by2 Mar 14, 2023
26ffbd3
README.md
KylePrograms2by2 Mar 14, 2023
49fe104
Update README.md
KylePrograms2by2 Mar 14, 2023
0fc1bde
Update to README.md
KylePrograms2by2 Mar 14, 2023
3d22278
Update bot.js
KylePrograms2by2 Mar 14, 2023
3e50ace
Update README.md
KylePrograms2by2 Mar 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# detoxAI
A simple AI-powered moderation Discord Bot! PRs & issues are welcome :)

# Quickstart
# Self-Hosting
You can either install the bot into your Discord community, or self-host a version of the bot. We would **recommend installing our instance of the bot** as it is already configured with our database and is more reliable.

**Invite/Install here:** https://dsc.gg/detox
Expand All @@ -13,17 +13,25 @@ Alternatively, you can self-host the bot (complicated).
To self-host the bot, you would need to create the following environmental variables:

```
{
"TOKEN": "your discord bot token",
"STATCORD": "statcord token (optional)",
"ID": "bot client ID",
"DEEPAI": "deepAI API key"
}
TOKEN=your discord bot token
STATCORD=statcord token (optional)
ID=bot client ID
DEEPAI=deepAI API key
```

As well as the following file:
- `firestoreKey.json`: a service account key to your [Firestore](https://cloud.google.com/firestore) database.

To obtain the firestoreKey.json file, you need to follow these steps:

1. to the [Firebase Console](https://console.firebase.google.com/) and select your project.
2. Click on the gear icon in the top left corner and select "Project settings".
3. In the "Project settings" page, go to the "Service accounts" tab.
4. Scroll down to the section titled "Firestore Database Admin SDK" and click on "Generate new private key".
5. A JSON file containing your project's service account credentials will be downloaded to your computer. This is your firestoreKey.json file.
Note: Keep the firestoreKey.json file secure and do not share it with anyone. It contains sensitive information that can grant access to your Firebase project

Also, keep in mind that you have Visual [Studio Community 2022](https://visualstudio.microsoft.com/) installed with "Development with C++" on it. The bot won't be able to run if you use a normal Visual Studio Code.
# Features
- Uses TensorflowJS's Toxicity model to delete toxic Discord messages.
- Deletes small set of blacklisted reactions on messages.
Expand Down
4 changes: 2 additions & 2 deletions bot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const client = new Client({
activities: [{
name: '/help | Click Me!',
type: 'STREAMING',
url: 'https://youtu.be/zYD2VBgabX8',
url: 'https://www.youtube.com/watch?v=zYD2VBgabX8',
}],
},
});
Expand Down Expand Up @@ -70,4 +70,4 @@ for (const file of eventFiles) {

console.log('Loaded commands!');

process.on('unhandledRejection', error => console.error('Uncaught Promise Rejection', error));
process.on('unhandledRejection', error => console.error('Uncaught Promise Rejection', error));