OPDS Compatibility
This page covers tested OPDS servers and known issues or limitations when using OPDS with the mobile app.
OPDS Versions
The mobile app was built to be an OPDS v2.0-compatible client. OPDS v2.0 is a JSON-based (draft) standard that improves upon OPDS v1.2 (which is XML-based) in many ways, including better support for modern features like progression tracking.
That said, the app does have compatibility with some OPDS v1.2 servers, however the primary focus for OPDS-related features and compatibility will remain on OPDS v2.0.
Feature Comparison Matrix
| Feature | OPDS v1.2 | OPDS v2.0 | Notes |
|---|---|---|---|
| Basic Catalog Browsing | ✅ | ✅ | |
| Basic Downloading | ✅ | ✅ | Single publications only |
| Collection Downloading | 🚧 | 🚧 | |
| Publication Streaming | ✅ | ✅ | OPDS v1.2 support via PSE |
| Basic Search | ✅ | ✅ | |
| Complex Search | ❌ | 🚧 | This is not a v2.0 limitation |
| Reading Progression Syncing | ❌ | ✅ | |
| Arbitrary Metadata Support | ❌ | 🚧 | This is not a v2.0 limitation |
| Facets | 🚧 | 🚧 | This is not an OPDS limitation |
OPDS v1.2
Tested Servers
If you have tested the app with a server not listed here, please let me know so I can add it to the list!
Excluding Stump itself, the following servers have been tested:
| Server | Status | Notes |
|---|---|---|
| Codex | ✅ | - |
| Kavita | ✅ | - |
| Komga | ✅ | - |
Limitations, Known Issues, and Future Improvements
- If you configure an OPDS v1.2 server with
Loginauthentication, the feed must not be behind a login wall - There is no progression syncing support
- Complex search queries are not supported
Future Improvements / Planned Features
- Support for collection downloads (e.g., downloading an entire series at once)
- Support for favorites with a dedicated tab for easy access
OPDS v2.0
Tested Servers
If you have tested the app with a server not listed here, please let me know so I can add it to the list!
Excluding Stump itself, the following servers have been tested:
| Server | Status | Progression | Notes |
|---|---|---|---|
| Codex | ✅ | ✅ | Codex v1.9.0+ |
| Komga | ✅ | ✅ | - |
Progression
There exists a proposed standard for tracking reading progression in OPDS v2. If your OPDS server supports this feature, the mobile app will automatically attempt to sync your reading progression back to the server in most scenarios.
At this time, only page-based progression tracking is supported. In other words, EPUB files are not able to sync progression yet. This will be addressed in a future release.
Limitations, Known Issues, and Future Improvements
The mobile app aims to be a fully compatible OPDS v2 client. However, since there aren’t many client/servers in the space, and the mobile app is still very young, there are some limitations and known issues that will be addressed in future releases
EPUB Progression
This only applies to OPDS servers that support progression tracking. If you are using a Stump server, it does not apply since Stump uses its own custom API for progression syncing.
At this time, only page-based OPDS progression tracking is supported. In other words, EPUB files are not able to sync back progression yet. This will be addressed in a future release.
Search URL Templating
Some OPDS servers support templated search URLs, which allow clients to issue targeted search queries. An example templated URL might look like:
/opds/v2.0/search{?query,author,title,subject}The idea is that the client can replace any of the templated parameters with actual search values.
Currently, the mobile app only supports replacing a single query parameter in templated search URLs. This should function as a basic search, but more advanced searches that utilize the full templated options are not supported yet.
Future Improvements / Planned Features
- Full support for templated search URLs
- Support for displaying more metadata fields
- Support for facets
- Support for collection downloads (e.g., downloading an entire series at once)
- Support for favorites with a dedicated tab for easy access