Skip to main content

Installation

You should install the following Dependencies if you want to make use all the power of paw:

  • Command line tools

    • sdcv (external command line dictionary)
    • mpv (or other command line mp3 player)
    • goldendict (external dictionary)
    • silverdict (external web-based dictionary, works on Android)
    • edge-tts (pronunciation)
    • kagome (For Japanese sentence segmentation)
  • python dependencies (install paw command line by pip install emacs-paw or one by one manually):

    • Python itself (3.10+, for mac 3.11+)
    • nltk
    • flask
    • flask-cors
    • requests
    • mecab-python3
    • unidic-lite
    • waitress (optional, for enhanced server performance)
  • Language detection python dependencies:

    • paw (emacs-paw cli), lingua-py, pycld2, or gcld3
  • Emacs packages (Not all are needed, some are optional, but paw just supports them. Some needed packages will be installed along with paw):

    • go-translate (Needed, for online transalation)
    • gptel (Needed, for ai translation)
    • emacsql (Needed)
    • transient (Needed)
    • focus
    • svg-lib
    • anki-eidtor
    • all-the-icons
    • nerd-icons
    • immersive-translate
    • ivy
    • consult
    • posframe
    • jieba
    • eldoc-box
    • evil
    • esxml
    • shrface
    • wallabag
    • eaf
    • popweb
    • pdf-tools
    • elfeed
    • telega
  • Offline Dictionary:

    • stardict dictionaries (Used by sdcv, you can download mine from sdcv_dictionaries)
    • ECDICT (Please go into the page and download the ecdict-stardict-28.zip, unzip as startdict.db)
    • yomichan-jlpt-vocab (Please go into the page, clone the repo, and build the japanese.db by yourself, or download mine in paw_dictionaries)
    • text/csv dictionaries (I uploaded my dictionaries to paw_dictionaries, you can also easily convert the any Anki Deck into csv format and use them. Also, this project also provides some functions to download, check paw-util.el)
  • Other Dictionaries

Five steps:

  • Install Offline Dictionaries (See above)
  • Install Python
brew install python # You can use pyenv or other tools to install python

pip install emacs-paw

Note: The Python CLI tool and server components have been migrated to paw_server for better organization and standalone usage.

  • Please be patient... run the following command lines, you may need to adjust them based on your system, take mac for example:

brew install sdcv
brew install mpv
pip install edge-tts
python -m nltk.downloader stopwords
python -m nltk.downloader punkt
python -m nltk.downloader punkt_tab

  • For android install:

pkg install tur-repo # https://github.com/termux-user-repository/tur
pkg install python3.10 # install python 3.10 (newer versions may not work at the time of writing)

  • Finally, Install paw.el
(package! paw :recipe (:host github :repo "chenyanming/paw" :files ("*")))