|
1 | | -<p align="center"> |
2 | | - <img src="Src/Assets/min_logo.png" style="max-width: 55%;" alt="video working" /> |
| 1 | +<p align="center" > |
| 2 | + <img src="./Src/Assets/min_logo.png" title="SDWebImage logo" float=left> |
3 | 3 | </p> |
4 | 4 |
|
5 | | -## Overview. |
| 5 | +# Overview. |
| 6 | + |
6 | 7 | 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. |
7 | 8 |
|
8 | 9 | ## Join us |
9 | | -You can chat, help improve this repo, or just hang around for some fun in the **Git_StreamingCommunity** Discord [Server](https://discord.gg/c3JSUM5Hqw) |
10 | | - |
| 10 | +You can chat, help improve this repo, or just hang around for some fun in the **Git_StreamingCommunity** Discord [Server](https://discord.gg/by8UsqhPWx) |
11 | 11 | # Table of Contents |
| 12 | + |
12 | 13 | * [INSTALLATION](#installation) |
13 | | - * [Requirement](#requirement) |
14 | | - * [Usage](#usage) |
15 | | - * [Update](#update) |
16 | 14 |
|
17 | | -* [FEATURES](#features) |
| 15 | + * [Requirement](#requirement) |
| 16 | + * [Usage](#usage) |
| 17 | + * [Update](#update) |
18 | 18 | * [USAGE AND OPTIONS](#options) |
19 | 19 | * [TUTORIAL](#tutorial) |
20 | 20 |
|
21 | 21 | ## Requirement |
| 22 | + |
22 | 23 | Make sure you have the following prerequisites installed on your system: |
| 24 | + |
23 | 25 | * python > [3.11](https://www.python.org/downloads/) |
24 | 26 | * ffmpeg [win](https://www.gyan.dev/ffmpeg/builds/) |
25 | 27 |
|
26 | | - |
27 | 28 | ## Installation |
| 29 | + |
28 | 30 | Install the required Python libraries using the following command: |
| 31 | + |
29 | 32 | ``` |
30 | 33 | pip install -r requirements.txt |
31 | 34 | ``` |
32 | 35 |
|
33 | 36 | ## Usage |
| 37 | + |
34 | 38 | Run the script with the following command: |
35 | 39 |
|
36 | 40 | #### On Windows: |
| 41 | + |
37 | 42 | ```powershell |
38 | 43 | python run.py |
39 | 44 | ``` |
40 | 45 |
|
41 | 46 | #### On Linux/MacOS: |
| 47 | + |
42 | 48 | ```bash |
43 | 49 | python3 run.py |
44 | 50 | ``` |
45 | 51 |
|
46 | | - |
47 | 52 | ## Update |
| 53 | + |
48 | 54 | Keep your script up to date with the latest features by running: |
49 | 55 |
|
50 | 56 | #### On Windows: |
| 57 | + |
51 | 58 | ```powershell |
52 | 59 | python update.py |
53 | 60 | ``` |
54 | 61 |
|
55 | 62 | #### On Linux/MacOS: |
| 63 | + |
56 | 64 | ```bash |
57 | 65 | python3 update.py |
58 | 66 | ``` |
59 | 67 |
|
60 | | - |
61 | | -## Features |
62 | | -- Download Single Film: Easily download individual movies with a simple command. |
63 | | -- Download Specific Episodes or Entire Series: Seamlessly retrieve specific episodes or entire series using intuitive commands. Specify a range of episodes with square brackets notation, e.g., [5-7], or download all episodes with an asterisk (*). |
64 | | -- Download Subtitles: Automatically fetch subtitles if available for downloaded content. (Note: To disable this feature, see [Configuration](#configuration)) |
65 | | -- Sync Audio and Video: Ensure perfect synchronization between audio and video during the download process for an enhanced viewing experience. |
66 | | - |
67 | 68 | ## Configuration |
| 69 | + |
68 | 70 | You can change some behaviors by tweaking the configuration file. |
69 | 71 |
|
70 | 72 | ```json |
71 | 73 | { |
72 | | - "root_path": "videos", |
73 | | - "movies_folder_name": "Movies", |
74 | | - "series_folder_name": "Series", |
75 | | - "download_subtitles": true, |
76 | | - "download_default_language": true, |
77 | | - "selected_language": "English", |
78 | | - "max_worker": 20 |
| 74 | + "DEFAULT": { |
| 75 | + "debug": false, |
| 76 | + "get_info": false, |
| 77 | + "show_message": true, |
| 78 | + "clean_console": true, |
| 79 | + "get_moment_title": false, |
| 80 | + "root_path": "videos", |
| 81 | + "movies_folder_name": "Movies", |
| 82 | + "series_folder_name": "Series", |
| 83 | + "anime_folder_name": "Anime", |
| 84 | + "not_close": false, |
| 85 | + "swith_anime": false |
| 86 | + }, |
| 87 | + "SITE": { |
| 88 | + "streaming_site_name": "streamingcommunity", |
| 89 | + "streaming_domain": "forum", |
| 90 | + "anime_site_name": "animeunity", |
| 91 | + "anime_domain": "to" |
| 92 | + }, |
| 93 | + "M3U8": { |
| 94 | + "tdqm_workers": 20, |
| 95 | + "tqdm_progress_timeout": 10, |
| 96 | + "minium_ts_files_in_folder": 15, |
| 97 | + "donwload_percentage": 1, |
| 98 | + "requests_timeout": 5, |
| 99 | + "enable_time_quit": false, |
| 100 | + "tqdm_show_progress": false, |
| 101 | + "cleanup_tmp_folder": true |
| 102 | + }, |
| 103 | + "M3U8_OPTIONS": { |
| 104 | + "download_audio": true, |
| 105 | + "download_subtitles": true, |
| 106 | + "specific_list_audio": [ |
| 107 | + "ita" |
| 108 | + ], |
| 109 | + "specific_list_subtitles": [ |
| 110 | + "eng" |
| 111 | + ], |
| 112 | + } |
79 | 113 | } |
80 | | - |
81 | 114 | ``` |
| 115 | + |
82 | 116 | #### Options |
83 | | -| Key | Default Value | Description | Value Example | |
84 | | -|---------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------------| |
85 | | -| root_path | videos | Path where the script will add movies and tv series folders (see [Path Examples](#Path-examples)). Do not put trailing slash. | media/streamingcommunity | |
86 | | -| movies_folder_name | Movies | The folder name where all the movies will be placed. Do not put trailing slash. | downloaded-movies | |
87 | | -| series_folder_name | Series | The folder name where all the TV Series will be placed. Do not put trailing slash. | mytvseries | |
88 | | -| download_subtitles | true | Whether or not you want all the found subtitles to be downloaded. | false | |
89 | | -| download_default_language | true | Whether or not you want to download only the default Italian audio language. | false | |
90 | | -| selected_language | English | If `"download_default_language"` is `False` the script will download this language. | French | |
91 | | -| max_worker | 20 | How many workers will cooperate to download .ts file. **High value may slow down your pc**. | 30 | |
| 117 | + |
| 118 | +| Key | Default Value | Description | Value Example | |
| 119 | +| -------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------ | |
| 120 | +| DEFAULT | | Contains default configuration options for users. | | |
| 121 | +| debug | false | Whether debugging information should be displayed or not. | true | |
| 122 | +| get_info | false | Whether additional information should be fetched or not with debug enable. | true | |
| 123 | +| show_message | true | Whether messages should be displayed to the user or not. | false | |
| 124 | +| clean_console | true | Whether the console should be cleared before displaying new information or not. | false | |
| 125 | +| get_moment_title | false | Whether to fetch the title of the moment or not. | true | |
| 126 | +| root_path | videos | Path where the script will add movies and TV series folders (see[Path Examples](#Path-examples)). | media/streamingcommunity | |
| 127 | +| movies_folder_name | Movies | The folder name where all the movies will be placed. Do not put a trailing slash. | downloaded-movies | |
| 128 | +| series_folder_name | Series | The folder name where all the TV series will be placed. Do not put a trailing slash. | mytvseries | |
| 129 | +| anime_folder_name | Anime | The folder name where all the anime will be placed. Do not put a trailing slash. | myanime | |
| 130 | +| not_close | false | Whether to keep the application running after completion or not. | true | |
| 131 | +| -------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------ | |
| 132 | +| SITE | | Contains site-specific configuration options. | | |
| 133 | +| streaming_domain | forum | The domain of the streaming site. | express | |
| 134 | +| anime_domain | to | The domain of the anime site. | estate | |
| 135 | +| -------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------ | |
| 136 | +| M3U8 | | Contains options specific to M3U8. | | |
| 137 | +| tdqm_workers | 20 | The number of workers that will cooperate to download .ts files.**A high value may slow down your PC** | 40 | |
| 138 | +| tqdm_progress_timeout | 10 | The timeout duration for progress display updates in seconds after quit download. | 5 | |
| 139 | +| minium_ts_files_in_folder | 15 | The minimum number of .ts files expected in a folder. | 10 | |
| 140 | +| donwload_percentage | 1 | The percentage of download completion required to consider the download complete. | 0.95 | |
| 141 | +| requests_timeout | 5 | The timeout duration for HTTP requests in seconds. | 10 | |
| 142 | +| enable_time_quit | false | Whether to enable quitting the download after a certain time period. | true | |
| 143 | +| tqdm_show_progress | false | Whether to show progress during downloads or not.**May slow down your PC** | true | |
| 144 | +| cleanup_tmp_folder | true | Whether to clean up temporary folders after processing or not. | false | |
| 145 | +| -------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------ | |
| 146 | +| M3U8_OPTIONS | | Contains options specific to M3U8 file format. | | |
| 147 | +| download_audio | true | Indicates whether audio files should be downloaded or not. | false | |
| 148 | +| download_subtitles | true | Indicates whether subtitles should be downloaded or not. | false | |
| 149 | +| specific_list_audio | ["ita"] | A list of specific audio languages to download. | ["eng", "fra"] | |
| 150 | +| specific_list_subtitles | ["eng"] | A list of specific subtitle languages to download. | ["spa", "por"] | |
92 | 151 |
|
93 | 152 | > [!IMPORTANT] |
94 | 153 | > If you're on **Windows** you'll need to use double black slashes. On Linux/MacOS, one slash is fine. |
|
0 commit comments