CatBlock (previously known as "AdBlock with CatBlock") is like an ad blocking extension, but instead of blocking ads it shows you pictures of cats by default (configurable).
You can also disable replacing ads by cats, so CatBlock can work as a standard ad blocking extension (useful for when you're doing presentations anywhere!)
If you want to find out the history of this extension, you can check it out here.
This project aims at maintaining and improving the original CatBlock project by Michael Gundlach (the creator of AdBlock and CatBlock), which is built on top of the AdBlock code.
AdBlock has recently switched to the Adblock Plus codebase in version 3.0, but instead of importing those changes to CatBlock, we think it would be better to improve the original codebase.
CatBlock is available in Chrome Web Store, Opera Extensions Store and Firefox Addons Store.
Right now, CatBlock is not available in the Safari Extensions Store, or in the Windows Store, but we are looking into releasing CatBlock there as well!
If you can't wait for an official release of CatBlock on Windows Store, find out how to sideload CatBlock on Edge right now.
CatBlock is compatible with following browsers:
- Chrome: 49+
- Opera: 35+
- Safari: 6+
- Firefox: 48+
- Edge: Windows 10 Anniversary - version 1607
We use many different services to help keep CatBlock working! We use Travis to build new versions automatically for us.
We also have Travis connected to , to run a few automated unit tests for us. If "builds:passing" shows at the top of this README, then it's probably working fine, otherwise the current version of the code might not work so well.
The original Catblock has been modified with changes for use in biomedical informatics research. Major changes include:
- Improved display of ads. Ads are limited and restricted to try to fit more naturally into a given space than what catblock does.
- Clicking an ad now redirects to a page. Photos to display are pulled from a Flickr photostream which accepts the image title as the target URL for redirection.
- Added support for gif images
- Analytics to monitor research
- Various minor tweaks and adjustments to suit Catblock for this purpose.
There have been 3 items added to the settings menu. These are:
- User ID - Unique user identifier for analytics use
- Total ads to display per page - Limits the total number of ads per page to this amount
- Ads per ad group to display - Limits the number of ads per block
Implemented are some basic analytics that log which ads are shown and which the user clicks on. This is currently done using AWS to intercept and log requests.
The target URL's are located in /catblock/contentscript.js:499, for a displayed ad, and 312 for a clicked ad. These requests send a JSON POST request with a body of:
{
"display_time": String,
"user": String,
"url": String
}
- Chrome is the only supported browser
- Flickr image resizing is no longer functional. This means that images will need to be uploaded to Flickr in the desired size to work properly. This was disabled to allow gifs, which Flickr doesn't resize and will just return a static image. This can be changed back if needed in
catblock/channels.js.
The development guide will make your life easier if you need to build CatBlock or create an unpacked development environment and change the source code.
If you want to contribute any improvements to the code, please go ahead and send us a pull request from a fork of this repo!
If we see that you are a dedicated contributor, we may provide you with contributor permissions. The people to contact for this project are @kpeckett and @tomasko126.
If you want to keep an eye on CatBlock or even know more about it, check out our Wiki page, where you can find all important information.
We use Slack a lot - make an account at http://catblock-slackin.herokuapp.com and log in at https://catblock.slack.com. You can ask questions there (the main contributors are all in Europe, so anyone in Australia should expect a bit of a wait).