Skip to content

Latest commit

Β 

History

610 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

yaabsa

Build test for all platforms

An unofficial cross-platform app for Audiobookshelf

Installation

Sponsor Vito0912

Android Play Store (Open Beta)

  • Download the newest app file from the releases page or use the Play Store link above to join the beta.
  • There are 3 versions:
    • Auto: This is for Android Auto. Even if you do not use Android Auto, this is the version to use for all other Android devices.
    • AAOS: This is for Android Automotive OS. This version only works with Android Automotive OS. It does not work with Android Auto or other Android devices.
    • Wear: This is for Wear OS. This version only works with Wear OS. It does not work with Android Auto or other Android devices. Wear requires the app to be installed on your phone to sign in and, for now, to choose what you play. Playing and syncing does not depend on the phone.

Warning

Wear is in an alpha stage of development. If you use Wear OS regularly, please consider helping by creating issues or pull requests.

Linux Flatpak AUR (Community maintained)

  • Use the Flatpak (recommended):

    flatpak remote-add --if-not-exists yaabsa https://Vito0912.github.io/yaabsa/de.vito0912.yaabsa.flatpakrepo --user
    flatpak install yaabsa de.vito0912.yaabsa --user
  • The AUR package is maintained by @caitlynrw. Thanks!

  • For all other installation methods, please refer to the Platform hints section below and download them from the releases page.

macOS TestFlight

  • Join the beta via TestFlight using the button above.
  • Alternatively, download the latest app bundle from the releases page.

iOS TestFlight

  • Join the beta via TestFlight using the button above.
  • Alternatively, download the latest IPA from the releases page to use it with tools like AltStore.

Windows

  • Download the latest installer from the releases page. (Microsoft Store availability will follow).

Web

  • IMPORTANT: You need to add https://yaabsa.de (or the domain you host the web version on) to the list of allowed origins in ABS, before you can connect with the web version. Please see the ABS docs on how. If you use http for Audiobookshelf, please see the note about mixed content.
  • The web version is provided, but it is not officially supported. I do not test it, and it might not work correctly. Please do not report problems as issues. Instead, start a new thread in the web discussion.

Impressions

Expand

Player

Desktop Player Mobile Player Full
Mobile Player Minimalistic Mobile Player Minimalistic Menu

Usage of AI

As I myself criticize the lack of disclosure about AI, which most ABS apps now use, I want to be clear that later in the making of the app, AI/LLMs were used in the development process. I still know the API endpoints used very well and have already helped a ton of people with API usage.

Features, features, features

Below is a list of all features, but I want to highlight a few, as this client has features that are only and or very rarely found in other clients:

  • First client that supports Android Automotive (AAOS) for Audiobookshelf (ABS)
  • Basic eBook/PDF support with syncable annotations
  • subtitle support with karaoke-style highlighting support (later planned to be extended like Whispersync)
  • Support for all platforms Linux, Android, Android Automotive, iOS, macOS, Windows with responsive design
  • More actions directly via the notification player
  • You can customize the player components and move them around

Note

Please note that this client is a mainly personal project I started because it lacks features
There are many options now, most of them just vibe-coded, and I do not want to add another app to the pile. This App by no means is AI-free, but not vibed
If you find this app or see me mention it in a thread because of one of its unique features, please note that, since it is a personal project, any changes are very personal/opiniated.

If you have better ideas for design, I am open to restructuring or redesigning the app

Compatibility Matrix

Note

  • βœ…: Feature is available and tested for the platform before the release on at least one personal device.
  • ❓: Feature is available but not tested for the platform before the release. The features should work, but they are not guaranteed to work.
  • ❌: Feature is not available for the platform, due to missing libraries. It does not mean that it will never be available
  • πŸ…ΏοΈ: Feature is planned for the platform, but not yet implemented.

If a feature already has a πŸ…ΏοΈ, ❓, or βœ… and ❌ for the other platforms for the same feature, it is not planned to be implemented, either because it is not possible or not worth the effort for a single platform. However, PRs will not be closed. Issues will

Library

Feature Android iOS Windows MacOS Linux
Library (Book) βœ… βœ… βœ… βœ… βœ…
Library (Podcast) βœ… βœ… βœ… βœ… βœ…
Personalized/Shelf βœ… βœ… βœ… βœ… βœ…
Series βœ… βœ… βœ… βœ… βœ…
Collections βœ… βœ… βœ… βœ… βœ…
Playlists βœ… βœ… βœ… βœ… βœ…
Author βœ… βœ… βœ… βœ… βœ…
Narrator βœ… βœ… βœ… βœ… βœ…
Search βœ… βœ… βœ… βœ… βœ…
Stats βœ… βœ… βœ… βœ… βœ…
Music* βœ… βœ… βœ… βœ… βœ…

* This is no official library type and just changes behaviour in the app, making it more suitable for music libraries.

Player

