Liseursync

Set up CrossPoint on your Xteink

Pair the reader with your account and it keeps your place in step with your other devices. Add your library and you can download books straight onto it. Add the statistics plugin and your reading time shows up on the website.

Start

Position sync takes a few minutes. The library and the statistics are optional and can be added later.

CrossPoint's OPDS browser on an Xteink showing the books on the LiseurSync server, with Treasure Island selected.
Your library, browsed from the Xteink.

Before you start

  • An account on your LiseurSync server, the one you sign into with a username and password.
  • An Xteink X3 or X4 running CrossPoint, connected to Wi-Fi.
  • A computer to read the codes from the website and to copy the statistics plugin onto the reader.

The steps

Get a pairing code

On your computer, sign into LiseurSync and open Settings, then Devices & integrations. In the KOReader (kosync) box, press Generate pairing code. CrossPoint syncs the same way KOReader does, so it uses the same box.

The code is shown once. Save it in your password manager under the name you will give the reader, because it becomes the reader's sync password and you need it again in step 4.

The pairing code box on the LiseurSync Devices page, showing a one-time code with a Copy button.
The pairing code is shown once and works for 15 minutes.

Sign up from the Xteink

On the reader, open Settings, go to the Connectivity tab and choose CrossPoint Sync. Fill in:

UsernameA name for this reader, such as my-xteink
PasswordThe pairing code
Sync Server URLYour server's address followed by /adapter/kosync, for example https://books.example.com/adapter/kosync
Server TypeKoSync
Document MatchingBinary

Then choose Sign Up. The reader says Account created, which here means it is now attached to your existing account on the website.

Choose Binary even when Filename is the default. It lets the server recognise the same book on all your devices. Leave Sync Clippings off.

CrossPoint Sync settings with the username my-xteink, the server address ending in /adapter/kosync, Server Type KoSync, Document Matching Binary and Sign Up selected.
Settings, Connectivity, CrossPoint Sync.

Add your library

This step is optional. It lets you download books from your server onto the reader, and those copies match the books on the website for syncing and statistics.

On the website, open the Apps tab of Devices & integrations. Under API tokens, type a name such as Xteink library, leave only library-read ticked and press New token. Copy the secret it shows.

On the reader, open Settings, then Connectivity, then OPDS Servers, and add a server:

OPDS Server URLYour server's address followed by /opds/v1.2
UsernameThe word token
PasswordThe token secret

Your books are then under OPDS Browser on the home screen. Once plugins are turned on in step 5, it moves into Plugins. Pick a book and choose Download.

Leave downloaded books as they are. Converting or optimising an EPUB can make the server treat it as a different book.

The API tokens box on the Apps tab, with Xteink library typed in, only library-read ticked and a New token button.
A token that can only read the library.

Download the statistics plugin

The plugin sends how long you read to the Insights page. It needs a recent CrossPoint, so update the reader first if you haven't for a while.

Back on the E-readers tab, open your reader's entry under KOReader (kosync) and expand CrossPoint reading statistics. Type the pairing code from step 1 and press Enable statistics & download plugin. You get liseur-stats.zip.

From now on this reader's reading time comes only from the plugin, so install it straight away. The ZIP holds a login for your reader. Keep it private.

The KOReader (kosync) box listing my-xteink, with CrossPoint reading statistics expanded, a password field for the pairing code and an Enable statistics and download plugin button.
The pairing code unlocks a plugin made for this reader.

Install and turn on the plugin

Unzip the file on your computer. Copy the liseur-stats folder into a folder called plugins at the top of the reader's storage, creating plugins if it is missing. Make sure device.json sits directly inside plugins/liseur-stats.

You can copy it over Wi-Fi: start File Transfer on the reader, open the address it shows in your computer's browser and use its file manager. Or switch the reader off, take out the SD card and copy the folder with a card reader.

Then, on the reader, open Settings, Connectivity, Plugins and choose Enabled. Restart the reader, check that Liseur reading statistics is listed under Plugins on the home screen, and reopen your book.

Where the folder goes on the reader.

What you'll see

CrossPoint saying Account created, CrossPoint sync is ready to use.
Signed upThe reader is paired with your account.
The OPDS Servers list with LiseurSync in it.
OPDS ServersYour server, added under Connectivity.
The OPDS server settings with the server name LiseurSync, the address ending in /opds/v1.2 and the username token.
Its settingsThe address ends in /opds/v1.2 and the username is token.
Treasure Island in the OPDS browser with its cover and Details and Download buttons.
A book from the serverDownload puts it on the reader.
The Connectivity settings with Plugins set to Enabled.
Plugins enabledSettings, Connectivity, Plugins.
The Plugins list with OPDS Browser, Plugin Hub and Liseur reading statistics.
The statistics pluginLiseur reading statistics is listed under Plugins.
A page of Treasure Island open on the reader.
ReadingTurn pages forward as usual and the time is counted.
The reader menu with Sync Progress selected.
Sync ProgressPress Confirm while reading to open this menu.
CrossPoint saying Progress uploaded.
Position sentYour other devices can now pick up from here.

Which password goes where

Your account password only signs you into the website. The reader uses two other logins, and each can be revoked on its own.

The KOReader (kosync) box listing the reader my-xteink.

The pairing code

Typed as the password in CrossPoint Sync, and again to download the statistics plugin. After pairing it stays the reader's sync password, and the website cannot show it again.

The API tokens box with a library-read token being created.

The library token

Typed as the password in OPDS Servers, with token as the username. It can list and download your books and nothing else.

If something doesn't work

Sign Up says the username is already registered

That name is already paired. Pick another name and use a fresh pairing code. A revoked name cannot be registered again.

The plugin download says the password does not match

Use the pairing code you typed on the reader for that same name, and check you expanded the right reader. Your account password and your library token do not work here. If the code is lost, follow the next answer.

I lost the pairing code

Generate a new code and save it. On the reader, open CrossPoint Sync, change Username to a new name such as my-xteink-new, put the new code in Password and choose Sign Up. Download the plugin for the new name with the same code and copy it over the old files. Once it works, revoke the old name on the website. Your books, positions and statistics stay with your account.

The catalog says "Failed to parse feed"

CrossPoint shows this for refused logins as well as broken catalogs. Check that the address ends in /opds/v1.2, the username is token and the token has library-read and has not been revoked. If it still fails, ask whoever runs the server whether your account can see the folder holding your books.

Liseur reading statistics is not in the Plugins list

Check that device.json is directly inside plugins/liseur-stats/. A ZIP left on the reader, or a second liseur-stats folder inside the first, will not load. Restart the reader after enabling plugins. If it is still missing, update CrossPoint.

My position syncs but no reading time appears

Close and reopen the book after installing the plugin, since a session that started earlier is ignored. Read for a few minutes, turning pages forward, then close the book or put the reader to sleep with Wi-Fi in reach. Only forward page turns count.

Reading done offline is sent the next time the reader connects. After a very long time offline some of it can be lost, so connect now and then.

The same book shows up twice or doesn't share its position

Set Document Matching to Binary in CrossPoint Sync, and read the EPUB exactly as it came from the server. A converted or optimised copy looks like a different book.