Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ancalentari/twitch-stream-recorder
Record twitch streams live!
https://github.com/ancalentari/twitch-stream-recorder
streamlink twitch twitch-api-helix
Last synced: 26 days ago
JSON representation
Record twitch streams live!
- Host: GitHub
- URL: https://github.com/ancalentari/twitch-stream-recorder
- Owner: ancalentari
- License: mit
- Created: 2020-06-06T18:24:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-20T07:01:49.000Z (11 months ago)
- Last Synced: 2024-08-03T13:01:56.099Z (4 months ago)
- Topics: streamlink, twitch, twitch-api-helix
- Language: Python
- Homepage:
- Size: 28.3 KB
- Stars: 246
- Watchers: 16
- Forks: 69
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-twitch-dev - ancalentari/twitch-stream-recorder - Record twitch streams live! (Libraries / Python)
README
# Ancalentari Twitch Stream Recorder
This script allows you to record twitch streams live to .mp4 files.
It is an improved version of [junian's twitch-recorder](https://gist.github.com/junian/b41dd8e544bf0e3980c971b0d015f5f6), migrated to [**helix**](https://dev.twitch.tv/docs/api) - the new twitch API. It uses OAuth2.
## Requirements
1. [python3.8](https://www.python.org/downloads/release/python-380/) or higher
2. [streamlink](https://streamlink.github.io/)
3. [ffmpeg](https://ffmpeg.org/)
## Setting up
1) Check if you have latest version of streamlink:
* `streamlink --version` shows current version
* `streamlink --version-check` shows available upgrade
* `sudo pip install --upgrade streamlink` do upgrade
2) Install `requests` module [if you don't have it](https://pypi.org/project/requests/)
* Windows: ```python -m pip install requests```
* Linux: ```python3.8 -m pip install requests```
3) Create `config.py` file in the same directory as `twitch-recorder.py` with:
```properties
root_path = "/home/abathur/Videos/twitch"
username = "forsen"
client_id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
client_secret = "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
```
`root_path` - path to a folder where you want your VODs to be saved to
`username` - name of the streamer you want to record by default
`client_id` - you can grab this from [here](https://dev.twitch.tv/console/apps) once you register your application
`client_secret` - you generate this [here](https://dev.twitch.tv/console/apps) as well, for your registered application
## Running script
The script will be logging to a console and to a file `twitch-recorder.log`
### On linux
Run the script
```shell script
python3.8 twitch-recorder.py
```
To record a specific streamer use `-u` or `--username`
```shell script
python3.8 twitch-recorder.py --username forsen
```
To specify quality use `-q` or `--quality`
```shell script
python3.8 twitch-recorder.py --quality 720p
```
To change default logging use `-l`, `--log` or `--logging`
```shell script
python3.8 twitch-recorder.py --log warn
```
To disable ffmpeg processing (fixing errors in recorded file) use `--disable-ffmpeg`
```shell script
python3.8 twitch-recorder.py --disable-ffmpeg
```
If you want to run the script as a job in the background and be able to close the terminal:
```shell script
nohup python3.8 twitch-recorder.py >/dev/null 2>&1 &
```
In order to kill the job, you first list them all:
```shell script
jobs
```
The output should show something like this:
```shell script
[1]+ Running nohup python3.8 twitch-recorder > /dev/null 2>&1 &
```
And now you can just kill the job:
```shell script
kill %1
```
### On Windows
You can run the scipt from `cmd` or [terminal](https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701?activetab=pivot:overviewtab), by simply going to the directory where the script is located at and using command:
```shell script
python twitch-recorder.py
```
The optional parameters should work exactly the same as on Linux.