Skip to content

Feature Overview

github-actions[bot] edited this page Nov 19, 2026 · 9 revisions

What GZreader does, in short, with where to read more. It runs on e-readers from the Kindle 2 and Nook 1 to the Kindle Scribe, and on Kobos (test build). Not every feature is on every device: see Device compatibility.

Reading and your library

  • Reading — EPUB, PDF, MOBI, AZW3, FB2, CBZ, TXT and more in KOReader's reader, with the ZenOS interface, a built-in dictionary and the quick panel for layout, fonts and light. → Using GZreader
  • Catalog — one tab, three pages you swipe between: Books, Audiobooks and Music. Search and browse your Grimmory server laid out like a bookshop: Continue reading, Recently added, All books, Libraries, Shelves (and magic shelves), Authors, Series. Lists open at once from a saved copy. → Grimmory library
  • Downloads in the background — with a progress bar, a queue, resuming after a dropped connection or a restart, and an auto-download shelf. → Grimmory library
  • Sync with Grimmory — reading position (to the exact place, as an EPUB CFI the web reader understands), bookmarks, highlights and notes (both ways, with a three-way merge), ratings and reading sessions. → Grimmory sync
  • Bookshelves — books stand on shelves, spines out, the selected one turns to show its cover; audiobooks as a cassette walkman, music as a CD player. Also lists and tiles. → Home and bookshelves
  • Bookshelf theme and ornaments — an oak, walnut or plain plank, and ornaments on the shelves' free ends (plants, a clock, a model ship…, seasonal ones in their season, or your own pictures). Choose on a screen of tiles with a preview of your shelf, or hold an ornament; in colour on colour Kindles. → Home and bookshelves
  • Grimmory reading stats on Home — read this week, day streak, books finished, across all your devices. → Home and bookshelves
  • Picture books — scanned-page EPUBs are recognized and each page fills the screen. → Picture books
  • Sleep screen — the book's cover while reading, your pictures from Home: from the USB drive's screensavers folder (send them from your phone's browser) or from an Immich album. → Home and bookshelves
  • Immich — an album's photos as the sleep screen and the Home wallpaper, kept on the Kindle and changed now and then on Wi‑Fi. → Home and bookshelves
  • English dictionary built in (Open English WordNet).

Setting up

  • Set up from your browser — scan one QR code (or type the address and PIN) and one page connects Grimmory (password or single sign-on), Notes, calendars and Plex. → Setup page and connections
  • Send books from your browser — pick EPUBs, PDFs and other books on your phone or computer and they go straight into Downloads (no Grimmory needed); pictures become sleep screens. → Setup page and connections
  • Copy connections from another GZreader over the Wi‑Fi with a PIN (SPAKE2, encrypted). → Setup page and connections
  • Cloudflare — a key or an Access service token so servers behind Cloudflare let the Kindle through. → Setup page and connections
  • No Wi‑Fi? The Kindle 2 and DX sync through a web page on a computer, over USB: reading goes to Grimmory, books, audiobooks, music, notes, calendars and updates come back. → Sync with a computer

More than books

  • Notes — your Memos notes as sticky notes, in a list or side by side, compact or whole; tick checklists, offline too; journal entries. On touch Kindles a rich text editor like Memos' web editor: the note formatted as you type, with a formatting bar for headings, bold, italic, lists, checklists and tags. → Notes
  • Drawing notes — full drawing on touch and pen Kindles: with a finger, or with the Scribe's pen (pressure, the side button erases, your hand can rest on the screen). Pen, fountain pen, marker, pencil, highlighter and eraser, undo and redo, pinch zoom, pages and notepaper (ruled, Gregg, dot grid, graph, Cornell…). Drawings go to Memos as Memos' own drawings, and drawings made in Memos show and edit on the Kindle. → Notes
  • Calendars — calendar links (Proton, Google, Outlook…) and CalDAV accounts: agenda, day, week, month. → Calendar
  • Music — albums and playlists from Plex, downloaded and played while you read (Kindles with a speaker or headphone jack, or with Bluetooth). → Music
  • Audiobooks — from Grimmory (or Plex), with your place kept in sync (Kindles with a speaker or headphone jack, or with Bluetooth). → Audiobooks and read aloud
  • Read aloud — any EPUB, MOBI, AZW3, FB2 or TXT in the Kindle's own voice, the sentence highlighted and pages turning by themselves (Kindle 2, 3, DX, Touch; on Bluetooth Kindles in Amazon's voice). → Audiobooks and read aloud
  • Bluetooth — pair and connect headphones or a speaker from Settings on the Kindles that have Bluetooth (Scribe, Paperwhite 5 and newer…). → Bluetooth
  • House — your Home Assistant rooms: lights, switches, thermostats, locks, garage doors and scenes to switch from the Kindle, straight over your Wi‑Fi (Kindles with Wi‑Fi). → House

Using it

  • The quick panel — one panel of square tiles on every device (Menu, or swipe down): Wi‑Fi, night mode, sleep, updates, settings, and what fits where you are (Home or the book); choose its tiles in Settings → Home and tabs → Quick panel. → Using GZreader
  • Letter keys everywhere on keyboard Kindles; the 5-way on the Kindle 4; touch on the others, and the pen on the Kindle Scribe; the colour touchscreen on the Nook 1st Edition; touch and page keys on Kobos. → Using GZreader, Kobo
  • First-time tour on touch Kindles, showing the quick panel. → Using GZreader

Looking after itself

  • Updates from GitHub over Wi‑Fi (or the sync page), with a What's new screen after each; test builds for trying changes early. → Updates and test builds
  • Wi‑Fi on, off or auto — Auto (the default) turns it on for what needs it and off after a minute, to save battery; the quick panel's Wi‑Fi tile goes through the three. → Wi‑Fi
  • Faster on old Kindles — a shadow screen for drawing, precompiled code, pre-sized covers. → Performance
  • Debug reports and diagnostics — no usage statistics; debug reports go to the developer only if you choose, and the diagnostic log goes to the developer in one tap. → Privacy and diagnostics

Clone this wiki locally