Skip to content
Jimmy Pautz edited this page May 12, 2026 · 26 revisions

KOReader X-Ray Plugin

This plugin brings Kindle-style X-Ray features to KOReader. It uses AI to track characters, build plot timelines, and provide historical context while you read.

Main Menu

What it does

  • AI-Powered Insights: Supports Google Gemini, OpenAI, DeepSeek, Claude, and Custom API providers (like OpenRouter).
  • Character Tracking: View bios and roles. Supports Merging Duplicates with AI-consolidated summaries.
  • Customizable Detail: Choose between short or long AI descriptions.
  • Linked Entries: Automatically connect related characters and locations through smart cross-referencing.
  • Plot Timeline: Keeps track of major events chapter by chapter.
  • Historical Context: Pulls real-world info for historical figures and locations.
  • Mention Scanning: Find every occurrence of a character or location throughout the book for quick navigation, complete with page numbers and context snippets.
  • Spoiler Protection: "Spoiler-free" mode only reads up to your current page so future twists aren't ruined.
  • Auto Fetching: Automatically fetches data in the background when you get to a new chapter.
  • X-Ray Mode & Inline Fetching: Get instant lookups via dictionary popups; missing entries can be fetched on-the-fly.
  • Offline First: You only need internet to fetch the data initially. After that, it's saved locally.
  • Multilingual: Works in 9 languages, including English, German, French, Spanish, Brazilian Portuguese, Russian, Ukrainian, Turkish, and Simplified Chinese.

Navigation

  • Get Started: How to install it and set up your API keys.
  • Core Features: A deeper look at Characters, Timeline, and other tools.
  • Fetching: How data gets into the plugin — manual fetch, merge updates, auto-fetching, and targeted inline fetching.
  • AI Providers & Models: Details on using Gemini vs ChatGPT.
  • Spoiler Protection: How the plugin keeps you safe from spoilers.
  • Advanced Usage: Gestures, text selection lookups, and editing config files.

If you run into any issues or have ideas for new features, feel free to open an issue on GitHub.

Clone this wiki locally