yattee/README.md

51 lines
2.7 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-10-27 16:02:11 +00:00
<p>Privacy oriented video player for iOS, tvOS and macOS<br /></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)
2022-07-04 17:54:41 +00:00
[![Matrix](https://img.shields.io/matrix/yattee:matrix.org)](https://matrix.to/#/#Yattee:matrix.org)
2022-12-04 22:56:20 +00:00
[![Discord](https://invidget.switchblade.xyz/pSnNKhZHEG)](https://yattee.stream/discord)
2021-11-16 20:12:47 +00:00
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
* Player queue and history
2022-10-27 16:02:11 +00:00
* Player component with custom controls, gestures and support for 4K playback
* Fullscreen, Picture in Picture and background audio playback
2022-12-04 23:29:49 +00:00
* [SponsorBlock](https://sponsor.ajay.app/), configurable categories to skip
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)
2022-12-04 23:29:49 +00:00
* [Features](https://github.com/yattee/yattee/wiki/Features)
2023-01-08 15:07:13 +00:00
* [FAQ](https://github.com/yattee/yattee/wiki/FAQ)
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-05-22 21:27:59 +00:00
Use [building instructions](https://github.com/yattee/yattee/wiki/Building-instructions) or
2022-07-04 17:54:41 +00:00
join [Discord](https://yattee.stream/discord) or [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
2022-09-26 15:31:14 +00:00
## Translations
You can help to make this project accessible to everyone by contributing to its localizations.
<a href="https://hosted.weblate.org/engage/yattee/">
<img src="https://hosted.weblate.org/widgets/yattee/-/localizable-strings/multi-auto.svg" alt="Translation status" />
</a>
Localization service and hosting is provided by [Weblate](https://weblate.org/en/).
2022-05-22 21:27:59 +00:00
## License
2021-11-09 21:34:11 +00:00
Yattee and its components is shared on [AGPL v3](https://www.gnu.org/licenses/agpl-3.0.en.html) license.