explaingit

rime/weasel

7,220C++Audience · generalComplexity · 3/5LicenseSetup · moderate

TLDR

Weasel is the Windows version of the Rime open-source Chinese input method engine, supporting Pinyin, Zhuyin, Cangjie, Wubi, and other schemes with deep customization via config files.

Mindmap

mindmap
  root((Weasel Rime))
    Input schemes
      Pinyin
      Zhuyin and Bopomofo
      Cangjie and Wubi
      Cantonese
    Platform
      Windows 8.1 to 11
      System tray integration
      Config files
    Customization
      Config file editing
      Personal dictionary
      Plum package manager
    Rime family
      macOS Squirrel
      Linux ibus-rime
      Shared engine
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Switch your Windows keyboard to Pinyin, Bopomofo, or Cangjie to type Chinese characters without buying commercial software.

USE CASE 2

Customize key mappings, input schemes, and appearance by editing plain-text configuration files.

USE CASE 3

Sync your personal word dictionary and settings across Rime installations on Windows, macOS, and Linux.

Tech stack

C++Windows

Getting it running

Difficulty · moderate Time to first run · 30min

README is in Traditional Chinese, additional input schemes must be downloaded separately via the plum package manager.

Free to use and modify, but any distributed modifications must also be released as open source under GPLv3.

In plain English

Weasel is the Windows version of Rime, an open-source Chinese input method engine. An input method is the software layer that lets users type Chinese characters on a keyboard, since the writing system has far more characters than a standard keyboard has keys. Rime is designed to be highly customizable and supports multiple input schemes, making it popular among users who want precise control over how they enter text. The software works on Windows 8.1 through Windows 11. After installation, users switch to Weasel through the system input indicator and can press a keyboard shortcut to bring up a menu for switching between different input modes. Configuration files and personal word dictionaries are stored in a folder under the Windows user profile directory. Changes to the configuration take effect after a redeployment step. Rime supports a wide range of Chinese input schemes. Pinyin, which maps romanized syllables to characters, is the most common method used in mainland China. Zhuyin and Bopomofo are phonetic scripts used in Taiwan. Cangjie and Wubi are shape-based methods where keys correspond to structural components of characters. Cantonese, Shanghainese, Hokkien, and Classical Chinese phonetics are also supported. Several of these additional schemes are no longer bundled in the installer by default and must be downloaded separately using a companion package manager called plum. The same Rime engine is available on other platforms. Linux users can use ibus-rime or fcitx5-rime, and macOS users have a companion app called Squirrel. All versions share the same underlying engine and use the same configuration format. The README is written entirely in Traditional Chinese. The project is licensed under GPLv3. Bug reports go to GitHub Issues, and questions about Rime behavior across all platforms go to the central Rime home repository.

Copy-paste prompts

Prompt 1
I just installed Weasel on Windows 11. Walk me through switching the system input method to Weasel and enabling Pinyin input.
Prompt 2
How do I add the Cantonese input scheme to Weasel using the plum package manager? List the exact steps.
Prompt 3
I want to customize the Weasel candidate window appearance, font size, colors, and horizontal vs vertical layout. Which config file do I edit and what are the key settings?
Prompt 4
How do I share my Rime configuration and personal word dictionary between Weasel on Windows and Squirrel on macOS?
Open on GitHub → Explain another repo

← rime on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.