mirror of
https://github.com/dmunozv04/iSponsorBlockTV.git
synced 2026-01-27 12:50:52 +03:00
Final v2 commit before launch?
Adds better logging and modifies README.md
This commit is contained in:
47
README.md
47
README.md
@@ -1,33 +1,49 @@
|
||||
# iSponsorBlockTV
|
||||
Skip sponsor segments in YouTube videos playing on a YouTube TV device (see below for compatibility details).
|
||||
|
||||
Skip sponsor segments in YouTube videos playing on an Apple TV. Sponsor Block in YouTube for apple TV
|
||||
This project is written in asynchronous python and should be pretty quick.
|
||||
|
||||
This project is written in asycronous python and should be pretty quick.
|
||||
|
||||
# Installation
|
||||
## Installation
|
||||
Check the [wiki](https://github.com/dmunozv04/iSponsorBlockTV/wiki/Installation)
|
||||
|
||||
Warning: armv7 builds have been deprecated.
|
||||
Warning: docker armv7 builds have been deprecated. Amd64 and arm64 builds are still available.
|
||||
|
||||
# Usage
|
||||
## Compatibility
|
||||
Leyend: ✅ = Working, ❌ = Not working, ❔ = Not tested
|
||||
|
||||
Run iSponsorBLockTV on the same network as the Apple TV.
|
||||
Open an issue/pull request if you have tested a device that isn't listed here.
|
||||
|
||||
It connects to the Apple TV, watches its activity and skips any sponsor segment using the [SponsorBlock](https://sponsor.ajay.app/) API.
|
||||
| Device | Status |
|
||||
|:-------------------|:------:|
|
||||
| Apple TV | ✅ |
|
||||
| Samsung TV (Tizen) | ✅ |
|
||||
| LG TV (WebOS) | ✅ |
|
||||
| Android TV | ❔ |
|
||||
| Chromecast | ❔ |
|
||||
| Roku | ❔ |
|
||||
| Fire TV | ❔ |
|
||||
| Nintendo Switch | ✅ |
|
||||
| Xbox One/Series | ❔ |
|
||||
| Playstation 4/5 | ❔ |
|
||||
|
||||
The last 5 videos' segments are cached to limit the number on queries on SponsorBlock and YouTube.
|
||||
## Usage
|
||||
Run iSponsorBlockTV on a computer that has network access.
|
||||
Auto discovery will require the computer to be on the same network as the device during setup.
|
||||
|
||||
It connects to the device, watches its activity and skips any sponsor segment using the [SponsorBlock](https://sponsor.ajay.app/) API.
|
||||
It can also skip/mute YouTube ads.
|
||||
|
||||
# Libraries used
|
||||
- [pyatv](https://github.com/postlund/pyatv) Used to connect to the Apple TV
|
||||
## Libraries used
|
||||
- [pyytlounge](https://github.com/FabioGNR/pyytlounge) Used to interact with the device
|
||||
- asyncio and [aiohttp](https://github.com/aio-libs/aiohttp)
|
||||
- [async-cache](https://github.com/iamsinghrajat/async-cache)
|
||||
- [Textual](https://github.com/textualize/textual/) Used for the amazing new graphical configurator
|
||||
- [ssdp](https://github.com/codingjoe/ssdp) Used for auto discovery
|
||||
|
||||
# Projects using this proect
|
||||
## Projects using this project
|
||||
- [Home Assistant Addon](https://github.com/bertybuttface/addons/tree/main/isponsorblocktv)
|
||||
|
||||
# Contributing
|
||||
|
||||
## Contributing
|
||||
1. Fork it (<https://github.com/dmunozv04/iSponsorBlockTV/fork>)
|
||||
2. Create your feature branch (`git checkout -b my-new-feature`)
|
||||
3. Commit your changes (`git commit -am 'Add some feature'`)
|
||||
@@ -35,9 +51,8 @@ The last 5 videos' segments are cached to limit the number on queries on Sponsor
|
||||
5. Create a new Pull Request
|
||||
|
||||
## Contributors
|
||||
|
||||
- [dmunozv04](https://github.com/dmunozv04) - creator and maintainer
|
||||
- [HaltCatchFire](https://github.com/HaltCatchFire) - updated dependencies and improved skip logic
|
||||
- [Oxixes](https://github.com/oxixes) - added support for channel whitelist and minor improvements
|
||||
# License
|
||||
## License
|
||||
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
|
||||
|
||||
Reference in New Issue
Block a user