Update readme.md
This commit is contained in:
298
readme.md
298
readme.md
@@ -1,149 +1,149 @@
|
||||
# 📅 XC Downloader
|
||||
_Automated movie and series downloader for M3U IPTV playlists using aria2c_
|
||||
|
||||
---
|
||||
|
||||
## 📋 Requirements
|
||||
|
||||
- Python 3.8 or higher
|
||||
- `pip` (Python package manager)
|
||||
- `aria2c` executable in the project folder
|
||||
|
||||
### Python Libraries
|
||||
Installed easily with:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Installation
|
||||
|
||||
### Windows
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### Linux (Ubuntu/Debian)
|
||||
|
||||
```bash
|
||||
pip3 install -r requirements.txt
|
||||
```
|
||||
|
||||
> Make sure you are inside the folder where `requirements.txt` is located.
|
||||
|
||||
### Setup aria2c
|
||||
|
||||
1. Download `aria2c` from [Official Aria2 Releases](https://github.com/aria2/aria2/releases)
|
||||
2. Place it into the same directory as `downloader.py`
|
||||
- Windows ➔ `aria2c.exe`
|
||||
- Linux ➔ `aria2c` (then run `chmod +x aria2c`)
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Usage
|
||||
|
||||
### Run the Script
|
||||
|
||||
- **Windows**:
|
||||
|
||||
```bash
|
||||
python downloader.py
|
||||
```
|
||||
|
||||
- **Linux**:
|
||||
|
||||
```bash
|
||||
python3 downloader.py
|
||||
```
|
||||
or if executable:
|
||||
```bash
|
||||
./downloader.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✏️ How to Use
|
||||
|
||||
1. After launch, you’ll see the banner:
|
||||
|
||||
```
|
||||
XC Downloader
|
||||
by redhat@woi
|
||||
```
|
||||
|
||||
2. Enter your IPTV credentials:
|
||||
- Server URL and Port
|
||||
- Username
|
||||
- Password
|
||||
- Max concurrent downloads
|
||||
|
||||
3. If credentials fail, you will see an **error in red** and will be prompted again.
|
||||
|
||||
4. On success, the **Main Menu** appears:
|
||||
```
|
||||
1. Show Movies Categories
|
||||
2. Show Series Categories
|
||||
3. Download all Movies
|
||||
4. Download all Series
|
||||
5. Exit
|
||||
```
|
||||
|
||||
5. Browse categories, select movies or series, and start downloading!
|
||||
|
||||
---
|
||||
|
||||
## 📂 Folder Structure
|
||||
|
||||
- Movies are saved as:
|
||||
|
||||
```
|
||||
Movies/<Category>/<Movie Title>/<MovieFile>.mkv
|
||||
```
|
||||
|
||||
- Series are saved as:
|
||||
|
||||
```
|
||||
Series/<Category>/<Series Name>/<Season>/<Episode>/<EpisodeFile>.mkv
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Features
|
||||
|
||||
- Supports both **Movies** and **Series** separately.
|
||||
- Organizes downloads into category folders automatically.
|
||||
- Resume support for partially downloaded files.
|
||||
- Supports **single connection** servers.
|
||||
- Works on **Windows** and **Linux** without code change.
|
||||
- Colored error messages using `colorama`.
|
||||
- Beautiful ASCII banner using `pyfiglet`.
|
||||
|
||||
---
|
||||
|
||||
## 🛠 Troubleshooting
|
||||
|
||||
- If `aria2c` download speed is slow with `1 connection`, it’s due to server restrictions (cannot be improved beyond a limit).
|
||||
- If Python throws a missing package error, re-run:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
- On Linux, don't forget:
|
||||
```bash
|
||||
chmod +x aria2c
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧐 Credits
|
||||
|
||||
Created by **redhat@woi**
|
||||
Special thanks to `pyfiglet`, `aria2c`, and `colorama` libraries!
|
||||
|
||||
---
|
||||
|
||||
# ✨ Enjoy fast and organized downloading! ✨
|
||||
# 📅 XC Downloader
|
||||
_Automated movie and series downloader for M3U IPTV playlists using aria2c_
|
||||
|
||||
---
|
||||
|
||||
## 📋 Requirements
|
||||
|
||||
- Python 3.8 or higher
|
||||
- `pip` (Python package manager)
|
||||
- `aria2c` executable in the project folder
|
||||
|
||||
### Python Libraries
|
||||
Installed easily with:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Installation
|
||||
|
||||
### Windows
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### Linux (Ubuntu/Debian)
|
||||
|
||||
```bash
|
||||
pip3 install -r requirements.txt
|
||||
```
|
||||
|
||||
> Make sure you are inside the folder where `requirements.txt` is located.
|
||||
|
||||
### Setup aria2c (only if nessary, aria2c v1.3.7 for Windows and Linux 64 OS is already inluded)
|
||||
|
||||
1. Download `aria2c` from [Official Aria2 Releases](https://github.com/aria2/aria2/releases)
|
||||
2. Place it into the same directory as `downloader.py`
|
||||
- Windows ➔ `aria2c.exe`
|
||||
- Linux ➔ `aria2c` (then run `chmod +x aria2c`)
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Usage
|
||||
|
||||
### Run the Script
|
||||
|
||||
- **Windows**:
|
||||
|
||||
```bash
|
||||
python downloader.py
|
||||
```
|
||||
|
||||
- **Linux**:
|
||||
|
||||
```bash
|
||||
python3 downloader.py
|
||||
```
|
||||
or if executable:
|
||||
```bash
|
||||
./downloader.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✏️ How to Use
|
||||
|
||||
1. After launch, you’ll see the banner:
|
||||
|
||||
```
|
||||
XC Downloader
|
||||
by redhat@woi
|
||||
```
|
||||
|
||||
2. Enter your IPTV credentials:
|
||||
- Server URL and Port
|
||||
- Username
|
||||
- Password
|
||||
- Max concurrent downloads
|
||||
|
||||
3. If credentials fail, you will see an **error in red** and will be prompted again.
|
||||
|
||||
4. On success, the **Main Menu** appears:
|
||||
```
|
||||
1. Show Movies Categories
|
||||
2. Show Series Categories
|
||||
3. Download all Movies
|
||||
4. Download all Series
|
||||
5. Exit
|
||||
```
|
||||
|
||||
5. Browse categories, select movies or series, and start downloading!
|
||||
|
||||
---
|
||||
|
||||
## 📂 Folder Structure
|
||||
|
||||
- Movies are saved as:
|
||||
|
||||
```
|
||||
Movies/<Category>/<Movie Title>/<MovieFile>.mkv
|
||||
```
|
||||
|
||||
- Series are saved as:
|
||||
|
||||
```
|
||||
Series/<Category>/<Series Name>/<Season>/<Episode>/<EpisodeFile>.mkv
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Features
|
||||
|
||||
- Supports both **Movies** and **Series** separately.
|
||||
- Organizes downloads into category folders automatically.
|
||||
- Resume support for partially downloaded files.
|
||||
- Supports **single connection** servers.
|
||||
- Works on **Windows** and **Linux** without code change.
|
||||
- Colored error messages using `colorama`.
|
||||
- Beautiful ASCII banner using `pyfiglet`.
|
||||
|
||||
---
|
||||
|
||||
## 🛠 Troubleshooting
|
||||
|
||||
- If `aria2c` download speed is slow with `1 connection`, it’s due to server restrictions (cannot be improved beyond a limit).
|
||||
- If Python throws a missing package error, re-run:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
- On Linux, don't forget:
|
||||
```bash
|
||||
chmod +x aria2c
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧐 Credits
|
||||
|
||||
Created by **redhat@woi**
|
||||
Special thanks to `pyfiglet`, `aria2c`, and `colorama` libraries!
|
||||
|
||||
---
|
||||
|
||||
# ✨ Enjoy fast and organized downloading! ✨
|
||||
|
||||
Reference in New Issue
Block a user