Skip to content

Repository files navigation

rime-nom-viet

RIME input schema for Vietnamese Chữ Nôm (喃字).

Type Vietnamese using Telex to input Nôm characters.

Features

  • 100,000+ entries - One of the most comprehensive Nôm dictionaries
  • 46,000 compound words - Multi-syllable phrases like "việt nam" → 越南
  • Telex input - Type nguowfi to get 𠊛 (người)
  • Vietnamese preview - Shows "người" instead of "nguowfi" while typing
  • Frequency ranking - Common characters appear first

Telex Input Guide

Type Get Example
aa â aan → ân
aw ă awn → ăn
ee ê ees → ế
oo ô oof → ồ
ow ơ owf → ờ
uw ư uws → ứ
dd đ ddi → đi

Tones:

Key Tone Example
s sắc (á) as → á
f huyền (à) af → à
r hỏi (ả) ar → ả
x ngã (ã) ax → ã
j nặng (ạ) aj → ạ

Installation

macOS (Squirrel 鼠鬚管)

Step 1: Install Squirrel

brew install --cask squirrel

Or download from: https://github.com/rime/squirrel/releases

Step 2: Install nom_viet

Option A: One-line installer (recommended)

curl -fsSL https://github.com/nomnaviet/rime-nom-viet/raw/main/install.sh | bash

Option B: Manual download

  1. Download these 2 files:
  2. Copy both to ~/Library/Rime/

Step 3: Add to schema list

Create/edit ~/Library/Rime/default.custom.yaml:

patch:
  schema_list:
    - schema: nom_viet
    - schema: luna_pinyin

Step 4: Deploy

  • Click Squirrel icon in menu bar → Deploy (重新部署)
  • Or run: /Library/Input\ Methods/Squirrel.app/Contents/MacOS/Squirrel --reload

Step 5: Select schema

  • Press Ctrl+`` or F4` to switch to "Nôm Việt 喃越"

Windows (Weasel 小狼毫)

Step 1: Install Weasel

Step 2: Install nom_viet

Option A: One-click installer (recommended)

  1. Download install.cmd
  2. Double-click to run

Option B: Manual download

  1. Download these 2 files:
  2. Copy both to %APPDATA%\Rime\

Tip: Type %APPDATA%\Rime in File Explorer address bar to open the folder.

Step 3: Add to schema list

Create/edit %APPDATA%\Rime\default.custom.yaml:

patch:
  schema_list:
    - schema: nom_viet
    - schema: luna_pinyin

Step 4: Deploy

  • Right-click Weasel icon in system tray → 重新部署 (Deploy)

Step 5: Select schema

  • Press Ctrl+`` or F4` to switch to "Nôm Việt 喃越"

Linux (ibus-rime / fcitx5-rime)

Step 1: Install ibus-rime or fcitx5-rime

# Ubuntu/Debian
sudo apt install ibus-rime
# or
sudo apt install fcitx5-rime

# Arch
sudo pacman -S ibus-rime
# or
sudo pacman -S fcitx5-rime

Step 2: Install nom_viet

Option A: One-line installer (recommended)

curl -fsSL https://github.com/nomnaviet/rime-nom-viet/raw/main/install.sh | bash

Option B: Manual download

# For ibus-rime
cd ~/.config/ibus/rime

# For fcitx5-rime
cd ~/.local/share/fcitx5/rime

# Download files
curl -LO https://github.com/nomnaviet/rime-nom-viet/raw/main/nom_viet.schema.yaml
curl -LO https://github.com/nomnaviet/rime-nom-viet/raw/main/nom_viet.dict.yaml

Step 3: Add to schema list

Edit default.custom.yaml in the same directory:

patch:
  schema_list:
    - schema: nom_viet
    - schema: luna_pinyin

Step 4: Deploy

  • ibus: Right-click icon → Deploy
  • fcitx5: Right-click icon → Restart

Android (Trime 同文輸入法)

  1. Install Trime from GitHub releases
  2. Download nom_viet.schema.yaml and nom_viet.dict.yaml
  3. Copy to /sdcard/rime/ using file manager
  4. Open Trime → Settings → Deploy
  5. Select "Nôm Việt" in schema list

iOS (iRime)

  1. Install iRime from App Store
  2. Download the schema files
  3. Transfer via iCloud Drive or WebDAV (built into iRime)
  4. Deploy in app settings
  5. Select "Nôm Việt" schema

Usage Examples

Input Vietnamese Output
nguowfi người 𠊛
vieetj nam việt nam 越南
awn cowm ăn cơm 咹𩚵
tooi tôi
ddij đi 𨅸

Data Source

Dictionary data from Nôm Na Việt — a comprehensive Vietnamese Hán-Nôm dictionary platform.

Maintenance

The dictionary is partly auto-generated from the upstream Nôm Na Việt database. Entries between the markers # >>> NOM-NA-VIET-AUTO-START and # <<< NOM-NA-VIET-AUTO-END at the end of nom_viet.dict.yaml are appended by an automated export; re-runs strip and rewrite only the marked block, so hand-curated lines outside it are preserved across refreshes. To add an entry by hand, place it anywhere outside the auto-block.

License

MIT

Related Projects

About

RIME input schema for Vietnamese Chữ Nôm (喃字). Type Vietnamese with Telex to input Nôm characters. 100,000+ entries including 46,000 compound words. Works on macOS, Windows, Linux, iOS, Android.

Resources

Stars

Watchers

Forks

Releases

Sponsor this project

Packages

Contributors

Languages