Installation on ReMarkable - koreader/koreader GitHub Wiki

Installation via Toltec

1. Install Toltec (check system version requirements on their website before attempting anything!)
2. Run:

opkg install koreader

• You may also install a launcher

Manual installation on reMarkable 1 & 2

0. Install rm2fb (reMarkable 2 only; check system version requirements at the link first!)
1. Download the latest release of KOReader
2. Copy the file to your device:

scp koreader-remarkable-* [email protected]:

3. Log into your device:

ssh [email protected]

4. Extract the contents of the file:

tar -xf /home/root/koreader-remarkable-*

5. Copy the systemd unit file to the system directory:

cp /home/root/koreader/koreader.service /etc/systemd/system/

6. Launch KOReader:

systemctl start koreader

• To launch KOReader by holding down the middle button for 3 seconds (reMarkable 1):

cp /home/root/koreader/button-listen.service /etc/systemd/system/
systemctl enable --now button-listen

• To launch KOReader at startup:

systemctl disable --now xochitl && systemctl enable --now koreader

• To allow KOReader screensavers for poweroff and reboot events:

systemctl disable remarkable-shutdown remarkable-reboot

Manual Installation on reMarkable Paper Pro

Pre-installation steps

1. Install xovi by using included installation script.
2. Install qt-resource-rebuilder (from the xovi repo), rm-appload, and qtfb (you need to compile it yourself with reMarkable official toolchain) as xovi extension.
3. Compile rmpp-qtfb-shim with reMarkable official toolchain, and copy the resulting qtfb-shim.so somewhere (e.g. /home/root/shims/qtfb-shim.so)
4. (Re)build hashtab by running:

xovi/rebuild_hashtable

5. Run xovi by running (you must do this after reboot, you can automate this by writing systemd service):

xovi/start

Installation steps

1. Download the latest release of KOReader
2. Copy the file to your device:

scp koreader-remarkable-aarch64-* [email protected]:

3. Log into your device:

ssh [email protected]

4. Extract the contents of the file:

tar -xf /home/root/koreader-remarkable-aarch64-*

5. Create xovi/exthome/appload/koreader folder and cd into the directory by:

mkdir -p xovi/exthome/appload/koreader
cd xovi/exthome/appload/koreader

6. Create external.manifest.json in the directory and write this into the file:

{
    "name": "KOReader",
    "application": "reader.lua",
    "workingDirectory": "/home/root/koreader",
    "environment": {
      "LD_PRELOAD": "(absolute path of where you put qtfb-shim.so file)",
      "KO_DONT_GRAB_INPUT": "1",
      "QTFB_SHIM_INPUT": "false",
      "QTFB_SHIM_MODEL": "false",
      "QTFB_SHIM_MODE": "RGB565"
    }
}

7. Launch KOReader by opening sidebar, touch "AppLoad", and launch KOReader from the AppLoad menu.