Z-Library browser and downloader for reMarkable devices
Installation
- Know how to SSH to your device: https://remarkablewiki.com/tech/ssh
- Make sure package manager toltec is installed.
- Run following command to install zshelf:
opkg update
opkg install zshelf
- [reMarkable 2 only] You definitely need
rm2fb
package to run any app:
opkg install rm2fb
[IMPORTANT] Configure domain and cookie
zshelf
basically is a web crawler, which fetches and parses z-library web pages, gets the gist of them and natively displays book items on UI. Because it's not web browser, user needs to manually configure domain and cookie so zshelf
can download books on demand. Free user account is still limited at downloading 10 books a day.
- Open https://z-lib.org on your web browser
- Under "Books" link, you should notice domain part that is specifically available for your region/country. Note it down.
- Log in with your account.
- In any page, open up Console (hit F12 and switch to tab Console), run:
document.cookie
It will return a string contains your ids. Copy the parts have remix_userkey
and remix_userid
and ignore the rest:
- SSH to your reMarkable device and open config file:
nano /opt/etc/zshelf/config.json
- Replace keys
"domain"
and"cookie"
's values with yours.
- Save file (In
nano
: Ctrl + X -> Y -> Enter) - Start zshelf to test configuration:
zshelf
reMarkable 2 user, use this instead:
LD_PRELOAD=/opt/lib/librm2fb_client.so.1.0.0 zshelf
Downloaded EPUB and PDF books will be automatically available on your reMarkable app (if not, please restart the app or restart device). zshelf
also makes a copy of the book to location configured in additionalBookLocation
, so you can open it in other reader like KOReader
, which has ten fold better reading experience, highly recommended and also available on toltec
.
Also, install an app launcher so that you can open zshelf easier. Recommend oxide
, draft
or remux
, all of them are available on toltec
.
Development
- Set up reMarkable toolchain, NodeJS and
npm
git clone https://github.com/khanhas/zshelf
qmake
make
cd backend
node install
Credits
- Qt-Quick-Keyboard by mireq