jchammons / filtrite

Custom AdBlock filterlist generator for Bromite

filtrite

filtrite is a project for generating filter lists for Bromite. See the page about Custom Ad Block Filters for more info.

Lists

You can choose any list from below, copy the link and add it in Bromite by going to settings > AdBlock settings, then setting Filters URL to the one you just copied.

Here's a list:

Link	Description
Bromite Default	Bromite default filter list, but generated by this tool
Bromite Extended	The default list with additional annoyance blockers I use with uBlock Origin on Desktop
German	The "Bromite Extended" list with additional region-specific blocklists for german sites

These lists are regularly updated automatically using GitHub Actions.

Note: I'm not 100% sure if all list formats that are used are actually supported by the ruleset generation tool (as the output indicates some failures). If you have a comment on that, please open an issue :)

Using your own filter lists

This program is designed in a way that allows easily adding new lists.

To create a new list:

1. Fork this repository
2. Enable GitHub Actions by switching to the "Actions" tab of your repo, then confirming that you want to enable them
3. Choose a name for the list, e.g. example-list
4. Search for filter lists you want to use. You can for example find them here, use those in "uBlock Origin" or "AdBlock Plus" format (however, it's possible that not all types of rules are supported). Go to info, then "View" and copy the URL to the list.
5. Create a file lists/example-list.txt (aka in the lists directory) that contains the URLs to filter lists you copied before. It should look like this:

   # Lines starting with # are comments, empty lines are also allowed
   # List one URL per line:
   https://easylist.to/easylist/easylist.txt
   https://...
   
   # The following line doesn't work, only put either a comment or an URL in one line, not both
   http://  # Invalid comment on URL
   

6. Save your file, commit and push. GitHub actions should now build the list and create a release
7. After GitHub Actions generated the release, you can copy the linked URL in the release to always get the latest generated version. This URL looks something like https://github.com/USERNAME/filtrite/releases/latest/download/FILENAME.dat.
8. Check that the generated filter file size is less than the allowed maximum of 10 MB. If it isn't, you must remove some lists
9. Set this URL as the filter file in Bromite settings.

License

This is free as in freedom software. Do whatever you like with it.