Tweetcord

A Discord Bot for Twitter Notifications

English | 繁體中文

📝Introduction

Tweetcord is a Discord bot that leverages the tweety-ns module to provide real-time tweet updates from specific Twitter users directly to your Discord server. Simply configure the Twitter users and Discord channels you want to monitor, and Tweetcord will automatically forward tweets to the designated channels, ensuring you never miss important updates.🐦

✨Features

Screenshots

👇Whenever a followed user posts a new tweet, your server will receive an instant notification.

Commands

👉 /add notifier username channel | mention type

parameters	types	descriptions
username	str	The username of the twitter user you want to turn on notifications for
channel	discord.TextChannel	The channel to which the bot delivers notifications
mention	discord.Role	The role to mention when notifying
type	str	Whether to enable notifications for retweets & quotes (new in 0.4.1)

👉 /remove notifier username channel

parameters	types	descriptions
username	str	The username of the twitter user you want to turn off notifications for
channel	discord.TextChannel	The channel which set to delivers notifications

👉 /list users

• List all twitter users whose notifications are enabled on the current server

👉 /sync (new in 0.4)

• Sync the notification of new Twitter account with database. If you change the twitter account used by bot, please use this command

👉 /customize message username channel | default (new in 0.4)

parameters	types	descriptions
username	str	The username of the twitter user you want to set customized message
channel	discord.TextChannel	The channel which set to delivers notifications
default	bool	Whether to use default setting (default is false)

Custom notification messages are in f-string format, currently supporting 4 special variables for use, which will be explained below.

• {action} : poster's action, include tweeted, retweeted and quoted
• {author} : poster's display name
• {mention} : the role to mention when sending to discord
• {url} : the link of the tweet

📥Installation

Before running the bot, you need to install the necessary modules.

pip install -r requirements.txt

⚡Usage

📢This tutorial is suitable for version 0.3.2 or later. (Recommended: 0.3.5 or later)

⬆️View Version Upgrade Guides

1. Create and configure the .env file

BOT_TOKEN=YourDiscordBotToken
TWITTER_TOKEN=YourTwitterAccountAuthToken
DATA_PATH=./data/

You can retrieve your auth token from cookies, or you can explore other methods to obtain it.

2. Configure the configs.yml file

All time-related configurations are measured in seconds.

prefix: ''                          # The prefix for bot commands.
activity_name: ''                   # The activity name displayed by the bot.
tweets_check_period: 10             # The check frequency for the posts (it is not recommended to set this value too low to avoid rate limiting).
tweets_updater_retry_delay: 300     # Retry Interval when Tweets Updater encounters exceptions (e.g., rate limitations).
tasks_monitor_check_period: 60      # Interval at which to check if each tasks is functioning properly, and if a task has stopped, attempt a restart.
tasks_monitor_log_period: 14400     # Interval at which to output the list of currently running tasks to the execution log.
auto_turn_off_notification: true    # (v0.4 or later) If all notifications for a user are disabled, decide whether to unfollow the user.
auto_unfollow: true                 # (v0.4 or later) If all notifications for a user is disabled, decide whether to disable notification for the user (twitter side).
use_fx: false                       # (v0.4.1 or later) Whether to use FxTwitter to embed content instead of using the built-in embed
default_message: |                  # (v0.4.1 or later) Set default message format globally
  {mention}**{author}** just {action} here: 
  {url}

3. Run and invite the bot to your server

python bot.py

🔧Bot Permissions Setup 2147666944

• Read Messages/View Channels
• Send Messages
• Embed Links
• Attach Files
• Mention Everyone
• Use Slash Commands

Note

If you want to host the bot on a server, here is a recommended service that is basically free: fly.io.

⚙️some configuration files you may need if you use fly.io

• dockerfile

FROM python:3.10.9
WORKDIR /bot
COPY requirements.txt /bot/
RUN pip install -r requirements.txt
COPY . /bot/
CMD python bot.py

• fly.toml

app = "YOUR_APP_NAME"
primary_region = "YOUR_APP_REGION"

[env]
  DATA_PATH = "/data/"

[mounts]
  source = "YOUR_APP_VOLUME_NAME"
  destination = "/data"

4. Have fun

Now you can go back to Discord and use the /add notifier command to set up notifications for the Twitter users you wish to receive updates from!

💪Contributors

This project exists thanks to all the people who contribute.