SassBot

Discord bot for your favorite e-girl

Platforms Supported:

• Twitch
• Kick
• Youtube
• Onlyfans
• Fansly
• Chaturbate
• Cam4
• MyFreeCams
• BongaCams
• StripChat
• ePlay
• ManyVids

Features

• Get notifications when your streamer is online sent to a discord channel
• Rerun detection/support. If stream titles contains a variation of rerun/rr/not live then it will be detected as a rerun.
  • by default reruns won't be announced, but you can choose to announce them to custom roles just for reruns
• Track multiple accounts per platform. (for example, if they have a paid and free account)
• There's a minimum time between notifications, so your discord members won't get spammed if you're having connection issues.
• Bot's status reflects what the streamer is doing. Offline or streaming on Kick, yt, etc.
• White list commands to certain roles.
• Log who uses what commands
• Add/remove images yourself to embed into notifications via image commands. Images are rotated through, so add as many as you like.
• Rebroadcast online notifications with rebroadcast commands
• Subathon online timers via subathon commands
• Send alerts during peak discord usage times
• ... and many more!

Commands

• /stream-status - See if your streamer is currently offline or online. Shows time online/offline and total time streamed.
• /ping-toggle - Toggle for role pings in online announcements. This is defaulted to false, so set true if you want role pings
• /announce-rerun-toggle - Toggle if reruns will be announced. If a title contains a variation of rr/rerun/not live then the stream will be detected as a rerun.
• /title - Allows you to temporarily add a custom title for a platform/username combo. TEMP_TITLE_UPTIME in constants.py determines how long a temp title added via /title will be used for.
• Image list commands - Images can be manually added. These images are used for embeds for all supported platforms.
  • /image-list-show - show the list of image urls that will be rotated through during online announcements
  • /image-list-add - add an image url to the image list
  • /image-list-remove - remove an image from the image list. Must provide the url
• Pin image commands - If there is no pinned image, Kick, Twitch, CB, and YT use thumbnail images from the video feed, OF/Fans will embed images from the image list.
  • /image-pin - pin an image for a number of hours you choose. Pinned images will be embedded into notifications in the announcements channel.
  • /image-check-pin - Check to see if an image is pinned
  • /image-unpin - unpin an image if it is pinned.
• /rebroadcast - Send out online notifications to the announcements channel IF the streamer is online. Isn't isntant but goes off when the next online check is made.
  • /rebroadcast-image - same as above but you can attach a URL of an image to embed into the new announcement(s)
• Subathon commands - apart from commands, subathon status is also displayed in the Bot's status.
  • /subathon - check the status of the current subathon, if there is one.
  • /subathon-start - start a subathon timer
  • /subathon-end - end a subathon timer
• Stats
  • /users-graph Get a graph of online/dnd/idle/ users in your discord. The data is mainly used to send out alerts but why not use it for graphs as well!
    • Has two optional arguements, InputDate and Days. InputDate defaults to todays date and days (to include in graph) defaults to 1.
  • /stream-stats Shows total time streamed for the week, two weeks, and four weeks for each platform.
• Anonymous questions/confessions
  • /confess - unlogged and anonymous confession that a user can post to a channel via the bot. Must be reviewed first
  • /confess-review - whitelisted roles/people can review submitted confessions and approve or deny them.
    • approved confessions/questions are posted to a preset channel immediately
• Test commands
  • /test-permission - test if Sassbot has the necessary permissions to post in the specified channel ID.

How to set up the bot:

1. Go to https://discord.com/developers and set up an app and get a token. Put that token in a file called token (no file extension needed), and put that file in a subfolder called secrets.
2. At https://discord.com/developers/ - generate an invite code under oauth2 to invite your bot to your server. Under scope make sure bot is checked. Give the bot permissions you want it to have. At minimum it'll need to be able to post messages and embeds
3. Go to the bot section in the developers portal and turn on all the intents.
4. In the Constants.py file, change the GUILD_ID value to the guild id of your server, and each platform NOTIFICATION_CHANNEL_ID to the channel ID you want alerts posted to. To easily get both of these IDs, in discord advanced options turn on developer mode. After that you can right click servers/channels and a new option to copy the IDs will be available. Also edit and add vairus URLs to your streamer in Constants.py. Everything is described in comments.
   • After editing constants you can create a copy called AppConstants.py - This will be used before DefaultConstants.py. So you can pull changes without stashing or overwriting
5. Generate the database with 'python GenerateDatabase.py' or 'python3 GenerateDatabase.py'
6. Replace images in the image folder with those of your streamer, but keep same file names.
   • images/errIcon.png - icon used for embeds if there is an issue getting one from the platform, or if one doesn't exist
   • images/twitErrImg.jpg - default photo used for embeds if no other thumbnail or photo can be grabbed from the image list (if its empty)
   • images/avatars/calmStreamer.png - Bot avatar if streamer has streamed within the MIN_TIME_BEFORE_AVATAR_CHANGE time frame (default 48 hours)
   • images/avatars/pissedStreamer.png - Bot avatar if streamer hasn't streamed within the MIN_TIME_BEFORE_AVATAR_CHANGE time frame
7. Make sure you have python 3.10 installed.
   • make sure you have Chrome/Chromium another browser may work but not tested.
   • Make sure Xvfb is installed if on Linux. Xephyr, or Xvnc may work but untested
   • run command 'pip install -r requirements.txt'
8. Start the bot: 'python3 run.py' or 'python run.py'

