blacklisterBot

README

Discord Blacklist Bot

About • Features • Commands • Setup • Todo

About

This Discord bot can automatically remove images that are posted. Once the image has been checked against the database and identified as being banned so will it be removed.

The bot checks images with four techniques and can thus detect alterations, making attemps to fool the bot and bypass the blacklist difficult.

Each individual detection thresholds can be edited in the configuration file.

Detection methods used:

1. SHA-1 Hash
2. Average hashing
3. Difference hashing
4. Perception hashing

You can read more about these methods here

All data is stored in a local SQLite database

Features

• Automatic removal of inappropriate images

• Intelligent detection which can detect subtle changes

• Works with: PNG, JPEG, JPG, WEBP (Does not support video)

How it works

The first thing the bot does when an image is posted in a chat is to

1. Download the image
2. Calcualte the SHA-1 hash
3. Check that hash against the database

Commands

• Ban

Bans the provided image. Can be an URL or uplaoded as an attachment

• Unban

Attach the image or link to the image you want to unban

• Reload

Updates the settings from the configuration file

Setup

Clone the repo

git clone https://github.com/CarlFlo/blacklisterBot.git

Install all the requirements

go mod download

Configuration

Running the bot will create a config.json file in the directory where it was run.

Insert:

1. The bot token
2. The Discord user ID for the user(s) that are allowed to run the commands
3. The ID of the bot

Thresholds

Each individual detection thresholds can be edited in the configuration file.

A thresholds of zero means that it is a complete match. Ten seems like like a good default value. But you may have to tweak the thresholds to your liking.

Going too high (around 30) will yeild a lot of false positives.

Todo

• Basic functionality
• Gif support
• List of channels that the bot will ignore alt. listen to
• Make the bot aware of what discord server it is in
• Automated action once banned image is posted (banned, kick, timeout etc)