Note: This is a fork of the original plugin by 0zd3m1r/koreader-xray-plugin.
This plugin brings Kindle-style X-Ray features to KOReader. It uses AI to track characters, build plot timelines, and provide insights while you read.
- AI-Powered Insights: Uses Google Gemini or OpenAI ChatGPT to scan your books and generate descriptions, summaries, and more.
- Character Tracking: View bios and roles so you never forget who someone is. Includes a Character Disambiguation Picker for ambiguous names.
- Plot Timeline: Keeps track of major events chapter by chapter, strictly sorted by physical page location for accuracy.
- Historical Context: Pulls real-world info for historical figures and locations.
- Mention Scanning: Find every occurrence of a character or location throughout the book, complete with page numbers and context snippets for quick navigation.
- Spoiler Protection: "Spoiler-free" mode only reads up to your current page so future twists aren't ruined.
- Auto Fetching while you read: Automatically fetches data in the background when you get to a new chapter.
- X-Ray Mode & Inline Fetching: Get instant lookups by tapping the "X-Ray" button in dictionary or selection popups. If an entity is missing, the plugin can fetch it on-the-fly using AI without requiring a full book scan.
- Silent Weekly Updates: Automatically checks for new plugin versions in the background once a week.
- Offline First: You only need internet to fetch the data. After that, it's saved locally.
- Multilingual: Available in English, German, French, Spanish, Brazilian Portuguese, Russian, Ukrainian, Turkish, and Simplified Chinese.
For full setup instructions and a deep dive into features, check out the GitHub Wiki.
- Get Started: Installation and API key setup.
- Core Features: Characters, Timeline, and Lookups.
- Fetching: Manual and automatic background fetching.
- AI Providers: Using Gemini vs ChatGPT.
- Spoiler Protection: How we keep the story safe.
- Advanced Usage: Gestures, lookups, and manual config.