How To: Docker Compose or Portainer

1. Install Docker
2. Install Docker Compose and/or Portainer
3. Complete steps 1-6 above in the "how to set up the bot" section
4. Edit docker-compose.yml and follow the commented instructions
5. If using docker compose, from the Sassbot directory start it via "sudo docker compose up -d"
6. If using Portainer go to stacks > add stack
   • Copy paste over the non commented code from docker-compose.yml into the window
   • Deploy Stack

Known Issues

1. If multiple accounts are streaming on the same platform at the same time, /rebroadcast will only show an announcement for one of the accounts.
2. Cam4 will ban your IP if you make too many calls from the same ip to the api. Make check times very long and/or rotate your ip
3. Fansly will 404 you for a period of time if you make too many requests from the same ip.
4. If the requesting ip is in a state that requires age verification, some of these checkers wont work.

Update History

• 11/22/2024
  • Docker File improvements
  • fix for manyvids link
• 10/22/2024
  • Added ManyVids Support
    • Because of this many things have changed in Default/App Constants so they will need to be updated with new vars
  • Added proxy support for most of the checkers. Anything that doesn't use nodriver will use socks5
  • Changed requirements update them with 'pip install -U -r requirements.txt'
  • Change nodriver temp file behavior. Uses default behavior in windows
  • Changed Dockerfile to improve size and fixed docker image to work with windows
• 10/19/2024
  • Improvements on Twitch checker to hopefully work more quickly
  • Improvements with nodriver temp folders (was previously taking up too much disk space)
• 10/12/2024
  • Moved more things to config to constants
    • Changing thumbnail behavior
    • Changing default avatar/Icon paths/images
  • Constants.py renamed to DefaultConstants.py
  • You can create your own version of Constants.py called AppConstants.py. Just copy over the contents of constants into this file, it's untracked and you can pull changes without stashing!
    • AppConstants.py is used before DefaultConstants.py
  • ghcr.io/bombg/sassbot:latest - now supports arm as well. The package ghcr.io/bombg/sassbot:latest-arm is no longer needed.
• 10/11/2024
  • added workflow to auto make docker images. They are
    • ghcr.io/bombg/sassbot:latest
    • ghcr.io/bombg/sassbot:latest-arm
  • Moving prints over to pythyon logging library
  • Improved some exception handling
  • Fixed file descriptor leak-- happened over a week ago but i'm confident it's gone now.
  • added newer versions of hikari/tanjun to requirements. No code changes so old will still work too for now.
• 10/3/2024
  • Fixed MFC, SC, BC checkers
• 9/24/2024
  • Checkers that once used selenium now use nodriver instead. Chromedriver no longer required or supported
    • works with Chromium as well as Chrome. Other browsers are untested.
  • Added more reqirements nodriver,PyVirtualDisplay. Install them via the command 'pip install -U -r requirements.txt'
  • Xvfb is now required if using Linux. Xephyr or Xvnc may work but not tested.
  • Fixed a long standing bug with Chaturbate checker I just noticed; whoops.
  • One browser open at a time limit to work better on slower machines (have it working on a Raspberrypi 3B+)
  • Removed support for twitter (it's been broken for a while anyway)
  • Each platform has its own check timer in constants now. Instead of normal/long
  • Updated Dockerfile to reflect the new changes
  • Fixed Twitch checker
• 8/02/2024
  • Added Docker support - Thanks jasmeralia!
  • Added /test-permission command that takes the channelId you wish to test permissions with as an input.
• 5/03/2024
  • Added ePlay support (80% revenue share for the win)
• 12/22/2023
  • Twitch checking hopefully fixed and turned back on
• 12/16/2023
  • Temporarily disabling twitch detection until it's fixed. All channels are showing as live
• 10/04/2023
  • Implemented the ability to post anonymous confessions/questions via /confess command.
    • These are unlogged server side
    • Must be approved by a whitelisted role/person via /confess-review
  • A new package is required to be installed so install it via the command 'pip install -U -r requirements.txt'
• 9/29/2023
  • Expanded rerun support.
    • If a title contains a variation of rr/rerun/not live then the stream will be detected as a rerun.
      • reruns won't be announced by default, but you can turn on rerun-announcements with the /announce-rerun-toggle command
        • if ping-toggle is turned on you can also set roles to announce reruns to in constants.py
• 9/18/2023
  • /title command added. It allows you to temporarily add a custom title for a platform/username combo.
    • title and platform arguments are required and with an optional accountName argument that is required if there's more than one account for that platform
    • TEMP_TITLE_UPTIME in constants.py determines how long a temp title added via /title will be used for. Current default is 16 hours
  • fix for Kick titles with ampersands
• 9/14/2023
  • /users-graph command upgraded to include multiple days in a graph with an optional arguemnt.
• 9/12/2023
  • Alerts can now happen for multiple accounts on the same platform at the same time.
• 9/09/2023
  • Stream-status bug fix that was causing it to give strange values and not record data
  • Can mention other roles other than everyone and each platform can get their own custom mentions
  • everyone-ping-toggle renamed to ping-toggle
  • Can now have a custom notification channel per platform if you wish
• 9/06/2023
  • Can now track multiple accounts per platform
• 9/01/2023
  • Can now add individual user IDs to command white list as well as roles.
• 8/xx/2023
  • Added StripChat Support
  • Added BongaCams Support
  • Added MyFreeCamsSupport
  • Added Cam4 Support