HANSEL / KOREADER & MAC

Lose yourself in a good story.
Hansel knows the way back.

Organise it in Grimmory.
Open it with Hansel.

Your books and shelves, right in KOReader and on your Mac. Choose what to read, and download the books you want to keep with you.

Hansel Mac dashboard showing a sample Classics collection and continue-reading books.
Hansel Classics library on the NovaAir e-ink reader.

THE LIBRARY LIVES IN ONE PLACE

Your server does the organising.
Hansel gets you reading.

Add books. Arrange shelves. Edit metadata. Do it once in Grimmory; open that collection wherever you read.

SOURCE OF TRUTH

Your Grimmory server

Books · Covers · Shelves · Series · Authors · Tags

↓ THE SAME LIBRARY

Hansel for Mac

Hansel for Mac brings your Grimmory collection and EPUB and PDF reading to the desktop.

See Hansel for Mac →
↓ THE SAME LIBRARY

Hansel for KOReader

Make your server’s cover grid the entrance to your e-ink reader. Tap a book to download it and open it in KOReader.

See the KOReader experience →

Book files are downloaded locally for reading. Your master collection stays in Grimmory.

01 / ORGANISE ONCE

The shelves you made.
On the screen you pick up.

Your “Read next” shelf shouldn’t need rebuilding on every device.

Shelves, series, authors, genres, and tags come from Grimmory. Browse your collection, including the books you haven’t downloaded yet.

Try it: save a server book, switch to On This Device, then remove the local copy. It stays in the library.

Your library

02 / KEEP THE COLLECTION, SKIP THE FILE CHORES

A whole library to choose from.
Only a few books to carry.

You don’t have to fill the reader before you know what you want to read.

Browse the server’s collection. Download a book when you choose it. In the KOReader plugin, pin the books you want to keep through cleanup; remove a local copy when you’re done. The book on your server stays put.

Going away? Download first. When the server is out of reach, read the books already on the device. Reconnect to reach the rest of your library again.

GRIMMORY Keep the master collectionHANSEL Find a book and bring it downYOUR DEVICE Keep what you’re reading

03 / YOUR LIBRARY IS THE HOME SCREEN

Open KOReader.
There are your books.

Go straight from a cover to the first page.

Your Grimmory covers, shelves, search, and filters, right in KOReader. Tap a book to download and open it. No trip back to the file browser.

Set Start with → Hansel. Your library becomes KOReader’s home screen, with large targets and a grid made for e-ink.

Requires KOReader 2024.12+ with plugin support, including supported Android readers. Gretel is optional.

Get the KOReader plugin · v0.3.1
Hansel KOReader Classics library on the e-ink reader.
Browse Classics

04 / HANSEL FOR MAC

Give your shelves
a little more room.

Your Grimmory collection on a larger screen. The Mac reader currently opens EPUB and PDF, with downloaded books ready offline.

Hansel Mac dashboard with a sample Classics collection and continue-reading cards.
Start with your reading dashboard
See more of your collection.Covers and shelves with room to breathe.Open a book on your Mac.EPUB and PDF reading built in.Keep the organising in Grimmory.No desktop library to rebuild.

ONE BOOK / TWO SCREENS

Same story.
A different place to read.

Alice’s Adventures in Wonderland, Chapter I. A quiet e-ink page on the reader; more room on your Mac.

Alice Chapter I displayed on the KOReader e-ink reader.
Hansel Mac interface reading Alice’s Adventures in Wonderland, Chapter I.

Reading-position sync needs the same book file, configured Grimmory sync, and a connection.

05 / YOUR PLACE BELONGS WITH YOUR BOOK

Put down the reader.
Pick up the story.

Your reading position can travel through the same server as your books.

With Grimmory’s KOReader sync and web-reader bridge configured, EPUB progress can move between the Mac edition, KOReader, and Grimmory’s web reader. Position transfer depends on the book and server configuration.

The Mac edition offers a choice when the server has a later position. The KOReader plugin’s progress sync is opt-in and stands down when another supported sync plugin is handling it. Both devices need a connection to exchange progress. The Mac app keeps an unsent position on this Mac, including after you quit. It sends that position after you reconnect with the same account only while progress sync is not Off and Work offline is off. A new install leaves progress sync on Auto and Work offline off. Turning sync Off, or turning Work offline on, keeps the saved position on this Mac and does not send it. A position kept locally is not yet one the server has received.

Reading progress

You’re at 32% here.
Your server has a later position: 48%.

This device32%32%

Choose where to continue in this example.

06 / MAKE THE WHOLE DEVICE A READER

Press Home.
Come back to your library.

Hansel makes your library the first thing KOReader shows. Gretel makes KOReader the app your Android reader comes home to. Together, they take you from the Home button to the collection you keep in Grimmory.

Choose KOReader in Gretel, make Gretel your Android home app, and set KOReader to start with Hansel. You can still reach settings: press Home twice quickly. It’s a reading-first setup you can change whenever you want.

