[GUI Plugin] FanFicFare

[ownedbycats]

Originally Posted by JimmXinu

New Test Version Posted

2026-05-22
- Add retry_failedtoload_images option
- PI: Don't throw notifications when doing show_message()
- PI: INI Snippets

Three changes to this version:

PI: Don't throw notifications when doing show_message() -- What it says. FFF shouldn't generate notifications any time it shows a status message.

Add retry_failedtoload_images option -- When retry_failedtoload_images:true and you update an epub with images that failed to download since the image handling update back in Jan2026, FFF will retry them.

(I need to add the description for this to defaults.ini. This hasn't been hugely tested because my commonly updated stories don't have failed images, apparently.)

However, I don't think this should be turned on all the time, so I finally implemented:

PI: INI Snippets - Under 'Show Download Options' on the Add / Update dialog boxes there's now a dropdown for 'INI Snippet'. You can enter a one-time INI snippet, or use previously saved snippets.

FFF will offer to save one-time snippets and there's basic add/edit/remove snippets under the personal.ini tab in FFF config.

A new snippet will already have an [overrides] section. You can use other sections instead. But even if you remove all sections, FFF will still inject an [overrides] section header in front of the snippet because these are meant to be highest priority.

My personal use cases for this are retry_failedtoload_images as mentioned above, and ffnet check_next_chapter.

After I already set this up

[texasnightowl]

Originally Posted by JimmXinu

Here's one way:

[defaults]
# create a couple new entries.
# note the leading ',' it's necessary.
add_to_extra_valid_entries:,romships,platships

# copy regular ships into them.  
# All replace_meetadata/etc for ships will already be done.
include_in_romships:ships
include_in_platships:ships

# keep only those containing / in romships
include_metadata_pre:
 romships=~/

# remove any containing / from platships
exclude_metadata_pre:
 platships=~/

# put them in your columns.
# Use your custom column identifiers instead of #romships / #platships.
add_to_custom_columns_settings:
 romships=>#romships
 platships=>#platships

I added this code to my personal.ini and it's mostly working? But romships are not kept in the original ships order when sent to the custom column?

Example, this story has relationships listed as follows in my custom metadata column:

<p><span class='label'>Relationships</span>: <div class='metadata list' id='ships'><ul>
<li>James "Bucky" Barnes/Darcy Lewis</li>
<li>James "Bucky" Barnes/Steve Rogers</li>
<li>Darcy Lewis/Steve Rogers</li>
<li>James "Bucky" Barnes/Darcy Lewis/Steve Rogers</li>
<li>background Natasha Romanov/Clint Barton</li>
<li>background Tony Stark/Pepper Potts</li>
<li>Steve Rogers/Peggy Carter</li>
</ul></div><p>

But when romships writes to my custom column, the order is: background Natasha Romanov/Clint Barton, background Tony Stark/Pepper Potts, Darcy Lewis/Steve Rogers, James "Bucky" Barnes/Darcy Lewis, James "Bucky" Barnes/Darcy Lewis/Steve Rogers, James "Bucky" Barnes/Steve Rogers, Steve Rogers/Peggy Carter


My keep_in_order_ships:true line appears to work since the list is correct. So, how can I keep the "romships" in the same orders as the original ships list? (I tried to add a keep_in_order_romships:true and refreshed from saved metadata but that did not work.)

edit: adding my personal.ini with most commented stuff removed to shorten it up more.

## This is an example of what your personal configuration might look
## like.  Uncomment options by removing the '#' in front of them.

[defaults]
## [defaults] section applies to all formats and sites but may be
## overridden at several levels.  See
## https://github.com/JimmXinu/FanFicFare/wiki/INI-File for more
## details.

## firefox browser cache on new PC as of January 2025
## C:\Users\name\AppData\Local\Mozilla\Firefox\Profiles\kgl3ip34.default-release\cache2 
browser_cache_path:C:\Users\name\AppData\Local\Mozilla\Firefox\Profiles\kgl3ip34.default-release\cache2

is_adult:true


## Items to include in the title page
## this is the default
#titlepage_entries: seriesHTML,category,genre,language,characters,ships,status,datePublished,dateUpdated,dateCreated,rating,warnings,numChapters,numWords,publisher,description


## to change the order, ie. move genre to the end, after
## the summary, try
titlepage_entries: seriesHTML,category,language,characters,ships,status,datePublished,dateUpdated,dateCreated,rating,warnings,numChapters,numWords,publisher,description,<p>,<p>,<p>,genre


[epub]

## titlepage entry format
## ${id}, ${label}, ${value}
titlepage_entry:
 <b>${label}:</b> ${value}<br /><br />


[fanfiction.net]
username:XXXXXXXX
password:XXXXXXXX
use_basic_cache:true
continue_on_chapter_error:true
use_browser_cache:true
open_pages_in_browser:true
use_browser_cache_only:true
never_make_cover:true
skip_author_cover:true
slow_down_sleep_time:12
ships_label:Pairings
## How do I exclude "genre" as I don't want those tags?
include_subject_tags: extratags, category, characters, ships, status


[archiveofourown.org]
## include_subject_tags: extratags, genre, category, characters, ships, lastupdate, status
## I removed genre which seems to remove/hide all the freeform tags
include_subject_tags: extratags, category, characters, ships, status

username:XXXXXXXX
password:XXXXXXXX
slow_down_sleep_time:4

## if having issues, can try
use_archiveofourown_gay:true


keep_in_order_characters:true
keep_in_order_ships:true
keep_in_order_genre:true
keep_in_order_category:true


