Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jangxx/twitch-auto-recorder-3000
Automatically downloads streams from twitch as streamers go live
https://github.com/jangxx/twitch-auto-recorder-3000
Last synced: 3 months ago
JSON representation
Automatically downloads streams from twitch as streamers go live
- Host: GitHub
- URL: https://github.com/jangxx/twitch-auto-recorder-3000
- Owner: jangxx
- License: mit
- Created: 2022-01-09T16:27:09.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-17T15:38:49.000Z (11 months ago)
- Last Synced: 2024-05-29T23:20:20.943Z (6 months ago)
- Language: Python
- Size: 91.8 KB
- Stars: 18
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Twitch Auto Recorder 3000
A better way to automatically download streams from twitch as streamers go live.
> Note: Due to this projects reliance on [streamlink](https://github.com/streamlink/streamlink), the recording functionality might break in the future if twitch decides to change their API again.
Other services are also supported an can be used by prepending the service name to the username separated by an equals sign.
Currently these services are supported:
- `twitch`
- `vrcdn`
[](https://sonarcloud.io/summary/new_code?id=jangxx_twitch-auto-recorder-3000)
# Requirements
- Python >=3.7
- `ffmpeg` _if you want to use the ffmpeg plugin_
# Installation
Clone this repositoy and create a new virtualenv in its directory.
python3 -m venv venv
Activate the virtalenv
_Linux, macOS_:
source venv/bin/activate
_Windows_:
- Bash: `source venv/Scripts/activate`
- Powershell: `.\venv\Scripts\activate`
- CMD: `.\venv\Scripts\activate.bat`
and then install the required packages:
```bash
pip install -r requirements.txt
```
if you want to use the plugins, you also have to install their requirements as well:
```bash
pip install setuptools==57.5.0 # optionally run this in case the next line fails
pip install -r requirements-plugins.txt
```
# Usage
Activate the virtualenv and then run `python main.py` with some of these command line arguments:
`-h, --help`
Show help message and exit.
`--twitch-clientid `
**Optional:** Client ID of your twitch application (from the [Developer console](https://dev.twitch.tv/console/apps))
`--twitch-secret `
**Optional:** Client Secret of your twitch application (from the [Developer console](https://dev.twitch.tv/console/apps))
`-s `
**Required:** Add a username to the list of watched streamers.
The quality (for twitch) can be set by writing it after the username separated by a colon [username:quality].
The service is specified by writing it before the name separated by an equals sign [service=username].
`-C , --config `
**Optional:** Path to a config file in YAML format.
`-O , --output-path `
**Optional:** Path where the recordings are stored (Default: ./recordings)
`--update-interval `
**Optional:** Update interval in seconds (Default: 120)
`--update-end-interval `
**Optional:** Update interval in seconds after a recording has stopped but before it is finished (Default: 10).
This option only comes into play if `stream_end_timeout` is also used.
`--stream-end-timeout `
**Optional:** Time to wait after a recording ended before considering the stream as finished (Default: 0)
`--log `
**Optional:** Sets the loglevel, one of CRITICAL, ERROR, WARNING, INFO, DEBUG (Default: INFO)
`-c `
**Advanced:** Set a streamlink config option in the format `optionname:type=value`, e.g. `-c ipv4:bool=True` or `-c ffmpeg-ffmpeg:str=/usr/bin/ffmpeg`
`--print-config`
Print the config for debug purposes, to figure out if it got merged correctly.
Instead of supplying these values as command line arguments, you can also write a config file that contains all (or some) of them.
Options from the config file and the command line will be merged, with command line arguments taking precedence, so you can mix and match.
The config file uses this format:
```yaml
twitch:
clientid:
secret:
streamers:
-
- "="
streamlink_options:
-
-
plugins:
plugin_name:
option1:
option2:
# some plugins don't have configuration
# and just need an empty object here to be included
plugin2_name: {}
output_path:
update_interval:
update_end_interval:
stream_end_timeout:
Except for the plugin options, all configuration options can be set with command line arguments as well.
# Plugins
Plugins can add some additional postprocessing to your recordings. Two plugins are included in the _plugins/_ directory, which serve as the examples on how to write your own.
`ffmpeg_remux`
Automatically remuxes the recorded .ts file into a .mp4 (with qtfaststart for better streamability).
It has no config options, so it can be enabled with `-p ffmpeg_remux` or by adding `ffmpeg_remux: {}` to the plugin section of the config file.
_Note:_ For convenience there is also a clean-up script included in this project _cleanup_remuxed.py_, which takes the recording path as a parameter and which can be run as a cronjob to automatically and periodically delete the already remuxed .ts files.
`pushover`
This plugin uses [pushover](https://pushover.net) to send notifications about your recordings to your phone.
Since it needs configuration, it can only be enabled with the config file:
```yaml
plugins:
pushover:
user_key:
api_token:
```
You get your user key and an API token on the pushover website.
`discord_notifications`
This plugin sends notifications about your recordings to a Discord channel by utilizing the [Webhooks](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) feature.
Since it needs configuration, it can only be enabled with the config file:
```yaml
plugins:
discord_notifications:
webhook:
```