TwitchVault

Simplified tool to automatically archive VODs, clips, highlights, including associated chat logs for specified Twitch channels

Concept

My personal goal has been to find or develop a tool that can not only automate archiving the latest VODs, clips, and highlights from selected Twitch channels, but also archiving the chat logs as they are available for each medium.

goldbattle's Twitch VOD Creator had everything needed to accomplish this with just a little bit of unneeded cruft on top. This repo has been heavily modified from that and slimmed down to the core functions: Automatically download available VODs, highlights, uploads, and clips for selected channels. Additionally the added ability to download chat logs for each video, optionally rendering the chat to video through TwitchDownloaderCLI's render function. As a bonus, Speech-to-Text exists from the original code via the Vosk speech recognition API. This has been maintained with this fork as an optional tool.

Install Guide

0) Ensure Python 3.6 or higher is installed. 1) Clone this repository:

• git clone https://github.com/cr08/TwitchVault 2) Install main python dependencies:
• python3 -m pip install --user -r requirements.txt 3) Download and place TwitchDownloaderCLI for your platform into /thirdparty
• Latest release recommended, minimum 1.50.7 required. Code has been updated to use new mode syntax introduced in this version.
• Ensure TwitchDownloaderCLI is set as executable. This may be necessary on *nix platforms
  • chmod +x thirdparty/TwitchDownloaderCLI
  • If on a stripped distro such as an LXC container, ensure to install the available libicuXX package available as it appears to be required by TDCLI. 4) Copy and fill out all config/*.yaml.example files as necessary.
• An application needs to be registered with Twitch from the Twitch Dev console - client ID and secret need to be entered into config/config.yaml 5) Run scripts as desired:
• python3 videos.py
• python3 clips.py

Optional tasks

• Linux targets: Add scripts to crontab using docs/crontab_script_launcher.sh and ensure to mark the launcher script executable
  • chmod +x ./docs/crontab_script_launcher.sh
  • sudo crontab -e

  • */25 * * * * /path/to/repo/docs/crontab_script_launcher.sh videos.py
    * */12 * * * /path/to/repo/docs/crontab_script_launcher.sh clips.py

• For SRT transcription: Download Vosk Speech Recognition model and extract to ./thirdparty/, pointing path_model variable in videos.py to this folder.
  • vosk-model-small-en-us-<ver> highly recommended for English speaking content and is referenced by default. Low resource usage and decent accuracy. Full size models in testing have high resource usage requirements (6GB+ free RAM and a high end CPU). These can be used at your own discretion but support will be limited here.

    ---

    Known Issues

• None at this time...

Credit & Attribution

This repo has been heavily modified from goldbattle's Twitch VOD Creator - All credit and attribution as well as a huge amount of thanks goes out to them for creating the core functionality of automatically retrieving the requisite content from Twitch.