## 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 out to all formats and sites but may be
## overridden at several levels. See
##
https://github.com/JimmXinu/FanFicFare/wiki/INI-File for more
## details.
## This section changes how chapters are handled. I did not like the default “1. Chapter 1” display. The below block of code turns “1. Chapter 1” into “- Chapter 1 -” for stories with no chapter titles. It looks like this otherwise: “Chapter 1 - Title of chapter.”
## I also included the ability for WIP to show which chapters are “new”
mark_new_chapters:true
# used for WIP
strip_chapter_numbers:true
add_chapter_numbers:true
chapter_title_add_pattern: - Chapter ${number} - ${title}
chapter_title_new_pattern: - Chapter ${number} - (new) ${title} # used for WIP
chapter_title_addnew_pattern: - Chapter ${number} - (new) ${title} # used for WIP
chapter_title_strip_pattern:^([0-9]+[\.: -]+)?(Chapter *[0-9]+[\.:, -]*)?
##Browser cache path for sourcing fics from the cache
##browser_cache_path:~/Library/Caches/com.apple.Safari/
### Chrome:
browser_cache_path:C:\Users\XXX\AppData\Local\Goog le\Chrome\User Data\Profile 5\Cache\Cache_Data
#browser_cache_path:C:\Users\XXX\AppData\Local\Goo gle\Chrome\User Data\Profile 1\Cache\Cache_Data
## Some sites also require the user to confirm they are adult for
## adult content. Uncomment by removing '#' in front of is_adult.
is_adult:true
## Don't like the numbers at the start of chapter titles on some
## sites? You can use strip_chapter_numbers to strip them off. Just
## want to make them all look the same? Strip them off, then add them
## back on with add_chapter_numbers. Don't like the way it strips
## numbers or adds them back? See chapter_title_strip_pattern and
## chapter_title_add_pattern in defaults.ini.
#strip_chapter_numbers:true
#add_chapter_numbers:true
##This is what metadata is put into the main tags category in Calibre on download or update,
##if FFF is configured to update tags every time. Will add missing tags if updating an existing
##story but will not overwrite/remove other tags on update if "Keep Existing Tags when Updating Metadata?"
##is checked on the Basic tab of the Customize FanFicFare menu.
include_subject_tags: status, extratags
##Sorts ships alphabetically, ie Quinlan Vos/Obi-Wan Kenobi will become Obi-Wan Kenobi/Quinlan Vos
sort_ships:true
##The keep_in_order operator means that when the title page is generated, the chosen metadata categories
##will show up on the title page in the order they're listed on the original website instead of alphabetized
keep_in_order_ships:true
keep_in_order_characters:true
##Labels are what this metadata type shows up as on the title page if generated
publisher_label:Source Website
## extra tags (comma separated) to include
extratags: Type.Fanfiction
## keeps embedded style (helps with things like making right/left align text conversations look correct on downloaded ebook)
add_to_keep_html_attrs:,style,align
##Includes workskin
use_workskin:true
[epub]
epub_version:2.0
replace_br_with_p: true
## Include images from img tags in the body and summary of stories.
## Images will be converted to jpg for size if possible. Images work
## in epub format only. To get mobi or other format with images,
## download as epub and use Calibre to convert.
## true by default, uncomment and set false to not include images.
include_images:true
## If set false, the summary will have all html stripped for safety.
## Both this and include_images must be true to get images in the
## summary.
## true by default, uncomment and set false to not keep summary html.
keep_summary_html:true
## If set true, and there isn't a specific cover image, the first
## image found in the story will be made the cover image. If
## keep_summary_html is true, images in the summary will be before any
## in chapters.
## true by default, uncomment and set false to turn off
make_firstimage_cover:true
## Most common, I expect will be using this to save username/passwords
## for different sites. Here are a few examples. See defaults.ini
## for the full list.
[
www.twilighted.net]
#username:YourPenname
#password:YourPassword
## default is false
#collect_series: true
[
www.fimfiction.net]
#is_adult:true
#fail_on_password: false
[
www.tthfanfic.org]
#is_adult:true
## tth is a little unusual--it doesn't require user/pass, but the site
## keeps track of which chapters you've read and won't send another
## update until it thinks you're up to date. If you set
## username/password, FFF will login to download. Then the site
## thinks you're up to date.
#username:YourName
#password:yourpassword
[archiveofourown.org]
##username:XXX
##password:XXX
##always_login:true
use_basic_cache:true
##This section is to slow down how fast FanFicFare accesses Ao3. It's mostly unnecessary at this point,
##because of changes to how FanFicFare accesses Ao3, but if you are having Cloudflare issues
##try enabling this setting to slow down your access rate and avoid triggering an IP cooldown period.
slow_down_sleep_time:2
##Directs FanFicFare to use the browser cache if available, useful for avoiding Cloudflare issues
use_browser_cache:true
##Directs FanFicFare to only use the browser cache - necessary at times if the Cloudflare protection
##level has been increased, but is a pain otherwise and should be kept commented out unless FanFicFare
##is running into issues with cloudflare.
use_browser_cache_only:true
##If a page isn't in your browser cache or is older than the FanFicFare default of 4 hours,
##this will load the pages via your default browser and then check the cache again.
##Requires the browser cache path you set in the defaults to use your system's default browser.
##If you use container tabs in Firefox, the only cache FanFicFare checks is the one not associated with a container.
##If it doesn't work, just make sure you've opened every story chapter in a tab that's not in a container and try again.
open_pages_in_browser:true
##Works better for avoiding Cloudflare related problems even when using browser cache method
is_adult:true
##Extra metadata captured from Ao3, full list of options available in plugin-defaults.ini
extra_valid_entries: ao3categories, fandoms, freeformtags, subscribed, kudos, series00, series01, series02, series03,series00Url, series01Url, series02Url, series03Url, series00HTML, series01HTML, series02HTML, series03HTML
##Labels are what this metadata type shows up as on the title page if generated
ao3categories_label:Ship Types
fandoms_label:Fandoms
freeformtags_label:Additional Tags
kudos_label:kudos
series00HTML_label:Series
series01HTML_label:Additional Series
series02HTML_label:Additional Series
series03HTML_label:Additional Series
chapterslashtotal_label: Total Chapters
chapterstotal_label: Total Chapters
Kudos_label: Kudos
custom_columns_settings:
kudos=>#kudoscount,r
chapterslashtotal=>#chapterslashtotal,r
##The keep_in_order operator means that when the title page is generated, the chosen metadata
## categories will show up on the title page in the order they're listed on Ao3 instead of alphabetized,
## useful for keeping conversational tags in order and ordering ships by priority
keep_in_order_freeformtags:true
keep_in_order_fandoms:true
##Puts the metadata in the custom columns I created
add_to_custom_columns_settings:
ao3categories=>#shiptype
fandoms=>#sourcefandoms
freeformtags=>#additionaltags
"Ao3"=>#ficsource
subscribed=>#subscribed
subscribed=>#seriessubs
series00, series01, series02, series03=>#secondaryseries
##What metadata generates on the title page of the epub and what order it generates in
titlepage_entries: seriesHTML,rating,warnings,ao3categories,fandoms,s hips,characters,freeformtags,language,status,dateP ublished,dateUpdated,dateCreated,numChapters,numWo rds,publisher,description
replace_metadata:
ships=>(?i)\bomc\b=>Original Male Character(s)
ships=>(?i)\bofc\b=>Original Female Character(s)
ships=>(?i)\(oc\)|\boc\b=>(OC)
ships=>(?i)Original Male Character((\(s\))|s)?=>Original Male Character(s)
ships=>(?i)Original Female Character((\(s\))|s)?=>Original Female Character(s)
ships=>(?i)Original Nonbinary Character((\(s\))|s)?=>Original Nonbinary Character(s)
ships=>(?i)Original Non-Binary Character((\(s\))|s)?=>Original Nonbinary Character(s)
ships=>(?i)Original Trans Character((\(s\))|s)?=>Original Trans Character(s)
ships=>(?i)Original Trans Male Character((\(s\))|s)?=>Original Trans Male Character(s)
ships=>(?i)Original Trans Female Character((\(s\))|s)?=>Original Trans Female Character(s)
ships=>(?i)Original Cis Character((\(s\))|s)?=>Original Cis Character(s)
ships=>(?i)Original Cis Male Character((\(s\))|s)?=>Original Cis Male Character(s)
ships=>(?i)Original Cis Female Character((\(s\))|s)?=>Original Cis Female Character(s)
ships=>(?i)Original Character((\(s\))|s)?=>Original Character(s)
ships=>(?i)background|minor| - relationship|preslash|pre-slash|pre-relationship|pre relationship=>
ships=>(?i)pre-|mentioned|if you squint|implied|past|future=>
ships=>\(\)=>
## This section will override anything in the system defaults or other
## sections here.
[overrides]
## default varies by site. Set true here to force all sites to
## collect series.
collect_series: true
## Needed to make all of it work
extra_valid_entries:fandoms, storyUrl, storyUrlHTML, storyUrlUrl, chapterslashtotal, freeformtags, freefromtags, ao3categories, kudos, hits, bookmarks, collections, series00, series01, series02, series03, series04, series00Url, series01Url, series02Url, series03Url, series04Url, series00HTML, series01HTML, series02HTML, series03HTML, series04HTML
## Needed for Extra Title Page Entries I wanted
fandoms_label:Fandoms
freeformtags_label:Freeform Tags
freefromtags_label:Freeform Tags
kudos_label:Kudos
hits_label:Hits
collections_label:Collections
## Needed for Series Title Page Entry LABELS
series00HTML_label:Series
series01HTML_label:Additional Series
series02HTML_label:Additional Series
series03HTML_label:Additional Series
series04HTML_label:Additional Series
storyUrl_label:URL
storyUrlHTML_label:Link
ao3categories_label:Category
chapterslashtotal_label: Chapters
## Needed to make Series on Titlepage linked
make_linkhtml_entries:series00,series01,series02,s eries03,series04,storyUrl
## Needed to make stuff display on Title Page
titlepage_entries: seriesHTML,fandoms,language,characters,ships,ao3ca tegories,storyUrl,<br/> ,freeformtags,status,datePublished,dateUpdated,dat eCreated,rating,warnings,chapterslashtotal, numWords,<br/>series01HTML,series02HTML,series03HTML,series04HT ML,kudos,hits,bookmarks,site,description
## The bit that puts it in the multiseries column,
## column lookup must match #multiseries, or be changed
custom_columns_settings:
## series=>#multiseries,a
## series00=>#multiseries,a
## series01=>#multiseries,a
## series02=>#multiseries,a
## series03=>#multiseries,a
## series04=>#multiseries,a
fandoms=>#fandom
chapterslashtotal=>#chapter2
## The keep_in_order operator means that when the title page is generated, the chosen metadata
## categories will show up on the title page in the order they're listed on Ao3 instead of alphabatized,
## useful for keeping conversational tags in order and ordering ships by priority
keep_in_order_freeformtags:true
keep_in_order_ships:true
## Adding a comma for kudos over 3 digits
add_to_comma_entries:,kudos