Skip to content

2. Core Features

Jump to bottom
Jimmy Pautz edited this page Apr 22, 2026 · 32 revisions

Here's a breakdown of what the plugin can actually do once you've fetched the data for a book.

Characters

This is a list of everyone mentioned in the story.

  • Details: Tap any character's name to read their bio, role, and occupation.
  • Search: Use the search icon to find a specific person quickly.
  • Fetch More: If you notice a minor character is missing, hit "Fetch More Characters". The AI will do another pass just looking for names it missed.

For information on how X-Ray data gets fetched and updated — including the background auto-fetch feature — see the Fetching page.

Timeline

The Timeline gives you a chronological summary of the plot, broken down by chapter. It follows your Spoiler Protection settings, so it won't show you events you haven't read yet if you're using Spoiler-free mode.

Historical Figures & Locations

  • Historical Figures: If you're reading historical fiction or non-fiction, this pulls up real-world info about actual historical people mentioned in the text. This may not be useful or even populate for fiction books.
  • Locations: Gives you a quick description and context for the places the story happens.

Author Info

If you want to know a bit more about the author, go to Menu → X-Ray → Author Info. If it's empty, you can run a quick search to pull their bio and birth/death dates.

Quick In-Text Lookups

You don't have to navigate through the main menu every time you want to check a character's name.

  • Selection Popup: If you long-press a word or name while reading, you'll see an X-Ray button in the dictionary popup. Tap that to instantly search your X-Ray data for that specific text.
  • Highlights: If you long-press an existing highlight, the standard KOReader menu will pop up. There's an X-Ray option added in there too.
  • Keyboard Shortcut: If you happen to be using a device with a keyboard, pressing Alt + X will open the quick menu.

Checking for Updates

The plugin can check for new versions automatically. You can find this under Menu → X-Ray → Maintenance → Check for Updates. It's a quick way to grab the latest improvements without having to manually download files from GitHub.

There's also a weekly silent check that runs automatically when you open a book, so you'll get a notification if something new is available without having to think about it.

Clone this wiki locally