Skip to content

JKBustillo/KReader

Repository files navigation

KReader

A lightweight desktop reader for comics and documents, built with Tauri + React + TypeScript.

It reads comic archives, PDFs, and standalone images, and includes a built-in library system for organizing and browsing your collection.

Supported formats

Format Description
.cbz / .zip Comic Book ZIP — a ZIP of images (most common comic format)
.cbr / .rar Comic Book RAR — a RAR of images
.pdf PDF documents
Images .jpg .jpeg .png .gif .webp .bmp .avif — opening one loads the whole folder as pages

Features

Reader

  • Multiple view modes — single page, double page, cascade (all pages scrollable vertically, height-capped), and webtoon (continuous vertical scroll, no gaps).
  • Bookmarks — toggle bookmarks per page and jump between them; persisted per file.
  • Reading progress — remembers the last page and view mode for each file.
  • Sibling navigation — jump to the previous/next comic in the same folder without leaving the reader.
  • Zoom — scale content between 50% and 300%.
  • RTL support — right-to-left reading direction for manga.
  • Fullscreen — toggle with a key or by double-clicking anywhere.
  • Recent files — keeps a list of the last 10 opened files for quick access.

Library

A built-in collection manager for browsing large libraries:

  • Folder scanning — point KReader at a folder and it indexes all supported files recursively.
  • Two view modes — grid (cover thumbnails) and details (sortable table).
  • Sorting — by name, size, date, last opened, or page count.
  • Filtering — by tags and by folders (recursive or direct-children-only), with union semantics.
  • Tags — auto-parsed from filename brackets (e.g. [Circle (Author)]) plus your own custom tags, editable individually or in bulk.
  • Ratings — 1–5 stars per entry.
  • Favorites & reading state — mark entries as favorite and as read / in-progress; filter to favorites only.
  • Reading progress bar — optional per-card/row progress indicator.
  • Metadata that sticks to the file — your custom tags, favorites, ratings and reading state are saved per file, so they're restored if you remove and re-add the same folder (toggleable in settings).
  • Cover thumbnails — extracted and cached on disk.
  • File management — move entries to subfolders, send them to the OS trash, or copy file names to the clipboard (right-click; multi-selection copies one name per line). Removing a library asks for confirmation first.
  • Export / import — back up or transfer your whole library, including your per-file metadata.
  • Automatic backups — optional: KReader snapshots your library on startup (at most once a day) and keeps the most recent few.

App

  • Multiple windows — open several reader windows at once; they run in a single process and share state, so bookmarks and settings never clobber each other.
  • Themes — dark and light.
  • Languages — English and Spanish.
  • File association.cbz, .cbr, .zip, and .rar files can be opened directly with KReader from your OS.

Keyboard shortcuts

Global

Key Action
F Toggle fullscreen
X Close window
Double-click Toggle fullscreen

Reader

Key Action
/ Previous / next page (respects RTL)
PageUp / PageDown Scroll, or turn page when at edge
Home / End Jump to first / last page
Ctrl + ← / Ctrl + → Previous / next comic in the same folder
W Toggle webtoon mode
C Toggle cascade mode
B Toggle bookmark on current page
[ / ] Jump to previous / next bookmark
D Toggle double-page mode
S Toggle RTL reading direction
G Toggle gap between pages
+ / - Zoom in / out
J Toggle smooth scroll
I Toggle info overlay
P Pin / unpin page number permanently
Escape Close reader, return to home screen

Development

# Install dependencies
npm install

# Start in development mode (Vite + Tauri window)
npm run dev

# Build for production
npm run build

# Lint
npm run lint

Requires Rust and the Tauri prerequisites for your OS.

Vite's dev server must run on port 1420 — Tauri hardcodes this in tauri.conf.json.

Tech stack

About

A lightweight desktop reader for comics and documents.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors