mirror of
https://github.com/gabehf/Fladder.git
synced 2026-03-07 21:48:14 -08:00
126 lines
6.1 KiB
Markdown
126 lines
6.1 KiB
Markdown
|
||
<h1 align="center">
|
||
<br>
|
||
<a href="https://github.com/DonutWare/Fladder"><img src="https://raw.githubusercontent.com/DonutWare/Fladder/refs/heads/develop/icons/production/fladder_macos_icon.png" alt="Fladder" width="200"></a>
|
||
<br>
|
||
Fladder
|
||
<br>
|
||
</h1>
|
||
|
||
<h4 align="center">A Simple Jellyfin Frontend built on top of <a href="https://flutter.dev/" target="_blank">Flutter</a>.</h4>
|
||
|
||
<p align="center">
|
||
<a href="#key-features">Key Features</a> •
|
||
<a href="#screenshots">Screenshots</a> •
|
||
<a href="#planned-features">Planned Features</a> •
|
||
<a href="#download">Download</a> •
|
||
<a href="#how-to-contribute">Contributing</a> •
|
||
<a href="#credits">Credits</a> •
|
||
<a href="#license">License</a>
|
||
</p>
|
||
|
||
<div align="center">
|
||
|
||
[](https://github.com/DonutWare/Fladder/actions/workflows/build.yml)
|
||
[](https://github.com/DonutWare/Fladder/releases/latest)
|
||
[](https://github.com/DonutWare/Fladder/releases/latest)
|
||
[](https://conventionalcommits.org)
|
||
|
||
</div>
|
||
|
||
|
||
|
||
## Key Features
|
||
|
||
* Play media – Stream or sync content locally to your device.
|
||
* Manage your library – Refresh content and edit metadata.
|
||
* Multiple profiles – Lock profiles and connect to different servers.
|
||
* Direct/Transcode playback
|
||
* Intro/Credits skipping
|
||
* Trickplay support (timeline scrubbing)
|
||
* Dark/Light mode
|
||
* Simple comic book format reading support (.cbz, .crb)
|
||
* Sync supported on Mobile/Desktop
|
||
* Platforms
|
||
- Android
|
||
- Web
|
||
- macOS
|
||
- Windows
|
||
- iOS
|
||
- Linux
|
||
|
||
## Screenshots
|
||
<details close>
|
||
<summary>Mobile</summary>
|
||
<img src="https://github.com/DonutWare/Fladder/blob/develop/assets/marketing/screenshots/Mobile/Dashboard.png?raw=true" alt="Fladder" width="200">
|
||
<img src="https://github.com/DonutWare/Fladder/blob/develop/assets/marketing/screenshots/Mobile/Details_2.png?raw=true" alt="Fladder" width="200">
|
||
<img src="https://github.com/DonutWare/Fladder/blob/develop/assets/marketing/screenshots/Mobile/Favourites.png?raw=true" alt="Fladder" width="200">
|
||
<img src="https://github.com/DonutWare/Fladder/blob/develop/assets/marketing/screenshots/Mobile/Library.png?raw=true" alt="Fladder" width="200">
|
||
<img src="https://github.com/DonutWare/Fladder/blob/develop/assets/marketing/screenshots/Mobile/Resume_Tab.png?raw=true" alt="Fladder" width="200">
|
||
<img src="https://github.com/DonutWare/Fladder/blob/develop/assets/marketing/screenshots/Mobile/Sync.png?raw=true" alt="Fladder" width="200">
|
||
<img src="https://github.com/DonutWare/Fladder/blob/develop/assets/marketing/screenshots/Mobile/Player.png?raw=true" alt="Fladder" width="1280">
|
||
</details>
|
||
|
||
<details close>
|
||
<summary>Tablet</summary>
|
||
<img src="https://github.com/DonutWare/Fladder/blob/develop/assets/marketing/screenshots/Tablet/Dashboard.png?raw=true" alt="Fladder" width="1280">
|
||
<img src="https://github.com/DonutWare/Fladder/blob/develop/assets/marketing/screenshots/Tablet/Details.png?raw=true" alt="Fladder" width="1280">
|
||
<img src="https://github.com/DonutWare/Fladder/blob/develop/assets/marketing/screenshots/Tablet/Settings.png?raw=true" alt="Fladder" width="1280">
|
||
<img src="https://github.com/DonutWare/Fladder/blob/develop/assets/marketing/screenshots/Tablet/Sync.png?raw=true" alt="Fladder" width="1280">
|
||
</details>
|
||
|
||
Web/Desktop [try out the web build!](https://DonutWare.github.io/Fladder)
|
||
> [!NOTE]
|
||
> The GitHub hosted web build only allows `https` connections. This is a limitation on GitHub's end, for self-hosted versions `http` works fine.
|
||
|
||
## Planned Features
|
||
|
||
* Music playback
|
||
* Android TV support
|
||
* Server management
|
||
* And more???
|
||
|
||
## Download
|
||
|
||
The latest executables for Windows, macOS, Linux, iOS, Android and Web can be found on the [releases page](https://github.com/DonutWare/Fladder/releases).
|
||
|
||
You can pull the Docker version using the following tag: ```ghcr.io/donutware/fladder:latest```.
|
||
|
||
*Platform-specific installation and usage instructions can be found [here](https://github.com/DonutWare/Fladder/blob/develop/INSTALL.md).*
|
||
|
||
<a href='https://play.google.com/store/apps/details?id=nl.jknaapen.fladder&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width=250/></a>
|
||
|
||
> [!WARNING]
|
||
> For windows users, some applications are marked as false positives by windows defender for more info see [this issue](https://github.com/DonutWare/Fladder/issues/197).
|
||
|
||
## How to Contribute
|
||
Interest in contributing? Here are a couple of ways you can help:
|
||
|
||
### 🐛 Reporting Bugs
|
||
- Before reporting a bug, **please ensure** that the issue hasn't been reported already.
|
||
- When submitting a bug report, provide detailed steps on how the bug can be reproduced. This will help us to understand and fix the issue faster.
|
||
- Bug reports are appreciated and very helpful!
|
||
|
||
### 🚀 Submitting Pull Requests
|
||
- **Pull requests are always welcome!**
|
||
- For new features or large changes, please open a discussion or issue first to ensure that no one else is already working on it.
|
||
- **Keep pull requests short and focused**: try to avoid fixing multiple issues in a single pull request. This helps make the review process smoother and quicker.
|
||
|
||
### 🌐 Translations
|
||
<a href="https://hosted.weblate.org/engage/fladder/">
|
||
<img src="https://hosted.weblate.org/widget/fladder/fladder/multi-auto.svg" alt="Translation status" />
|
||
</a>
|
||
|
||
Thank you for helping to make this project better! 🙌
|
||
|
||
|
||
## Credits
|
||
|
||
This software uses the following open source packages:
|
||
- [Flutter](https://flutter.dev/)
|
||
|
||
## License
|
||
|
||
This project is licensed under the GNU General Public License v3.0. More information about the license can be found in [this file](https://github.com/DonutWare/Fladder/blob/develop/LICENSE).
|
||
|
||
|