Fladder/README.md
2024-10-17 18:07:21 +02:00

111 lines
5.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<h1 align="center">
<br>
<a href="https://github.com/DonutWare/Fladder"><img src="https://github.com/DonutWare/Fladder/blob/develop/icons/fladder_macos_icon.png?raw=true" 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 Featuress</a>
<a href="#download">Download</a>
<a href="#how-to-contribute">Contributing</a>
<a href="#credits">Credits</a>
<a href="#license">License</a>
</p>
<p align="center">
<a href="https://github.com/DonutWare/Fladder/actions/workflows/build.yml"><img src="https://github.com/DonutWare/Fladder/actions/workflows/build.yml/badge.svg?branch=develop" alt="Build" /></a>
<a href="https://github.com/DonutWare/Fladder/releases/latest"> <img alt="GitHub Downloads (all assets, all releases)" src="https://img.shields.io/github/downloads/Fladder-app/fladder/total"></a>
<a href="https://github.com/DonutWare/Fladder/releases/latest"> <img alt="GitHub Release" src="https://img.shields.io/github/v/release/Fladder-app/fladder?display_name=tag"></a>
</p>
## 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 book reading support
* 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 it out the web build!](https://fladder-app.github.io/Fladder)
## Planned Features
* Music playback
* Android TV
* Server management
* And more???
## Download
The latest release executeables for Windows, MacOS, iOS, Android and Web can be found [here](https://github.com/DonutWare/Fladder/releases).
### Playstore
The Android app is currently in testing you can help testing by joining this group https://groups.google.com/g/fladder
<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>
## 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.
Thank you for helping to make this project better! 🙌
## Credits
This software uses the following open source packages:
- [Flutter](https://flutter.dev/)
## License
GNU General Public License v3.0