Feature Android iOS Windows MacOS Linux
Play/Pause/Seeking/Speed/Volume βœ… βœ… ❓ βœ… βœ…
Background Playback βœ… βœ… ❓ βœ… βœ…
Device Controls βœ… βœ… ❌ βœ… ❌
(Auto)-Queue βœ… βœ… ❓ βœ… βœ…
Gapless playback βœ… βœ… ❓ βœ… βœ…
Buffering βœ… βœ… ❓ βœ… ❓
Volume Boost βœ… ❌ ❌ ❌ βœ…
Audio ducking βœ… ❓ ❌ ❌ ❌
Sleep Timer βœ… βœ… ❓ βœ… βœ…
Chapters βœ… βœ… ❓ βœ… βœ…
Play History βœ… βœ… ❓ βœ… βœ…
Shake to rewind βœ… βœ… ❌ ❌ ❌
Cast βœ… ❓ ❌ ❌ ❌
Auto-Download next in queue πŸ…ΏοΈ πŸ…ΏοΈ πŸ…ΏοΈ πŸ…ΏοΈ πŸ…ΏοΈ
Auto-Resume βœ… βœ… βœ… βœ… βœ…
Subtitles (karaoke-style) βœ… βœ… βœ… βœ… βœ…

E-Reader

Feature Android iOS Windows MacOS Linux
ePUB support βœ… ❓ ❓ ❓ ❌
MOBI support βœ… ❓ ❓ ❓ ❌
CBZ support βœ… ❓ ❓ ❓ ❌
KF8 (AZW3) support βœ… ❓ ❓ ❓ ❌
FB2 support βœ… ❓ ❓ ❓ ❌
PDF support βœ… πŸ…ΏοΈ πŸ…ΏοΈ βœ… βœ…
Annotations βœ… βœ… πŸ…ΏοΈ βœ… βœ…
Sync Annotations βœ… βœ… ❓ βœ… βœ…
Media Overlays** βœ… βœ… βœ… βœ… ❌

** Media Overlays allow a whispersync-like experience for eBooks. This allows you to read and listen to your book at the same time. Please note that the player support is way more limited than for normal audiobooks. Media Overlays need to be added manually before adding them to ABS. I do maintain a soft fork of ABS that will have the capabilities to embed the audiofile into the eBook.

Other Features

Feature Android iOS Windows MacOS Linux
Sync βœ… βœ… βœ… βœ… βœ…
Caching βœ… βœ… βœ… βœ… βœ…
Downloads βœ… βœ… ❓ βœ…* βœ…
Headers βœ… βœ… βœ… βœ… βœ…
Tray/Statusbar Icon ❌ ❌ ❓ βœ… βœ…
Car βœ… βœ… ❌ ❌ ❌
Android Automotive βœ… ❌ ❌ ❌ ❌
Widgets βœ… πŸ…ΏοΈ ❌ ❌ ❌
OIDC Login** βœ… ❓ βœ… ❓ βœ…

* Only supports the default download location, due to sandboxing limitations. Will be addressed in the future.
** You need to add yaabsa://oauth to the list of "Allowed Mobile Redirect URIs" in the OIDC settings of ABS. Please see the ABS docs for more information.

Server Management

Feature Android iOS Windows MacOS Linux
Manage Playlists βœ… βœ… βœ… βœ… βœ…
Manage Collections βœ… βœ… βœ… βœ… βœ…
Edit items βœ… βœ… βœ… βœ… βœ…
Delete items βœ… βœ… βœ… βœ… βœ…
Upload items βœ… βœ… βœ… βœ… βœ…
Match items βœ… βœ… βœ… βœ… βœ…
Bulk editing πŸ…ΏοΈ πŸ…ΏοΈ πŸ…ΏοΈ πŸ…ΏοΈ πŸ…ΏοΈ
Embedding/Encoding βœ… βœ… βœ… βœ… βœ…
Open RSS feeds πŸ…ΏοΈ πŸ…ΏοΈ πŸ…ΏοΈ πŸ…ΏοΈ πŸ…ΏοΈ
Send to E-Reader πŸ…ΏοΈ πŸ…ΏοΈ πŸ…ΏοΈ πŸ…ΏοΈ πŸ…ΏοΈ
Feature Android iOS Windows MacOS Linux
User management βœ… βœ… βœ… βœ… βœ…
Metadata utils βœ… βœ… βœ… βœ… βœ…
Listening Sessions* βœ… βœ… βœ… βœ… βœ…
Server Settings βœ… βœ… βœ… βœ… βœ…
Library Management βœ… βœ… βœ… βœ… βœ…
API Key Management βœ… βœ… βœ… βœ… βœ…
Manage Backups βœ… βœ… βœ… βœ… βœ…
Server Logs βœ… βœ… βœ… βœ… βœ…
Email/E-Reader βœ… βœ… βœ… βœ… βœ…
RSS Feeds βœ… βœ… βœ… βœ… βœ…
Authentication βœ… βœ… βœ… βœ… βœ…

* Also allows editing sessions

Platform hints

The releases are used daily on Android and Linux. Other OSes should not break, but they are not tested more deeply. Issues with iOS should be easy to catch since, while not used daily, it is still used.

Linux requirements

For the best experience and security, please use the Flatpak. It includes everything you need and is easy to remove later. The Snap package is currently broken and might be removed in the future. For all other installation methods, you need to make sure that the correct dependencies are installed on your system. If the app starts with a black screen, please set the ENV YAABSA_RELEASE_CONSOLE_LOG=1, as this will log issues if you start the application from the terminal. In general, you need the following dependencies:

  • libmpv
  • libsecret

About

An unofficial feature rich, responsive, modern client/app for audiobookshelf

Topics

Resources

Contributing

Stars

78 stars

Watchers

2 watching

Forks

Releases

Used by

Contributors

Languages