Kemono-Downloader/features.md
2025-08-27 19:50:13 -07:00

10 KiB

Kemono Downloader - Comprehensive Feature Guide

This guide provides a detailed overview of all user interface elements, input fields, buttons, popups, and functionalities available in the application.


1. Core Concepts & Supported Sites

URL Input (🔗)

This is the primary input field where you specify the content you want to download.

Supported URL Types:

  • Creator URL: A link to a creator's main page. Downloads all posts from that creator.
  • Post URL: A direct link to a specific post. Downloads only that single post.
  • Batch Command: Special keywords to trigger bulk downloading from a text file (see Batch Downloading section).

Supported Websites:

  • Kemono (kemono.su, kemono.party, etc.)
  • Coomer (coomer.su, coomer.party, etc.)
  • Discord (via Kemono/Coomer API)
  • Bunkr
  • Erome
  • Saint2.su
  • nhentai

2. Main Download Controls & Inputs

Download Location (📁)

This input defines the main folder where your files will be saved.

  • Browse Button: Opens a system dialog to choose a folder.
  • Directory Creation: If the folder doesn't exist, the app will ask for confirmation to create it.

Filter by Character(s) & Scope

Used to download content for specific characters or series and organize them into subfolders.

  • Input Field: Enter comma-separated names (e.g., Tifa, Aerith). Group aliases using parentheses for folder naming (e.g., (Cloud, Zack)).
  • Scope Button: Cycles through where to look for name matches:
    • Filter: Title: Matches names in the post title.
    • Filter: Files: Matches names in the filenames.
    • Filter: Both: Checks the title first, then filenames.
    • Filter: Comments: Checks filenames first, then post comments.

Skip with Words & Scope

Prevents downloading content based on keywords or file size.

  • Input Field: Enter comma-separated keywords (e.g., WIP, sketch, preview).
  • Skip by Size: Enter a number in square brackets to skip any file smaller than that size in MB. For example, WIP, [200] skips files with "WIP" in the name AND any file smaller than 200 MB.
  • Scope Button: Cycles through where to apply keyword filters:
    • Scope: Posts: Skips the entire post if the title matches.
    • Scope: Files: Skips individual files if the filename matches.
    • Scope: Both: Checks the post title first, then individual files.

Remove Words from Name (✂️)

Enter comma-separated words to remove from final filenames (e.g., patreon, [HD]). This helps clean up file naming.


3. Primary Download Modes (Filter File Section)

This section uses radio buttons to set the main download mode. Only one can be active at a time.

  • All: Default mode. Downloads every file and attachment.
  • Images/GIFs: Downloads only common image formats.
  • Videos: Downloads only common video formats.
  • Only Archives: Downloads only .zip, .rar, etc.
  • Only Audio: Downloads only common audio formats.
  • Only Links: Extracts external hyperlinks (e.g., Mega, Google Drive) from post descriptions instead of downloading files. This mode unlocks special features (see section 6).
  • More: Opens a dialog to download text-based content.
    • Scope: Choose to extract text from the post description or comments.
    • Export Format: Save as PDF, DOCX, or TXT.
    • Single PDF: Compile all text from the session into one consolidated PDF file.

4. Advanced Features & Toggles (Checkboxes)

Folder Organization

  • Separate folders by Known.txt: Automatically organizes downloads into subfolders based on name matches from your Known.txt list or the "Filter by Character(s)" input.
  • Subfolder per post: Creates a unique folder for each post, named after the post's title. This prevents files from different posts from mixing.
  • Date prefix: (Only available with "Subfolder per post") Prepends the post date to the folder name (e.g., 2025-08-03 My Post Title) for chronological sorting.

Special Modes

  • Favorite Mode: Switches the UI to download from your personal favorites list instead of using the URL input.
  • Manga/Comic mode: Sorts a creator's posts from oldest to newest before downloading, ensuring correct page order. A scope button appears to control the filename style (e.g., using post title, date, or a global number).

File Handling

  • Skip Archives: Ignores .zip and .rar files during downloads.
  • Download Thumbnail Only: Saves only the small preview images instead of full-resolution files.
  • Scan Content for Images: Parses post HTML to find embedded images that may not be listed in the API data.
  • Compress to WebP: Converts large images (over 1.5 MB) to the space-saving WebP format.
  • Keep Duplicates: Opens a dialog to control how duplicate files are handled (skip by default, keep all, or keep a specific number of copies).

General Functionality

  • Use cookie: Enables login-based access. You can paste a cookie string or browse for a cookies.txt file.
  • Use Multithreading: Enables parallel processing of posts for faster downloads. You can set the number of concurrent worker threads.
  • Show external links in log: Opens a secondary log panel that displays external links found in post descriptions.

5. Specialized Downloaders & Batch Mode

Discord Features

  • When a Discord URL is entered, a Scope button appears.
    • Scope: Files: Downloads all files from the channel/server.
    • Scope: Messages: Saves the entire message history of the channel/server as a formatted PDF.
  • A "Save as PDF" button also appears as a shortcut for the message saving feature.

Batch Downloading (nhentai & saint2.su)

This feature allows you to download hundreds of galleries or videos from a simple text file.

  1. In the appdata folder, create nhentai.txt or saint2.su.txt.
  2. Add one full URL per line to the corresponding file.
  3. In the app's URL input, type either nhentai.net or saint2.su and click "Start Download".
  4. The app will read the file and process every URL in the queue.

6. "Only Links" Mode: Extraction & Direct Download

When you select the "Only Links" radio button, the application's behavior changes significantly.

  • Link Extraction: Instead of downloading files, the main log panel will fill with all external links found (Mega, Google Drive, Dropbox, etc.).
  • Export Links: An "Export Links" button appears, allowing you to save the full list of extracted URLs to a .txt file.
  • Direct Cloud Download: A "Download" button appears next to the export button.
    • Clicking this opens a new dialog listing all supported cloud links (Mega, G-Drive, Dropbox).
    • You can select which files you want to download from this list.
    • The application will then download the selected files directly from the cloud service to your chosen download location.

7. Session & Process Management

Main Action Buttons

  • Start Download: Begins the download process. This button's text changes contextually (e.g., "Extract Links", "Check for Updates").
  • Pause / Resume: Pauses or resumes the ongoing download. When paused, you can safely change some settings.
  • Cancel & Reset UI: Stops the current download and performs a soft reset of the UI, preserving your URL and download location.

Restore Interrupted Download

If the application is closed unexpectedly during a download, it will save its progress.

  • On the next launch, the UI will be pre-filled with the settings from the interrupted session.
  • The Pause button will change to "🔄 Restore Download". Clicking it will resume the download exactly where it left off, skipping already processed posts.
  • The Cancel button will change to "🗑️ Discard Session", allowing you to clear the saved state and start fresh.

Other UI Controls

  • Error Button: Shows a count of failed files. Clicking it opens a dialog where you can view, export, or retry the failed downloads.
  • History Button: Shows a log of recently downloaded files and processed posts.
  • Settings Button: Opens the settings dialog where you can change the theme, language, and check for application updates.
  • Support Button: Opens a dialog with links to the project's source code and developer support pages.