Cutlery/Kyoo
1
0
Fork 0
mirror of https://github.com/zoriya/Kyoo.git synced 2025-07-09 03:04:20 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Zoe Roux 2024-01-30 03:23:51 +01:00 committed by GitHub
parent e80543e0a2
commit b760287ca2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 43 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@ -1,40 +1,53 @@
# <img width="24px" src="./icons/icon-256x256.png" alt="Kyoo"> Kyoo
# <img width="24px" src="./icons/icon-256x256.png" alt=""> Kyoo
Kyoo is an open-source media browser which allow you to stream your movies, tv-shows or anime.
It is an alternative to Plex, Emby or Jellyfin.
Welcome to Kyoo, the next-generation open-source media browser that redefines your streaming experience. Designed from the ground up, Kyoo stands out as a powerful alternative to Plex and Jellyfin. Unleash the full potential of your media library with cutting-edge features and a commitment to being free and open-source.
Kyoo has been created from scratch, it is not a fork. Everything is and always will be free and open-source.
![Kyoo in Action](https://raw.githubusercontent.com/zoriya/kyoo/screens/home.png)
Feel free to open issues or pull requests, all contribution are welcomed.
## 🌐 Getting Started
## Getting started
- **[Installation](./INSTALLING.md):** Set up Kyoo effortlessly to enjoy seamless streaming of your favorite movies, TV shows, or anime.
- **[API Documentation](https://kyoo.zoriya.dev/api/doc):** Dive into our comprehensive API documentation to explore advanced functionalities.
- **[Contributing](./CONTRIBUTING.md):** Feel free to open issues, submit pull requests, and contribute to making Kyoo even better.
- [Installation](./INSTALLING.md)
- [Api Documentation](https://kyoo.zoriya.dev/api/doc)
- [Contributing](./CONTRIBUTING.md)
## 🚀 Features
## Features
- Automatically organize your library of movies, tv or animes
- No configuration or manual edit needed
- guessit, thexem and themoviedb are used to retrive metadata even if your files are named in absurd ways
- Transmux/Transcode files to make them available on every platform
- Create smart watchlists that will automatically update when you watch movies/episodes
- Download files for offline support (your watchlists will still be updated)
- Android and web apps
- Search your collection via names, tags or descriptions
- Download metadata automatically
- Handle subtitles natively with embedded fonts (ass, subrip or vtt)
- Entirely free and works without internet (when metadata have already been downloaded)
- **Dynamic Transcoding:** Transcode your media to any quality, change on the fly with auto quality, and seek effortlessly without waiting for the transcoder.
- **Auto Watch History:** Enjoy automatic watch history with continue watching, allowing you to quickly resume your series or discover new episodes.
## Live Demo
- **Intelligent Metadata Retrieval:** Experience smart metadata retrieval, even for oddly named files, thanks to the power of guessit and themoviedb. It even uses thexem for enhanced anime handling.
You can see a live demo with copyright-free movies here: [kyoo.zoriya.dev](https://kyoo.zoriya.dev).
Thanks to the [blender studio](https://www.blender.org/about/studio/) for providing open-source movies available for all.
- **Cross-Platform Access:** Access Kyoo on Android and web clients, ensuring your media is at your fingertips wherever you go.
## Screens
- **Meilisearch-Powered Search:** Utilize our advanced, typo-resilient search system powered by Meilisearch for lightning-fast results.
![Movie](https://raw.githubusercontent.com/zoriya/kyoo/screens/movie.png)
- - -
![Show](https://raw.githubusercontent.com/zoriya/kyoo/screens/show.png)
- - -
![Player](https://raw.githubusercontent.com/zoriya/kyoo/screens/player.png)
- **Fast Scrubbing Support:** Navigate your media effortlessly with fast scrubbing support, enhancing your control over playback.
- **Download and Offline Support:** Enjoy the freedom to download and watch offline, with the watch history seamlessly updating when you reconnect.
- **Enhanced Subtitle Support:** Kyoo goes beyond the basics with enhanced subtitle support, including SSA/ASS formats and customizable fonts.
## 🌟 Philosophy: Setup Once, Enjoy Forever
Kyoo's philosophy revolves around simplicity. Set it up once, forget about configuration hassles. Once installed, your library undergoes automatic scanning, adding new episodes or movies as soon as they're moved into your library's folder. No need for a specific file structure or meticulously renamed files – Kyoo does the right thing™.
## 🔗 Live Demo
Curious to see Kyoo in action? Check out our live demo featuring copyright-free movies at [kyoo.zoriya.dev](https://kyoo.zoriya.dev). Special thanks to the Blender Studio for providing open-source movies available for all.
## 👀 Screens
![Web Show](https://raw.githubusercontent.com/zoriya/kyoo/screens/show-details.png)
![Desktop Scrubber](https://raw.githubusercontent.com/zoriya/kyoo/screens/hover-scrubber.png)
![Touch Scrubber](https://raw.githubusercontent.com/zoriya/kyoo/screens/bottom-scrubber.png)
![Collection](https://raw.githubusercontent.com/zoriya/kyoo/screens/collection.png)
![List](https://raw.githubusercontent.com/zoriya/kyoo/screens/list.png)
<p align="center"><img src="https://raw.githubusercontent.com/zoriya/kyoo/screens/android-movie.png" alt="Android Movie" width="350"></p>
Ready to elevate your streaming experience? Dive into Kyoo now! 🎬🎉