RIME: Rime Input Method Engine
Rime with your keystrokes.
Project home
License
Features
- A modular, extensible input method engine in cross-platform C++ code, built on top of open-source technologies
- Covering features found in a large variety of Chinese input methods, either shape-based or phonetic-based
- Built with native support for Traditional Chinese, conversion to Simplified Chinese and other regional standards via OpenCC
- Rime input schema, a DSL in YAML syntax for fast trying out innovative ideas of input method design
- Spelling Algebra, a mechanism to create variant spelling, especially useful for Chinese dialects
- Support for chord-typing with a generic Qwerty keyboard
Install
Follow the instructions to build librime on platforms other than Linux:
Build dependencies
- compiler with C++17 support
- cmake>=3.12
- libboost>=1.74
- libglog>=0.7 (optional)
- libleveldb
- libmarisa
- libopencc>=1.0.2
- libyaml-cpp>=0.5
- libgtest (optional)
Runtime dependencies
- libboost
- libglog (optional)
- libleveldb
- libmarisa
- libopencc
- libyaml-cpp
Build and install librime on Linux
make
sudo make installFrontends
Official:
Community:
- emacs-rime: frontend for Emacs
- coc-rime: frontend for Vim
- rime.nvim: frontend for Vim
- fcitx5.nvim: Fcitx5 frontend for Vim
- fcitx5-ui.nvim: Fcitx5 frontend for Vim
- zsh-rime: frontend for Zsh
- pyrime: frontend for Ptpython
- fcitx-rime: Fcitx frontend for Linux
- fcitx5-rime: Fcitx5 frontend for Linux
- fcitx5-macos: Fcitx5 frontend for macOS
- XIME: frontend for macOS
- PIME: frontend for Windows
- rabbit: frontend for Windows
- Trime: frontend for Android
- fcitx5-android: frontend for Android
- Hamster: frontend for iOS
- My RIME: frontend for web
Plugins
- librime-charcode (Deprecated) Module that deals with character encoding; depends on boost::locale and ICU libraries
- librime-legacy (Deprecated) Legacy module with GPL-licensed code
- librime-lua Lua scripting
- librime-octagram Language model
- librime-predict Predict next word
- librime-proto IPC using CapnProto
Related works
- plum: Rime configuration (recipe) installer
- combo-pinyin: an innovative chord-typing practice to input Pinyin
- rime-essay: the preset vocabulary
- SCU: Squirrel Configuration Utilities
Credits
We are grateful to the makers of the following open source libraries:
- Boost C++ Libraries (Boost Software License)
- google-glog (The 3-Clause BSD License)
- Google Test (The 3-Clause BSD License)
- LevelDB (The 3-Clause BSD License)
- marisa-trie (BSD 2-Clause License, LGPL 2.1)
- OpenCC (Apache License 2.0)
- yaml-cpp (MIT License)