explaingit

mintimate/oh-my-rime

4,617LuaAudience · generalComplexity · 2/5Setup · moderate

TLDR

A ready-to-use configuration package for the Rime Chinese input method engine that gives you a polished multi-schema Chinese typing experience on Windows, macOS, and Linux without having to configure anything from scratch.

Mindmap

mindmap
  root((oh-my-rime))
    What it does
      Rime configuration
      Chinese input setup
      Ready to use
    Input Schemas
      Mint Pinyin
      Double Pinyin
      Wubi strokes
      Nine grid iOS
    Key Features
      Large dictionaries
      Visual themes
      GitHub auto-update
    Supported Platforms
      Windows Weasel
      macOS Squirrel
      Linux IBus
    Audience
      Chinese typists
      Rime users
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

Replace a bare Rime installation with a fully configured Chinese input experience by copying in the config files and redeploying

USE CASE 2

Switch between Pinyin, double-pinyin, Wubi, and nine-grid input schemas with a single keyboard shortcut

USE CASE 3

Apply a pre-built visual theme to your Chinese input method or create your own using the override file approach

USE CASE 4

Use large built-in dictionaries like Wanxiang and Frost that auto-update via GitHub Actions for better word prediction

Tech stack

LuaRimeGitHub Actions

Getting it running

Difficulty · moderate Time to first run · 30min

Requires Rime (Squirrel on macOS, Weasel on Windows, or IBus/Fcitx5 on Linux) to be installed first, documentation is primarily written in Chinese.

License type is not specified in the explanation.

In plain English

Oh-my-rime is a ready-to-use configuration package for Rime, an open-source input method engine used to type Chinese characters on computers and phones. Rime itself is a powerful but largely unconfigured framework: it works on Windows (as Weasel), macOS (as Squirrel), and Linux (as IBus or Fcitx5), but setting it up well takes time. This project provides a complete starting configuration so users can get a polished Chinese input experience by copying in the files and redeploying Rime, without building the settings from scratch. The README is written primarily in Chinese. The package includes several different input method schemas that users can switch between. The default is Mint Pinyin full-pinyin input, which suits the broadest range of Chinese typists. Other included options are a Xiahe double-pinyin variant (a more compact pinyin system), a mixed input mode combining full pinyin with double-pinyin, an Earth Pinyin variant with a larger vocabulary, and two Wubi stroke-based input methods (the 98 and 86 versions). A nine-grid layout for iOS users is also included. After installation, pressing Ctrl and tilde together lets users cycle through the available schemas. Word dictionaries are a major part of what makes a Chinese input method useful. Oh-my-rime bundles several large dictionaries including the Wanxiang dictionary (used as the primary pinyin dictionary since July 2025), the Rime Ice dictionary for correction assistance, and the Frost dictionary for English words. Most of these are automatically refreshed by GitHub Actions so the word lists stay current without manual updates. Users can also add their own custom vocabulary file alongside the provided ones. Two visual themes come pre-installed: a duckling series and a green pudding series. Users can switch themes through the Squirrel (Mac) or Weasel (Windows) configuration files, or create their own color scheme using an override file approach the documentation recommends. The project links to video tutorials on Bilibili and YouTube, and to written guides covering installation, configuration overrides, and connecting a language model for sentence completion.

Copy-paste prompts

Prompt 1
Walk me through installing oh-my-rime to configure Rime for Chinese Pinyin input on macOS (Squirrel)
Prompt 2
How do I switch between the Mint Pinyin and Xiahe double-pinyin schemas in oh-my-rime using the keyboard shortcut?
Prompt 3
Show me how to add my own custom vocabulary to oh-my-rime without overwriting the built-in dictionaries
Prompt 4
How do I change the visual theme in oh-my-rime on Windows (Weasel) from the default to the green pudding series?
Prompt 5
How do I enable the language model sentence completion feature in oh-my-rime?
Open on GitHub → Explain another repo

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

Verify against the repo before relying on details.