Potatoshield - Block Adblock on your website

Potatoshield is a revolutionary script designed to empower website owners in the battle against adblock software. With its lightweight and user-friendly nature, Potatoshield effortlessly detects adblockers and displays a captivating banner to users.

⚠️ *Note: This project is still in development. The current version is a beta version, and it may not work as expected, it may have bugs and it may change in the future. Use it at your own risk. For the best experience, please read the RTFM article here.

Features

• [x] Detect adblock software on your website
• [x] Undetectable by adblockers (with some tweaks)
• [x] Lightweight script (less than 20KB in obfuscated mode)
• [x] Easy to use, just inline the script in your HTML layout
• [x] Open-source, no hidden fees or subscriptions, no data collection
• [ ] Shows a banner to the user in multiple languages (coming soon)
• [ ] Use with NPM (coming soon)

List of detected adblocks

Here you can find a list of adblock software that has been detected by potatoshield, along with their versions and the date of the last check.

If you want to update the list, please see the CONTRIBUTOR.md file

Adblockers

| Software | Version | Detected | Last check | Official Site | |------------------|---------|----------|------------|------------------------------| | uBlock | 1.0 | ✅ | 2024-07-29 | uBlock | | Adblock | N/D | ✅ | 2024-07-29 | Adblock | | Adblock Plus | | | | Adblock Plus | | Adblock Ultimate | | | | Adblock Ultimate | | Adblock Max | | | | Adblock Max | | AdGuard | | | | AdGuard | | Ghostery | | | | Ghostery |

Browsers

| Browser | Version | Detected | Last check | |---------|----------|----------|--------------------| | Brave | 92.0 | ✅ | 2024-07-29 | | Opera | 90.0 | ✅ | 2024-07-29 | | Arc Browser | 92.0 | ✅ | 2024-07-29 | | Safari | 14.0 | ✅ | 2024-07-29 |

Before you start

Before you start using potatoshield, you need to know that it is not a 100% bulletproof solution. Adblockers are constantly evolving, and they may find a way to detect potatoshield in the future.

The best way to fight against adblock users is to clone the project, build the script, and host it on your server (jump to #https://github.com/The-3Labs-Team/potatoshield#make-it-undetectable). This way, you can rotate the script name and make it harder for adblockers to detect it.

Installation

You have four methods to use potatoshield on your website:

1. Inline the script (recommended)

You can inline the script in your HTML layout before the closing </body> tag:

<script type="module" defer>
  // Add dist/potatoshield.min.ob.js content here
</script>

2. Import the script (partially recommended) // Not yet implemented

You can install potatoshield by using NPM:

npm install potatoshield

Then, you can import it in one of your main JavaScript file:

import 'potatoshield';

3. Download the script (not recommended)

You can download the script from releases at the root of your website, rename it to something less suspicious and import it in your layout:

<script type="module" defer src="your-potato-random-file.js"></script>

This can be easily detected by adblocker lists, so it is not recommended.

💡 Why not using CDN? Because adblockers can easily block the CDN URL. You can host the file on your own server and randomize the name to avoid detection. Remember to rotate the file name every week or so, or Adblock users (and lists) will be able to block it.

4. Use the CDN (not recommended)

You can use the CDN to import the script in your layout:

<script src="https://cdn.jsdelivr.net/gh/The-3Labs-Team/potatoshield@main/dist/potatoshield.min.ob.js"></script>

This can be easily detected by adblocker lists, so it is not recommended.

Make it undetectable

To make potatoshield undetectable by adblockers, you can use the following tips:

• Rotate the script name: Change the name of the script file every week or so. This will make it harder for adblockers to detect it.

• Obfuscate the code: You can obfuscate the code of the script to make it harder to read and detect.

You can clone the repository and build the script with the following command:

npm run build

This will generate a minified and obfuscated version of the script in the dist folder called potatoshield.min.ob.js.

It is important to remember that potatoshield is not a 100% bulletproof solution. It is a tool to help you fight against adblock users, but it is not a guarantee that it will work forever. Adblockers are constantly evolving, and they may find a way to detect potatoshield in the future.