Giter Club home page Giter Club logo

ao3-enhancer's Introduction

AO3 Enhancer

Firefox extension for the fanfiction website ArchiveOfOurOwn.

Installing

Install this add-on for Firefox

Installing on Mobile

This guide details how to install any add-on in general on Firefox Nightly browsers on mobile.

Note: This extension should work on mobile, but it has not been extensively tested there. Please report any bugs you find in the issues tab!

  1. Create a collection on the Firefox Add-ons collections page
  2. Add "AO3 Enhancer" (Or any other add-on) to that collection
  3. Open Firefox Nightly's settings
  4. Select Custom Add-on Collection in the Advanced section
  5. Your User ID can be found by looking at the URL of your Firefox Add-on's profile
  6. Your Collection name is whatever you decided to name your collection
  7. Firefox Nightly will now allow you to install all the add-ons in your collection

Features

Most features are disabled by default. Please click on the extension icon to enable features in the options menu.

Enhancer Additions

  • Kudos to Hit Ratio: Adds a kudos to hit percentage to the stats list of a work.
  • Hide Fics by Ratio: Automatically hides works with too low kudos to hit ratio.
  • Hide Fics With Too Many Fandoms: Automatically hides works with too many fandoms.

Built-in Filtering Settings

Automatically modifies AO3 urls using the archive's built-in filter.

  • Exclude tags/fandoms: Exclude works with specific tags/fandoms.
  • Exclude archive warnings: Exclude selected warnings.
  • Select a default language: Only works of a selected language will be displayed.
  • More options: Filter for crossovers, completion, word count, date updated, and search within results.

Roadmap

These are features I currently plan on adding. Please suggest additional features in the issues tab!

TODO

  • Filter & sort your marked-for-later fics
  • Filter fics by if already read
  • Filter fics by individual fic ID
  • Add ability to get notified when fics are completed

TODO Lower Priority

These features are unlikely to be added.

  • Reading list: Add specific chapters of fics to a list (Bookmarking chapters)
  • Auto-include stuff
    • Ratings
    • Warnings
    • Categories
    • Tags/Fandoms

Building the Add-on

This section will walk you through how to build the add-on yourself.

Begin by installing required packages with npm install, then build the add-on with provided scripts using webpack.

Development build

This will cause webpack to optimize for development. To build for development, run:

npm run build:dev

Production build

This will cause webpack to optimize for production. To build for production, run:

npm run build:prod

Add-on Compilation

Latest version of the add-on was built using these software versions:

Windows 10
Version: 21H2
Npm: 8.19.2
Node: v18.12.1

Acknowledgements

This addon was inspired by the extensions I use to browse AO3:

The icon is a modified version of the icon for AO3 Enhancements by jsmnbom.

The options page background is CC-BY-4.0 by Hero Patterns.

ao3-enhancer's People

Contributors

ann4belle avatar dependabot[bot] avatar monoscyron avatar

Stargazers

 avatar

Watchers

 avatar

ao3-enhancer's Issues

chrome extension

hey this is lovely, i was wondering if you'd consider also making it a chrome extension? thank you for your work!

Ratio Limit N/A, Works Still Being Hidden

Describe the bug
Even with the ratio limit set to the default of N/A (which reappears when manually entering 0 into the options), works with zero kudos are still being hidden.

To Reproduce
Steps to reproduce the behavior:

  1. Find a work that has zero Kudos
  2. Observe that the extension hides the work

Expected behavior
Unless a >0 ratio is specified by the user, the function to hide works based on kudos/hits ratio should be disabled.

Desktop (please complete the following information):

  • OS: Windows
  • Browser Firefox 113.0.1
  • Version 0.0.6

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.