lovingcivilian / fkulibrary

Scrape metadata from FAKKU for your local collection!

F! Library

Scrape metadata from FAKKU or Panda and build your own local FAKKU library with Komga or any other CMS that supports ComicInfo.xml metadata.

Example results

<ComicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Title>Sekigahara-san Has Something to Hide</Title>
  <Series>Sekigahara-san Has Something to Hide</Series>
  <Number>1</Number>
  <Summary>Thrilling and agonizing! The start of a rich girl series!</Summary>
  <Year>2020</Year>
  <Month>01</Month>
  <Writer>Tsukako</Writer>
  <Publisher>FAKKU</Publisher>
  <Tags>Bunny Girl, Busty, Cosplay, Deepthroat, Fishnets, Hentai, Light Hair, No Sex, Ojousama, Paizuri, Stockings, Story Arc, Uncensored</Tags>
  <Genre>Original Work</Genre>
  <Web>https://www.fakku.net/hentai/sekigahara-san-has-something-to-hide-english</Web>
  <LanguageISO>en</LanguageISO>
  <Manga>Yes</Manga>
  <SeriesGroup>Comic Kairakuten BEAST 2020-01</SeriesGroup>
  <AgeRating>Adults Only 18+</AgeRating>
</ComicInfo>

Quick links

• Getting Started
• Setup
• Usage
• Examples
• Parameters

Getting Started

Prerequisites

• PowerShell 5.0 or higher (6.0+ recommended)
• Komga or any other CMS that supports ComicInfo.xml metadata

Accepted archive filenames examples

• [Circle (Artist)] Title (Comic XXX) [Publisher] [etc.].ext
• [Artist] Title (Comic XXX).ext
• Title (Comic XXX).ext
• Title.ext

Supported filetypes

• .zip
• .cbz
• .rar
• .cbr
• .7z
• .cb7

Setup

Clone the repository

• Clone the repository by downloading and extracting the files to a directory of your choice or with Git.

git clone https://github.com/shrublet/FKULibrary.git

Setup Selenium WebDriver (optional)

• It's highly recommneded to setup and download Selenium as well to access publicly blocked pages. Download the WebDriver for your browser and the Selenium for C# package (linked below). Extract the WebDriver executable (for Google Chrome, this would be chromedriver.exe) and WebDriver.dll from the raw .nupkg package to the root of your extracted repository (i.e. .\fakku-meta-scraper-main).

  • _{⚠️ The WebDriver.dll is packaged inside .nupkg file under .\lib\net48\ and can be opened via any file archiver. Most Windows PCs should have .NET 4.8, so this is the recommended library. If the WebDriver isn't working as expected, ensure the version matches with your browser or try updating your browser/downgrading the WebDriver.}

  • Browser WebDriver executables ¹

  • Selenium WebDriver for C#

Import the module

• You will need to do this every time you close your PowerShell window unless you add the module to your PowerShell module PATH. Ensure that your PowerShell window is opened in the correct directory.

cd "C:\path\to\extracted\repository"

Import-Module .\Fakku-Library.psm1

Usage

Set metadata for archive(s)

Set-FakkuMetadata

Available parameters

-FilePath -Recurse -Url -UrlFile -InputFile -Sleep -Destination -Safe -Headless -Incognito -Log -LogPath

Retrieve and write metadata to the console

Show-FakkuMetadata

Available parameters

-Name -Url -Safe -Headless -Incognito

Return corresponding FAKKU links for archive(s)

Get-FakkuLinks

Available parameters

-FilePath -Name -Recurse

Examples

Set metadata for an archive

Set-FakkuMetadata -FilePath "C:\path\to\file.zip"

Set metadata for archives in specified directory

Set-FakkuMetadata -FilePath "C:\path\to\files"

Set metadata for an archive from a FAKKU link

Set-FakkuMetadata "C:\path\to\file.zip" -Url "https://www.fakku.net/hentai/Bare-Girl-english"

Set metadata for a list of archives

Set-FakkuMetadata -InputFile "C:\path\to\list\of\archives.txt"

Set metadata for archives in specified directory with a list of URLs

Set-FakkuMetadata "C:\path\to\files" -UrlFile "C:\path\to\list\of\urls.txt"

Get and display metadata from a FAKKU link

Show-FakkuMetadata https://www.fakku.net/hentai/Bare-Girl-english

Get and display metadata from a title

Show-FakkuMetadata "Bare Girl"

Parameter Descriptions

-FilePath

_{Archive or directory or archives to set metadata for}

-Name

_{Work title to search FAKKU/Panda for}

-Recurse

_{Whether to recursively search the directory for archives (default: False)}

-Url

_{FAKKU/Panda URL to pull metadata from}

-Sleep

_{Time to sleep between scrapes (default: 0)}

-InputFile

_{Text file with directories to tag}

-UrlFile

_{Text file with FAKKU/Panda URLs to use for tagging (compatible with both -FilePath and -InputFile)}

-Destination

_{Path to move completed archives to (default: None)}

-Safe

_{Force the use of Selenium to scrape metadata to avoid edge-case metadata issues (default: False)}

-Headless

_{Launches browser in headless mode (default: True)}

-Incognito

_{Launches browser in incognito/private mode (default: False)}

-Log

_{If logs should be written (default: False)}

-LogPath

_{Path to save log to (default: .\fakku_library.log)}

Footnotes

1. Currently only supports Google Chrome, Microsoft Edge, and Firefox. ↩