{"id":13626029,"url":"https://github.com/khanhas/zshelf","last_synced_at":"2025-04-16T11:31:07.079Z","repository":{"id":45884300,"uuid":"334340353","full_name":"khanhas/zshelf","owner":"khanhas","description":"reMarkable app: Browse and download books from Z-Library","archived":false,"fork":false,"pushed_at":"2021-11-29T23:45:24.000Z","size":4174,"stargazers_count":312,"open_issues_count":8,"forks_count":13,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-11-08T15:46:57.024Z","etag":null,"topics":["embedded-linux","qt","remarkable-tablet","zlibrary"],"latest_commit_sha":null,"homepage":"","language":"QML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/khanhas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-30T05:59:33.000Z","updated_at":"2024-11-07T07:32:14.000Z","dependencies_parsed_at":"2022-09-05T08:11:21.183Z","dependency_job_id":null,"html_url":"https://github.com/khanhas/zshelf","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhas%2Fzshelf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhas%2Fzshelf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhas%2Fzshelf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhas%2Fzshelf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khanhas","download_url":"https://codeload.github.com/khanhas/zshelf/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249235040,"owners_count":21235135,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["embedded-linux","qt","remarkable-tablet","zlibrary"],"created_at":"2024-08-01T21:02:08.144Z","updated_at":"2025-04-16T11:31:06.735Z","avatar_url":"https://github.com/khanhas.png","language":"QML","funding_links":[],"categories":["QML","remarkable-tablet"],"sub_categories":[],"readme":"# ![title](https://gist.githubusercontent.com/khanhas/40999296b19662cdc1f877505c35a934/raw/fdc223e2c557b7be2e5e68e87f93cb3950c8b887/zshelf_title.svg)\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://z-lib.org\"\u003eZ-Library\u003c/a\u003e browser and downloader for \u003ca href=\"https://remarkable.com/\"\u003ereMarkable\u003c/a\u003e devices\n  \u003cbr\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n  \u003cimg src=\"https://i.imgur.com/UbcwJ9L.png\" width=\"300\" title=\"Browse\"\u003e\n  \u003cimg src=\"https://i.imgur.com/CWWoQfk.png\" width=\"300\" title=\"Book metadata\"\u003e\n  \u003cimg src=\"https://i.imgur.com/38oxA3a.png\" width=\"300\" title=\"Search UI\"\u003e\n\u003c/p\u003e\n\n## Installation\n0. Know how to SSH to your device: https://remarkablewiki.com/tech/ssh\n1. Make sure package manager [toltec](https://github.com/toltec-dev/toltec/) is installed.\n2. Run following command to install zshelf:\n```bash\nopkg update\nopkg install zshelf\n```\n3. **[reMarkable 2 only]** You definitely need `rm2fb` package to run any app:\n```bash\nopkg install rm2fb\n```\n\n## [IMPORTANT] Configure domain and cookie\n`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.\n\n1. Open [https://z-lib.org](https://z-lib.org) on your web browser\n2. Under \"Books\" link, you should notice domain part that is specifically available for your region/country. Note it down.  \n\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://i.imgur.com/khlqkaW.png\" width=\"800\"\u003e\u003c/p\u003e\n\n3. Log in with your account.\n4. In any page, open up Console (hit \u003ckbd\u003eF12\u003c/kbd\u003e and switch to tab Console), run:\n```js\ndocument.cookie\n```\nIt will return a string contains your ids. Copy the parts have `remix_userkey` and `remix_userid` and ignore the rest:\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://i.imgur.com/OwkgSTp.png\" width=\"800\"\u003e\u003c/p\u003e\n\n\n5. SSH to your reMarkable device and open config file:\n```bash\nnano /opt/etc/zshelf/config.json\n```\n\n7. Replace keys `\"domain\"` and `\"cookie\"`'s values with yours.\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://i.imgur.com/5dZfQrC.png\" width=\"800\"\u003e\u003c/p\u003e\n\n8. Save file (In `nano`: \u003ckbd\u003eCtrl + X\u003c/kbd\u003e -\u003e \u003ckbd\u003eY\u003c/kbd\u003e -\u003e \u003ckbd\u003eEnter\u003c/kbd\u003e)\n9. Start zshelf to test configuration:\n```bash\nzshelf\n```\n\nreMarkable 2 user, use this instead:\n```bash\nLD_PRELOAD=/opt/lib/librm2fb_client.so.1.0.0 zshelf\n```\n\nDownloaded 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`.\n\nAlso, install an app launcher so that you can open zshelf easier. Recommend `oxide`, `draft` or `remux`, all of them are available on `toltec`.\n\n## Development\n0. [Set up reMarkable toolchain](https://remarkablewiki.com/devel/qt_creator#toolchain), NodeJS and `npm`\n1. `git clone https://github.com/khanhas/zshelf`\n2. `qmake`\n3. `make`\n4. `cd backend`\n5. `node install`\n\n## Credits\n- [Qt-Quick-Keyboard](https://github.com/mireq/Qt-Quick-Keyboard) by mireq\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhanhas%2Fzshelf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhanhas%2Fzshelf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhanhas%2Fzshelf/lists"}