## extra_valid_entries:chapterslashtotal, chapterstotal
## removed kudos, hits, bookmarks, collections, collectionsURL, 
## collectionsHTML, bookmarked, bookmarktags, bookmarksummary, 
## bookmarkprivate, bookmarkrec, subscribed, markedforlater, 
## restricted
extra_valid_entries:fandoms, freeformtags, freefromtags,
 ao3categories, chapterslashtotal, chapterstotal, 
 subscribed, markedforlater, restricted, series00, 
 series01, series02, series03, series00Url, series01Url, 
 series02Url, series03Url, series00HTML,
 series01HTML, series02HTML, series03HTML
chapterslashtotal_label:Chapters/Total Chapters
chapterstotal_label:Total Chapters
fandoms_label:Fandoms
freeformtags_label:Freeform Tags
freefromtags_label:Freeform Tags
ao3categories_label:AO3 Categories
#comments_label:Comments
#collections_label:Collections
#collectionsHTML_label:CollectionsHTML
## removed comments, kudos, hits, bookmarks, collections
## collectionsURL, collectionsHTML, bookmarked, bookmarktags
## bookmarksummary, bookmarkprivate, bookmarkrec

custom_columns_settings:
 chapterslashtotal=>#chapters

## chapterslashtotal contains 1/3 or 1/1 or 3/? etc as reported by AO3.
## chapterstotal is just the total chapters part after the /
#include_in_chapterstotal:chapterslashtotal.NOREPL
#add_to_replace_metadata:
# chapterstotal=>^([0-9])+/(.+)$=>\2

## AO3 doesn't have anything it calls 'genre'.  The adapter used to be
## hardcoded to include the site specific metadata freeformtags &
## ao3categories in the standard metadata field genre.  By making it
## configurable, users can change it.
include_in_genre: freeformtags, ao3categories

## default
## include_in_category:fandoms

## AO3 chapters can include several different types of notes.  We've
## traditionally included them all in the chapter text, but this allows
## you to customize which you include.  Copy this parameter to your
## personal.ini and list the ones you don't want.
#exclude_notes:authorheadnotes,chaptersummary,chapterheadnotes,chapterfootnotes,authorfootnotes,inspiredlinks
exclude_notes:inspiredlinks


## May 2026, testing some pairing/ships wrangling
## from https://www.mobileread.com/forums/showpost.php?p=4579994&postcount=11840
# create a couple new entries.
# note the leading ',' it's necessary.
add_to_extra_valid_entries:,romships,platships,firstship,otherships
# copy regular ships into them.  
# All replace_meetadata/etc for ships will already be done.
include_in_romships:ships
include_in_platships:ships
include_in_firstship:ships
include_in_otherships:ships

# keep only those containing / in romships
include_metadata_pre:
 romships=~/

# remove any containing / from platships
exclude_metadata_pre:
 platships=~/


keep_in_order_romships:true
keep_in_order_platships:true
keep_in_order_otherships:true


# put them in your columns.
# Use your custom column identifiers instead of #romships / #platships.
add_to_custom_columns_settings:
 romships=>#pairings
# platships=>#platships


replace_metadata:
## copied from a user on mobileread site,publisher=>archiveofourown.org=>Archive of Our Own
 publisher=>archiveofourown.org=>AO3 by FFF
 characters=>^OC(s|)$=>Original Character(s)
 characters=>^OFC(s|)$=>Original Female Character(s)
 characters=>^OMC(s|)$=>Original Male Character(s)
 characters=>^Original (.*)Character(\(s\)|s|).*$=>Original Character(s)
## Generic Cleanup
# category=> (- All Media Types|- Fandom|\(Movies\)|\(Movie [0-9]+\)|\(Comics\)|\(TV\))$=>
 characters=>\(mentions of\) =>
 characters=> \([Ch]haracter\)=>
 characters=> ?\((cameo|briefly|if you squint|sort of)\)=>
 characters=> - Character=>
 characters=>^Other mentions$=>
## replace orphan_account author links with one that works.
 authorUrl=>(/users/orphan_account)/pseuds/.*$=>\1
## Marvel stuff
 category=>^Marvel$=>Marvel Cinematic Universe
 category=>^Marvel \(Comics\)$=>Marvel Cinematic Universe
 category=>^Marvel \(Movies\)$=>Marvel Cinematic Universe
 category=>Captain America.*=>Marvel Cinematic Universe
 category=>The Avengers.*=>Marvel Cinematic Universe
 category=>Thor.*=>Marvel Cinematic Universe
 category=>Iron Man.*=>Marvel Cinematic Universe
 category=>Black Panther.*=>Marvel Cinematic Universe
 category=>Shang-Chi.*=>Marvel Cinematic Universe
 category=>Black Widow.*=>Marvel Cinematic Universe
 category=>Doctor Strange.*=>Marvel Cinematic Universe
 category=>Deadpool.*=>Marvel Cinematic Universe
 category=>Hulk.*=>Marvel Cinematic Universe
 category=>Spider.*=>Marvel Cinematic Universe
 category=>^Invaders \(Marvel\)$=>Marvel TV (Invaders)
 category=>WandaVision.*=>Marvel TV (WandaVision)
 category=>Hawk[Ee]ye.*=>Marvel TV (Hawkeye)
 category=>Guardians of the Galaxy.*=>Marvel Cinematic Universe
 category=>The Falcon and the Winter Soldier.*=>Marvel TV (TFatWS)
 category=>The Defenders.*=>Marvel TV (The Defenders)
 category=>^Marvel Avengers Movies Universe$=>Marvel Cinematic Universe
 category=>^the avengers 2012$=>Marvel Cinematic Universe