Skip to content

Commit 9bada2d

Browse files
committed
docs: update README and CLI version to 0.2
1 parent ac3c8e1 commit 9bada2d

2 files changed

Lines changed: 48 additions & 29 deletions

File tree

README.md

Lines changed: 46 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,42 @@
11
# E(X)Hentai Downloader
22

3+
A manga downloader for e-hentai.org and exhentai.org, written in Rust.
34

4-
**Download Manga from e-hentai/exhentai**
5+
## Features
56

6-
Be careful, the E(x)Hentai website has image limit for user(It can be viewd at your ehentai home page)
7-
8-
![limit](https://i.imgur.com/OglhmK5.png)
9-
10-
So, you will take hours to recover if you exceed this image limit.
7+
- Multi-threaded downloading for maximum speed
8+
- Automatic retry with verification (up to 5 attempts)
9+
- Supports both e-hentai.org and exhentai.org
10+
- Cross-platform: Linux, macOS, Windows
1111

1212
## Installation
1313

14-
There have two way to install this downloader, the first one is you can directly donwload it from Release page, or the other is compile it by yourself.
14+
### Download Pre-built Binary
1515

16-
Support `Linux`, `Windows` right now.
16+
Download the latest release from the [Releases](https://github.com/rniczh/hentai-downloader/releases) page.
1717

18-
## Compilation
18+
| Platform | Download |
19+
|----------|----------|
20+
| Linux (x64) | `hentai-downloader-x86_64-unknown-linux-gnu.tar.gz` |
21+
| macOS (Intel) | `hentai-downloader-x86_64-apple-darwin.tar.gz` |
22+
| macOS (Apple Silicon) | `hentai-downloader-aarch64-apple-darwin.tar.gz` |
23+
| Windows (x64) | `hentai-downloader-x86_64-pc-windows-msvc.zip` |
1924

20-
Make sure you have installed `rustup`, link: https://rustup.rs/
25+
### Build from Source
2126

22-
and input this command:
27+
Make sure you have [Rust](https://rustup.rs/) installed, then run:
2328

24-
```
29+
```bash
2530
cargo build --release
2631
```
2732

28-
Then the exectable will placed in target/release/hentai-downloader
33+
The executable will be at `target/release/hentai-downloader`.
2934

3035
## Usage
3136

32-
See `hentai-downloader --help` for help.
33-
3437
```
35-
hentai-downloader 0.1
36-
H.-S Zheng <mathan0203@gmail.com>
38+
hentai-downloader 0.2
39+
Hongsheng Zheng <mathan0203@gmail.com>
3740
Download the Manga from e(x)hentai website.
3841
3942
USAGE:
@@ -45,25 +48,41 @@ FLAGS:
4548
4649
OPTIONS:
4750
-c, --cookie <file> The cookie file for access exhentai.org
48-
-u, --url <url> The url of Manga for which you want to downloa
51+
-u, --url <url> The url of Manga for which you want to download
52+
```
4953

54+
### Examples
55+
56+
**Download from e-hentai.org:**
57+
58+
```bash
59+
hentai-downloader -u https://e-hentai.org/g/12345/abcdef/
5060
```
5161

62+
**Download from exhentai.org (requires cookie):**
5263

53-
**Example.**
64+
```bash
65+
hentai-downloader -u https://exhentai.org/g/12345/abcdef/ -c cookie.txt
66+
```
5467

55-
`hentai-downloader -u https://e-hentai.org/g/12345/hijklmn/ `
68+
Downloaded files will be saved to `tmp{gallery_id}/` directory.
5669

57-
And it will download the Manga into tmp12345 directory
70+
## Cookie Setup (for exhentai.org)
5871

59-
If you are exhentai user then you can provide you cookie file with `-c ` option
72+
To access exhentai.org, you need to provide your session cookies.
6073

61-
`hentai-downloader -u https://exhentai.org/g/12345/hijklmn/ -c cookie.txt`
74+
1. Log in to exhentai.org in your browser
75+
2. Open Developer Tools (F12) -> Storage/Application -> Cookies
76+
3. Copy the cookie values and save to `cookie.txt`:
6277

63-
## Cookies
78+
```
79+
ipb_member_id=YOUR_ID; ipb_pass_hash=YOUR_HASH; igneous=YOUR_IGNEOUS
80+
```
6481

65-
How to get the cookie.txt ?
82+
## Notice
6683

67-
Copy this information (take FireFox as example) to cookie.txt
84+
E(X)Hentai has an implicit image viewing limit per user.
85+
If you exceed this limit, you'll need to wait several hours for it to recover.
6886

69-
![example](https://i.imgur.com/kUBPTyn.png)
87+
## License
88+
GPL-3.0 license

src/cli.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: hentai-downloader
2-
version: "0.1"
3-
author: H.-S Zheng <mathan0203@gmail.com>
2+
version: "0.2"
3+
author: Hongsheng Zheng <mathan0203@gmail.com>
44
about: Download the Manga from e(x)hentai website.
55
args:
66
- cookie:

0 commit comments

Comments
 (0)