Pedro-Gregorio / TubeMod

A browser extension that allows users to visualize YouTube the way they want.
MIT License
276 stars 23 forks source link

TubeMod

What is it?

TubeMod is a Browser Extension that allows users to hide specific YouTube elements, giving them more control over their viewing experience. Rather than permanently removing elements, TubeMod provides simple toggles to hide parts of YouTube’s UI, making it a lightweight and customizable solution. It is planned, for a future release, allowing users to completely remove elements, instead of simply hiding them.

How to Use

After installing the extension:

  1. Click on the TubeMod icon in your browser toolbar.
  2. Toggle the YouTube elements you want to hide via the popup interface.
  3. Changes will be applied instantly. Enjoy your customized YouTube experience!

How to Install

From the Chrome Web Store

  1. Go to the TubeMod Extension Page on Chrome Web Store.
  2. Click 'Add to Your Browser' and follow the prompts.

From the FireFox Add-Ons

  1. Go to the TubeMod Extension Page on Firefox Add Ons.
  2. Click 'Add to Firefox' and follow the prompts.

How to set up Dev

  1. Clone the repository
git clone https://github.com/Pedro-Gregorio/TubeMod.git
cd TubeMod

If the clone command doesn't work just download the repository as a ZIP file and extract it to your desired location.

Depending on your browser you will have to take different routes:

For Chromium based browsers:

  1. Go to chrome://extensions. The "chrome" part might be changed to the name of the browser.
  2. Enable the developer mode toggle.
  3. Click on "Load unpacked".
  4. Select the folder where the repository is (it should contain the manifest.json)
  5. Every time you make a change either reload the extension or remove it an add it again. The latter works better when dealing with js parts of the code.

For Firefox based browsers:

  1. Change the name of the manifest.json to something like manifest_chrome.json to avoid conflicts.
  2. Also rename manifest_firefox.json to manifest.json.
  3. On Firefox set it up as a temporary add-on by going to about:debugging and on the "Load Temporary Addon" click add and select any file of the repository.
  4. Every time you make a change either reload the temporary add-on or remove it and add it again. The latter works better when dealing with js parts of the code.
  5. Before pushing your changes to GitHub, make sure to revert the name changes in the manifests.

Before pushing to GitHub, please update the release notes with the feature you're adding.

Some things to consider:

Features and Future Plans

Check all the available and planned features here.

How can I support the project?

The extension will always remain free to use. While contributions are not required, any support is greatly appreciated! If you'd like to contribute, you can:

License

This project is licensed under the MIT License - see the LICENSE file for details.