yattee/README.md

63 lines
3.2 KiB
Markdown
Raw Normal View History

2021-12-10 22:32:48 +00:00
<div align="center">
<img src="https://r.yattee.stream/icons/yattee-150.png" width="150" height="150" alt="Yattee logo">
<h1>Yattee</h1>
2022-01-20 22:13:19 +00:00
<p>Alternative YouTube frontend for iOS, tvOS and macOS<br />built with <a href="https://github.com/iv-org/invidious">Invidious</a> and <a href="https://github.com/TeamPiped/Piped">Piped</a></p>
2021-11-09 21:34:11 +00:00
2021-11-16 20:12:47 +00:00
[![AGPL v3](https://shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.en.html)
2021-11-28 14:37:55 +00:00
[![GitHub issues](https://img.shields.io/github/issues/yattee/yattee)](https://github.com/yattee/yattee/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/yattee/yattee)](https://github.com/yattee/yattee/pulls)
2021-11-16 20:12:47 +00:00
[![Matrix](https://img.shields.io/matrix/yattee:matrix.org)](https://matrix.to/#/#yattee:matrix.org)
2021-11-09 21:34:11 +00:00
![Screenshot](https://r.yattee.stream/screenshots/all-platforms.png)
2021-12-10 22:32:48 +00:00
</div>
2021-11-08 13:29:38 +00:00
2021-12-07 23:08:13 +00:00
## Features
2021-12-10 22:32:48 +00:00
* Native user interface built with [SwiftUI](https://developer.apple.com/xcode/swiftui/) with customization settings
2021-11-08 13:29:38 +00:00
* Multiple instances and accounts, fast switching
2021-11-16 20:12:47 +00:00
* [SponsorBlock](https://sponsor.ajay.app/), configurable categories to skip
2021-11-08 13:29:38 +00:00
* Player queue and history
2021-11-16 20:12:47 +00:00
* Fullscreen playback, Picture in Picture and AirPlay support
2021-11-08 13:29:38 +00:00
* Stream quality selection
2022-03-27 21:13:53 +00:00
### Features in alpha testing
2022-03-20 22:29:26 +00:00
* New player component with custom controls, gestures and support for 4K playback
2022-05-22 21:23:05 +00:00
You can leave your feedback in [discussion on v1.4.alpha.4 release](https://github.com/yattee/yattee/discussions/132) or join [Matrix Channel](https://matrix.to/#/#yattee:matrix.org) for a chat. Thanks!
2022-03-20 22:29:26 +00:00
2021-11-08 13:29:38 +00:00
### Availability
2022-03-20 22:29:26 +00:00
|| Invidious | Piped |
2021-11-09 21:34:11 +00:00
| - | - | - |
| User Accounts | ✅ | ✅ |
| Subscriptions | ✅ | ✅ |
| User Playlists | ✅ | ✅ |
2021-11-08 13:29:38 +00:00
| Trending | ✅ | ✅ |
| Channels | ✅ | ✅ |
| Channel Playlists | ✅ | ✅ |
| Search | ✅ | ✅ |
| Search Suggestions | ✅ | ✅ |
2021-11-09 21:34:11 +00:00
| Search Filters | ✅ | 🔴 |
2022-05-22 21:23:05 +00:00
| Popular | ✅ | 🔴 |
2021-11-09 21:34:11 +00:00
| Subtitles | 🔴 | ✅ |
2021-12-04 19:35:41 +00:00
| Comments | 🔴 | ✅ |
2021-11-08 13:29:38 +00:00
2021-12-06 18:13:57 +00:00
You can browse and use accounts from one app and play videos with another (for example: use Invidious account for subscriptions and use Piped as playback source). Comments can be displayed from Piped even when Invidious is used for browsing/playing.
2021-11-28 14:37:55 +00:00
2021-12-06 18:13:57 +00:00
## Documentation
2022-05-22 21:23:05 +00:00
* [Installation](https://github.com/yattee/yattee/wiki/Installation-Instructions)
* [Building](https://github.com/yattee/yattee/wiki/Building-instructions)
2021-12-10 22:32:48 +00:00
* [FAQ](https://github.com/yattee/yattee/wiki)
2021-12-06 18:13:57 +00:00
* [Screenshots Gallery](https://github.com/yattee/yattee/wiki/Screenshots-Gallery)
* [Tips](https://github.com/yattee/yattee/wiki/Tips)
2021-12-10 22:32:48 +00:00
* [Integrations](https://github.com/yattee/yattee/wiki/Integrations)
2021-12-06 18:13:57 +00:00
* [Donations](https://github.com/yattee/yattee/wiki/Donations)
2021-11-28 14:37:55 +00:00
## Contributing
If you're interestred in contributing, you can browse the [issues](https://github.com/yattee/yattee/issues) list or create a new one to discuss your feature idea. Every contribution is very welcome.
2022-03-28 19:30:31 +00:00
Join [Matrix Channel](https://matrix.to/#/#yattee:matrix.org) for a chat if you need an advice or want to discuss the project.
2021-11-09 21:34:11 +00:00
## License and Liability
Yattee and its components is shared on [AGPL v3](https://www.gnu.org/licenses/agpl-3.0.en.html) license.
This tool is an open source software built for learning and research purposes.