Files
Kemono-Downloader/features.md
2025-07-25 10:49:51 -07:00

13 KiB
Raw Blame History

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.


Main Window: Core Functionality

The application is divided into a configuration panel on the left and a status/log panel on the right.

Primary Inputs (Top-Left)

  • URL Input Field: This is the starting point for most downloads. You can paste a URL for a specific post or for an entire creator's feed. The application's behavior adapts based on the URL type.
  • 🎨 Creator Selection Popup: This button opens a powerful dialog listing all known creators. From here, you can:
    • Search and Queue: Search for creators and check multiple names. Clicking "Add Selected" populates the main input field, preparing a batch download.
    • Check for Updates: Select a single creator's saved profile. This loads their information and switches the main download button to "Check for Updates" mode, allowing you to download only new content since your last session.
  • Download Location: The primary folder where all content will be saved. The Browse... button lets you select this folder from your computer.
  • Page Range (Start/End): These fields activate only for creator feed URLs. They allow you to download a specific slice of a creator's history (e.g., pages 5 through 10) instead of their entire feed.

Filtering & Naming (Left Panel)

These features give you precise control over what gets downloaded and how it's named and organized.

  • Filter by Character(s): A powerful tool to download content featuring specific characters. You can enter multiple names separated by commas.
    • Filter: [Scope] Button: This button changes how the character filter works:
      • Title: Downloads posts only if a character's name is in the post title.
      • Files: Downloads posts if a character's name is in any of the filenames within the post.
      • Both: Combines the "Title" and "Files" logic.
      • Comments (Beta): Downloads a post if a character's name is mentioned in the comments section.
  • Skip with Words: A keyword-based filter to avoid unwanted content (e.g., WIP, sketch).
    • Scope: [Type] Button: This button changes how the skip filter works:
      • Posts: Skips the entire post if a keyword is found in the title.
      • Files: Skips only individual files if a keyword is found in the filename.
      • Both: Applies both levels of skipping.
  • Remove Words from name: Automatically cleans downloaded filenames by removing any specified words (e.g., "patreon," "HD").

File Type Filter (Radio Buttons)

This section lets you choose the kind of content you want:

  • All, Images/GIFs, Videos, 🎧 Only Audio, 📦 Only Archives: These options filter the downloads to only include the selected file types.
  • 🔗 Only Links: This special mode doesn't download any files. Instead, it scans post descriptions and lists all external links (like Mega, Google Drive) in the log panel.
  • More: Opens a dialog for text-only downloads. You can choose to save post descriptions or comments as formatted PDF, DOCX, or TXT files. A key feature here is the "Single PDF" option, which compiles the text from all downloaded posts into one continuous, sorted PDF document.

Download Options & Advanced Settings (Checkboxes)

  • Skip .zip: A simple toggle to ignore archive files during downloads.
  • Download Thumbnails Only: Downloads only the small preview images instead of the full-resolution files.
  • Scan Content for Images: A crucial feature that scans the post's text content for embedded images that may not be listed in the API, ensuring a more complete download.
  • Compress to WebP: Saves disk space by automatically converting large images into the efficient WebP format.
  • Keep Duplicates: Opens a dialog to control how files with identical content are handled. The default is to skip duplicates, but you can choose to keep all of them or set a specific limit (e.g., "keep up to 2 copies of the same file").
  • Subfolder per Post: Organizes downloads by creating a unique folder for each post, named after the post's title.
  • Date Prefix: When "Subfolder per Post" is on, this adds the post's date to the beginning of the folder name (e.g., 2025-07-25 Post Title).
  • Separate Folders by Known.txt: This enables the automatic folder organization system based on your "Known Names" list.
  • Use Cookie: Allows the application to use browser cookies to access content that might be behind a paywall or login. You can paste a cookie string directly or use Browse... to select a cookies.txt file.
  • Use Multithreading: Greatly speeds up downloads of creator feeds by processing multiple posts at once. The number of Threads can be configured.
  • Show External Links in Log: When checked, a secondary log panel appears at the bottom of the right side, dedicated to listing any external links found.

