Skip to content

discord bot notifying when a user goes live on twitch

License

Notifications You must be signed in to change notification settings

marcsances/rolelive

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

We're working on a new, exciting version with more features!

We're building a Discord server to get more feedback and give updates. Feel free to join here: https://discord.gg/XBAtC4MxKb

rolelive

This is a very quickly hacked together Discord bot that monitors when a user with a certain role goes live on Twitch and makes a notification on the given Discord channel. Current version is rolelive2.py.

Users can add their streams using the !addstream command.

There is also an implementation using a different approach (Rich Presence) in rolelive.py. That implementation is absolutely basic. But it may serve you as a template for a more rich bot. Up to you.

2.0.0 version changelog

  • Upgraded Twitch API to use Helix API
  • Fixed stability issues with the fixes already introduced with Rolelive 0.3.1.
  • Much faster performance since now we take profit of Helix API allowing us to request up to 100 streams at once.
  • Rolelive will now detect ahead of time if the channel names are valid and exist on Twitch.
  • Database back to alive.json since the format has been rolled back to the old one.
  • Removed !streaminfo command since it was not used widely.
  • Minor bug fixes and usability improvements.

0.3.1 version changelog

  • Fixed a bug which caused Rolelive to stop sending alerts when it encountered a network error.
  • Rolelive won't show notifications anymore for channels that disconnect and reconnect in less than an hour (usually due to technical issues).
  • Rolelive will try to automatically guess the channel added by the user even if they include a twitch.tv URL.
  • Rolelive will now confirm the user which is the channel added, this can prevent some errors.
  • The bot will now reply to messages with the nickname of the user for the server instead of the Discord username.
  • Added a configurable variable to let everyone join regardless of role.
  • The help message now shows the correct notification channel instead of the name of the channel where the user typed the help command.
  • Changed database from alive.json to channel_status.json, this will help to have a smooth migration of existing servers, you may delete alive.json after migration.
  • Removed rolelive.py from VCS to prevent confusion to new users.

User commands

  • !addstream stream_name - users can add their stream using this command, if they have an authorized role. Users may only have a stream at once, running this command with more than one stream will replace the stream.
  • !removestream - users can remove the stream they've added so the bot doesn't track it.
  • !onlinestreams - shows a list of live streams
  • !rolelive - shows RoleLive help and version

Admin commands

This commands require the user running them to have a role of ADMIN_IDS or be one of ADMIN_USERS.

  • !admin.add stream_name - adds the given stream to watch. Notice this stream is not linked to any Discord user, you can add as many as you want.
  • !admin.remove stream_name - removes the given stream from the list.
  • !admin.reload - reloads the stream list from the members.json file. Useful if you're making huge offline changes like populating the list for the first time.

Requirements

Linux or Mac with Python 3 and pip.

Installation

Just install the project requirements.

python3 -m pip install -r -requirements.txt

Configuration

Go to Discord developer portal, create an application. The new application has a "Client ID". Keep this information.

Go to the "Bot" tab of your new application and click on "Add Bot". Copy the "token". That is your CLIENT_SECRET. Keep it (and keep it secret).

Let's make the bot join your server. Modify YOUR_CLIENT_ID with the Client ID you copied from the first step, then copy the resulting URL and visit it in your browser to add the bot to your own server:

https://discord.com/oauth2/authorize?client_id=YOUR_CLIENT_ID&scope=bot&permissions=3072

Now enable Developer Mode on Discord (go to Appearance > Developer mode). This will let you get the IDs we need for the bot.

Now open the rolelive2.py file in this project and modify the export lines with the following values:

  • DISCORD_TOKEN: the discord client secret you just copied from the developer portal.
  • GUILD_ID: the server ID on Discord. Right click the icon of your server and click on "Copy ID".
  • ROLE_IDS: all the role IDs (find a user with the role, right click the role label and choose "Copy ID") authorized to add their stream. Each role separated by commas.
  • ROLE_NAMES: names of the roles in ROLE_IDS, for help purposes
  • CHANNEL_ID: the ID of the channel where the live notifications will be sent. Right click the channel name to click on Copy ID.
  • INTERVAL: polling rate for the bot. This interval is the time the bot will sleep after checking all streams, before starting another cycle. Allows to help with rate limiting APIs, at the cost of less responsiveness. Keep it between 0 (for a lot of streams) to 120.
  • ADMIN_USERS: User IDs allowed to manage the service.
  • ADMIN_IDS: Role IDs allowed to manage the service (i.e. ALL users with the role will be able to run admin commands).
  • STREAM_EXPIRY: time in seconds to wait since a channel goes online before it will be elligible again for notifications, this prevents duplicate alerts when a stream has technical issues and goes offline for a few minutes.
  • IGNORE_ROLES: ignores ROLE_IDS parameter and lets anybody add himself into the list with no restriction
  • HELIX_CLIENT_ID: Twitch client ID required for accessing Twitch API. Get an ID here.
  • HELIX_SECRET: Twitch client secret token required for accessing Twitch API. Get an ID here.
  • ITEMS_PER_PAGE: How many streams we check at a time. Maximum 100. Lower amount = more requests to Twitch, and that may mean you exceeding the quota, so keep it as high as possible.

Installation

Install as a regular systemd service.

About

discord bot notifying when a user goes live on twitch

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published