Repository files navigation

A web extension forroyalroad.com.
For people who juggle multiple stories.

I've been an avid reader onroyalroad.com for over 4 years and like many others, I jugglemultiple stories at the same time. At some point this got somewhat unmanagable and often I drew a blank when thinkingabout what happened in the last chapter of the story I just opened. More and more I found myself having to go back onechapter and scroll all the way down just to re-read the last few paragraphs as a refresher. This is especially annoyingwhile on mobile, where I often read while on the train.

That's when decided on trying to implement this little idea implementing a refresh of what happened in the last chapter.

RoyalRefresh is a browser extension forroyalroad.com that inserts a button next to RoyalRoad's"Reader Preferences" button on chapter URLs. When clicked, the last few paragraphs of the previous chapter get fetchedand displayed at the top of the chapter, which you can toggle on and off using the button. The extension defaults toshowing you the last 250 words of the previous chapter (adjustable in extension settings,see Settings).

Here's an example of what it looks like:

The extension comes with a settings page where you can adjust the refresh length and other settings.There are a few ways to access the settings page:

1. Click the extension icon in the browser toolbar to open the popup (Recommended)
2. Open RoyalRoad's "Reader Preferences" menu and click "Open RoyalRefresh settings"
3. Depending on your browser, there may be alternative methods to access the extension settings,(such as usingabout:addons in Firefox)

Advanced users can take advanced of the "Advanced options" toggle to reveal more settings. In case the website gets anupdate, the user can adjust the CSS selectors to make the extension work again, until a new update of RoyalRefresh isreleased with the adjusted defaults:

Check out everything I'm tracking in this project'sissues.

This is my first public repo, for now and until changes are needed, just create a issue with an appropriate label and adescriptive message and I will take a look. Any contributions are welcome, issues where I specifically need help aremarked with thecontributions welcome label.

Pull this repo and runpnpm i to install the dependencies. You can then runpnpm dev orpnpm dev:chrometo temporarily load the extension into your browser. The extension will be reloaded automatically when you make changestomost of the code.

You can pass customweb-ext arguments to thepnpm dev command by creating a.webextrc.(json|json5|yml|yaml) filein the root of the project. For more information, see Vite Plugin Web Extension'sdocumentation.

For example to always start the dev browser on certain URLs, you can create a.webextrc.json file with thefollowing content:

{"startUrl": ["https://www.royalroad.com/","about:addons"  ]}

For a full list of arguments, see theweb-extcommand reference.