Repository files navigation

filtrite is a project for generating filter lists forBromite andCromite. See the page aboutCustom Ad Block Filters for more info.

You can choose any list from the table, then hold the name to copy its link. Add it to Bromite by going to settings > AdBlock settings, then setting "Filters URL" to the link you just copied.

Alternatively, you cango here to search forks of this project for more lists, e.g. for other countries.

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 bythe ruleset generation tool (as the output indicates some failures). If you have a comment on that, please open an issue :)

The normal Bromite ad blocking engine does not support all blocking formats. However, since the introduction of user scripts, it has become possible to block even more annoying elements. If you want more blockers (e.g. for cookie prompts), see mycustom Bromite user scripts repository.

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. in the following the name isexample-list. Please note that the file name must end with.txt, so in our case we call itexample-list.txt (put it in thelists directory).
4. Search for filter lists you want to use. You can for example find themhere, use those in "uBlock Origin" or "AdBlock Plus" format (however, it's possible thatnot all types of rules are supported). Go to info, then "View" and copy the URL to the list.
5. Create a filelists/example-list.txt (in thelists directory) that contains the URLs to filter lists you copied before. It should look like this:

   # Lines starting with # are ignored, empty lines are also allowed# List one URL per line:https://easylist.to/easylist/easylist.txthttps://...# The following line doesn't work, only put either a comment or an URL in one line, not bothhttp://  # 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 likehttps://github.com/USERNAME/filtrite/releases/latest/download/FILENAME.dat. If your URL (except for the username/filename part) contains numbers, you copied the wrong link.
8. Check that the generated filter file size is less than the allowed maximum of20 MB. If it isn't, you must remove some lists
9. Set this URL as the filter file in Bromite settings.

Another thing to note is thatGitHub disables scheduled workflows after 60 days, meaning that you sometimes have to commit something to keep your fork "alive".

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