Home
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.
- AI-Powered Insights: Supports Google Gemini, OpenAI, DeepSeek, Claude, and Custom API providers (like OpenRouter).
- Character Tracking: View bios and roles. Supports manual or automated Merging Duplicates with AI suggestions and consolidated summaries.
- Glossary & Terminology: Tracks special terms, items, factions, or concepts unique to the book's world (such as magic systems or sci-fi jargon).
- Series Context: Automatically detects books in a series (Book 2+) and fetches a recap of previous books to populate characters, locations, terms, and timeline data.
- 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 inline footnote-style popups or traditional layouts; missing entries can be fetched on-the-fly.
- Unit Conversion: Automatically scans books for measurements (length, weight/mass, temperature, volume, speed, area) and displays metric or imperial conversions in inline tooltips.
- Offline First: You only need internet to fetch the data initially. After that, it's saved locally.
- Multilingual: Works in 17 languages, including English, German, French, Spanish, Brazilian Portuguese, Russian, Ukrainian, Turkish, Simplified Chinese, Dutch, Hungarian, Polish, Indonesian, Arabic, Italian, Serbian, and Japanese.
- Get Started: How to install it and set up your API keys.
- Core Content & Features: A look at Characters, Timeline, Glossary, and Series recap.
- Lookups & Navigation: In-text lookups, footnote popup UI, Gestures, and Mention scanning.
- Data Management & Settings: Merging duplicates, verbosity settings, and language localization.
- AI Providers & Models: Details on supported APIs, models, and reasoning effort.
- Spoiler Protection: How the plugin keeps you safe from spoilers.
- Fetching Data: Guide to initial fetching, background auto-updates, and targeted fetching.
- Advanced Configuration & Maintenance: Custom endpoints, config files, formats, logs, and maintenance tools.
If you run into any issues or have ideas for new features, feel free to open an issue on GitHub.