TLDRBot

TLDRBot is a Discord bot that generates a monthly summary of all the happenings on the server on the 1st of every month. It is best used for small to medium-sized servers with not more than 20-30 people.

Features

• Automatically collects messages from all text channels in the server.
• Generates a summary of the collected messages.
• Posts the summary to a specified channel on the 1st of every month.
• Allows manual extraction and summarization of messages.
• Configurable role and channel settings for posting summaries.

Installation

1. Invite the bot to your server using the following link: Invite TLDRBot

Deploy Bot Locally

1. Clone the repository:

   git clone https://github.com/yourusername/TLDRBot.git
   cd TLDRBot

2. Create a virtual environment and activate it:

   python -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`

3. Install the required packages:

   pip install -r requirements.txt

4. Create a .env file in the root directory and add your Discord bot token and Google API key:

   DISCORD_TOKEN=your_discord_token
   GOOGLE_API_KEY=your_google_api_key

5. Run the bot:

   python bot.py

Configuration

• Use the $setup command to configure the bot for your server:

  !setup <channel_to_post_summary> <announcement_channel> <emoji_to_react_to> <role_name> <role_color>

<emoji_to_react_to> should be a Unicode string. For role names with more than one word, use quotation marks.

• Example:

  !setup summaries announcements \ud83d\uddd3\ufe0f "Monthly Bot Summary" 0x00ff00

Issues/Requests

If you face any issues with the bot, please feel free to raise an issue on GitHub. I will try to resolve it as soon as possible. For any feature requests, feel to reach out to me on Discord: gunjou1213.