Giter VIP home page Giter VIP logo

boysclub_trending_bot's Introduction

BoysClub Discord Bot

This Discord bot is designed to enhance your Discord server's engagement by tracking popular messages based on reactions. It features functionality for highlighting trending messages.

Features

  • Trending Messages Highlighter: Monitors reactions on messages in specified channels to identify and promote trending content. Automatically updates or forwards these messages to a designated trending channel.
  • Channel Purge for Testing: Automates the deletion of all messages in specified channels during test mode, useful for maintaining a clean environment.
  • Reaction-Based Message Promotion: Tracks specific reactions and promotes messages based on reaction counts, ensuring popular content gets highlighted.
  • Configurable Settings: Allows customization of tracked reactions, reaction thresholds, and target channels through environment variables and configuration files.

Installation and Setup

Prerequisites

  • Python 3.10 or newer
  • discord-py library
  • pandas library
  • Poetry for dependency management

Steps

  1. Clone the Repository: git clone <repository-url> Replace <repository-url> with the URL of the repository.

  2. Install Dependencies: Ensure you have Poetry installed. If not, you can install it following the instructions on Poetry's documentation. Install the project dependencies with:

    poetry install
    
  3. Setup Environment Variables: Create a .env file in the project root with the following entries:

    BOT_TOKEN=<Your_Bot_Token>
    TEST_CHANNEL_ID=<Your_Test_Channel_ID>
    TRENDING_CHANNEL_ID=<Your_Trending_Channel_ID>
    

    Replace placeholders with the actual values for your setup.

  4. Configure Channels: Define the channels the bot should listen to by editing channel_whitelist.json in the project root directory:

    {
      "ChannelName": "ChannelID"
    }

    Add your specific channel names and IDs accordingly.

  5. Run the Bot: Start the bot using Poetry:

    poetry run python main.py
    

Usage

  • In test mode, the bot will automatically delete messages in specified channels if the TEST_MODE_DELETE environment variable is enabled.
  • The bot will monitor messages in whitelisted channels for specific reactions to determine trending messages.
  • Trending messages will be forwarded or updated in the designated trending channel.
  • The bot can be configured to track different reactions and set thresholds for what constitutes a trending message.
  • It is designed to run continuously and can be scheduled as a CRON job for regular execution.

boysclub_trending_bot's People

Contributors

zkxp-admin avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.