Please read this short documentation if you would like to contribute to the hufilter project! Thank you!

First of all, the project is being developed in this repository. The another repository, called hufilter, is only the result of the build process and its content are overwritten after each build.

We primarily support following adblockers:

• AdGuard
• uBlock Origin
• Adblock Plus
• AdBlocker Ultimate (uses AdGuard rule syntax)
• AdBlock (uses Adblock Plus rule syntax)

Filter rule categories can be found in sections directory. Currently available filter categories:

Filename	Description	Syntax
ads.txt	Filtering rules that blocks ads only.	Adblock Plus syntax
trackers.txt	Filtering rules that blocks trackers and analytics systems.	Adblock Plus syntax
annoyances.txt	Filtering rules that blocks annoying elements, such as cookie popups, intrusive notifications, recommendations, floating elements, etc.	Adblock Plus syntax
antiadblock.txt	Filtering rules that bypasses anti-adblock scripts, only if this can be solved with ABP capabilities.	Adblock Plus syntax
selfpromo.txt	Filtering rules that blocks self-promitions.	Adblock Plus syntax
other.txt	Anything that does not fall into the categories listed above.	Adblock Plus syntax
ublock-specific.txt	Mixed rules that requires uBlock Origin capabilities.	uBlock Origin syntax *
adguard-specific.txt	Mixed rules that requires AdGuard capabilities.	AdGuard syntax *

* Both of Adguard and uBlock Origin are able to interpret the syntax of Adblock Plus.

Useful links to documentations.

• Adblock Plus:
  • ABP filter cheatsheet
  • ABP filter how-to
  • ABP scriptlets
• uBlock Origin:
  • uBO filter syntax
  • uBO scriptlets
• AdGuard:
  • AG filter syntax
  • AG scriptlets
• Scriptlets compatibility table (by AdGuard)
• Redirects compatibility table
• CSS selectors (MDN)

The build process is executed automatically if a push event is triggered in this repository.

We recommend using Visual Studio Code for development. Please install recommended extensions in order to work with syntax highlight and automatic rule ordering. Node.js is also required for automatic ordering!

• E-mail: [email protected]
• Forum: Discussions
• Issue management: Please use this form (GitHub account required).

The project hufilter is distributed under the "Creative Commons Attribution 4.0" license. Contributors are licensing their work under the very same terms and conditions.