東風破 /plum/: Rime configuration manager and input schema repository
Rime configuration manager and input schema repository
/plum/ is a configuration manager for Rime input method engine.
/// 東風破 是 中州韻輸入法引擎 的配置管理工具。///
It's designed for Rime users to install and update the default configuration and a collection of data packages maintained by Rime Developers.
It also works perfectly well with personal configuration hosted on GitHub and input schema packages from third-party developers.
A Rime input schema (Rime 輸入方案) defines the rules of a specific "input method", or in technical terms how user input sequences are interpreted by the Rime input method engine. It consists of a configuration file named
.schema.yaml, and usually an optional Rime dictionary (韻書) file named
A package may contain one or several interrelated input schemata and their affiliated Rime dictionaries. A package is also good for publishing general configuration files and data files used by Rime.
In /plum/ terms, a re-usable piece of configuration is known as a recipe (配方), denoted by the "℞" symbol.
A data package itself can be a recipe, this is the common case. In the future, /plum/ will support more fine-grained recipes that allow you to select what to install from a package, or even take parameters like the target input schema to customize.
This is an index of the packages maintained by Rime Developers as separate projects.
These packages aim to offer a sensible default configuration for most users, and support various Chinese input methods including those based on modern dialects and historical Chinese phonology.
/// 配方一覽 ///
prelude: 基礎配置 / the prelude package, providing Rime's default settings
essay: 八股文 / a shared vocabulary and language model
Modern Standard Madarin
luna-pinyin: 朙月拼音 / Pinyin input method for Tranditional Chinese
terra-pinyin: 地球拼音 / School-taught Pinyin, with tone marks
bopomofo: 注音 / Zhuyin (aka. Bopomofo)
Derivatives of Pinyin
double-pinyin: 雙拼 / Double Pinyin (ZiRanMa, ABC, flyPY, MSPY, PYJJ variants)
combo-pinyin: 宮保拼音 / Combo Pinyin, a chord-typing input method
stenotype: 打字速記法 / a stenographic system derived from ABC Easy Shorthand
Other modern varieties of Chinese
cantonese: 粵語拼音 / Cantonese
jyutping: 粵拼（無聲調） / Cantonese (without tones)
wugniu: 上海吳語 / Wu (Shanghainese)
soutzoe: 蘇州吳語 / Wu (Suzhounese)
middle-chinese: 中古漢語拼音 / Middle Chinese Romanization
stroke: 五筆畫 / five strokes
cangjie: 倉頡輸入法 / Cangjie input method
quick: 速成 / Simplified Cangjie
emoji: 繪文字 / input emoji with English or Chinese Pinyin keywords
ipa: 國際音標 / International Phonetic Alphabet
curl -fsSL https://git.io/rime-install | bash
/// 用法：Linux、macOS 系統，在終端輸入以上命令行，安裝配置管理器及預設配方。 ///
Paste the command line in Linux terminal or macOS
Terminal.appand hit enter.
The one-liner runs the
rime-installscript to download preset packages and install source files to Rime user directory. (Yet it doesn't enable new schemas for you)
Alternatively, you can specify a configuration among
:all(note the colon):
curl -fsSL https://git.io/rime-install | bash -s -- :preset
This is equivalent to cloning this repo and running the local copy of
git clone --depth 1 https://github.com/rime/plum.git cd plum bash rime-install :preset
You can then add packages from all the great Rime developers on GitHub by specifying a list of package names or refer to packages by
bash rime-install jyutping lotem/rime-zhung acevery/rime-zhengma
optionally, specific a branch by appending "@"
Lastly, it's also possible to install other author's Rime configuration from a
*-packages.conffile hosted on GitHub. For example:
bash rime-install https://github.com/lotem/rime-forge/raw/master/lotem-packages.conf
or in short form: "//"
bash rime-install lotem/rime-forge/lotem-packages.conf
or specify a branch: "/@/"
bash rime-install lotem/[email protected]/lotem-packages.conf
For third-party Rime distributions, specify the
rime_frontendvariable in the command line:
rime_frontend=fcitx-rime bash rime-install
rime_dirto Rime user directory
rime_dir="$HOME/.config/fcitx/rime" bash rime-install
To update /plum/ itself, run
bash rime-install plum
--selectflag as the first argument to
rime-install, then add configurations (
:presetis the default) and/or individual packages to display in the menu.
bash rime-install --select :extra
bash rime-install --select :all lotem/rime-forge/lotem-packages.conf
Screenshot of usage example
To get started on Windows, download the bootstrap bundle, unpack the ZIP archive and run
rime-install-bootstrap.batfor initial setup.
It will fetch the latest installer script
rime-install.batan create a shortcut to it, which can then be copied or moved anywhere for easier access.
/// Windows 用家可以通過 小狼毫 0.11 以上「輸入法設定／獲取更多輸入方案」調用配置管理器。///
/// 或者下載獨立的 啓動工具包。///
You can use the installer script to download and install ZIP packages from GitHub, in a number of ways:
Double-click the shortcut to bring up an interactive package installer, then input package name,
/or GitHub URL for the package.
rime-install.batin the command line. The command takes a list of packages to install as arguments.
rime-install :preset combo-pinyin jyutping wubi
You can find ZIP packages downloaded by the installer script in
%TEMP%folder (can be customized via variable
To manually download ZIP package from a GitHub repository, click the button Clone or download, then Download ZIP.
If Git for Windows is installed in the default location or is available in your
PATH, the script will use git-bash to install or update packages.
Use the following command to install Git for Windows, if you are new to git. In China, it's probably faster to download Git from a local mirror by specifying
(set git_mirror=taobao) && rime-install git
You can set more options in
rime-install-config.batin the same directory as
rime-install.bat, for example:
set git_mirror=taobao set plum_dir=%APPDATA%\plum set rime_dir=%APPDATA%\Rime set use_plum=1
Makefilebuilds and installs Rime data as a software on Unix systems.
For downstream packagers for the package management systems of the OS, it's recommend to create separate packages for the /plum/ configuration manager (possibly named
rime-install) and the data package(s) (possibly named
rime-data-*if separated into many) created by the make targets.
The default make target uses
gitcommand to download the latest packages from GitHub.
make sudo make install
You can optionally build the by default enabled input schemas to binaries. This saves user's time building those files on first startup.
Code in the
rime/plumrepository is licensed under LGPLv3. Please refer to the
LICENSEfile in the project root directory.
Note that make targets provided by the
Makefilemay include files downloaded by the configuration manager. Individual packages can be released under different licenses. Please refer to their respective
LICENSEfiles. The license compatible with all the maintained packages is GPLv3.
We are grateful to the makers of the following open source projects:
Also to the inventors of the following input methods:
This software is a result of collective effort. It was set up by the following people by contributing files, patches and pull-requests. See also the contributors page for a list of open-source collaborators.