explaingit

dhaizon/imagecrop.koplugin

Analysis updated 2026-05-18

0Audience · generalComplexity · 2/5Setup · easy

TLDR

A KOReader plugin that lets you crop any image with two taps and save it as a PNG or pin it to a reading notes list.

Mindmap

mindmap
  root((imagecrop.koplugin))
    Purpose
      Crop Images
      Inside KOReader
    Interaction
      Two Tap Selection
      Pixel Nudge
      Visual Overlay
    Output
      Save As PNG
      Non Destructive
    Integration
      PinnedElements Plugin
      Shared ImageViewer
    Install
      App Store Plugin
      Wi-Fi File Transfer

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

Crop out just a diagram, photo, or panel from an image while reading an ebook or PDF on a Kindle or Kobo running KOReader.

USE CASE 2

Nudge a crop selection pixel by pixel for a precise result on an e-ink screen.

USE CASE 3

Save a cropped image as its own PNG file next to the original for later reference.

USE CASE 4

Send a cropped image straight into a pinned reading-notes list using the companion PinnedElements plugin.

What is it built with?

LuaKOReader

How does it compare?

dhaizon/imagecrop.koplugin0verflowme/alarm-clock0xhassaan/nn-from-scratch
Stars00
LanguageCSSPython
Last pushed2022-10-03
MaintenanceDormant
Setup difficultyeasyeasymoderate
Complexity2/52/54/5
Audiencegeneralvibe coderdeveloper

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

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires KOReader already installed on your e-reader device, such as a Kindle or Kobo.

In plain English

imagecrop.koplugin is a plugin for KOReader, the popular open-source e-reader software used on devices like Kindles and Kobos. It adds a crop tool directly into KOReader's built-in Image Viewer, letting you select a rectangular piece of any image you are looking at and save just that piece as its own picture file. To use it, you open an image inside KOReader, tap a new Crop button that the plugin adds to the viewer, then tap once on the image to set one corner of your selection and tap again to set the opposite corner. A visible black and white bordered rectangle with corner markers shows your selection clearly, even on the black and white e-ink screens these devices use. If you need to adjust the selection precisely, arrow buttons let you nudge the whole rectangle one pixel at a time before you finish. Once you are happy with the selection, you can save it as a PNG image, which the plugin places in the same folder as the original image with a timestamped filename, or in a screenshots folder if the original image has no file path. The original image itself is never changed. There is also a Reset option to clear the current selection and start over, and a Cancel option to leave crop mode entirely. The plugin also works together with a companion plugin called pinnedelements.koplugin, which lets you pin pages, text, and images to a persistent list while reading. If that plugin is installed too, a Pin button becomes available in the crop tool, letting you send a cropped image directly into your pinned items list without saving a separate file first. The two plugins are designed so that both add their own buttons to the Image Viewer without interfering with each other, in whatever order they load. Installation can be done either through an app store plugin for KOReader that automatically downloads and installs it, or by transferring the plugin folder over Wi-Fi to the device's plugins directory using a file browser plugin, then restarting KOReader. The README notes the plugin was built with help from Claude, Anthropic's AI assistant.

Copy-paste prompts

Prompt 1
I'm writing a KOReader plugin that needs to patch the built-in ImageViewer widget to add a new button. Show me how to inject a button into an existing widget's button bar in Lua.
Prompt 2
How do I capture a rectangular region from a screen framebuffer in Lua and save it as a PNG using BlitBuffer?
Prompt 3
Show me a pattern for a two-tap selection tool: first tap sets one corner, second tap sets the opposite corner, and I need to draw a selection rectangle in between.
Prompt 4
How can two independent KOReader plugins both patch the same widget without one overwriting the other's changes?
Prompt 5
I want one plugin to detect whether a second, optional companion plugin is installed and active, using a global flag set on document open. Show me this pattern in Lua.

Frequently asked questions

What is imagecrop.koplugin?

A KOReader plugin that lets you crop any image with two taps and save it as a PNG or pin it to a reading notes list.

How hard is imagecrop.koplugin to set up?

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

Who is imagecrop.koplugin for?

Mainly general.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.