Skip to content

Commit da8a70d

Browse files
committed
Merge branch 'docs-update-help-and-readme'
2 parents 8693454 + 5e34b43 commit da8a70d

File tree

2 files changed

+121
-34
lines changed

2 files changed

+121
-34
lines changed

README.md

Lines changed: 117 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,131 @@
1+
12
# voe-dl
2-
A Python downloader for voe.sx videos
33

4-
# Warning
4+
A Python-based downloader for videos hosted on [voe.sx](https://voe.sx).
55

6-
**Please use always the newest Version, because these suckers at voe change their site from time to time
7-
to make it harder for us to download via script!**
8-
**Currently working Version is v1.2.4**
6+
[![Latest Release](https://img.shields.io/github/v/release/p4ul17/voe-dl)](https://github.com/p4ul17/voe-dl/releases)
97

10-
# Usage
11-
1. Download the latest Release
12-
2. add the executable to PATH (just search for how to do it if you don't know)
13-
3. use the:
8+
---
149

15-
### Single File Downloader
16-
```
17-
voe-dl [URL]
18-
voe-dl -u [URL]
10+
## ⚠️ Always Use the Latest Version
11+
12+
> Voe frequently updates their website to break download scripts.
13+
> **Make sure you are using the latest version** of `voe-dl` to ensure compatibility.
14+
15+
---
16+
17+
## 📥 How to Use `voe-dl`
18+
19+
### Method 1: Using `voe-dl.exe`
20+
21+
1. **Open Command Prompt**
22+
Press `Win + R`, type `cmd`, and press Enter.
23+
24+
2. **Navigate to the folder with `voe-dl.exe`**
25+
Example:
26+
```cmd
27+
cd "C:\Users\YourName\Downloads"
28+
```
29+
30+
3. **Download a video**
31+
```cmd
32+
voe-dl.exe -u https://voe.sx/yourvideo
33+
```
34+
35+
> 📝 You don’t need to add `voe-dl.exe` to your system PATH. Just navigate to the folder in CMD.
36+
37+
---
38+
39+
### Method 2: Running from Python Source Code
40+
41+
1. **Install Python**
42+
[Download Python](https://www.python.org/downloads) and make sure to check the box:
43+
- ✅ "Add Python to PATH"
44+
45+
2. **Clone or download the repository**
46+
47+
3. **Install requirements**
48+
In the project folder:
49+
```cmd
50+
pip install -r requirements.txt
51+
```
52+
53+
4. **Run the script**
54+
```cmd
55+
python dl.py -u https://voe.sx/yourvideo
56+
```
57+
58+
5. **See all options**
59+
```cmd
60+
python dl.py -h
61+
```
62+
63+
---
64+
65+
## 📄 Command Line Usage
66+
67+
### Download Single Video
68+
```bash
69+
voe-dl -u https://voe.sx/yourvideo
1970
```
20-
21-
whereas [URL] is the Link to the voe site\
22-
just downloads the link you specify
23-
24-
### Multiple File Downloader
25-
Put your links in [links.txt] or any other File, one at each line\
26-
example:
71+
72+
### Download from a list (batch)
73+
Create a `links.txt` file:
2774
```
28-
https://voe.sx//xxxxxxx
29-
https://voe.sx//yyyyyyy
30-
https://voe.sx//zzzzzzz
75+
https://voe.sx/xxxxxxx
76+
https://voe.sx/yyyyyyy
3177
```
32-
execute
78+
79+
Run:
80+
```bash
81+
voe-dl -l links.txt
3382
```
34-
voe-dl -l [File_Name]
83+
84+
### Optional: Parallel Downloads
85+
You can add the `-w` option to set number of parallel workers:
86+
```bash
87+
voe-dl -l links.txt -w 8
3588
```
36-
It will download the links one after another
37-
38-
# Output
39-
The Output Video Files will be saved in the folder you execute the script
89+
(Default is 4)
90+
91+
---
92+
93+
## 📂 Output
94+
95+
Downloaded videos will be saved in the same folder where you run the command.
96+
97+
---
98+
99+
## 🛠 Common Errors & Fixes
100+
101+
### ❌ SyntaxError when pasting into Python
102+
Make sure you run commands in **CMD/Terminal**, not in the Python shell (`>>>` prompt).
40103

41-
# Help
42-
execute
104+
### ❌ CMD window closes instantly
105+
Open CMD manually and run the tool from there to see error output.
106+
107+
### `requests.exceptions.InvalidSchema`
108+
Make sure the URL is valid and doesn't contain brackets or formatting issues.
109+
110+
✅ Correct:
111+
```
112+
https://voe.sx/fi3fqtyh7932
43113
```
114+
115+
### ❌ No connection adapter found
116+
Ensure the URL starts with `http://` or `https://` and doesn't contain strange characters.
117+
118+
---
119+
120+
## 🆘 Help
121+
Run:
122+
```bash
44123
voe-dl -h
45124
```
46-
for help directly from the script
125+
This will print all available options, arguments, and descriptions.
126+
127+
---
128+
129+
## 💡 Contributing
130+
131+
Pull requests are welcome! If you fix a bug or add a feature, please update the README accordingly.

dl.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,8 @@ def main():
8181

8282
def help():
8383
print("Version History:")
84-
print("- Version v1.5.0 (Latest, Improved source detection and bait handling)")
84+
print("- Version v1.5.1 (Documentation updates: help descriptions, README usage info)")
85+
print("- Version v1.5.0 (Improved source detection and bait handling)")
8586
print("- Version v1.4.0 (Forked by MPZ-00)")
8687
print("- Version v1.3.1 (Forked by HerobrineTV, Fixed issues with finding the Download Links)")
8788
print("")
@@ -90,10 +91,11 @@ def help():
9091
print("-h shows this help")
9192
print("-u <URL> downloads the <URL> you specify")
9293
print("-l <doc> opens the <doc> you specify and downloads every URL line after line")
94+
print("-w <number> sets the number of parallel workers for list downloads (default: 4)")
9395
print("<URL> just the URL as Argument works the same as with -u Argument")
9496
print("______________")
9597
print("")
96-
print("Credits to @NikOverflow, @cuitrlal and @cybersnash on GitHub for contributing")
98+
print("Credits to @NikOverflow, @cuitrlal, @cybersnash, @HerobrineTV and @MPZ-00 on GitHub for contributing")
9799

98100
def list_dl(doc, workers=4):
99101
"""

0 commit comments

Comments
 (0)