A Discord bot that displays live data from Tautulli
Tauticord uses the Tautulli API to pull information from Tautulli and display them in a Discord channel, including:
- Number of current streams
- Number of transcoding streams
- Total bandwidth
- Total LAN bandwidth
- Stream state (playing, paused, stopped, loading)
- Media type (tv show/movie/song/photo)
- User
- Media title
- Product and player
- Quality profile
- Stream bandwidth
- If stream is transcoding
- Progress of stream
- ETA of stream completion
Administrator (the bot owner) can react to Tauticord's messages to terminate a specific stream (if they have Plex Pass).
Users can also indicate what libraries they would like monitored. Tauticord will create/update a voice channel for each library name with item counts every hour.
- A Plex Media Server
- Tautulli (formerly known as PlexPy)
- A Discord server
- Python 3.10+
HOW TO MAKE A DISCORD BOT: https://www.digitaltrends.com/gaming/how-to-make-a-discord-bot/ Permissions required:
- Manage Channels
- View Channels
- Send Messages
- Manage Messages
- Read Message History
- Add Reactions
Install requirements with:
pip3 install -r requirements.txt
Copy config.yaml.example to config.yaml and complete the variables in the file.
Run the script with the following command:
python3 Tauticord.py
You can also run Tauticord as a Docker container. The Dockerfile is included in this repository, or can be pulled from Docker Hub or GitHub Packages.
You will need to set the following environment variables:
| Environment Variable | Value | Example/Default |
|---|---|---|
| TC_TAUTULLI_URL (required) | IP of your Tautulli server | http:https://192.168.1.x:8181 |
| TC_TAUTULLI_KEY (required) | API key for Tautulli server | abcd1234efgh5678ijkl9012mnop3456qrst |
| TC_PLEX_PASS | Enable PlexPass Features | "False" |
| TC_REFRESH_SECONDS | Seconds between updates (5-second minimum built-in) | 15 |
| TC_TERMINATE_MESSAGE | Message sent to users when a stream is killed | "Your stream has ended." |
| TC_USE_24_HOUR_TIME | Whether to display times in 24-hour time | "False" |
| TC_VC_STATS_CATEGORY_NAME | Name of the stats voice channel category | "Tautulli Stats" |
| TC_VC_STREAM_COUNT | Whether to display current stream count in a voice channel | "False" |
| TC_VC_TRANSCODE_COUNT | Whether to display current transcode count in a voice channel | "False" |
| TC_VC_BANDWIDTH | Whether to display current bandwidth in a voice channel | "False" |
| TC_VC_LOCAL_BANDWIDTH | Whether to display current local bandwidth in a voice channel | "False" |
| TC_VC_REMOTE_BANDWIDTH | Whether to display current remote bandwidth in a voice channel | "False" |
| TC_VC_PLEX_STATUS | Whether to display Plex online status in a voice channel | "False" |
| TC_VC_LIBRARIES_CATEGORY_NAME | Name of the libraries voice channel category | "Tautulli Libraries" |
| TC_VC_LIBRARY_STATS | Whether to display library statistics in voice channels | "False" |
| TC_VC_LIBRARY_NAMES | Comma-separated list of libraries to display statistics of | "Movies,TV Shows,Music" |
| TC_VC_LIBRARY_REFRESH_SECONDS | Seconds between updates (5-minute minimum built-in) | 3600 |
| TC_DISCORD_BOT_TOKEN (required) | Discord Bot Token | |
| TC_DISCORD_SERVER_ID (required) | Discord Server ID | <ID, right-click server> |
| TC_DISCORD_ADMIN_IDS | List of Discord IDs with admin privileges | <ID, right-click profile> |
| TC_DISCORD_CHANNEL_NAME | Channel name for updates | "Tautulli Status" |
| TC_USE_EMBEDS | Use embedded messages rather than regular text chat | "True" |
| TC_ALLOW_ANALYTICS | Allow Anonymous Crash Analytics? | "True" |
| TC_LOG_LEVEL | Severity threshold for logs | "INFO" |
| TZ | Timezone that your server is in | "America/New_York" |
Tauticord uses Google Analytics to collect statistics such as common errors that will help with future development. This data is limited, anonymous, and never sold or redistributed.
When and what data is collected?
- Whenever the bot comes online
- What operating system the bot is running on (Windows, Linux, MacOS, etc.)
- Whenever an error is logged
- What Python function the error occurred in.
What data is NOT collected:
- Any identifying information about the user
- Any identifying information about the computer/machine (a random ID is generated on each analytics call, IP addresses are anonymized)
- Settings for Discord or Tautulli, including passwords, API tokens, URLs, etc.
- Any data from Tautulli
- Anything typed in Discord.
This bot is still a work in progress. If you have any ideas for improving or adding to Tauticord, please do a pull request.
Thanks goes to these wonderful people (emoji key):
Nate Harris |
Thomas White |
Tim Wilson |
Roy Du |