mirror of
https://github.com/yattee/yattee.git
synced 2025-10-31 12:41:57 +00:00
Update README
This commit is contained in:
Arkadiusz Fal
109
README.md
109
README.md
@@ -2,16 +2,14 @@
|
|||||||
|
|
||||||
Video player for [Invidious](https://github.com/iv-org/invidious) and [Piped](https://github.com/TeamPiped/Piped) instances built for iOS, tvOS and macOS.
|
Video player for [Invidious](https://github.com/iv-org/invidious) and [Piped](https://github.com/TeamPiped/Piped) instances built for iOS, tvOS and macOS.
|
||||||
|
|
||||||
|
|
||||||
[](https://www.gnu.org/licenses/agpl-3.0.en.html)
|
[](https://www.gnu.org/licenses/agpl-3.0.en.html)
|
||||||
[](https://github.com/yattee/yattee/issues)
|
[](https://github.com/yattee/yattee/issues)
|
||||||
[](https://github.com/yattee/yattee/pulls)
|
[](https://github.com/yattee/yattee/pulls)
|
||||||
[](https://matrix.to/#/#yattee:matrix.org)
|
[](https://matrix.to/#/#yattee:matrix.org)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Major Features
|
||||||
* Native user interface built with [SwiftUI](https://developer.apple.com/xcode/swiftui/)
|
* Native user interface built with [SwiftUI](https://developer.apple.com/xcode/swiftui/)
|
||||||
* Multiple instances and accounts, fast switching
|
* Multiple instances and accounts, fast switching
|
||||||
* [SponsorBlock](https://sponsor.ajay.app/), configurable categories to skip
|
* [SponsorBlock](https://sponsor.ajay.app/), configurable categories to skip
|
||||||
@@ -37,104 +35,15 @@ Video player for [Invidious](https://github.com/iv-org/invidious) and [Piped](ht
|
|||||||
| Subtitles | 🔴 | ✅ |
|
| Subtitles | 🔴 | ✅ |
|
||||||
| Comments | 🔴 | ✅ |
|
| Comments | 🔴 | ✅ |
|
||||||
|
|
||||||
## Installation
|
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.
|
||||||
### Requirements
|
|
||||||
System requirements:
|
|
||||||
* iOS 14 (or newer)
|
|
||||||
* tvOS 15 (or newer)
|
|
||||||
* macOS Big Sur (or newer)
|
|
||||||
|
|
||||||
### How to install?
|
## Documentation
|
||||||
|
* [Installation Instructions](https://github.com/yattee/yattee/wiki/Installation-instructions)
|
||||||
#### macOS
|
* [Integrations](https://github.com/yattee/yattee/wiki/Integrations)
|
||||||
Download and run latest version from the [Releases](https://github.com/yattee/yattee/releases) page.
|
* [Screenshots Gallery](https://github.com/yattee/yattee/wiki/Screenshots-Gallery)
|
||||||
|
* [Tips](https://github.com/yattee/yattee/wiki/Tips)
|
||||||
#### iOS/tvOS: [AltStore](https://altstore.io/) (free)
|
* [FAQ](https://github.com/yattee/yattee/wiki)
|
||||||
You can sideload IPA files downloaded from the [Releases](https://github.com/yattee/yattee/releases) page to your iOS or tvOS device - check [AltStore FAQ](https://altstore.io/faq/) for more information.
|
* [Donations](https://github.com/yattee/yattee/wiki/Donations)
|
||||||
|
|
||||||
If you have to access to the beta AltStore version (v1.5, for Patreons only), you can add the following repository in `Browse > Sources` screen:
|
|
||||||
|
|
||||||
`https://alt.yattee.stream`
|
|
||||||
|
|
||||||
#### iOS/tvOS: Signing IPA files online (paid)
|
|
||||||
[UDID Registrations](https://www.udidregistrations.com/) provides services to sign IPA files for your devices. Refer to: ***Break free from the App Store*** section of the website for more information.
|
|
||||||
|
|
||||||
#### iOS/tvOS: Manual installation
|
|
||||||
Download sources and compile them on a Mac using Xcode, install to your devices. Please note that if you are not registered in Apple Developer Program you will need to reinstall every 7 days.
|
|
||||||
|
|
||||||
## Integrations
|
|
||||||
### macOS
|
|
||||||
With [Finicky](https://github.com/johnste/finicky) you can configure your system to open all the video links in the app. Example configuration:
|
|
||||||
```js
|
|
||||||
{
|
|
||||||
match: [
|
|
||||||
finicky.matchDomains(/(.*\.)?youtube.com/),
|
|
||||||
finicky.matchDomains(/(.*\.)?youtu.be/)
|
|
||||||
],
|
|
||||||
browser: "/Applications/Yattee.app"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Screenshots
|
|
||||||
### iOS
|
|
||||||
| Player | Search | Playlists |
|
|
||||||
| - | - | - |
|
|
||||||
| [](https://r.yattee.stream/screenshots/iOS/player.png) | [](https://r.yattee.stream/screenshots/iOS/search-suggestions.png) | [](https://r.yattee.stream/screenshots/iOS/playlists.png) |
|
|
||||||
### iPadOS
|
|
||||||
| Settings | Player | Subscriptions |
|
|
||||||
| - | - | - |
|
|
||||||
| [](https://r.yattee.stream/screenshots/iPadOS/settings.png) | [](https://r.yattee.stream/screenshots/iPadOS/player.png) | [](https://r.yattee.stream/screenshots/iPadOS/subscriptions.png) |
|
|
||||||
### tvOS
|
|
||||||
| Player | Popular | Search | Now Playing | Settings |
|
|
||||||
| - | - | - | - | - |
|
|
||||||
| [](https://r.yattee.stream/screenshots/tvOS/player.png) | [](https://r.yattee.stream/screenshots/tvOS/popular.png) | [](https://r.yattee.stream/screenshots/tvOS/search.png) | [](https://r.yattee.stream/screenshots/tvOS/now-playing.png) | [](https://r.yattee.stream/screenshots/tvOS/settings.png) |
|
|
||||||
### macOS
|
|
||||||
| Player | Channel | Search | Settings |
|
|
||||||
| - | - | - | - |
|
|
||||||
| [](https://r.yattee.stream/screenshots/macOS/player.png) | [](https://r.yattee.stream/screenshots/macOS/channel.png) | [](https://r.yattee.stream/screenshots/macOS/search.png) | [](https://r.yattee.stream/screenshots/macOS/settings.png) |
|
|
||||||
|
|
||||||
## Tips
|
|
||||||
### Settings
|
|
||||||
* [tvOS] To open settings, press Play/Pause button while hovering over navigation menu or video
|
|
||||||
### Navigation
|
|
||||||
* Use videos context menus to add to queue, open or subscribe channel and add to playlist
|
|
||||||
* [tvOS] Pressing buttons in the app trigger switch to next available option (for example: next account in Settings). If you want to access list of all options, press and hold to open the context menu.
|
|
||||||
* [iOS] Swipe the player/title bar: up to open fullscreen details view, bottom to close fullscreen details or hide player
|
|
||||||
### Favorites
|
|
||||||
* Add more sections using ❤️ button in views channels, playlists, searches, subscriptions and popular
|
|
||||||
* [iOS/macOS] Reorganize with dragging and dropping
|
|
||||||
* [iOS/macOS] Remove section with right click/press and hold on section name
|
|
||||||
* [tvOS] Reorganize and remove from `Settings > Edit Favorites...`
|
|
||||||
### Keyboard shortcuts
|
|
||||||
* `Command+1` - Favorites
|
|
||||||
* `Command+2` - Subscriptions
|
|
||||||
* `Command+3` - Popular
|
|
||||||
* `Command+4` - Trending
|
|
||||||
* `Command+F` - Search
|
|
||||||
* `Command+P` - Play/Pause
|
|
||||||
* `Command+S` - Play Next
|
|
||||||
* `Command+O` - Toggle Player
|
|
||||||
|
|
||||||
|
|
||||||
## Donations
|
|
||||||
|
|
||||||
You can support development of this app with
|
|
||||||
[Patreon](https://www.patreon.com/arekf) or cryptocurrencies:
|
|
||||||
|
|
||||||
**Monero (XMR)**
|
|
||||||
```
|
|
||||||
48zfKjLmnXs21PinU2ucMiUPwhiKt5d7WJKiy3ACVS28BKqSn52c1TX8L337oESHJ5TZCyGkozjfWZG11h6C46mN9n4NPrD
|
|
||||||
```
|
|
||||||
**Bitcoin (BTC)**
|
|
||||||
```
|
|
||||||
bc1qe24zz5a5hm0trc7glwckz93py274eycxzju3mv
|
|
||||||
```
|
|
||||||
**Ethereum (ETH)**
|
|
||||||
```
|
|
||||||
0xa2f81A58Ec5E550132F03615c8d91954A4E37423
|
|
||||||
```
|
|
||||||
|
|
||||||
Donations will be used to cover development program access and domain renewal costs.
|
|
||||||
|
|
||||||
## Contributing
|
## 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.
|
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.
|
||||||
|
|||||||
Reference in New Issue
Block a user