Summary
Stable release of this fork, built on the same CrossInk v1.6.0.
If you are coming from v1.5.0+bookorbit.2 or from CrossInk, read the v1.5.1+bookorbit.1 notes first, they cover the removal of KOReader Sync, the reduced built-in fonts, and the BookOrbit Sync shortcut that has to be picked again once.
Installing
This is a stable release: on a device already running this fork (v1.5.1+bookorbit.1 or newer), Settings → System → Check for Updates installs it over the air.
A device running CrossInk has to be flashed once by USB or from the SD card — see the installation guide, which also covers USB-locked devices and reverting to upstream. Pick the file for your device:
| Device | File |
|---|---|
| Xteink X3 / X4 | firmware-x3-x4-v1.6.0-bookorbit.2.bin
|
| Xteink X4 Pro | firmware-x4-pro-v1.6.0-bookorbit.2.bin
|
| Xteink X4 Classic | firmware-x4-classic-v1.6.0-bookorbit.2.bin
|
| Seeed reTerminal Sticky | firmware-sticky-v1.6.0-bookorbit.2.bin
|
Warning
I do not own an X4 Pro or an X4 Classic. The X4 Classic build is untested.
What's Changed since v1.6.0+bookorbit.1
Sync
- Sync on Sleep (#74). Turn it on under Settings → System → BookOrbit Sync, or on the web Settings page. Each time the device goes to sleep, whether from the power button, the sleep timer or a Quick Lock timeout, the sleep screen goes up first. The device then joins a saved Wi-Fi network (the last one used first, then any other saved network in range), syncs progress, highlights, bookmarks and reading sessions behind that screen, draws the sleep screen again (it loses some contrast during the sync) and finishes going to sleep.
- Waking the device cancels the sync. Press Power the way you would to wake it: the sync stops at its next step and the device wakes as usual. What was already sent is kept, and the rest follows on the next sync.
- Progress follows the Smart sync rules, whatever Sync Behavior says, since nobody is there to answer the choice screen. When those rules cannot decide (the first sync of a book on this device, or both sides having moved), progress is left for your next manual sync. Highlights, bookmarks and reading sessions sync either way.
- It is skipped when no book is open, when no Wi-Fi network is saved, and when the battery is below 10% with no charger connected.
- The option is off by default: each sync keeps Wi-Fi on for a few seconds, and longer when no saved network answers.
- Highlights made outside a regular paragraph now sync to BookOrbit (#84). That covers books whose text sits in blockquotes, and highlights in headings, list items and other blocks. They were saved on the device but never sent. Highlights skipped this way are sent once you reopen their chapter, one per visit to the chapter.
Controls
- BookOrbit Sync can be assigned to the button combos (#85): Power + Up, and Up + Down on devices that have it, under Settings → Controls, like the other sync actions.
Full Changelog: v1.6.0+bookorbit.1...v1.6.0+bookorbit.2