KOReader plugin that syncs reading progress back to the Onyx Boox library

Tumeconnais · 02-17-2026, 08:11 AM

Hey everyone,

I use KOReader as my main reader on an Onyx Boox Go 7, but one thing always bugged me: the Boox library has no idea what I'm reading or how far I am, since KOReader handles everything independently. So I built a small plugin to fix that.

What it does:

Syncs your current page position (e.g. "173/488") to the Boox Library
Sets the reading status (New / Reading / Finished) based on KOReader's status
Updates the "last accessed" timestamp so books sort correctly in the Boox library
Includes a bulk update option from the file browser menu — scans the current directory and pushes progress for all books at once, so you don't have to open each one individually

Installation:

Create a folder in koreader/plugins/onyx_sync.koplugin
Copy main.lua and _meta.lua into the folder
Restart KOReader.
Ensure the plugin is enabled in KOReader settings.

It's still a Beta, sometime it fails to sync and I don't know really why, an issue is open. I released a V0.0.2 https://github.com/Tukks/onyxbooxsyn...ses/tag/v0.0.2, it seems to have fixed the sync error, but I'm not sur.

GitHub: https://github.com/Tukks/onyxbooxsync.koplugin

Would love feedback, especially from people on other Boox models to see if it works flawlessly. PRs welcome!

Edit : The last version includes a companion app to perform the synchronization and can now synchronize reading time statistics. go check the readme for installation instruction.

nattaponx · 03-17-2026, 04:52 AM

Awesome! I had been searching for how to sync reading progress from KOReader to Boox and now I found this. Thank you!

A question: In the GitHub page you mention the installation of onyx-sync.apk. Do I need to install this as well or is it good enough with the plugin?

Tumeconnais · 03-20-2026, 01:27 AM

Yes, the companion app is mandatory now. It was easier to keep in sync with the app.

Installation
1. Companion App
Download and install onyx-sync.apk from the latest release.
Long press the app icon on the home screen and tap Unfreeze — Onyx freezes newly installed apps by default, which would prevent the service from running in the background.
Launch the app once — a permission dialog will appear asking for All files access. Grant it so the app can read KOReader's statistics database. Nothing else will appear on screen; the app will close automatically.
2. Plugin
Create the folder koreader/plugins/onyxbooxsync.koplugin on your device.
Copy main.lua and _meta.lua into the folder.
Restart KOReader.
Ensure the plugin is enabled in KOReader settings

02-17-2026, 08:11 AM	#1
Tumeconnais Junior Member Posts: 5 Karma: 10 Join Date: Jan 2013 Device: Kobo Glo By fnac	KOReader plugin that syncs reading progress back to the Onyx Boox library Hey everyone, I use KOReader as my main reader on an Onyx Boox Go 7, but one thing always bugged me: the Boox library has no idea what I'm reading or how far I am, since KOReader handles everything independently. So I built a small plugin to fix that. What it does: Syncs your current page position (e.g. "173/488") to the Boox Library Sets the reading status (New / Reading / Finished) based on KOReader's status Updates the "last accessed" timestamp so books sort correctly in the Boox library Includes a bulk update option from the file browser menu — scans the current directory and pushes progress for all books at once, so you don't have to open each one individually Installation: Create a folder in koreader/plugins/onyx_sync.koplugin Copy main.lua and _meta.lua into the folder Restart KOReader. Ensure the plugin is enabled in KOReader settings. It's still a Beta, sometime it fails to sync and I don't know really why, an issue is open. I released a V0.0.2 https://github.com/Tukks/onyxbooxsyn...ses/tag/v0.0.2, it seems to have fixed the sync error, but I'm not sur. GitHub: https://github.com/Tukks/onyxbooxsync.koplugin Would love feedback, especially from people on other Boox models to see if it works flawlessly. PRs welcome! Edit : The last version includes a companion app to perform the synchronization and can now synchronize reading time statistics. go check the readme for installation instruction. Last edited by Tumeconnais; 03-20-2026 at 02:50 AM.

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
Would a Calibre plugin to extract reading progress from the kindle be useful?	tpb	Amazon Kindle	21	03-14-2026 03:08 PM
Dropsync reading progress not syncing Boox devices	suliabryon	Reading and Management	0	03-03-2025 12:04 PM
KOreader progress sync not working between Kobo Libra 2 and Boox Palma	konkeydonk	KOReader	4	11-19-2024 08:47 PM
Sync KOReader progress with Boox Library	Geremia	Onyx Boox	1	11-14-2022 06:55 AM
Onyx boox i62 or Onyx boox 92M for PDF reading?	tidyboyd	Which one should I buy?	16	04-02-2013 04:19 PM

03-17-2026, 04:52 AM	#2
nattaponx Junior Member Posts: 5 Karma: 10 Join Date: Sep 2023 Device: Boox Page	Awesome! I had been searching for how to sync reading progress from KOReader to Boox and now I found this. Thank you! A question: In the GitHub page you mention the installation of onyx-sync.apk. Do I need to install this as well or is it good enough with the plugin?

03-20-2026, 01:27 AM	#3
Tumeconnais Junior Member Posts: 5 Karma: 10 Join Date: Jan 2013 Device: Kobo Glo By fnac	Yes, the companion app is mandatory now. It was easier to keep in sync with the app. Installation 1. Companion App Download and install onyx-sync.apk from the latest release. Long press the app icon on the home screen and tap Unfreeze — Onyx freezes newly installed apps by default, which would prevent the service from running in the background. Launch the app once — a permission dialog will appear asking for All files access. Grant it so the app can read KOReader's statistics database. Nothing else will appear on screen; the app will close automatically. 2. Plugin Create the folder koreader/plugins/onyxbooxsync.koplugin on your device. Copy main.lua and _meta.lua into the folder. Restart KOReader. Ensure the plugin is enabled in KOReader settings