Skip to content

ultimatejimmy/xray.koplugin

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

411 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

X-Ray Plugin for KOReader

Platform License Status liberapay

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.

What it does

  • AI-Powered Insights: Supports Google Gemini, OpenAI, DeepSeek, Claude, and Custom API providers (like OpenRouter).
  • Character Tracking: View bios and roles. Now supports Merging Duplicates with AI-consolidated summaries.
  • Customizable Detail: Choose between short or long AI descriptions to fit your preference.
  • Linked Entries: Automatically connect related characters and locations through smart cross-referencing.
  • 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, Simplified Chinese, Dutch, Hungarian, Polish, Indonesian, Arabic, Italian, Serbian, and Japanese.

Documentation

For full setup instructions and a deep dive into features, check out the GitHub Wiki.

Support me

liberapay

Buy me a coffee

About

Character tracking, timeline, historical context, unit conversion, etc.

Topics

Resources

License

Stars

123 stars

Watchers

3 watching

Forks

Packages

 
 
 

Contributors

Languages

  • Lua 95.8%
  • Python 3.8%
  • Other 0.4%