mirror of
https://github.com/Arrowar/StreamingCommunity.git
synced 2025-06-08 04:25:24 +00:00
210 lines
6.6 KiB
Markdown
210 lines
6.6 KiB
Markdown
<p align="center" >
|
|
<img src="./Src/Assets/min_logo.png" title="SDWebImage logo" float=left>
|
|
</p>
|
|
|
|
# Overview.
|
|
|
|
This repository provide a simple script designed to facilitate the downloading of films and series from a popular streaming community platform. The script allows users to download individual films, entire series, or specific episodes, providing a seamless experience for content consumers.
|
|
|
|
## Join us
|
|
You can chat, help improve this repo, or just hang around for some fun in the **Git_StreamingCommunity** Discord [Server](https://discord.gg/PtMX28v5)
|
|
# Table of Contents
|
|
|
|
* [INSTALLATION](#installation)
|
|
* [Requirement](#requirement)
|
|
* [Usage](#usage)
|
|
* [Update](#update)
|
|
* [CONFIGURATION](#Configuration)
|
|
* [DOCKER](#docker)
|
|
* [TUTORIAL](#tutorial)
|
|
|
|
## Requirement
|
|
|
|
Make sure you have the following prerequisites installed on your system:
|
|
|
|
* python > [3.11](https://www.python.org/downloads/)
|
|
* ffmpeg [win](https://www.gyan.dev/ffmpeg/builds/)
|
|
|
|
## Installation
|
|
|
|
Install the required Python libraries using the following command:
|
|
|
|
```
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
## Usage
|
|
|
|
Run the script with the following command:
|
|
|
|
#### On Windows:
|
|
|
|
```powershell
|
|
python run.py
|
|
```
|
|
|
|
#### On Linux/MacOS:
|
|
|
|
```bash
|
|
python3 run.py
|
|
```
|
|
|
|
## Update
|
|
|
|
Keep your script up to date with the latest features by running:
|
|
|
|
#### On Windows:
|
|
|
|
```powershell
|
|
python update.py
|
|
```
|
|
|
|
#### On Linux/MacOS:
|
|
|
|
```bash
|
|
python3 update.py
|
|
```
|
|
|
|
## Configuration
|
|
|
|
You can change some behaviors by tweaking the configuration file.
|
|
|
|
### Options (DEFAULT)
|
|
|
|
* debug: Whether debugging information should be displayed or not.
|
|
- Default Value: false
|
|
|
|
* get_info: Whether additional information should be fetched or not with debug enabled.
|
|
- Default Value: false
|
|
|
|
* show_message: Whether messages should be displayed to the user or not.
|
|
- Default Value: true
|
|
|
|
* clean_console: Whether the console should be cleared before displaying new information or not.
|
|
- Default Value: true
|
|
|
|
* get_moment_title: Whether to fetch the title of the moment or not.
|
|
- Default Value: false
|
|
|
|
* root_path: Path where the script will add movies and TV series folders (see [Path Examples](#Path-examples)).
|
|
- Default Value: media/streamingcommunity
|
|
- Example Value: /path/to/root
|
|
|
|
* movies_folder_name: The folder name where all the movies will be placed. Do not put a trailing slash.
|
|
- Default Value: downloaded-movies
|
|
- Example Value: Movies
|
|
|
|
* series_folder_name: The folder name where all the TV series will be placed. Do not put a trailing slash.
|
|
- Default Value: mytvseries
|
|
- Example Value: Series
|
|
|
|
* anime_folder_name: The folder name where all the anime will be placed. Do not put a trailing slash.
|
|
- Default Value: myanime
|
|
- Example Value: Anime
|
|
|
|
* not_close: Whether to keep the application running after completion or not.
|
|
- Default Value: false
|
|
|
|
### Options (SITE)
|
|
|
|
* streaming_domain: The domain of the streaming site.
|
|
- Default Value: forum
|
|
- Example Value: express
|
|
|
|
* anime_domain: The domain of the anime site.
|
|
- Default Value: to
|
|
- Example Value: estate
|
|
|
|
### Options (M3U8)
|
|
|
|
* tdqm_workers: The number of workers that will cooperate to download .ts files. **A high value may slow down your PC**
|
|
- Default Value: 20
|
|
|
|
* tqdm_progress_timeout: The timeout duration for progress display updates in seconds after quit download.
|
|
- Default Value: 10
|
|
|
|
* minimum_ts_files_in_folder: The minimum number of .ts files expected in a folder.
|
|
- Default Value: 15
|
|
|
|
* download_percentage: The percentage of download completion required to consider the download complete.
|
|
- Default Value: 1
|
|
- Example Value: 0.95
|
|
|
|
* requests_timeout: The timeout duration for HTTP requests in seconds.
|
|
- Default Value: 5
|
|
|
|
* use_openssl: Indicates whether OpenSSL should be utilized for encryption during the conversion of TS files with key and IV.
|
|
- Default Value: false
|
|
|
|
* use_codecs: Specifies whether specific codecs (e.g., h264 for video, AAC for audio) should be used for converting TS files to MP4. **May slow down your PC**
|
|
- Default Value: false
|
|
|
|
* enable_time_quit: Whether to enable quitting the download after a certain time period.
|
|
- Default Value: false
|
|
|
|
* tqdm_show_progress: Whether to show progress during downloads or not. **May slow down your PC**
|
|
- Default Value: false
|
|
|
|
* cleanup_tmp_folder: Whether to clean up temporary folders after processing or not.
|
|
- Default Value: true
|
|
|
|
### Options (M3U8_OPTIONS)
|
|
|
|
* download_audio: Indicates whether audio files should be downloaded or not.
|
|
- Default Value: true
|
|
|
|
* download_subtitles: Indicates whether subtitles should be downloaded or not.
|
|
- Default Value: true
|
|
|
|
* merge_subtitles: Indicates if you want to merge subs in mp4 file or separate files .vtt
|
|
- Default Value: true
|
|
|
|
* specific_list_audio: A list of specific audio languages to download.
|
|
- Default Value: ["ita"]
|
|
- Example Value: ["eng", "fra"]
|
|
|
|
* specific_list_subtitles: A list of specific subtitle languages to download.
|
|
- Default Value: ["eng"]
|
|
- Example Value: ["spa", "por"]
|
|
|
|
* map_episode_name: Mapping to choose the name of all episodes of TV Shows (see [Episode Name Usage](#Episode-name-usage)).
|
|
- Default Value: %(tv_name)_S%(season)E%(episode)_%(episode_name)
|
|
- Example Value: %(tv_name) [S%(season)] [E%(episode)] %(episode_name)
|
|
|
|
> [!IMPORTANT]
|
|
> If you're on **Windows** you'll need to use double black slashes. On Linux/MacOS, one slash is fine.
|
|
|
|
#### Path examples:
|
|
|
|
* Windows: `C:\\MyLibrary\\Folder` or `\\\\MyServer\\MyLibrary` (if you want to use a network folder).
|
|
* Linux/MacOS: `Desktop/MyLibrary/Folder`
|
|
|
|
#### Episode name usage:
|
|
You can choose different vars:
|
|
* `%(tv_name)` : Is the name of TV Show
|
|
* `%(season)` : Is the number of the season
|
|
* `%(episode)` : Is the number of the episode
|
|
* `%(episode_name)` : Is the name of the episode
|
|
>NOTE: You don't need to add .mp4 at the end
|
|
|
|
## Docker
|
|
You can run the script in a docker container, to build the image just run
|
|
```
|
|
docker build -t streaming-community-api .
|
|
```
|
|
|
|
and to run it use
|
|
|
|
```
|
|
docker run -it -p 8000:8000 streaming-community-api
|
|
```
|
|
|
|
By default the videos will be saved in `/app/Video` inside the container, if you want to to save them in your machine instead of the container just run
|
|
|
|
```
|
|
docker run -it -p 8000:8000 -v /path/to/download:/app/Video streaming-community-api
|
|
```
|
|
|
|
## Tutorial
|
|
For a detailed walkthrough, refer to the [video tutorial](https://www.youtube.com/watch?v=Ok7hQCgxqLg&ab_channel=Nothing)
|