Known Names Management (Bottom-Left)

This powerful feature automates the creation of organized, named folders.

  • Known Shows/Characters List: Displays all the names and groups you've saved.
  • Search...: Filters the list to quickly find a name.
  • Open Known.txt: Opens the source file in a text editor for advanced manual editing.
  • Add New Name:
    • Single Name: Typing Tifa Lockhart and clicking Add creates an entry that will match "Tifa Lockhart".
    • Group: Typing (Boa, Hancock, Snake Princess)~ and clicking Add creates a single entry named "Boa Hancock Snake Princess". The application will then look for "Boa," "Hancock," OR "Snake Princess" in titles/filenames and save any matches into that combined folder.
  • ⤵️ Add to Filter: Opens a dialog with your full Known Names list, allowing you to check multiple entries and add them all to the "Filter by Character(s)" field at once.
  • 🗑️ Delete Selected: Removes highlighted names from your list.

Action Buttons & Status Controls

  • ⬇️ Start Download / 🔗 Extract Links: The main action button. Its function is dynamic:
    • Normal Mode: Starts the download based on the current settings.
    • Update Mode: After selecting a creator profile, this button changes to 🔄 Check for Updates.
    • Update Confirmation: After new posts are found, it changes to ⬇️ Start Download (X new).
    • Link Extraction Mode: The text changes to 🔗 Extract Links.
  • ⏸️ Pause / ▶️ Resume Download: Pauses the ongoing download, allowing you to change certain settings (like filters) on the fly. Click again to resume.
  • Cancel & Reset UI: Immediately stops all download activity and resets the UI to a clean state, preserving your URL and Download Location inputs.
  • Error Button: If files fail to download, they are logged. This button opens a dialog listing all failed files and will show a count of errors (e.g., (5) Error). From the dialog, you can:
    • Select specific files to Retry downloading.
    • Export the list of failed URLs to a .txt file.
  • 🔄 Reset (Top-Right): A hard reset that clears all logs and returns every single UI element to its default state.
  • ⚙️ (Settings): Opens the main Settings dialog.
  • 📜 (History): Opens the Download History dialog.
  • ? (Help): Opens a helpful guide explaining the application's features.
  • ❤️ Support: Opens a dialog with information on how to support the developer.

Specialized Modes & Features

Favorite Mode

Activating this mode transforms the UI for managing saved collections:

  • The URL input is disabled.
  • The main action buttons are replaced with:
    • 🖼️ Favorite Artists: Opens a dialog to browse and queue downloads from your saved favorite creators.
    • 📄 Favorite Posts: Opens a dialog to browse and queue downloads for specific saved favorite posts.
  • Scope: [Location] Button: Toggles where the favorited content is saved:
    • Selected Location: Saves all content directly into the main "Download Location".
    • Artist Folders: Creates a subfolder for each artist inside the main "Download Location".

📖 Manga/Comic Mode

This mode is designed for sequential content and has several effects:

  • Reverses Download Order: It fetches and downloads posts from oldest to newest.
  • Enables Special Naming: A Name: [Style] button appears, allowing you to choose how files are named to maintain their correct order (e.g., by Post Title, by Date, or simple sequential numbering like 001, 002, 003...).
  • Disables Multithreading (for certain styles): To guarantee perfect sequential numbering, multithreading for posts is automatically disabled for certain naming styles.

Session & Error Management

  • Session Restore: If the application is closed unexpectedly during a download, it will detect the incomplete session on the next launch. The UI will present a 🔄 Restore Download button to resume exactly where you left off. You can also choose to discard the session.
  • Update Checking: By selecting a creator profile via the 🎨 Creator Selection Popup, you can run an update check. The application compares the posts on the server with your download history for that creator and will prompt you to download only the new content.

Logging & Monitoring

  • Progress Log: The main log provides real-time feedback on the download process, including status messages, file saves, skips, and errors.
  • 👁️ Log View Toggle: Switches the log view between the standard Progress Log and a Missed Character Log, which shows potential character names from posts that were skipped by your filters, helping you discover new names to add to your list.