explaingit

helitra/koreader-remote

Analysis updated 2026-05-18

19LuaAudience · generalComplexity · 2/5Setup · easy

TLDR

A KOReader plugin that turns your phone's browser into a remote control for turning pages and managing notes on your ereader.

Mindmap

mindmap
  root((koreader-remote))
    What it does
      Phone as remote control
      Page turning
      Bookmarks and notes
      Display settings
    Tech stack
      Lua
      KOReader plugin
      Local HTTP API
    Use cases
      Remote page turning
      Note editing on phone
      Light and warmth control
    Audience
      Ereader owners
      KOReader users

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Turn pages on a Kindle or Kobo using your phone as a remote while reading in bed.

USE CASE 2

Browse, search, and edit bookmarks and notes from your phone without touching the ereader.

USE CASE 3

Adjust frontlight brightness, warmth, and night mode remotely from your phone.

What is it built with?

LuaKOReaderHTTP API

How does it compare?

helitra/koreader-remoteshenawy29/xdg-nvfilechooser.nvimmatem6/ultrac0re
Stars191918
LanguageLuaLuaLua
Setup difficultyeasyhardhard
Complexity2/53/55/5
Audiencegeneraldeveloperresearcher

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires the reader and phone on the same local Wi-Fi network with device-to-device traffic allowed, no authentication, so avoid exposing it beyond a trusted network.

See the repository's LICENSE file for exact terms.

In plain English

KOReader Remote is a plugin for KOReader, the open source ebook reading software used on devices like Kindle and Kobo, that turns your phone's web browser into a remote control for your reader. The maker built it because they often set their Kindle down while reading in bed and got tired of reaching for it just to turn a page, so this lets a phone that is already in hand do the job instead. There is no app to install on the phone, no account, and no cloud service involved. Once installed on the reader, you start a small local server from KOReader's menu, then scan a QR code with your phone to open a local web page. From there you can turn pages with large touch controls, use keyboard arrow keys if your phone supports them, browse and search bookmarks and notes, open EPUB footnotes where detected, edit your active note draft, and adjust supported settings like frontlight brightness, warmth, and night mode. It also supports an OLED mode for a pure black interface and can recover the connection automatically after your reader wakes from standby. Setup requires copying the plugin folder into KOReader's plugins directory, either on a Kindle or Kobo, restarting KOReader, and starting the remote server from the Tools menu. Both devices need to be on the same local Wi-Fi network with direct device-to-device communication allowed, which some guest networks block. The plugin includes its own manual update checker with a stable and a dev channel, and it verifies release checksums before replacing itself, keeping the previous version as a backup. The author is explicit that this tool has no authentication: anyone who can reach the reader's local IP address and port can control it and see the open book's notes, so it is meant only for trusted local networks and should never be exposed to the internet.

Copy-paste prompts

Prompt 1
Walk me through installing koreader-remote on my Kindle running KOReader.
Prompt 2
Explain how the QR code pairing between my phone and KOReader Remote works.
Prompt 3
Help me troubleshoot why my phone cannot connect to KOReader Remote after a Wi-Fi change.
Prompt 4
Summarize the security tradeoffs of running koreader-remote on my home network.

Frequently asked questions

What is koreader-remote?

A KOReader plugin that turns your phone's browser into a remote control for turning pages and managing notes on your ereader.

What language is koreader-remote written in?

Mainly Lua. The stack also includes Lua, KOReader, HTTP API.

What license does koreader-remote use?

See the repository's LICENSE file for exact terms.

How hard is koreader-remote to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is koreader-remote for?

Mainly general.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.