TwitchDownloader/README.md

29 lines
1.8 KiB
Markdown
Raw Normal View History

2022-12-03 08:57:56 -05:00
# Twitch Archive
Inspired by https://github.com/EnterGin/Auto-Stream-Recording-Twitch
2022-12-03 09:00:40 -05:00
2022-12-05 11:21:39 -05:00
Python script to check, download live stream, VOD, chat and upload them to any cloud service supported by rclone.
2022-12-03 08:57:56 -05:00
## Requirements
- [Python 3](https://www.python.org/downloads/)
- [Streamlink](https://github.com/streamlink/streamlink)
## Getting started
1. Install Python 3
2. Install Streamlink
2022-12-05 11:21:39 -05:00
3. If you want to upload to any cloud service using rclone, [configure rclone](https://rclone.org/docs/#configure) (Doesnt need to download, the `rclone.exe` is avalible in [bin/rclone.exe](https://github.com/piero0920/Twitch-Archive/blob/main/bin/rclone.exe)).
2022-12-03 09:08:38 -05:00
4. `git clone https://github.com/piero0920/Twitch-Archive.git`
2022-12-03 08:57:56 -05:00
5. `cd Twitch-Archive`
6. `pip install -r requirements.txt`
7. Edit the `.env.sample` and rename it to `.env`
2022-12-03 09:04:15 -05:00
```.env
2022-12-03 08:57:56 -05:00
CLIENT-ID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
CLIENT-SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
OAUTH-PRIVATE-TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```
2022-12-05 11:21:39 -05:00
8. if you want to enable/disable more available options, edit `twitch-archive.py`
2022-12-03 08:57:56 -05:00
9. run `Python twitch-archive.py` or for multiple streamers `Python twitch-archive.py -u streamer`
## Features
2022-12-06 11:02:35 -05:00
- Auto records the live stream | [Streamlink](https://streamlink.github.io/)
- Downloads the VOD after stream ended | [Streamlink](https://streamlink.github.io/)
- Downloads the chat logs of the VOD and renders it | [TwitchDownloaderCLI](https://github.com/lay295/TwitchDownloader)
- Downloads the metadata of the VOD | [Twitch api](https://dev.twitch.tv/docs/api/reference#get-videos)
- Uploads them to the Cloud | [rclone](https://rclone.org/)
- Notifies you through Gmail of the progress | [smtplib](https://docs.python.org/3/library/smtplib.html)