---
language:
  - zh
tags:
  - fcitx5
  - pinyin
  - personal-backup
license: other
---

<div align="center">
  <h1>My Custom Fcitx5 Pinyin Dictionary</h1>
  <p><strong>Fcitx5 Pinyin user dictionary and input-history backup</strong></p>
  <p><strong>🌎 English</strong>&nbsp;&nbsp;·&nbsp;&nbsp;<a href="https://huggingface.co/datasets/wty-yy/my_custom_fcitx5_pinyin_dict/blob/main/README.zh-CN.md">🇨🇳 中文</a></p>
</div>

## Usage

```sh
# Restore pinyin/user.dict and pinyin/user.history.
bash <(curl -fsSL https://huggingface.co/datasets/wty-yy/my_custom_fcitx5_pinyin_dict/resolve/main/install.sh)

# Restore config/pinyin.conf as well.
bash <(curl -fsSL https://huggingface.co/datasets/wty-yy/my_custom_fcitx5_pinyin_dict/resolve/main/install.sh) --with-pinyin-config
```

## Files

| File | Purpose |
| --- | --- |
| `pinyin/user.dict` | Learned user dictionary |
| `pinyin/user.history` | Input history and context-ranking model |
| `config/pinyin.conf` | Optional Pinyin settings |
| `install.sh` | Restore script |

## Restore Behavior

`install.sh` downloads the default Dataset `wty-yy/my_custom_fcitx5_pinyin_dict`.

The script restores `pinyin/user.dict` and `pinyin/user.history` by default.

Use `--with-pinyin-config` to restore `config/pinyin.conf`.

The script exits Fcitx5 before writing, creates `pinyin.before-restore-<timestamp>`, and restarts Fcitx5 when it was running.

Use `--repo-id OWNER/DATASET` to restore another compatible Dataset.

## Notes

- Target systems require Fcitx5 Pinyin. Ubuntu and Debian use the `fcitx5-chinese-addons` package.
- Use a matching or newer Fcitx5/libime version when possible.
- `.dict` and `.history` use binary Fcitx5/libime formats.
- This public Dataset exposes personal vocabulary, input history, and Pinyin settings.