VianneyDoleans / SpamFilterBot

Discord bot to filter messages and display only relevant messages

SpamFilterBot

Discord bot for filtering messages and display only relevant messages. The bot will read the Discord conversation, and according to its criterias (machine learning), choose interesting messages to display in a special channel.

DaVinci Competition

This project is a participation to DaVinci competition,
From "The DaVinci Learning Innovation Center".
June 2019, South Korea, Seoul.
You can find the PowerPoint used for the presentation to the jury here.

Motivation

This project was created following the observation that it's difficult to follow a Discord conversation with many members without spending hours there. We decided to do something about it. The Discord bot, based on maching learning, will treat data that we give it, and learn.

Platform

• Windows
• Linux
• Mac

Technologies used

• Bot discord
  • Language : Python
  • Platform : Discord
  • Natural Language Processing : Natural Language Toolkit
  • Database : SQLAlchemy
  • Database : PyMySQL
• Data Generator
  • Language : Java 11
  • GUI : JavaFX 11.0.1
  • Database : MySQL 8.0.16
  • Compilation : Gradle 5.4.1

Features

• Discord Bot, used for filtering Discord messages.
• Data Generation, used for trainning Discord Bot.

Screenshots

Data Generator

Discord Bot

Installation

Data Generator

1. Install MySQL
   • Download MySQL and install/configurate it.
   • Create a user root with password root, or change it here (createDB method and connectionDB method).
2. Install Java 11 or +
3. Create Jar
   • Windows
     • Open search bar and search for Command Prompt.
     • Write and execute :

       cd /[YourLocalPath]/SpamFilterBot/DataGenerator/
       

     • Write and execute :

       gradlew jar
       

     • Jar will be generated in "[YourLocalPath]/SpamFilterBot/DataGenerator/build/libs/" with name dataGenerator-[current version].jar.
   • Mac / Linux
     • Open a terminal.
     • Write and execute :

       cd /[YourLocalPath]/SpamFilterBot/DataGenerator/
       

     • Write and execute :

       ./gradlew jar
       

     • Jar will be generated in "[YourLocalPath]/SpamFilterBot/DataGenerator/build/libs/" with name dataGenerator-[current version].jar.
4. You can run it, enjoy !

Discord bot

1. Install Python
2. Install PIP
3. Install the dependencies
   • Windows / Mac / Linux
     • Open a terminal.
     • Write and execute :

     cd /[YourLocalPath]/SpamFilterBot/DiscordBot/src/
     

     • Write and execute :

     pip install -r requirements.txt
     

How to use?

Data Generator

1. Launch the Jar.
2. Enter the name of MySQL database you want to use.
   • If database doesn't exist, software will create it later.
   • If database exists, software will connect to it and use it later.
   • If don't write a name, it will be "data" by default.
3. Click on Choose a file button.
4. Select a KakaoTalk file with txt extension. If you haven't a KakaoTalk File, you can export it from KakaoTalk or use example file here
5. Wait processing of parsing file, and generation/connection on MySQL database.
6. The interface will change, now you can judge the interesting message by selecting yes or no for each message.
7. You can change of page at the end of the interface by clicking on number page, or directional arrows.
8. You can close the software, and run it later, all modifications will be save on database in live.

Discord bot

1. launch the bot :
   • Windows / Mac / Linux
     • Open a terminal.
     • Write and execute :

      cd /[YourLocalPath]/SpamFilterBot/DiscordBot/src/
     

     • Write and execute :

     python main.py
     

Why KakaoTalk file ?

We decided to use KakaoTalk file for generating data because it's the current platform we use for communication (so bigger data). Parsing class, here, can be re-implemented with another support platform.

Why Discord Bot ?

Discord bot because Discord is popular, have a great documentation, in English (KakaoTalk documentation is in Korean for major parts).

Contributors

@Sugihiru - 50181588
@VianneyDoleans - 50181551
@Hardkaise - 50181586
Philippe - 50181563
Walter - 50181549
Alexis - 50181595