Skip to content

Repository files navigation

KMReader

KMReader Icon

Native SwiftUI Komga client for iOS, macOS, and tvOS.

iOS macOS tvOS Swift Xcode

Download on the App Store

Important Features

Readers

  • DIVINA reader on iOS, macOS, and tvOS with LTR, RTL, vertical, Webtoon, spreads, zoom, page curl on iOS, cover transitions, tap zone layout presets, keyboard support, per-page rotation, border cropping, preload profiles, and per-book preferences.
  • EPUB reader on iOS/macOS with paged, scrolled, curl, or cover layouts, custom fonts, per-book theme and typography controls, dedicated EPUB behavior settings, status/footer overlays, multi-column reading, and nested table of contents.
  • PDF reader on iOS/macOS with native PDF or DIVINA mode, search, table of contents, page jump, automatic or explicit page presentation modes, spread layouts, configurable render quality, and continuous reading options.
  • Animated GIF and WebP pages play inline. Incognito mode, page image actions, persistent reader progress overlays, AI upscaling, and iOS Live Text are supported where available.

Browse and Discovery

  • Dashboard sections for Keep Reading, On Deck, Recently Added, Recently Updated, and pinned collections/read lists, with quick offline actions for current or full book sections where supported.
  • Browse Series, Books, Collections, and Read Lists with metadata filters, all/any matching, saved filters, reading history, a 90-day pages-read heatmap, dashboard search access on larger layouts, and optional unread-cover blur.
  • Local database storage keeps large libraries, dashboards, logs, downloaded content, and offline browsing responsive.
  • Server-specific dashboard library scopes, refreshed widget payloads, Spotlight indexing for downloaded content, plus iOS widgets and Home Screen quick actions for Keep Reading, Search, and Downloads.

Offline and Sync

  • Download books for offline reading across DIVINA, EPUB, and PDF workflows, with optional offline-first reading that prepares local content before opening the reader.
  • Per-series and per-read-list policies support manual, unread-only, unread + cleanup, and all-books downloads.
  • Downloaded library sections show book counts alongside storage usage, sync missing covers for offline data, and support pull to refresh on iOS and macOS.
  • Large downloads stream to disk, while CBZ, CBR, PDF, and supported EPUB offline flows keep source files available and prepare pages on demand.
  • Progress and offline changes sync when reconnecting, with stale progress protection and automatic recovery from server outages when offline mode was entered automatically. Cache controls cover pages and thumbnails.
  • iOS background downloads and Live Activities show reader progress, incognito status, download progress, and processing state.

Multi-Server and Management

  • Save multiple Komga servers, protect private servers with device authentication, and switch instantly.
  • Sign in with username/password or API key, and manage Komga API keys inside the app.
  • Admin tools cover metadata editing, library management, media analysis, missing posters, duplicate files/pages, task monitoring, and paginated log viewing, export, and clearing.

Platform Highlights

  • iOS/iPadOS: widgets, quick actions, Spotlight search, Dynamic Island Live Activities, background downloads, Live Text, and reader keyboard shortcuts.
  • macOS: dedicated reader windows, menu bar reader actions, Spotlight search, keyboard shortcuts, and keyboard help.
  • tvOS: remote-first DIVINA reading and TV-optimized browsing.

KMReader UI is localized in English, German, French, Japanese, Korean, Simplified Chinese, Traditional Chinese, Italian, Russian, and Spanish.

Getting Started

Prerequisites

  • Komga 1.19.0+
  • Xcode 15.0+
  • iOS 17.0+, macOS 14.0+, tvOS 17.0+

Build and run

git clone https://github.com/everpcpc/KMReader.git
cd KMReader
open KMReader.xcodeproj
make build-ios
make build-macos
make build-tvos

make run-ios-sim
make run-macos
make run-tvos-sim

Compatibility

  • Komga API v1 and v2

Community

Open Source Licenses

Third-party notices: OpenSourceLicenses.json, also shown in the in-app licenses screen.

About

A full-featured, native Komga client for iOS, macOS, and tvOS

Topics

Resources

Stars

105 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages