Skip to content

docs: update decoding limitations and thank Komga #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
everpcpc merged 2 commits into from
Oct 31, 2026
Merged

docs: update decoding limitations and thank Komga #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a846cbf
docs: drop JXL and JPEG 2000 from decoding limitations
everpcpc Oct 31, 2026
f96f0ca
docs: thank the Komga project and its contributors
everpcpc Oct 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/components/Footer.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
</div>
</div>
<p class="copyright">
kmworks projects are under the MIT License. Not affiliated with the Komga project.
kmworks projects are under the MIT License. Not affiliated with the Komga project, with thanks to its author and contributors.
</p>
</div>
</footer>
Expand Down
4 changes: 4 additions & 0 deletions src/content/docs/server/intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,7 @@ See the full list under [Enhancements](/server/enhancements).
## Migrating from Komga

Already running the Java version? The [Migration](/server/migration) guide keeps your library, database, and clients.

## Thanks

KMServer would not exist without [Komga](https://komga.org). Thanks to [gotson](https://github.com/gotson) and the Komga contributors, whose work defines the API, data model, and behavior KMServer follows. Its SQL migrations, OpenAPI document, and test fixtures come directly from the [Komga source tree](https://github.com/gotson/komga).
2 changes: 1 addition & 1 deletion src/content/docs/server/limitations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ These are excluded on purpose rather than gaps:

## Media formats

- No JXL / HEIF / JPEG2000 decoding: those types are sniffed but excluded from the readable image types, so converting or resizing those pages fails the same way as for any unsupported image format. The Java version decodes them via ImageIO/TwelveMonkeys.
- No HEIF / HEIC / AVIF decoding: those types are sniffed but excluded from the readable image types, so converting or resizing those pages fails the same way as for any unsupported image format. The Java version decodes them via ImageIO/NightMonkeys and libheif.
- PDF support requires a runtime libpdfium, looked up in `KOMGA_PDFIUM_PATH`, next to the executable, then system paths; when unavailable, every PDF operation returns `Unsupported`. The Java version bundles PDFBox. The Docker image ships libpdfium next to the binary; for the release archives, see [Installation](/server/installation).
- JPEG output is not byte-identical to ImageIO (different encoder), an accepted deviation that affects byte-level comparisons of thumbnails and page hashes.

Expand Down
Loading