A calibre plugin that generates Word Wise and X-Ray files then sends them to Kindle. Supports KFX, AZW3 and MOBI eBooks.

Languages X-Ray supports: Català, Dansk, Deutsch, English, Español, Français, Italiano, Lietuvių, Nederlands, Norsk bokmål, Polski, Português, Română, Ελληνικά, Македонски, Русский, 中文, 日本語.

X-Ray doesn't support macOS, because macOS prohibits calibre from loading unsigned library.

Please read CONTRIBUTING.

• Install calibre

  • Arch Linux

  # pacman -Syu --needed calibre
  

  • Other Linux distros

  $ sudo -v && wget -nv -O- https://download.calibre-ebook.com/linux-installer.sh | sudo sh /dev/stdin
  

  • macOS: use Homebrew or download from https://calibre-ebook.com/download_osx

  $ brew install calibre
  

  • Windows: install 64bit calibre with Chocolatey or download from https://calibre-ebook.com/download_windows64

  $ choco install calibre
  

• Install Python(pip) for X-Ray

  • Arch Linux

    pip module is included in python.

  • Debian or Ubuntu based distro

  $ sudo apt install python3-pip
  

  • Windows: use Chocolatey or download from https://www.python.org/downloads

  $ choco install python
  

• Install WordDumb:

• Install KFX Input plugin for KFX books(optional).

• Set preferences

  • Enable "search people" option for nonfiction books and novels that have character pages on Wikipedia to add people descriptions in X-Ray.

  • Larger spaCy model has higher NER precision therefore improves X-Ray quality, more details at https://spacy.io/models/en

• Connect Kindle to calibre, select one book or multiple books then click the plugin icon or menu.

• Don't add soft hyphens, it will cause the plugin to produce mediocre Word Wise and X-Ray files.

• This plugin requires access to https://files.pythonhosted.org (download dependencies) and https://raw.githubusercontent.com (download spaCy model) at first run, and https://wikipedia.org every time if X-Ray is enabled. These domains might be blocked in some countries(Censorship of Wikipedia, Censorship of GitHub).

• Display Word Wise in other languages

This work is licensed under GPL version 3 or later.

Icon made by Freepik from www.flaticon.com.