【東風破】Rime Schema Repository
Shell Makefile

README.md

La brise: 東風破

Rime schema repository

Project home

rime.im

License

GPLv3

Individual packages in this collection can be released under different licenses. Please refer to their respective LICENSE files.

Contents

This software is a collection of data packages used by Rime to support various Chinese input methods, including those based on modern dialects or historical diasystems of the Chinese language.

A Rime input schema describes the behaviors of a specific input method in Rime's DSL. It consists of a configuration file named *.schema.yaml where * is schema ID, and an optional Rime dictionary file named *.dict.yaml.

A package may contain one or several interrelated input schemata and their affiliated Rime dictionaries.

Packages

Essentials

  • prelude: the prelude package, providing Rime's default settings
  • essay: 八股文 / a shared vocabulary and language model

Phonetic-based input methods

Modern Standard Madarin

  • luna-pinyin: 朙月拼音 / Pinyin in Tranditional Chinese
  • terra-pinyin: 地球拼音 / School-taught Pinyin, with tone marks
  • bopomofo: 注音 / Zhuyin (aka. Bopomofo)
  • pinyin-simp: 袖珍簡化字拼音 / Pinyin in Simplified Chinese

Derivatives of Pinyin

  • double-pinyin: 雙拼 / Double Pinyin (ZiRanMa, ABC, flyPY, MSPY, PYJJ variants)
  • combo-pinyin: 宮保拼音 / Chord-typing Pinyin
  • stenotype: 打字速記法 / a stenographic system derived from ABC Easy Shorthand

Other modern varieties of Chinese

  • jyutping: 粵拼 / Cantonese
  • wugniu: 上海吳語 / Wu (Shanghainese)
  • soutzoe: 蘇州吳語 / Wu (Suzhounese)

Middle Chinese

Shape-based input methods

  • stroke: 五筆畫 / five strokes
  • cangjie: 倉頡輸入法 / Cangjie input method
  • quick: 速成 / Simplified Cangjie
  • wubi: 五筆字型
  • array: 行列輸入法
  • scj: 快速倉頡

Miscelaneous

  • emoji: 繪文字 / input emoji with English or Chinese Pinyin keywords
  • ipa: 國際音標 / International Phonetic Alphabet

Usage

To prepare your Rime configuration for Squirrel, Weasel or ibus-rime, you can get started by running

curl -fsSL https://git.io/v13uY | bash

Or to get the "preset" configuration (note the colon):

curl -fsSL https://git.io/v13uY | bash -s -- :preset

This is equivalent to cloning this repo and running rime-install:

git clone --depth 1 https://github.com/rime/brise.git
cd brise
bash rime-install :preset

You can then add packages, many of them, from great Rime developers on GitHub:

bash rime-install middle-chinese lotem/rime-zhung acevery/rime-zhengma

For other Rime distributions, specify the path to Rime user directory in the command line:

rime_dir=$HOME/.config/fcitx/rime bash rime-install

To update la brise itself, run

bash rime-install update

Install

The Makefile builds and installs Rime data as a binary package on Unix systems.

Build dependencies

  • git
  • librime>=1.3 (for rime_deployer)

Run-time dependencies

  • librime>=1.3
  • opencc>=1.0.2

Build and install

The make target all uses git command line to download the latest packages from GitHub.

make
sudo make install

You can optionally build YAML files to binaries by setting the shell variable BRISE_BUILD_BINARIES. To build preset packages, do

BRISE_BUILD_BINARIES=yes make preset

Credits

We are grateful to the makers of the following open source projects:

Also to the inventors of the following input methods:

  • Cangjie / 倉頡輸入法 by 朱邦復
  • Array input method / 行列輸入法 by 廖明德
  • Wubi / 五筆字型 by 王永民
  • Scj / 快速倉頡 by 麥志洪
  • Middle Chinese Romanization / 中古漢語拼音 by 古韻

Contributors

The repository 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.

Contributing

Pull requests are welcome for established, open-source input methods that haven't been included in the repository. Thank you! But you'll be responsible for providing source files along with an open-source license because licensing will be rigidly scrutinized by downstream packagers.