https://github.com/julianfbeck/twitch-downloader

Check if a streamer is online and automatically download the streams using yt-dlp
https://github.com/julianfbeck/twitch-downloader

Last synced: 13 days ago
JSON representation

Check if a streamer is online and automatically download the streams using yt-dlp

• Host: GitHub
• URL: https://github.com/julianfbeck/twitch-downloader
• Owner: julianfbeck
• Created: 2024-02-24T20:58:59.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-02T07:26:22.000Z (8 months ago)
• Last Synced: 2024-05-02T21:08:34.255Z (8 months ago)
• Language: Shell
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Twitch Stream Downloader and Notifier

This project consists of a script for automatically downloading live streams from a specified Twitch user and notifying a user via Telegram when a new stream is available. It utilizes `yt-dlp` for downloading streams and the Telegram API for sending notifications.

## Features

- **Automatic Stream Download**: Automatically detects and downloads live streams from a specified Twitch user.

- **Telegram Notifications**: Sends a notification via Telegram when a new stream is downloaded and available.

- **Move downloaded Streams**: Downloaded streams get moved to a specified output/mounted directory 

## Prerequisites

- Docker and/or Docker Compose

- A Telegram Bot Token and a Chat ID where notifications will be sent

## Setup

### Compose

1. Copy the `.env.sample` file to a new file named `.env`.

2. Open the `.env` file and replace the placeholder values with your actual data.

   - `TWITCH_USERNAME`: The Twitch username of the streamer you're interested in.

   - `BOT_TOKEN` and `CHAT_ID`: Your Telegram bot's token and the chat ID where you want to send notifications.

   - Adjust other settings as necessary.

3. Save the `.env` file. The application will use these environment variables when running.

### Docker

```

docker run -d \

  -e TWITCH_USERNAME='example_username' \

  -e DOWNLOAD_DIR='/usr/src/app/downloads' \

  -e MOUNTED_DRIVE='/mnt/mounted_drive' \

  -e CHECK_INTERVAL='300' \

  -e BOT_TOKEN='your_telegram_bot_token_here' \

  -e CHAT_ID='your_telegram_chat_id_here' \

  -v /path/to/your/local/downloads:/usr/src/app/downloads \

  -v /path/to/your/mounted_drive:/mnt/mounted_drive \

  --name twitch-downloader ghcr.io/julianfbeck/twitch-downloader:latest

```