Skip to content

The most powerful and intuitive YouTube chat filter extension.

License

Notifications You must be signed in to change notification settings

LiveTL/ytcfilter

Repository files navigation

YtcFilter | YouTube Chat Filter

Installation

Chrome Web Store

Release packages are also available on GitHub.

Building from Source

For legacy reasons, we have a mv2 branch used by the LiveTL extension's Manifest V2 Firefox variant, while the main branch houses the main Manifest V3 version that's published to stores.

Development

Note: The repo expects a Linux or Unix-like environment. If you are on Windows, use WSL.

Clone the repository:

git clone [email protected]:LiveTL/ytcfilter.git

Open the repository and npm install:

cd ytcfilter
npm install --force # install dependencies

Serve the extension for local development:

npm run dev:chrome    # devserver for Chrome extension
npm run dev:firefox   # devserver for Firefox extension

npm run start:chrome  # devserver + open extension in Chrome
npm run start:firefox # devserver + open extension in Firefox

Building for Production

Our build script is an automated GitHub action, where ${{ github.ref }} should evaluate to a tag in the format vX.Y.Z (where X.Y.Z is the version number).

To simulate the build:

VERSION=X.Y.Z npm run build         # Chrome & Firefox
VERSION=X.Y.Z npm run build:chrome  # just Chrome
VERSION=X.Y.Z npm run build:firefox # just Firefox

The built ZIP files can be found in the build directory.