update artwork and documentation

This commit is contained in:
simon 2022-11-28 20:02:07 +07:00
parent 69e02e72be
commit b34d8a822c
No known key found for this signature in database
GPG Key ID: 2C15AA5E89985DD4
11 changed files with 33 additions and 15 deletions

View File

@ -1,19 +1,35 @@
![Tube Archivist Companion](assets/tube-archivist-companion-banner.png?raw=true "Tube Archivist Companion Banner") ![Tube Archivist Companion](assets/tube-archivist-companion-banner.png?raw=true "Tube Archivist Companion Banner")
<h1 align="center">Tube Archivist Companion for your Browser</h1> <h1 align="center">Browser Extension for Tube Archivist</h1>
<div align="center"> <div align="center">
<a href="https://www.tilefy.me" target="_blank"><img src="https://tiles.tilefy.me/t/tubearchivist-firefox.png" alt="tubearchivist-firefox" title="TA Companion Firefox users" height="50" width="190"/></a> <a href="https://www.tilefy.me" target="_blank"><img src="https://tiles.tilefy.me/t/tubearchivist-firefox.png" alt="tubearchivist-firefox" title="TA Companion Firefox users" height="50" width="190"/></a>
<a href="https://www.tilefy.me" target="_blank"><img src="https://tiles.tilefy.me/t/tubearchivist-chrome.png" alt="tubearchivist-chrome" title="TA Companion Chrome users" height="50" width="190"/></a> <a href="https://www.tilefy.me" target="_blank"><img src="https://tiles.tilefy.me/t/tubearchivist-chrome.png" alt="tubearchivist-chrome" title="TA Companion Chrome users" height="50" width="190"/></a>
</div> </div>
## Core Functionality ## Core Functionality
A browser extension to bridge YouTube with [Tube Archivist](https://github.com/tubearchivist/tubearchivist). This extension allows you to do the following: This is a browser extension to bridge YouTube with [Tube Archivist](https://github.com/tubearchivist/tubearchivist), your self hosted YouTube media server.
- Add your Tube Archivist connection details in the addon popup - Add your Tube Archivist connection details in the addon popup.
- Add a download button to the popup for YouTube links - On YouTube video pages, inject a download button to download that video and a subscribe button to subscribe to that channel.
- Add a subscribe button to subscribe to channels and playlists - On YouTube channel pages, inject a button to subscribe to the channel or download the complete channel.
- Throughout most places, hover over the top left corner of a video thumbnail to reveal a download button for that video.
- Sync your cookies for yt-dlp. - Sync your cookies for yt-dlp.
![popup screenshot](assets/screenshot.png?raw=true "Tube Archivist Companion Popup") ## Screenshots
![popup screenshot](assets/screenshot.png?raw=true "Tube Archivist Companion Popup")
Popup to enter your connection details.
<br><br>
![video page](assets/screenshot-video.png?raw=true "Tube Archivist Companion Video Page")
Button injected on video page to download the video or subscribe to the channel.
<br><br>
![search page](assets/screenshot-search.png?raw=true "Tube Archivist Companion Search Page")
Download button injected showing when hovering over top left corned of thumbnail
<br><br>
![channel page](assets/screenshot-channel.png?raw=true "Tube Archivist Companion Channel Page")
Channel button injected to subscribe or download whole channel, video download button showing when hovering over topleft corner of thumbnail.
<br>
## Install ## Install
- Firefox: The addon is available on the [Extension store](https://addons.mozilla.org/addon/tubearchivist-companion/). - Firefox: The addon is available on the [Extension store](https://addons.mozilla.org/addon/tubearchivist-companion/).
@ -23,35 +39,36 @@ A browser extension to bridge YouTube with [Tube Archivist](https://github.com/t
After a new release here on GitHub, you'll get updates automatically in your browser. Due to the verification process, for Firefox this usually takes 1-2 hours, for Chrome 2-3 days. After a new release here on GitHub, you'll get updates automatically in your browser. Due to the verification process, for Firefox this usually takes 1-2 hours, for Chrome 2-3 days.
## Permissions ## Permissions
- **Access your data for www.youtube.com**: Needed for the addon to know your current page on YouTube to send the link to Tube Archivist. - **Access your data for www.youtube.com**: Needed to inject download and subscribe buttons directly into the page.
- **Storage**: Needed to store your connection details, needed to store your last visited YouTube link within the browser. - **Storage**: Needed to store your connection details.
- **Cookie**: Needed to read your cookies for youtube.com to access restricted videos. - **Cookie**: Needed to read your cookies for youtube.com to access restricted videos.
## Setup ## Setup
- **URL**: This is where your Tube Archivist instance is located. Can be a host name or a IP address, use a full URL with protocol, e.g. *http://*. - **URL**: This is where your Tube Archivist instance is located. Can be a host name or an IP address. Add the port if needed at the end, e.g. `:8000`.
- **Port**: Network port of TA. - **API key**: You can find your API key on the settings page of your Tube Archivist instance.
- **API key**: You can find your API key on the settings page of your Tube Archivist instance.
A green checkmark will appear next to the *Save* button if your connection is working. A green checkmark will appear next to the *Save* button if your connection is working.
## Options ## Options
- **Sync YouTube cookies**: Send your cookies to TubeArchivist to use for yt-dlp requests. - **Sync YouTube cookies**: Send your cookies to TubeArchivist to use for yt-dlp requests.
## Test this extension ## Test this extension
Use the correct manifest file for your browser. Either rename the browser specific file to `manifest.json` before loading the addon or symlink it to the correct location, e.g. `ln -s manifest-firefox.json manifest.json`. Use the correct manifest file for your browser. Either rename the browser specific file to `manifest.json` before loading the addon or symlink it to the correct location, e.g. `ln -s manifest-firefox.json manifest.json`.
- Firefox - Firefox
- Open `about:debugging#/runtime/this-firefox` - Open `about:debugging#/runtime/this-firefox`
- Click on *Load Temporary Add-on* - Click on *Load Temporary Add-on*
- Select the *manifest.json* file to load the addon. - Select the *manifest.json* file to load the addon.
- You can *inspect* background.js by lunching the debug tools from there.
- Chrome / Chromium - Chrome / Chromium
- Open `chrome://extensions/` - Open `chrome://extensions/`
- Toggle *Developer mode* on top right - Toggle *Developer mode* on top right
- Click on *Load unpacked* - Click on *Load unpacked*
- Open the folder containing the *manifest.json* file. - Open the folder containing the *manifest.json* file.
- Click on *Service Worker* to open the dev tools at background.js.
## Compatibility ## Compatibility
- Verify that you are running the latest version of Tube Archivist as the API is under development and will change. - Verify that you are running the [latest version](https://github.com/tubearchivist/tubearchivist/releases/latest) of Tube Archivist as the API is under development and will change.
- For testing this extension between releases, use the *unstable* builds of Tube Archivist, only for your tesing environment. - For testing this extension between releases, use the *unstable* builds of Tube Archivist, only for your testing environment.
## Roadmap ## Roadmap
Join us on [Discord](https://discord.gg/AFwz8nE7BK) and help us improve and extend this project. This is a list of planned features, in no particular order: Join us on [Discord](https://discord.gg/AFwz8nE7BK) and help us improve and extend this project. This is a list of planned features, in no particular order:
@ -60,3 +77,4 @@ Join us on [Discord](https://discord.gg/AFwz8nE7BK) and help us improve and exte
- [ ] Implement download/subscribe button for playlists - [ ] Implement download/subscribe button for playlists
- [ ] Implement download button for videos on playlist - [ ] Implement download button for videos on playlist
- [ ] Error handling for connection errors - [ ] Error handling for connection errors
- [X] Dynamically inject buttons with mutation observer

BIN
assets/icon-128x128.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 370 KiB

BIN
assets/screenshot-video.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.8 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 12 KiB