https://github.com/the-3labs-team/potatoshield

🥔 Detects ad blockers and shows a banner to encourage users to disable them.
https://github.com/the-3labs-team/potatoshield

adblocking javascript

Last synced: over 1 year ago
JSON representation

🥔 Detects ad blockers and shows a banner to encourage users to disable them.

• Host: GitHub
• URL: https://github.com/the-3labs-team/potatoshield
• Owner: The-3Labs-Team
• License: mit
• Created: 2024-07-26T13:43:44.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-24T03:31:14.000Z (almost 2 years ago)
• Last Synced: 2025-01-31T08:43:26.762Z (over 1 year ago)
• Topics: adblocking, javascript
• Language: JavaScript
• Homepage: https://3labs.it
• Size: 696 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# PotatoShield - Detect & Block Adblock on your website

[![Lint](https://github.com/The-3Labs-Team/potatoshield/actions/workflows/lint.yml/badge.svg)](https://github.com/The-3Labs-Team/potatoshield/actions/workflows/lint.yml)

[![Playwright](https://github.com/The-3Labs-Team/potatoshield/actions/workflows/playwright.yml/badge.svg)](https://github.com/The-3Labs-Team/potatoshield/actions/workflows/playwright.yml)

[![Build](https://github.com/The-3Labs-Team/potatoshield/actions/workflows/build.yml/badge.svg)](https://github.com/The-3Labs-Team/potatoshield/actions/workflows/build.yml)

![License](https://img.shields.io/github/license/the-3labs-team/potatoshield)

[![Maintainability](https://api.codeclimate.com/v1/badges/a7b3762f32a20d9e8777/maintainability)](https://codeclimate.com/github/The-3Labs-Team/potatoshield/maintainability)

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](https://medium.com/@murdercode/defeat-adblock-step-by-step-guide-to-blocking-adblock-on-your-website-c78c1143e34d).



## 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.

### Adblockers

| Software         | Version | Detected | Last check | Official Site                |

|------------------|---------|----------|------------|------------------------------|

| uBlock           | 1.0     | ✅        | 2024-07-29 | [uBlock](https://ublock.org) |

| Adblock          | 6.6.0   | ✅        | 2024-07-30 | [Adblock](https://getadblock.com) |

| Adblock Plus     | 4.4     | ✅        | 2024-07-30 | [Adblock Plus](https://adblockplus.org) |

| Adblock Ultimate | 3.8.26  | ✅        | 2024-07-30 | [Adblock Ultimate](https://adblockultimate.net) |

| AdGuard AdBlocker| 4.3.64  | ✅        | 2024-07-30 | [AdGuard](https://adguard.com) |

| Ghostery         | 8.12.13 | ✅        | 2024-07-30 | [Ghostery](https://ghostery.com) |

| Lock Adblock     | 3.5.1   | ✅        | 2024-07-30 | [Lock Adblock](https://chromewebstore.google.com/detail/lock-adblock/ciadmnanclfadfcfjbbajmggediammha?hl=it&pli=1) |

| SmartAdblock     | 1.1.4   | ✅        | 2024-07-30 | [SmartAdblock](https://www.smartadblock.co.uk/) |

### Browsers

// TODO

## 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 `