Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khanhas/zshelf
reMarkable app: Browse and download books from Z-Library
https://github.com/khanhas/zshelf
embedded-linux qt remarkable-tablet zlibrary
Last synced: 3 days ago
JSON representation
reMarkable app: Browse and download books from Z-Library
- Host: GitHub
- URL: https://github.com/khanhas/zshelf
- Owner: khanhas
- License: gpl-3.0
- Created: 2021-01-30T05:59:33.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-29T23:45:24.000Z (almost 3 years ago)
- Last Synced: 2024-08-02T22:22:13.899Z (3 months ago)
- Topics: embedded-linux, qt, remarkable-tablet, zlibrary
- Language: QML
- Homepage:
- Size: 3.98 MB
- Stars: 300
- Watchers: 7
- Forks: 11
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - khanhas/zshelf - reMarkable app: Browse and download books from Z-Library (QML)
README
# 
Z-Library browser and downloader for reMarkable devices
## Installation
0. Know how to SSH to your device: https://remarkablewiki.com/tech/ssh
1. Make sure package manager [toltec](https://github.com/toltec-dev/toltec/) is installed.
2. Run following command to install zshelf:
```bash
opkg update
opkg install zshelf
```
3. **[reMarkable 2 only]** You definitely need `rm2fb` package to run any app:
```bash
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.
1. Open [https://z-lib.org](https://z-lib.org) on your web browser
2. Under "Books" link, you should notice domain part that is specifically available for your region/country. Note it down.
3. Log in with your account.
4. In any page, open up Console (hit F12 and switch to tab Console), run:
```js
document.cookie
```
It will return a string contains your ids. Copy the parts have `remix_userkey` and `remix_userid` and ignore the rest:
5. SSH to your reMarkable device and open config file:
```bash
nano /opt/etc/zshelf/config.json
```
7. Replace keys `"domain"` and `"cookie"`'s values with yours.
8. Save file (In `nano`: Ctrl + X -> Y -> Enter)
9. Start zshelf to test configuration:
```bash
zshelf
```
reMarkable 2 user, use this instead:
```bash
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`](https://github.com/koreader/koreader/wiki/Installation-on-Remarkable), 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
0. [Set up reMarkable toolchain](https://remarkablewiki.com/devel/qt_creator#toolchain), NodeJS and `npm`
1. `git clone https://github.com/khanhas/zshelf`
2. `qmake`
3. `make`
4. `cd backend`
5. `node install`
## Credits
- [Qt-Quick-Keyboard](https://github.com/mireq/Qt-Quick-Keyboard) by mireq