VueTube/readme.md

128 lines
8.7 KiB
Markdown
Raw Normal View History

2022-04-10 23:41:19 +00:00
<p align="center">
<a href="https://vuetube.app/">
2022-05-30 20:58:05 +00:00
<img src="https://cdn.discordapp.com/attachments/751596360108605500/980418672331988992/VueTube_Dark.svg" alt="VueTube icon" width="500"/>
2022-04-10 23:41:19 +00:00
</a>
</br>
<sub>Logo by <a href="https://github.com/afnzmn">@afnzmn</a></sub>
</br>
</br>
2022-04-10 23:41:19 +00:00
<strong>A simple FOSS video streaming client aimed to recreate ALL features from their respective apps (and more)</strong>
</br>
Pronounced View Tube (<code>/ˈvjuːˌtjuːb/</code>)
</p>
2022-02-25 01:07:45 +00:00
<p align="center">
<a href="https://github.com/VueTubeApp/VueTube/blob/main/LICENSE" alt="License"><img src="https://img.shields.io/github/license/VueTubeApp/VueTube"></img></a>
<a href="https://github.com/VueTubeApp/VueTube/actions/workflows/ci.yml" alt="CI"><img src="https://github.com/VueTubeApp/VueTube/actions/workflows/ci.yml/badge.svg"></img></a>
<a href="https://reddit.com/r/vuetube" alt="Reddit"><img src="https://img.shields.io/reddit/subreddit-subscribers/vuetube?label=r%2FVuetube&logo=reddit&logoColor=white"></img></a>
<a href="https://t.me/VueTube" alt="Telegram"><img src="https://img.shields.io/endpoint?label=VueTube&url=https%3A%2F%2Ftelegram-badge-4mbpu8e0fit4.runkit.sh%2F%3Furl%3Dhttps%3A%2F%2Ft.me%2FVuetube"></img></a>
<a href="https://discord.gg/7P8KJrdd5W" alt="Discord"><img src="https://img.shields.io/discord/946587366242533377?label=Discord&style=flat&logo=discord&logoColor=white"></img></a>
2022-05-04 02:23:40 +00:00
<a href="https://twitter.com/VueTubeApp" alt="Twitter"><img src="https://img.shields.io/twitter/follow/VueTubeApp?label=Follow&style=flat&logo=twitter"></img></a>
2022-05-08 08:33:20 +00:00
</p>
2022-06-19 21:24:43 +00:00
Read this in other languages: [English,](readme.md) [Español,](readme.es.md) [简体中文,](readme.zh-hans.md) [繁體中文,](readme.zh-hant.md) [日本語,](readme.ja.md) [עִברִית,](readme.he.md) [Nederlands,](readme.nl.md) [தமிழ்,](readme.ta.md) [Bahasa Melayu,](readme.ms.md) [Македонски,](readme.mk.md) [Français,](readme.fr.md) [Português Brasileiro,](readme.pt-br.md) [Bahasa Indonesia,](readme.id.md) [Polski,](readme.pl.md) [Български,](readme.bg.md) [Italiano](readme.it.md)
2022-06-14 09:24:43 +00:00
## Features
<img src="./resources/Features.svg" alt="VueTube icon" height="100"/>
2022-06-10 19:01:30 +00:00
2022-04-11 00:18:57 +00:00
- 🎨 Themes: Light, Dark, OLED, All the colors of the rainbow
2022-03-17 12:35:02 +00:00
- 🖌️ Customizable UI: You can fully customize the accent color, and other parts of the UI to remove features that you don't use!
2022-03-10 17:39:29 +00:00
- ⬆️ Auto Update: Be notified when an update is available & downgrade if you dislike it!
2022-05-04 02:23:40 +00:00
- 👁️ Tracking Protection: No telemetry is sent from your device by default
2022-06-14 13:35:12 +00:00
- 📺 Custom video player
- 👎 Return YouTube Dislike - [_More info_](https://returnyoutubedislike.com)
- 💰 SponsorBlock - [_More info_](https://sponsor.ajay.app)
2022-02-24 23:06:21 +00:00
## Install
<img src="./resources/Install.svg" alt="VueTube icon" height="100"/>
2022-06-10 19:06:34 +00:00
2022-04-10 23:41:19 +00:00
To install please visit www.vuetube.app/install
2022-06-14 14:54:01 +00:00
<details>
2022-06-16 00:45:27 +00:00
<summary>Or click here to display all versions available</summary>
2022-06-14 14:54:01 +00:00
<br />
2022-06-14 19:37:29 +00:00
### Android
2022-06-22 18:35:51 +00:00
| <a href=https://nightly.link/VueTubeApp/VueTube/workflows/ci/main/android.zip><img id="im" width="200" src=./resources/getunstable.png></a> | <a href=https://github.com/VueTubeApp/VueTube/releases/download/0.3/VueTube-Canary-June-22-2022.apk><img id="im" width="200" src=./resources/getcanary.png></a> | <a href=https://vuetube.app/install><img id="im" width="200" src=./resources/getstable.png></a> |
| ------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| A lot of bugs, but early access to features | Less bugs than unstable, slightly more features than stable | Not available until the app becomes more developed |
2022-06-14 19:37:29 +00:00
### iOS
| <a href=https://nightly.link/VueTubeApp/VueTube/workflows/ci/main/iOS.zip><img id="im" width="200" src=./resources/getunstable.png></a> | <a href=https://cdn.discordapp.com/attachments/949908267855921163/972164558930198528/VueTube-Canary-May-6-2022.ipa><img id="im" width="200" src=./resources/getcanary.png></a> | <a href=https://vuetube.app/install><img id="im" width="200" src=./resources/getstable.png></a> |
| --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
| A lot of bugs, but early access to features | Less bugs than unstable, slightly more features than stable | Not available until the app becomes more developed |
2022-06-14 14:54:01 +00:00
</details>
2022-06-14 14:37:45 +00:00
## Plans
<img src="./resources/Plans.svg" alt="VueTube icon" height="100"/>
2022-06-10 19:09:42 +00:00
2022-03-17 17:57:10 +00:00
- 🔍 Advanced Search
- 🗞️ Locally store watch history
- ✂️ Shorts
- 🧑 Google account sign in
- 🖼️ Picture in picture mode
- and more!
2022-02-24 23:06:21 +00:00
## Screenshots
View on our website: www.vuetube.app/info/screenshots
2022-06-14 14:58:20 +00:00
<details>
<summary> Or click here to display screenshots </summary>
<br />
2022-06-14 15:02:21 +00:00
2022-06-14 15:03:09 +00:00
<img src="https://vuetube.app/wtch.png" width="400">
<img src="https://vuetube.app/stng.png" width="400">
<img src="https://vuetube.app/srch.png" width="400">
2022-06-14 15:02:21 +00:00
2022-06-14 14:58:20 +00:00
</details>
2022-06-14 14:47:22 +00:00
2022-06-14 15:10:22 +00:00
### Technologies used
<a href="https://capacitorjs.com/solution/vue"><img src="https://cdn.discordapp.com/attachments/953538236716814356/955694368742834176/Capacitator-Dark.svg" height=40/></a> <a href="https://vuetifyjs.com/"><img src="https://cdn.discordapp.com/attachments/810799100940255260/973719873467342908/Vuetify-Dark.svg" height=40/></a> <a href="https://nuxtjs.org/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/NuxtJS-Dark.svg" height=40/></a> <a href="https://vuejs.org/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/VueJS-Dark.svg" height=40/></a> <a href="https://javascript.com/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/JavaScript.svg" height=40/></a> <a href="https://java.com/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Java-Dark.svg" height=40/></a> <a href="https://gradle.com/"><img src="https://cdn.discordapp.com/attachments/810799100940255260/955691550560636958/Gradle.svg" height=40/></a> <a href="https://developer.apple.com/swift/"><img src="https://github.com/tandpfun/skill-icons/raw/main/icons/Swift.svg" height=40/></a>
### Why am I doing this?
2022-02-24 23:06:21 +00:00
Well this has been thrown around on the Return Youtube Dislike discord server for quite some time, so I figured that I should probably take a crack at it!
2022-03-13 18:04:15 +00:00
### Want to contribute?
Please read our website on how to do so: www.vuetube.app/contributing
2022-04-10 23:41:19 +00:00
2022-06-18 11:29:28 +00:00
If you want to translate the app, [click here](/NUXT/plugins/languages) and read how to do it
## Contributors
<a href="https://github.com/VueTubeApp/VueTube/graphs/contributors">
<img src="https://contrib.rocks/image?repo=VueTubeApp/VueTube" />
2022-04-10 23:41:19 +00:00
</a>
<sub>Made with [contrib.rocks](https://contrib.rocks). </sub>
## Acknowledgements
- Emojis by the [Twemoji team](https://twemoji.twitter.com/), Licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/)
- VueTube Logo by [@afnzmn](https://github.com/afnzmn)
2022-06-18 05:03:49 +00:00
- Public YouTube dislike data provided by [Return Youtube Dislike](https://returnyoutubedislike.com)
- Ajay & Community for providing the [Sponsorblock API](https://sponsor.ajay.app), Licensed under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
2022-06-19 21:04:54 +00:00
2022-06-24 11:44:04 +00:00
## Donate
VueTube is and always will be free and open source, but you can support our devs with a donation that will help to mantain the project.
[Donate on Ko-Fi.com](https://ko-fi.com/vuetube)
[Donate to PickleNik on GitHub](https://github.com/sponsors/PickleNik)
## Disclaimer
2022-05-08 08:33:20 +00:00
2022-05-05 21:53:56 +00:00
The VueTube project and its contents are not affiliated with, funded, authorized, endorsed by, or in any way accociated with YouTube, Google LLC or any of its affiliates and subsidaries. The official YouTube website can be found at [www.youtube.com](https://www.youtube.com).
2022-05-05 21:51:16 +00:00
Any trademark, service mark, trade name, or other intellectual property rights used in the VueTube project are owned by the respective owners.