Android HomeGretel opens KOReaderHansel shows your library
Pair with Gretel →Optional · Android 8+ · Hansel also works on its own

THE READING TOOLS / SIDE BY SIDE

Choose your screen.
Know what comes with it.

Grimmory keeps the books and their organisation. Hansel for Mac includes its own reader; Hansel for KOReader brings your collection to KOReader’s reading tools.

GRIMMORY / THE SERVER & BROWSER

Keep the collection together.

Grimmory organises and serves your books, covers and reading progress. Its browser reads EPUB, PDF and comics. A format stored on the server may still need a compatible reader.

Grimmory’s documented formats ↗
KOREADER / THE READING ENGINE

Make the page your own.

KOReader opens the downloaded book and provides typography, chapter navigation, highlights and PDF tools. Hansel adds the Grimmory library, downloads and optional progress sync.

KOReader’s reading tools ↗

Hansel for Mac currently opens EPUB and PDF. The KOReader plugin uses KOReader to read formats served by Grimmory. MOBI, FB2 and CBZ are documented KOReader capabilities; they have not been verified on this device.

Scroll across to compare

Reading formats and features in Hansel for Mac and Hansel for KOReader.
Reading featureHansel for MacReads EPUB and PDFHansel for KOReaderReads with KOReader
EPUBBuilt inVia KOReader
PDFBuilt inDevice validation pendingVia KOReaderDevice validation pending
MOBI / FB2Not supported in the Mac appDocumented KOReader capabilityNot device-verified
CBZ comicsNot supported in the Mac appDocumented KOReader capabilityNot device-verified
EPUB text size, spacing & marginsBasic reader controlsKOReader controls
Chapter navigationEPUB contents
PDF outline, when present
KOReader contents
Highlights, notes & bookmarksNot includedKOReader toolsNo Hansel annotation sync
Offline readingDownloaded EPUB and PDFDownloaded books
Cached catalogue
Reading-position syncGrimmory progress syncOptional Hansel syncLeaves sync to another active plugin

Controls vary by format. PDF uses page and zoom controls; EPUB supports adjustable typography. KOReader format support also depends on the reader’s build.

Position handoff requires the same book file and configured Grimmory sync. Positions are approximate; typography and annotations do not transfer between these clients.

Server and reader documentation: Grimmory EPUB reader ↗ · Grimmory PDF reader ↗ · Grimmory + KOReader sync ↗ · KOReader user guide ↗

BEFORE THE FIRST CHAPTER

Bring your library.

THE CENTRE

Your Grimmory server

Keep your books here. Sign into the same server from each Hansel client. Your server must be reachable to browse uncached content, fetch books, and sync.

THE MAC CLIENT

Hansel for Mac

macOS 14+.
EPUB and PDF reading built in.

THE E-INK CLIENT

KOReader + Hansel

KOReader 2024.12+ with plugin support. Reading formats depend on KOReader. The plugin is v0.3.1; compatibility on your device depends on its KOReader build.

Can I use Hansel away from home?

Downloaded books stay available on your device. To browse uncached library content, download new books, or sync, your Grimmory server must be reachable from your current network.

Am I keeping a second library on each device?

Grimmory holds your master collection and its organisation. Hansel caches catalogue information and downloads local book files for reading. Those local copies let you read offline; they don’t replace your server library. In the KOReader plugin, removing a downloaded copy leaves the server’s book untouched.

Do I need another account or Gretel?

Use your Grimmory server address and account. There is no separate ABEANT account. Gretel is an optional Android home app; it is not needed for Hansel on Mac or in KOReader.

What do I need for KOReader progress sync?

Use the same book and Grimmory account, with KOReader sync configured against your server. EPUB handoff uses Grimmory’s web-reader bridge. Position transfer depends on server configuration and document compatibility.

Where are credentials stored, and how do updates work?

The Mac app stores its refresh token and optional KOReader sync credentials in macOS Keychain. The plugin stores credentials obfuscated in KOReader settings; this is not Keychain storage or encryption.

Check for Updates in build 9 reads https://updates.abeant.com/hansel/appcast.xml. Builds 7 and 8 read https://abeant.github.io/hansel/appcast.xml, which offers them build 9. After they install build 9, they use the new feed. Install KOReader plugin updates manually from the plugin’s release page.

Privacy details → · License details →

Download Hansel

Mac app

macOS 14+ · Universal (Apple silicon and Intel) · Version 0.1.1 (9).

Download for Mac

Open the disk image (9,452,353 bytes) and drag Hansel to Applications, or unzip the archive (9,542,555 bytes) and move Hansel to Applications. To uninstall, quit Hansel and move /Applications/Hansel.app to Trash. Preferences and Application Support stay.

Zip 0.1.1 (9) · Corresponding source · License · Checksums · Third-party notices

Bring your own server and books. Independent project, not affiliated with Grimmory or KOReader.