KOReader Z-library Plugin

English | 简体中文

Disclaimer: This plugin is for educational purposes only. Please respect copyright laws and use this plugin responsibly.

Access Z-library seamlessly within your KOReader application. This plugin allows you to browse and download content directly to your e-reader.

If you find this plugin helpful, please consider supporting its development. Your donations help keep the project alive and allow for new features and improvements.

 

Demo

Features

• Search Z-library for books.
• Filter search results by language and file extension.
• Browse most popular and recommended books.
• Download content directly to your device.

Prerequisites

• KOReader installed on your device.
• A Z-library account.

Installation

1. Download the latest release.
2. Copy the plugins/zlibrary.koplugin directory to the koreader/plugins folder on your device.
3. Restart KOReader.

Configuration

There are two ways to configure your Z-library credentials:

1. Via the KOReader User Interface (UI):

1. Ensure you are in the KOReader file browser.
2. Access the "Search" menu.
3. Select "Z-library" (it's probably on the second page of this menu).
4. Select "Settings".
5. Enter your Z-library email, password, and the base URL for your Z-library instance.
   • Tip: If you don't know which base URL to use, select "Auto-discover base URL" and the plugin will automatically try a list of known Z-library servers to find a working one.
6. Adjust other settings if needed.

2. Via a Credentials File (Advanced):

For a more permanent or automated setup, you can create a file named zlibrary_credentials.lua in the root of the zlibrary.koplugin directory (e.g., koreader/plugins/zlibrary.koplugin/zlibrary_credentials.lua).

This file allows you to override the credentials set in the UI. If this file exists and is correctly formatted, the plugin will use the values from this file.

Create the zlibrary_credentials.lua file with the following content, uncommenting and filling in the details you wish to use:

-- This file allows you to override Z-library credentials.
-- Uncomment and fill in the details you want to override.
-- Values set here will take precedence over those set in the plugin's UI.

return {
    -- baseUrl = "https://your.zlibrary.domain",
    -- email = "your_email",
    -- password = "your_password",
    -- userId = "your_remix_userid",
    -- userKey = "your_remix_userkey",
}

Note: Credentials set in the zlibrary_credentials.lua file will always take precedence over those set via the UI. The plugin loads these settings at startup.

Signing in with a session instead of a password: userId and userKey are a ready-made session. Set both (or neither) and the plugin uses them as-is, so it never has to reach a login endpoint — useful when Z-library's sign-in is refusing valid credentials, as it has done more than once. Sign in to Z-library in a browser and copy the remix_userid and remix_userkey cookies into these two fields. No email or password is needed alongside them, and these sessions do not expire.

Setup gesture (optional)

To easily access this plugin, you can set up a gesture to open the search menu:

1. Open the top menu and tap the Cog (⚙️) icon.
2. Navigate to Taps and gestures > Gesture manager.
3. Select your desired gesture in two steps.
4. Under General, find Z-library search on the last page and check the box.

Keyboard Controls

Right / Tab: Cycle through category tabs
Menu: Open search options
Home: Refresh category book list
Back: Close widget

Localization Support

This plugin provides basic multilingual support for more information see l10n/README.MD.

Usage

1. Ensure you are in the KOReader file browser.
2. Access the "Search" menu.
3. Select "Z-library".
4. Select "Search" and enter your search query.
5. Or select "Recommended" or "Most popular" to browse those lists.

Keywords

KOReader, Z-library, e-reader, plugin, ebook, download, KOReader plugin, Z-library integration, digital library, e-ink, bookworm, reading, open source.