Clarify project scope
All checks were successful
Build on Push and create Release on Tag / build (push) Successful in 15m15s

This commit is contained in:
MassiveBox 2025-06-16 10:38:51 +02:00
parent 4cf9a2a58f
commit 31fe6ba022

View file

@ -1,18 +1,36 @@
# FCaster # FCaster
FCaster is a native cross-platform application to cast media to a [FCast](https://fcast.org) Receiver, built with [Fyne](https://fyne.io). FCaster is a Go [library](https://pkg.go.dev/git.massive.box/massivebox/fcaster/fcast) implementing a [FCast](https://fcast.org) Sender, which allows to send media to a Receiver. It also has a simple cross-platform application, built with [Fyne](https://fyne.io), to showcase its features.
The protocol logic is all packaged into the [FCast Library](https://pkg.go.dev/git.massive.box/massivebox/fcaster/fcast), which you can use in your own projects to build a FCast Sender!
Currently, the app only allows you to stream from URLs, but I will add a way to stream local files and Jellyfin media directly. (You can already stream Jellyfin media by copying the stream URL from Jellyfin and pasting it in the app - [detailed instructions](https://s.massive.box/fcaster-jellyfin)). **Notice**: FCaster is NOT associated to, or endorsed by, FUTO. It's an unofficial implementation of the FCast Protocol.
If you're on Android, I recommend you [disable battery optimizations](https://support.google.com/pixelphone/thread/299966895/turn-off-battery-optimization-for-an-app?hl=en) for FCaster, otherwise the app will disconnect when your device locks. ## Library
## Screenshots The [FCast library](https://pkg.go.dev/git.massive.box/massivebox/fcaster/fcast) allows you to stream media to a FCast Receiver from your own software!
| Feature | Supported |
|-------------------|-----------|
| TCP | ✅ |
| WebSockets | ❌ |
| mDNS Discovery | ✅ |
| Outgoing Commands | ✅ |
| Incoming Commands | ✅ |
| QR Code | ❌ |
Since the library is in active development, its stability is not guaranteed.
## App
Due to the limitations of Fyne on Android (not implementing [foreground services](https://developer.android.com/guide/components/foreground-services)), the FCaster App will not support features such as local media casting in the near future. We are working on an alternative implementation.
Currently, the app only allows you to stream from URLs. (You can already stream Jellyfin media by copying the stream URL from Jellyfin and pasting it in the app - [detailed instructions](https://s.massive.box/fcaster-jellyfin)).
### Screenshots
| ![Main view](assets/mainView.png) | ![Cast view](assets/castView.png) | | ![Main view](assets/mainView.png) | ![Cast view](assets/castView.png) |
| --------------------------------- |-----------------------------------| | - | - |
## Download ### Download
Head over to the [Releases](https://git.massive.box/massivebox/fcaster/releases) page to find builds for your device. You can use [Obtanium](https://obtainium.imranr.dev/) to get automatic updates on Android. Head over to the [Releases](https://git.massive.box/massivebox/fcaster/releases) page to find builds for your device. You can use [Obtanium](https://obtainium.imranr.dev/) to get automatic updates on Android.