Skip to content

Latest commit

 

History

History
39 lines (34 loc) · 2.67 KB

readme.md

File metadata and controls

39 lines (34 loc) · 2.67 KB
Raw

what does it do

A simple bot that polls twitch for clips from a predefined list of streamers over the last hour and posts new clips to a discord webhook

included are:

  • a post script that sends a http post to a watchdog server of your choosing, wich wont happen if the url is left blank in the config
  • a http webserver running to use for uptime monitoring by having an approachable url wich can be checked with something like uptime kuma, NOTE must be integer, Can be left blank to disable.
  • remote logging capabilities with use of a discord webhook where debugging messages get posted, wich wont happen if the url is left blank in the config. Additionally a user or group id can be defined in the config so that group or user will be pinged if an error occurs, can also be left blank to disable
  • remote alerts on errors trough gotify, wich wont happen if the url is left blank in the config

how to use:

  1. install python on your system from the python website https://www.python.org/downloads/ (make sure you tick "install to path" if you intend to use the included start.bat)
  2. place all contents in a folder and make a "config" folder.
  3. make a config.json and copy the text below into the file
{
    "twitchClientId": "TWITCH_API_CLIENT_ID",
    "twitchSecret": "TWITCH_API_SECRET",
    "webhookurl": "MAIN_WEBHOOK_WHERE_CLIPS_GET_POSTED",
    "webhooklogurl": "WEBHOOK_TO_USE_TO_LOG_DEBUGGING_MESSAGES_TO_A_WEBHOOK/OPTIONAL",
    "webhookmonitorurl": "URL_FOR_REMOTE_MONITORING_SERVER/OPTIONAL",
    "gotifyurl": "URL_FOR_ALERTS_ON_ERRORS_TROUGH_GOTIFY/OPTIONAL",
    "pingid": "USER OR GROUP ID TO PING WHEN AN ERROR OCCURS/OPTIONAL",
    "botname": "NAME_VALUE_SEND_TO_REMOTE_MONITORING_SERVER/OPTIONAL",
    "posttimeout": "TIME_BETWEEN_POSTS_TO_REMOTE_MONITORING/OPTIONAL",
    "hostname": "ADRESS_FOR_LOCAL_WEBSERVER",
    "webport": PORT_FOR_LOCAL_WEBSERVER/OPTIONAL
    "vebose": "0, 1 or 2 (0 is basic logging, 1 is extensive logging, 2 is extensive logging with remote logging responses)"
}
  1. create a streamers.txt file in the config folder and add every streamer you want to poll on a new line, alternativly add the url to a txt file that contains the list to poll
  2. input the correct data and launch the script clipbot.py (start.bat on windows)
  • leave optional entries blank if you do not intent to use them but do include them otherwise the script will throw an error for example "webhooklogurl":""

Optionally a dockerfile is included wich can be used to build a docker image or use the one on my repository with the following code

docker run -dit --name clipbot -v /path/to/config:/usr/src/app/config -p <port for webserver>:<port defined in config> keyboardmedic/clipbot:latest