v1.5.0+bookorbit.1

Summary

First stable release of this fork built on CrossInk v1.5.0.

As stated in the CrossInk release notes:

This release should be SAFE for all known X3 and X4 variants.

Warning

This release is NOT compatible with the XTEINK X4 Pro — do not flash it on one. Upstream has announced X4 Pro support for a later release.

It brings everything upstream added in 1.5.0 — dictionary lookup, touch support for the Seeed Sticky, incremental indexing, nearby device-to-device file transfer, word spacing, and a long list of fixes — plus this fork's own features and fixes below. For the upstream half, see the CrossInk changelog and release notes.

Installing

Warning

This is a stable release, you should normally be able to install with Settings → System → Check for Updates on a device running this fork will offer it over the air but an it seems that there is a bug preventing it.
PLEASE perform a MANUAL install over USB or update through SD CARD firmware update.

There is no tiny or xlarge variant anymore. CrossInk 1.5.0 reworked the build targets and those two no longer exist:

• If you were on the tiny build, you will get the default font size back — set it again in Settings.
• If you were on the xlarge build, download the font sizes you need from Inky and place them on your SD card in a .fonts or fonts folder.

New features

• Highlights now sync with BookOrbit, in both directions: highlights made on the device appear in the web reader at their exact position in the text, highlights created on the web are drawn in the book, and deletions propagate both ways. Highlights made before this release gain their sync identity progressively as you read. by @agosez in #16
• Bookmarks sync with BookOrbit the same way, in both directions, alongside highlights. by @agosez in #18
• The BookOrbit catalog browser now uses the device theme, scrolls through listings seamlessly instead of paging with "Previous/Next" entries, and keeps the session's listings in a cache so navigating back is instant. by @CaptainFrito and @agosez in #25

Fixed in this fork

• BookOrbit sync, statistics and the catalog work again against servers whose TLS certificate chain has grown — most Let's Encrypt hosts today. If your catalog stopped connecting on v1.4.1, this is the fix.
• Starting a sync no longer crashes when the time server's address is not yet known.
• Reopening a book returns to the page you left, instead of the one before it.

Security — please read before installing

BookOrbit connections can no longer confirm that the server answering is really yours.
Your credentials and reading data are still encrypted in transit; what is no longer checked is the identity at the other end. That matters on a network you do not control rather than your home WiFi.

The same limitation applies to the OPDS catalog since CrossInk 1.5.0, and has always applied to KOReader Sync. It will be lifted once the SDK exposes a certificate store to that transport — until then, sync from a network you trust.

Known issues

• Check your button shortcuts after updating. CrossInk added a Lookup Word action that took the slot this fork used for BookOrbit Sync, and shortcuts are stored as numbers. If you had a short Power press or a long press set to BookOrbit Sync, it will now be Lookup Word — set it back in Settings → Controls. Nothing else is affected.
• Highlights are only sent to BookOrbit by batches of 8 entries. If you have more to send you will have to perform several sync.
• Downgrading is lossy for long highlights: this release stores up to 2 KB of text per clipping (previously 512 bytes). An older firmware reading a book whose clippings file holds a longer one treats that file as corrupt and drops it.
• Battery drain in CrossPoint v1.5.0 has been reported by some users. Keep in mind that the battery percentage is an estimation and might not reflect correctly its current status. If you use the "Keep Clock While Asleep" feature battery might drain even faster.

What is most useful to report

• BookOrbit highlight and bookmark round-trips against your own server — especially deletions and highlights created on the web.
• The catalog browser's new scrolling on large libraries.
• Anything from CrossInk 1.5.0 you rely on, since this is the fork's first stable build on that base.

Full Changelog: v1.5.0-bookorbit.1-rc2...v1.5.0+bookorbit.1