[GUI Plugin] Romance.io Fields

[plain-cover]

Romance.io is a community site for romance novels with detailed reader tags (tropes, themes, settings, etc.), steam ratings, and user star ratings. This plugin adds a toolbar button that fetches data from Romance.io and writes it into custom columns in your library:

• Steam rating (1-5) - sort or filter your library by steam level
• Star rating and vote count - community ratings from Romance.io
• Tags - tropes, themes, settings, and more (e.g. time travel, enemies to lovers, small town, nerdy hero); shows up in Calibre's tag browser where you can sort and filter by tag
• Link to Romance.io - Finds the Romance.io book ID and shows a link to the book's Romance.io page in the book details panel

Once the fields are stored in custom columns, you can do things like search for books with a steam rating >2, or click a tag in the tag browser to see all books with that trope.

Select one or more books and click the toolbar button to download fields from Romance.io. The plugin works on its own, but pairs well with the Romance.io metadata source plugin - if that plugin has already linked a book to Romance.io, this plugin can skip the search step and immediately start to download the fields.

For more detailed instructions, see the plugin's GitHub.

Installation:
In Calibre: Preferences > Plugins > Get new plugins, search for "Romance.io Fields", and click Install. Or download the zip from GitHub and install via Preferences > Plugins > Load plugin from file.

Setup:
Step 1 - Create custom columns (Preferences > Add your own columns):

Field               Lookup Name    Column Type
------------------------------------------------------------------------
Romance.io ID       #romanceio     Column built from other columns
                                   Template: {identifiers:select(romanceio)}
                                   Sort by: Text
Steam Rating        #romiosteam    Integers  (values 1-5)
Star Rating         #romiostars    Floating point numbers (2 decimals)
Vote Count          #romiovotes    Integers
Tags                #romiotags     Comma-separated text, like tags

You don't need all of them - only create the ones you want to use. Lookup names can be anything; you'll map them in plugin settings.

Step 2 - Map columns in plugin settings
Preferences > Plugins > Romance.io Fields > Customize plugin - map each field to the lookup name of the column you created.

Usage:
Select one or more books and click the Romance.io button in the toolbar. The plugin searches Romance.io by title and author, then downloads fields for each matched book. If a book already has a Romance.io ID stored, it skips the search and goes straight to downloading, which is faster.

Configuration options:

• Refresh existing fields (default: on) - re-download all fields even if already set
• Prompt to save (default: off) - confirm before writing to library
• Get tags from website HTML (default: off) - fetch tags from the Romance.io website directly instead of the JSON API, for exact tag matching; slower, requires a browser window
• Maximum tags (default: 50) - cap on tags to download per book

Wrong book matched? If your title or author in Calibre differs from Romance.io (different edition name, spelling, etc.), you can still link the book manually: open the book's detail page on Romance.io (URL contains /books/, not the series page), copy the ID from the URL (e.g. 5484ecd47a5936fb0405756c), then in Calibre open Edit metadata > Ids and add romanceio:5484ecd47a5936fb0405756c.

Notes:

• A browser window may open during downloads - just ignore it, it will close automatically. The plugin tries the JSON API first (fast, no browser); the browser is only used as a fallback.
• Only English is supported for now.

Source code, documentation, & issue reporting: GitHub

If you find this plugin useful, a small donation is appreciated!
Donate via PayPal

Version history:

• v1.0.0 - Initial release

[plain-cover]

Development Builds

If you want to test the latest unreleased changes before they make it into an official release, development builds are available on GitHub.

Development builds may contain bugs. If you encounter an issue with a development build, please report it on GitHub Issues with:

• The version number of the development build you are using (shown in Preferences > Plugins)
• Steps to reproduce the issue
• Any error messages or logs (right-click the Preferences gear icon and choose Restart in debug mode for verbose output; or click the job count in the bottom-right of Calibre, select the failed job, and click Show job details)

To install a development build: download the zip from GitHub and install via Preferences > Plugins > Load plugin from file.