Rime Workflow
How To Use This Skill
Use this as the first Rime skill. It should answer “where in Rime does this problem live?” and then route to a narrower skill.
| Task |
Next Skill |
| Create or restructure an input schema |
rime-schema |
| Inspect processors, segmentors, translators, filters, tags, or component order |
rime-gears |
Edit speller/algebra, preedit_format, or comment_format |
rime-spelling-algebra |
Write or debug lua_processor, lua_segmentor, lua_translator, or lua_filter |
rime-lua |
| Install, update, or package schemes with plum |
rime-plum |
| Configure Windows Weasel UI, app options, fonts, or colors |
rime-weasel |
For logs, platform paths, common troubleshooting checks, or sync setup, load operations.
First Checks
Before proposing a fix, identify:
- the OS and Rime frontend, such as Weasel, Squirrel, iBus Rime, fcitx5-rime, other unofficial frontends;
- whether the relevant file is in the user data directory, shared data directory, or deployed
build/ output;
- whether the change belongs in
<name>.custom.yaml instead of an upstream/default file;
- whether the user redeployed after changing YAML, dictionaries, Lua files, or OpenCC data;
- whether logs contain relevant
ERROR or WARNING lines.
Engine Flow
Rime handles input in this order:
processors receive each key event in order and return accepted, rejected, or noop.- If a processor changes
context.input, Rime rebuilds the composition.
segmentors split context.input into segments and attach tags.translators query tagged segments and lazily produce candidates.- Candidates from translations are merged by quality.
filters transform, annotate, remove, reorder, or deduplicate candidates.
If the problem is at a specific component, route to rime-gears.
Data Directories
Every Rime installation has:
| Directory |
Role |
| Shared data directory |
read-only defaults: bundled schemas, dictionaries, OpenCC data, frontend defaults |
| User data directory |
user schemas, default.yaml, *.custom.yaml, dictionaries, Lua scripts, user data |
User build/ directory |
deployed output after __patch / __include expansion and dictionary compilation |
Debug deployed behavior against files under build/, not only source YAML.
Schema Basics
A custom schema normally needs:
<schema_id>.schema.yaml<dict_name>.dict.yaml, unless it uses only echo_translator or other non-dictionary translators- an entry in
default.yaml:
schema_list:
- {schema: luna_pinyin}
- {schema: my_schema}
For schema structure, translator choices, dictionary format, and complete examples, use rime-schema.
Patching Rules
Prefer user patches over editing shared/default files directly.
Rime YAML supports __include and __patch. A schema without an explicit __patch implicitly includes:
__patch:
__include: <schema_id>.custom:/patch?
So user overrides usually go in <schema_id>.custom.yaml:
patch:
translator/enable_user_dict: false
menu/page_size: 9
Patch path reminders:
key/path: value overwrites a node.key/path/+: value appends to a list or merges into a map.- Source and target types must match: list with list, map with map, scalar with scalar.
Redeploy Checklist
After changes, redeploy and check:
- YAML parses without indentation or quoting errors.
- schema appears in the enabled scheme list.
translator/dictionary matches the dictionary name.- dictionary compilation produced expected
*.table.bin / *.prism.bin.
- custom patches appear in
build/<schema_id>.schema.yaml.
- relevant logs contain no new
ERROR or WARNING lines.
1---2name: rime-workflow3description: Start here for Rime configuration, schema, dictionary, deployment, debugging, or sync tasks. Provides the core engine flow, directory model, patching rules, redeploy checklist, and routing to specialized Rime skills. Load references/operations.md only for log locations, troubleshooting commands, or sync setup details.4---56# Rime Workflow78## How To Use This Skill910Use this as the first Rime skill. It should answer “where in Rime does this problem live?” and then route to a narrower skill.1112| Task | Next Skill |13|------|------------|14| Create or restructure an input schema | `rime-schema` |15| Inspect processors, segmentors, translators, filters, tags, or component order | `rime-gears` |16| Edit `speller/algebra`, `preedit_format`, or `comment_format` | `rime-spelling-algebra` |17| Write or debug `lua_processor`, `lua_segmentor`, `lua_translator`, or `lua_filter` | `rime-lua` |18| Install, update, or package schemes with plum | `rime-plum` |19| Configure Windows Weasel UI, app options, fonts, or colors | `rime-weasel` |2021For logs, platform paths, common troubleshooting checks, or sync setup, load [operations](references/operations.md).2223## First Checks2425Before proposing a fix, identify:26271. the OS and Rime frontend, such as Weasel, Squirrel, iBus Rime, fcitx5-rime, other unofficial frontends;282. whether the relevant file is in the user data directory, shared data directory, or deployed `build/` output;293. whether the change belongs in `<name>.custom.yaml` instead of an upstream/default file;304. whether the user redeployed after changing YAML, dictionaries, Lua files, or OpenCC data;315. whether logs contain relevant `ERROR` or `WARNING` lines.3233## Engine Flow3435Rime handles input in this order:36371. `processors` receive each key event in order and return accepted, rejected, or noop.382. If a processor changes `context.input`, Rime rebuilds the composition.393. `segmentors` split `context.input` into segments and attach tags.404. `translators` query tagged segments and lazily produce candidates.415. Candidates from translations are merged by quality.426. `filters` transform, annotate, remove, reorder, or deduplicate candidates.4344If the problem is at a specific component, route to `rime-gears`.4546## Data Directories4748Every Rime installation has:4950| Directory | Role |51|-----------|------|52| Shared data directory | read-only defaults: bundled schemas, dictionaries, OpenCC data, frontend defaults |53| User data directory | user schemas, `default.yaml`, `*.custom.yaml`, dictionaries, Lua scripts, user data |54| User `build/` directory | deployed output after `__patch` / `__include` expansion and dictionary compilation |5556Debug deployed behavior against files under `build/`, not only source YAML.5758## Schema Basics5960A custom schema normally needs:61621. `<schema_id>.schema.yaml`632. `<dict_name>.dict.yaml`, unless it uses only `echo_translator` or other non-dictionary translators643. an entry in `default.yaml`:6566```yaml67schema_list:68 - {schema: luna_pinyin}69 - {schema: my_schema}70```7172For schema structure, translator choices, dictionary format, and complete examples, use `rime-schema`.7374## Patching Rules7576Prefer user patches over editing shared/default files directly.7778Rime YAML supports `__include` and `__patch`. A schema without an explicit `__patch` implicitly includes:7980```yaml81__patch:82 __include: <schema_id>.custom:/patch?83```8485So user overrides usually go in `<schema_id>.custom.yaml`:8687```yaml88patch:89 translator/enable_user_dict: false90 menu/page_size: 991```9293Patch path reminders:9495- `key/path: value` overwrites a node.96- `key/path/+: value` appends to a list or merges into a map.97- Source and target types must match: list with list, map with map, scalar with scalar.9899## Redeploy Checklist100101After changes, redeploy and check:1021031. YAML parses without indentation or quoting errors.1042. schema appears in the enabled scheme list.1053. `translator/dictionary` matches the dictionary `name`.1064. dictionary compilation produced expected `*.table.bin` / `*.prism.bin`.1075. custom patches appear in `build/<schema_id>.schema.yaml`.1086. relevant logs contain no new `ERROR` or `WARNING` lines.
rimeinn