A calibre plugin that generates Kindle Word Wise and X-Ray files and EPUB footnotes then send them to e-reader. Supports KFX, AZW3, AZW, MOBI and EPUB eBooks.

Supported languages: Bokmål, Català, Dansk, Deutsch, English, Español, Français, Hrvatski, Italiano, Lietuvių, Nederlands, Polski, Português, Română, Suomi, Svenska, Ελληνικά, Македонски, Русский, Українська, 中文, 日本語, 한국어.

Test plugin will be uploaded to GitHub Actions Artifacts at each git push automatically.

Please read CONTRIBUTING.

• Install calibre 6

  • Arch Linux

  $ sudo 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: use Chocolatey or download from https://calibre-ebook.com/download_windows64

  # choco install calibre
  

• Install 64bit Python and pip

  • Arch Linux

  $ sudo pacman -Syu --needed python-pip
  

  • Debian

  $ sudo apt install python3-pip
  

  • macOS

  $ brew install python
  
  // or install Command Line Tools, not recommended
  $ xcode-select --install
  

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

  # choco install python
  

• Install WordDumb:

• Install KFX Input plugin for KFX books(optional if you don't use this format). The installation steps are similar to the above video.

• Set preferences

  • Click "Preferred format order" button then drag your preferred format to the top.

  • Customize Word Wise requires Kindle or Android(use adb) device connected for the first time use. Lemmas have difficulty of 5 will only display when the Word Wise slider on the far right.

  • Enable "Fetch X-Ray people descriptions from Wikipedia or Fandom" option for nonfiction books and novels that have character pages on Wikipedia or Fandom. A quote from the book will be used if it's disabled or the page is not found.

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

  • Enter a Fandom link to get X-Ray descriptions from Fandom, delete the link to search Wikipedia.

  • Enable "Add locator map to EPUB footnotes" if your e-reader supports image in footnotes.

• Customize X-Ray

  Add X-Ray entities that can't be recognized by spaCy model to improve NER accuracy for each selected book. It can also be used to remove entities by checking the "Omit" checkbox.

• Import Word Wise from Anki Deck Package, CSV file or Kindle Vocabulary Builder

  Words inside the imported file will be enabled.

  • Select the "Include scheduling information" option when exporting the .apkg file from Anki so the card schedule state can be used as Word Wise difficulty.

  • The CSV file should have at least one column of words and an optional column of difficulty value.

  • Kindle Vocabulary Builder database path: system/vocabulary/vocab.db

• Connect your e-reader, select one book or multiple books then click the plugin icon or menu. You can also run the plugin in terminal:

  $ calibre-debug -r WordDumb -- -h
  

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

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

• Display Word Wise in other languages

• For Android users:

  Currently, only KFX is supported.

  • Install Android platform tools

    • Arch Linux

    $ sudo pacman -Syu --needed android-tools
    

    • Debian

    $ sudo apt install android-tools-adb
    

    • macOS

    $ brew install android-platform-tools
    

    • Windows: Download from https://developer.android.com/studio/releases/platform-tools

  • Enable USB debugging, and Rooted debugging(only send Word Wise file requires this option). For more information, please read Android Debug Bridge user guide. Rooted debugging is only available on userdebug and eng build variant ROMs, some custom ROMs like LineageOS have this option.

  • Allow USB debugging

  • Disable USB debugging when the job is done

This work is licensed under GPL version 3 or later.

Icon made by Freepik from www.flaticon.com.