librime-plugin-predict for Debian
=================================

This plugin suggests the next word after a candidate is committed. It
does nothing on its own: it needs a prediction database and has to be
enabled in each input schema.

1. Prediction database

   The plugin looks up the file named by the "predictor/db" schema option
   (default: predict.db), first in the Rime user data directory and then
   in /usr/share/rime-data. Debian does not ship a database yet. Upstream
   provides a prebuilt one:

     https://github.com/rime/librime-predict/releases/tag/data-1.0

   The upstream release also provides the source text predict.txt; the
   database can be rebuilt from it with rime_build_predict (librime-bin):

     rime_build_predict predict.db < predict.txt

   Put predict.db into your Rime user data directory, for example
   ~/.local/share/fcitx5/rime/ (fcitx5-rime) or ~/.config/ibus/rime/
   (ibus-rime).

2. Enabling prediction in a schema

   Create <schema_id>.custom.yaml in the Rime user data directory, e.g.
   luna_pinyin.custom.yaml:

     patch:
       'engine/processors/@before 0': predictor
       'engine/translators/@before 0': predict_translator
       'switches/+':
         - name: prediction
           states: [ 關閉預測, 開啓預測 ]
           reset: 1
       predictor:
         db: predict.db
         max_candidates: 5
         max_iterations: 1

   Then redeploy Rime from your input method frontend.

 -- Boyuan Yang <byang@debian.org>, Wed, 30 Sep 2026