mirror of
https://github.com/streamyfin/streamyfin.git
synced 2025-08-20 18:37:18 +02:00
108 lines
4.4 KiB
Markdown
108 lines
4.4 KiB
Markdown
# 📺 Streamyfin
|
|
|
|
Welcome to Streamyfin, a simple and user-friendly Jellyfin client built with Expo. If you're looking for an alternative to other Jellyfin clients, we hope you'll find Streamyfin to be a useful addition to your media streaming toolbox.
|
|
|
|
<div style="display: flex; flex-direction: row; gap: 5px">
|
|
<img width=100 src="./assets/images/screenshots/1.jpg" />
|
|
<img width=100 src="./assets/images/screenshots/3.jpg" />
|
|
<img width=100 src="./assets/images/screenshots/4.jpg" />
|
|
<img width=100 src="./assets/images/screenshots/5.jpg" />
|
|
<img width=100 src="./assets/images/screenshots/7.jpg" />
|
|
</div>
|
|
|
|
## 🌟 Features
|
|
|
|
- 🔗 Connect to your Jellyfin instance: Easily link your Jellyfin server and access your media library.
|
|
- 📱 Native video player: Playback with the platform native video player. With support for subtitles, playback speed control, and more.
|
|
- 📥 Download media (Experimental): Save your media locally and watch it offline.
|
|
- 📡 Chromecast media (Experimental): Cast your media to any Chromecast-enabled device.
|
|
|
|
## 🧪 Experimental Features
|
|
|
|
Streamyfin includes some exciting experimental features like media downloading and Chromecast support. These are still in development, and we appreciate your patience and feedback as we work to improve them.
|
|
|
|
## 🛠️ Beta testing (iOS/Android)
|
|
|
|
## TestFlight
|
|
|
|
<a href="https://testflight.apple.com/join/CWBaAAK2">
|
|
<img height=75 alt="Get the beta on TestFlight" src="./assets/Get_the_beta_on_Testflight.svg"/>
|
|
</a>
|
|
|
|
## Play Store Open Beta
|
|
|
|
<a href="https://play.google.com/store/apps/details?id=com.fredrikburmester.streamyfin">
|
|
<img height=75 alt="Get the beta on Google Play" src="./assets/en_badge_web_generic.png"/>
|
|
</a>
|
|
|
|
## 🚀 Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Ensure you have an active Jellyfin server.
|
|
- Make sure your device is connected to the same network as your Jellyfin server.
|
|
|
|
## 🙌 Contributing
|
|
|
|
We welcome any help to make Streamyfin better. If you'd like to contribute, please fork the repository and submit a pull request. For major changes, it's best to open an issue first to discuss your ideas.
|
|
|
|
### Development info
|
|
|
|
Add this to AppDelegate.mm:
|
|
|
|
```
|
|
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
|
|
{
|
|
// @generated begin react-native-google-cast-didFinishLaunchingWithOptions - expo prebuild (DO NOT MODIFY) sync-8901be60b982d2ae9c658b1e8c50634d61bb5091
|
|
#if __has_include(<GoogleCast/GoogleCast.h>)
|
|
...
|
|
|
|
[GCKCastContext sharedInstance].useDefaultExpandedMediaControls = true;`
|
|
#endif
|
|
```
|
|
|
|
Add this to Info.plist:
|
|
|
|
```
|
|
<key>NSBonjourServices</key>
|
|
<array>
|
|
<string>_googlecast._tcp</string>
|
|
<string>_CC1AD845._googlecast._tcp</string>
|
|
</array>
|
|
<key>NSLocalNetworkUsageDescription</key>
|
|
<string>${PRODUCT_NAME} uses the local network to discover Cast-enabled devices on your WiFi network.</string>
|
|
```
|
|
|
|
## 📄 License
|
|
|
|
Streamyfin is licensed under the Mozilla Public License 2.0 (MPL-2.0).
|
|
This means you are free to use, modify, and distribute this software. The MPL-2.0 is a copyleft license that allows for more flexibility in combining the software with proprietary code.
|
|
Key points of the MPL-2.0:
|
|
|
|
- You can use the software for any purpose
|
|
- You can modify the software and distribute modified versions
|
|
- You must include the original copyright and license notices
|
|
- You must disclose your source code for any modifications to the covered files
|
|
- Larger works may combine MPL code with code under other licenses
|
|
- MPL-licensed components must remain under the MPL, but the larger work can be under a different license
|
|
- For the full text of the license, please see the LICENSE file in this repository.
|
|
|
|
## 🌐 Connect with Us
|
|
|
|
If you have questions or need support, feel free to reach out:
|
|
|
|
- GitHub Issues: Report bugs or request features here.
|
|
- Email: [fredrik.burmester@gmail.com](mailto:fredrik.burmester@gmail.com)
|
|
|
|
## 📝 Credits
|
|
|
|
Streamyfin is developed by Fredrik Burmester and is not affiliated with Jellyfin. The app is built with Expo, React Native, and other open-source libraries.
|
|
|
|
## ✨ Acknowledgements
|
|
|
|
I'd like to thank the following people and projects for their contributions to Streamyfin:
|
|
|
|
- [Reiverr](https://github.com/aleksilassila/reiverr) for great help with understanding the Jellyfin API.
|
|
- [Jellyfin TS SDK](https://github.com/jellyfin/jellyfin-sdk-typescript) for the TypeScript SDK.
|
|
- The Jellyfin devs for always being helpful in the Discord.
|