MobileRead Forums

Many people use their ebook readers to read FanFiction stories posted on the web on various sites. Many people also use Calibre to manage their ebook collections and readers.

This plugin brings the functionality of FanFicFare to Calibre. The source is available on the GitHub project home page. There are additional documentation and FAQs on the project wiki.

(FanFicFare is the official, renamed successor to FanFictionDownLoader)

Main Features of FanFicFare Plugin:

Download FanFiction stories from over 100 different sites into ebooks. Supported sites list is below.
Update calibre metadata from website.
Update existing EPUB format ebooks, downloading only new chapters.
Get Story URLs from Web Page
Create and update EPUB anthologies of several stories. (Uses EpubMerge Plugin)
Download in the background for user convenience.
Support for downloading images in the story text. (EPUB and HTML only--download EPUB and convert to AZW3 for Kindle) More details on configuring images in stories and cover images can be found in the FAQs or this post in the old FFDL thread.
Support for cover image. (EPUB only)
Support to call Generate Cover plugin on calibre metadata create or update.
Support to call Count Pages plugin on calibre metadata create or update.
Option to call Polish Book's Smarten Punctuation on each EPUB download/update.
Update/Overwrite existing FanFiction stories from story URL in Calibre identity or EPUB. FanFicFare ignores Virtual Library and Additional Restrictions while searching for books to update.
Optionally keep an Update Log of past updates (EPUB only).
Option to delete other formats on book update. Handy if you have both a Nook(EPUB) and Kindle(AZW3), for example.
Update Reading List plugin lists as an aid to device sync and keeping a list of new books to read.
Options now stored inside the Library rather than an external JSON file.
Keep a list of previously 'Rejected' story URLs and user notes on why. Report if the user tries to download a rejected story again.
CLI via calibre-debug --run-plugin

Supported Sites:

Spoiler:

Other useful Plugins:

FanFicFare can call Generate Cover to generate custom covers for downloaded stories.
FanFicFare can call Count Pages to generate page counts for downloaded stories.
FanFicFare can call Reading List to sync devices and keep a list of new books to read.
FanFicFare can call EpubMerge to create and update Epub anthologies of several stories in one book.

Special Notes:

Requires Calibre v1.48.0 or later.

Languages:

This plugin has (at least partial) translations for:

English
French
German
Portuguese (Brazil)
Spanish
Dutch
Ukrainian

Command Line Interface(CLI)

Calibre offers a command-line interface (CLI) for calling plugins.

This plugin supports that option and allows the user to call the plugin's basic functionality from outside calibre without having to install Python or get the plugin's files separately.

(Note that at this time, FanFicFare via calibre CLI will use your personal.ini settings from your library, but does not add to or update your library.)

Details:

Spoiler:

Code:

Usage: calibre-debug.exe --run-plugin FanFicFare -- [options] <storyurl>



Options:

  -h, --help            show this help message and exit

  --library-path=LIBRARY_PATH, --with-library=LIBRARY_PATH

                        Path to the calibre library. Default is to use the

                        path stored in the settings.

  -f FORMAT, --format=FORMAT

                        write story as FORMAT, epub(default), mobi, text or

                        html

  -c CONFIG, --config=CONFIG

                        read config from specified file(s) in addition to

                        calibre plugin personal.ini,

                        ~/.fanficfare/personal.ini, and ./personal.ini

  -b START, --begin=START

                        Begin with Chapter START

  -e END, --end=END     End with Chapter END

  -o NAME=VALUE, --option=NAME=VALUE

                        set an option NAME=VALUE

  -m, --meta-only       Retrieve metadata and stop.  Or, if --update-epub,

                        update metadata title page only.

  -u, --update-epub     Update an existing epub with new chapters, give epub

                        filename instead of storyurl.

  --update-cover        Update cover in an existing epub, otherwise existing

                        cover (if any) is used on update.  Only valid with

                        --update-epub.

  --force               Force overwrite of an existing epub, download and

                        overwrite all chapters.

  -i INFILE, --infile=INFILE

                        Give a filename to read for URLs (and/or existing EPUB

                        files with -u for updates).

  -l, --list            Get list of valid story URLs from page given.

  -n, --normalize-list  Get list of valid story URLs from page given, but

                        normalized to standard forms.

  -s, --sites-list      Get list of valid story URLs examples.

  -d, --debug           Show debug output while downloading.

Installation Steps:

Under Calibre's Preferences, there's an option for 'Get plugins to enhance Calibre'. Find FanFicFare on the list (check the 'Update' and 'All' lists if you don't see it), click Install in the lower right corner.

--OR--

Download the attached zip file and install the plugin/add to context menu or toolbar/restart Calibre as described in the Introduction to plugins thread.

Version History:

Spoiler: