Rime Input Method Engine, the core library
Clone or download
Permalink
Failed to load latest commit information.
cmake Link to iconv library. Feb 11, 2016
data fix(config_compiler): support creating list in-place by __patch and _… Apr 24, 2018
doc doc/Doxygen: use README as main page. Jul 18, 2014
sample shared_ptr => an. Sep 17, 2015
src feat: always_show_comments option (#220) Aug 22, 2018
test fix(config_compiler): support creating list in-place by __patch and _… Apr 24, 2018
thirdparty fix(thirdparty/src/leveldb): do not link to snappy library Mar 18, 2018
tools fix(levers): update deployment tasks for copy-free resource resolution Oct 19, 2017
.gitignore chore(.gitignore): do not ignore package-lock.json Feb 24, 2018
.gitmodules Squashed 'thirdparty/src/opencc/' content from commit a64ea61 Dec 11, 2014
.lvimrc set syntastic compiler options to support c++11 in .lvimrc. Dec 9, 2013
.npmrc chore(tags): adopt semver "X.Y.Z" without prefix [ci skip] Mar 10, 2018
.travis.yml Separate travis-ci scripts. Mar 27, 2016
.ycm_extra_conf.py YouCompleteMe configuration Jul 9, 2014
CHANGELOG.md chore(release): 1.3.2 🎉 Nov 12, 2018
CMakeLists.txt chore(release): 1.3.2 🎉 Nov 12, 2018
LICENSE switch to the (3-Clause) BSD License. Dec 29, 2014
Makefile fix(Makefile): make install-debug; do return error code on mac Sep 28, 2017
Makefile.thirdparty Update Travis CI scripts. Oct 19, 2016
Makefile.xcode fix(Makefile): make install-debug; do return error code on mac Sep 28, 2017
README-mac.md Update README. Feb 11, 2016
README-windows.md feat(build.bat): customize build settings via environment variables (#… Feb 21, 2018
README.md chore(REAME.md): require boost>=1.48, for boost::locale [ci skip] Apr 21, 2018
appveyor.install.bat chore(appveyor_ci): workaround for Windows XP compatibility Feb 13, 2018
appveyor.yml fix(CMakeLists.txt, build.bat): install header files (public API) Feb 23, 2018
build.bat fix(CMakeLists.txt, build.bat): install header files (public API) Feb 23, 2018
bump-version.sh chore(bump-version.sh): npm version script Apr 1, 2018
env.bat.template feat(build.bat): customize build settings via environment variables (#… Feb 21, 2018
package.json chore(release): 1.3.2 🎉 Nov 12, 2018
rime.pc.in refactor(cmake): cmake code style. Mar 30, 2017
travis-before-install.sh fix(ci): call cmake under /usr/local with sudo by passing $PATH envir… Jan 22, 2018
travis-script.sh chore(Makefile): make test; build `rime_test` in release configuration Jan 11, 2017

README.md

RIME: Rime Input Method Engine

Build Status Build status

rimes with your keystrokes.

Project home

rime.im

License

The 3-Clause BSD 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++11 support
  • cmake>=2.8
  • libboost>=1.48
  • libglog (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 install

Frontends

Official:

Third-party:

  • fcitx-rime: Fcitx frontend for Linux
  • iRime: frontend for iOS
  • PIME: frontend for Windows
  • Trime: frontend for Android
  • XIME: frontend for macOS

Plugins

Related works

  • plum: Rime configuration manager and input schema repository
  • Combo Pinyin: an innovative chord-typing practice to input Pinyin
  • essay: the vocabulary and language model for Rime
  • SCU: Squirrel Configuration Utilities

Credits

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

Contributors