From 510ae5e1d19f48fb5d739965ae8f21cbfcbd59b3 Mon Sep 17 00:00:00 2001
From: Yuvi9587 <114073886+Yuvi9587@users.noreply.github.com>
Date: Wed, 27 Aug 2025 19:59:11 -0700
Subject: [PATCH] Update readme.md
---
readme.md | 202 +++++++++++++++++++++---------------------------------
1 file changed, 78 insertions(+), 124 deletions(-)
diff --git a/readme.md b/readme.md
index b107473..c557cc0 100644
--- a/readme.md
+++ b/readme.md
@@ -1,162 +1,116 @@
-Kemono Downloader
+Kemono Downloader
----
+
-A powerful, feature-rich GUI application for downloading content from **[Kemono.su](https://kemono.su)** (and its mirrors like kemono.party) and **[Coomer.party](https://coomer.party)** (and its mirrors like coomer.su).
-
-Built with PyQt5, this tool is designed for users who want deep filtering capabilities, customizable folder structures, efficient downloads, and intelligent automation β all within a modern and user-friendly graphical interface.
+A powerful, feature-rich GUI application for downloading content from a wide array of sites, including Kemono, Coomer, Bunkr, Erome, Saint2.su, and nhentai.
+Built with PyQt5, this tool is designed for users who want deep filtering capabilities, customizable folder structures, efficient downloads, and intelligent automation β all within a modern and user-friendly graphical interface.
-
-[](features.md)
-[](LICENSE)
-[](note.md)
-
+
+
+
Core Capabilities Overview
-
-High-Performance Downloading
+Core Capabilities Overview
+High-Performance & Resilient Downloading
- Multi-threading: Processes multiple posts simultaneously to greatly accelerate downloads from large creator profiles.
- Multi-part Downloading: Splits large files into chunks and downloads them in parallel to maximize speed.
- - Resilience: Supports pausing, resuming, and restoring downloads after crashes or interruptions.
+ - Session Management: Supports pausing, resuming, and restoring downloads after crashes or interruptions, so you never lose your progress.
-
-Advanced Filtering & Content Control
+Expanded Site Support
+
+ - Direct Downloading: Full support for Kemono, Coomer, Bunkr, Erome, Saint2.su, and nhentai.
+ - Batch Mode: Download hundreds of URLs at once from
nhentai.txt or saint2.su.txt files.
+ - Discord Support: Download files or save entire channel histories as PDFs directly through the API.
+
+Advanced Filtering & Content Control
- Content Type Filtering: Select whether to download all files or limit to images, videos, audio, or archives only.
- Keyword Skipping: Automatically skips posts or files containing certain keywords (e.g., "WIP", "sketch").
- - Character Filtering: Restricts downloads to posts that match specific character or series names.
+ - Skip by Size: Avoid small files by setting a minimum size threshold in MB (e.g.,
[200]).
+ - Character Filtering: Restricts downloads to posts that match specific character or series names, with scope controls for title, filename, or comments.
-
-File Organization & Renaming
+Intelligent File Organization
- Automated Subfolders: Automatically organizes downloaded files into subdirectories based on character names or per post.
- - Advanced File Renaming: Flexible renaming options, especially in Manga Mode, including:
-
- - Post Title: Uses the post's title (e.g.,
Chapter-One.jpg).
- - Date + Original Name: Prepends the publication date to the original filename.
- - Date + Title: Combines the date with the post title.
- - Sequential Numbering (Date Based): Simple sequence numbers (e.g.,
001.jpg, 002.jpg).
- - Title + Global Numbering: Uses post title with a globally incrementing number across the session.
- - Post ID: Names files using the postβs unique ID.
-
-
+ - Advanced File Renaming: Flexible renaming options, especially in Manga Mode, including by post title, date, sequential numbering, or post ID.
+ - Filename Cleaning: Automatically removes unwanted text from filenames.
-
-Specialized Modes
+Specialized Modes
- Manga/Comic Mode: Sorts posts chronologically before downloading to ensure pages appear in the correct sequence.
- Favorite Mode: Connects to your account and downloads from your favorites list (artists or posts).
- - Link Extraction Mode: Extracts external links from posts for export or targeted downloading.
+ - Link Extraction Mode: Extracts external links (Mega, Google Drive) from posts for export or direct in-app downloading.
- Text Extraction Mode: Saves post descriptions or comment sections as
PDF, DOCX, or TXT files.
-
-Utility & Advanced Features
+Utility & Advanced Features
+ - In-App Updater: Check for new versions directly from the settings menu.
- Cookie Support: Enables access to subscriber-only content via browser session cookies.
- Duplicate Detection: Prevents saving duplicate files using content-based comparison, with configurable limits.
- Image Compression: Automatically converts large images to
.webp to reduce disk usage.
- Creator Management: Built-in creator browser and update checker for downloading only new posts from saved profiles.
- Error Handling: Tracks failed downloads and provides a retry dialog with options to export or redownload missing files.
-
-## π» Installation
-
-### Requirements
-
-- Python 3.6 or higher
-- pip (Python package installer)
-
-### Install Dependencies
-
-```bash
-pip install PyQt5 requests Pillow mega.py fpdf2 python-docx
-```
-
-### Running the Application
-Navigate to the application's directory in your terminal and run:
-```bash
-python main.py
-```
-
-### Optional Setup
-- **Main Inputs:**
-- Place your `cookies.txt` in the root directory (if using cookies).
-- Prepare your `Known.txt` and `creators.json` in the same directory for advanced filtering and selection features.
-
----
-
-## Troubleshooting
-
-### AttributeError: module 'asyncio' has no attribute 'coroutine'
-
-If you encounter an error message similar to:
-```
-AttributeError: module 'asyncio' has no attribute 'coroutine'. Did you mean: 'coroutines'?
-```
-This usually means that a dependency, often `tenacity` (used by `mega.py`), is an older version that's incompatible with your Python version (typically Python 3.10+).
-
-To fix this, activate your virtual environment and run the following commands to upgrade the libraries:
-
-```bash
-pip install --upgrade tenacity
-pip install --upgrade mega.py
-```
-
----
-
-## Contribution
-
-Feel free to fork this repo and submit pull requests for bug fixes, new features, or UI improvements!
-
----
-
-## License
-
-This project is under the MIT Licence
-
-## Star History
-
+π» Installation
+Requirements
+
+ - Python 3.6 or higher
+ - pip (Python package installer)
+
+Install Dependencies
+pip install -r requirements.txt
+
+Running the Application
+Navigate to the application's directory in your terminal and run:
+python main.py
+
+Contribution
+Feel free to fork this repo and submit pull requests for bug fixes, new features, or UI improvements!
+License
+This project is under the MIT Licence
+Star History
-
- 
+
-
