Skip to content
This repository was archived by the owner on Feb 19, 2026. It is now read-only.

fix: update translation, menu label, logo, README #59

Merged
nhktmdzhg merged 4 commits into from
Feb 17, 2026
Merged

fix: update translation, menu label, logo, README #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bcec188
change translation string
hthienloc Feb 17, 2026
56ed147
fix: update app mode menu labels for clarity
hthienloc Feb 17, 2026
4dfbb7d
feat: add project logo and update README
hthienloc Feb 17, 2026
dfdf306
fix: update TOC
hthienloc Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 51 additions & 84 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<div align="center">
<a href="https://github.com/nhktmdzhg/VMK">
<img src="data/icons/scalable/apps/fcitx-vmk.svg" alt="Logo" width="80" height="80">
<img src="data/icons/scalable/apps/fcitx-vmk-logo.svg" alt="Logo" width="80" height="80">
</a>

<h2 align="center">Fcitx5 VMK</h2>
Expand Down Expand Up @@ -51,7 +51,6 @@ Dự án này là một bản fork được tối ưu hóa từ [bộ gõ VMK g
<li><a href="#bật-bộ-gõ">Bật bộ gõ</a></li>
<li><a href="#hướng-dẫn-sử-dụng">Hướng dẫn sử dụng</a></li>
<li><a href="#gỡ-cài-đặt">Gỡ cài đặt</a></li>
<li><a href="#cải-tiến-nổi-bật">Cải tiến nổi bật</a></li>
<li><a href="#đóng-góp">Đóng góp</a></li>
<li><a href="#giấy-phép">Giấy phép</a></li>
</ol>
Expand All @@ -75,16 +74,17 @@ Hiện tại AUR có 3 gói cài đặt để bạn lựa chọn:
| `fcitx5-vmk-bin` | Dùng binary đã build sẵn (không cần biên dịch) |
| `fcitx5-vmk-git` | Build từ danh sách commit mới nhất |

Cài đặt bằng `yay` hoặc `paru`:
Cài đặt bằng `yay`:

```bash
# Cú pháp: yay -S <tên-gói>
yay -S fcitx5-vmk

# Hoặc nếu dùng paru
```
Hoặc `paru`:
```bash
# Cú pháp: paru -S <tên-gói>
paru -S fcitx5-vmk
```

</details>

<details>
Expand All @@ -108,7 +108,7 @@ Hoặc có thể xem cách cài của từng distro [tại đây](INSTALL.md).

Thêm input của fcitx5-vmk vào `flake.nix`:

```
```nix
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
Expand All @@ -127,7 +127,7 @@ Thêm input của fcitx5-vmk vào `flake.nix`:

Bật fcitx5-vmk service trong `configuration.nix`:

```
```nix
{
inputs,
...
Expand Down Expand Up @@ -158,18 +158,18 @@ Rebuild lại system để cài đặt.
> Việc biên dịch thủ công đòi hỏi bạn phải hiểu rõ về cấu trúc thư mục của hệ thống. Nếu bạn gặp lỗi "Not Available" hoặc thiếu thư viện khi cài theo cách này trên các distro phổ biến (Ubuntu/Fedora...), hãy quay lại dùng OBS để đảm bảo tính ổn định và tự động cập nhật.

##### Yêu cầu hệ thống

- Ubuntu/Debian
```bash
# Ubuntu/Debian
sudo apt-get install cmake extra-cmake-modules libfcitx5core-dev libfcitx5config-dev libfcitx5utils-dev libinput-dev libudev-dev g++ golang hicolor-icon-theme pkg-config libx11-dev

# Fedora/RHEL
```
- Fedora/RHEL
```bash
sudo dnf install cmake extra-cmake-modules fcitx5-devel libinput-devel libudev-devel gcc-c++ golang hicolor-icon-theme systemd-devel libX11-devel

# openSUSE
```
- openSUSE
```bash
sudo zypper install cmake extra-cmake-modules fcitx5-devel libinput-devel systemd-devel gcc-c++ go hicolor-icon-theme systemd-devel libX11-devel udev
```

##### Biên dịch và cài đặt

```bash
Expand Down Expand Up @@ -262,12 +262,11 @@ killall ibus-daemon || ibus exit
Thêm `fcitx5` vào danh sách ứng dụng khởi động cùng hệ thống (Autostart).

<details>
<summary><b>Hướng dẫn Autostart cho từng Desktop Environment (GNOME, KDE, ...)</b></summary>
<br>
<summary><b>Hướng dẫn thêm Autostart cho từng DE / WM (GNOME, Hyprland ...)</b></summary>

| DE / WM | Hướng dẫn chi tiết |
| :------------- | :----------------------------------------------------------------------------------------------------------------------------- |
| **GNOME** | Mở **GNOME Tweaks** → _Startup Applications_ → Add → `Fcitx 5` |
| **GNOME** | **GNOME Tweaks** → _Startup Applications_ → Add → `Fcitx 5` |
| **KDE Plasma** | **System Settings** → _Autostart_ → Add... → Add Application... → `Fcitx 5` |
| **Xfce** | **Settings** → _Session and Startup_ → _Application Autostart_ → Add → `Fcitx 5` |
| **Cinnamon** | **System Settings** → _Startup Applications_ → `+` → Choose application → `Fcitx 5` |
Expand All @@ -291,16 +290,18 @@ Sau khi đã log out và log in lại:
2. Tìm **VMK** ở cột bên phải.
3. Nhấn mũi tên **<** để thêm nó sang cột bên trái.
4. Apply.
<details>
<summary><b>Cấu hình thêm cho Wayland (KDE, Hyprland)</b></summary>

### 5. Cấu hình cho Wayland (KDE và Hyprland)

Nếu bạn sử dụng **Wayland**, Fcitx5 cần được cấp quyền để hoạt động như bàn phím ảo:
Nếu bạn sử dụng Wayland, Fcitx5 cần được cấu hình thêm để hoạt động như bàn phím ảo:

- **KDE Plasma:** Vào _System Settings_ → _Keyboard_ → _Virtual Keyboard_ → Chọn **Fcitx 5**.
- **Hyprland:** Thêm dòng sau vào `~/.config/hypr/hyprland.conf`:
```ini
permission = fcitx5-vmk-server, keyboard, allow
```
</details>


---

Expand All @@ -310,23 +311,25 @@ Nếu bạn sử dụng **Wayland**, Fcitx5 cần được cấp quyền để h

### 1. Menu chuyển mode nhanh

Khi đang ở trong bất kỳ ứng dụng nào, nhấn phím **`** (dấu huyền) để mở menu chọn nhanh:
Khi đang ở trong bất kỳ ứng dụng nào, nhấn phím **`** (dấu huyền) để mở menu chọn chế độ gõ:

| Chế độ | Mô tả |
|---|---|
| 🚀 **Mode 1 — Uinput (Smooth)** | Chế độ mặc định, phản hồi nhanh. Sử dụng server để gửi phím xoá.<br>_Hạn chế:_ Có thể không tương thích với ứng dụng xử lý chậm (ví dụ: LibreOffice). |
| 🐢 **Mode 2 — Uinput (Slow)** | Tương tự Mode 1 nhưng tốc độ gửi phím chậm hơn.<br>_Khuyên dùng:_ Cho ứng dụng có tốc độ xử lý input thấp. |
| 🍷 **Mode 3 — Uinput (Hardcore)** | Biến thể của Mode 1.<br>_Khuyên dùng:_ Khi chạy ứng dụng Windows qua Wine. |
| ✨ **Mode 4 — Surrounding Text** | Dùng cơ chế Surrounding Text của ứng dụng (tối ưu cho Qt/GTK). Cho phép sửa dấu trên văn bản đã gõ, hoạt động mượt.<br>_Lưu ý:_ Phụ thuộc mức hỗ trợ của ứng dụng (có thể không ổn định trên Firefox). |
| 📝 **Mode 5 — Preedit** | Hiển thị gạch chân khi gõ. Độ tương thích cao nhất nhưng trải nghiệm kém tự nhiên hơn các mode trên. |
| 😃 **Emoji Picker** | Tìm kiếm và nhập Emoji (nguồn EmojiOne, hỗ trợ fuzzy search). Xem danh sách [tại đây](data/emoji/EMOJI_GUIDE.md). |
| 📴 **OFF** | Tắt bộ gõ. |
| 🔄 **Remove App Settings** | Khôi phục cấu hình mặc định cho ứng dụng hiện tại. |
| 🚪 **Type `** | Nhập ký tự dấu huyền. |

| Chế độ | Mô tả |
| :------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 🚀 **Mode 1 (Uinput smooth)** | Chế độ mặc định, tốc độ phản hồi cao. Sử dụng server để gửi phím xóa. <br> _Hạn chế:_ Không tương thích với ứng dụng xử lý chậm (ví dụ: LibreOffice). |
| 🐢 **Mode 2 (Uinput)** | Tương tự Mode 1 nhưng tốc độ gửi phím chậm hơn. <br> _Khuyên dùng:_ Cho các ứng dụng có tốc độ xử lý input thấp. |
| 🍷 **Mode 3 (Uinput hardcore)** | Biến thể của Mode 1. <br> _Khuyên dùng:_ Chạy ứng dụng Windows qua Wine. |
| ✨ **Mode 4 (Surrounding Text)** | Sử dụng cơ chế Surrounding Text của ứng dụng (tối ưu cho Qt/GTK). Cho phép sửa dấu từ đã gõ và hoạt động mượt mà. <br> _Lưu ý:_ Phụ thuộc vào sự hỗ trợ của ứng dụng (có thể không ổn định trên Firefox). |
| 📝 **Mode 5 (Preedit)** | Hiển thị gạch chân khi gõ. Độ tương thích cao nhất nhưng trải nghiệm không tự nhiên bằng các mode trên. |
| 😃 **Emoji mode** | Chế độ tìm kiếm và nhập Emoji (nguồn EmojiOne, hỗ trợ Fuzzy Search). Xem danh sách [tại đây](data/emoji/EMOJI_GUIDE.md). |
| 📴 **OFF** | Tắt bộ gõ cho ứng dụng hiện tại. |
| 🔄 **Remove app settings** | Khôi phục cấu hình mặc định cho ứng dụng. |
| 🚪 **Close menu and type `** | Đóng menu và nhập ký tự dấu huyền. |
Bộ gõ sẽ lưu chế độ đã dùng gần nhất cho từng ứng dụng và tự động khôi phục cấu hình đó khi bạn mở lại cùng ứng dụng.

### 2. Cơ chế đặt lại thông minh
### 2. Cơ chế Smart Reset

Khi bạn click chuột hoặc chạm vào touchpad để đổi vị trí nhập liệu, bộ gõ sẽ tự động đặt lại trạng thái ngay lập tức. Điều này giúp tránh lỗi dính chữ cũ vào từ mới (một lỗi rất phổ biến trên các bộ gõ Linux khác).
Tự động reset trạng thái bộ gõ khi người dùng click chuột hoặc chạm touchpad để di chuyển con trỏ. Điều này ngăn chặn hiện tượng dính ký tự giữa các từ.

---

Expand All @@ -338,19 +341,16 @@ Khi bạn click chuột hoặc chạm vào touchpad để đổi vị trí nhậ
<summary><b>Arch / Arch-based - AUR</b></summary>
<br>

Bạn có thể dùng `pacman`, `yay` hoặc `paru` để gỡ cài đặt:

Bạn có thể dùng `pacman` (khuyên dùng), `yay` hoặc `paru` để gỡ cài đặt:
```bash
# Sử dụng pacman (Khuyên dùng)
sudo pacman -Rns fcitx5-vmk

# Nếu dùng yay
```
```bash
yay -Rns fcitx5-vmk

# Nếu dùng paru
```
```bash
paru -Rns fcitx5-vmk
```

> **Lưu ý:** Các file config ở `$HOME` sẽ được giữ lại.

</details>
Expand All @@ -360,18 +360,18 @@ paru -Rns fcitx5-vmk
<br>

Gỡ package thông thường qua trình quản lý gói:

- Debian/Ubuntu
```bash
# Debian/Ubuntu
sudo apt remove fcitx5-vmk

# Fedora
```
- Fedora
```bash
sudo dnf remove fcitx5-vmk

# openSUSE
```
- openSUSE
```bash
sudo zypper remove fcitx5-vmk
```

</details>

<details>
Expand All @@ -396,46 +396,13 @@ sudo make uninstall

---

<a id="cải-tiến-nổi-bật"></a>

## 🚀 Cải tiến nổi bật

<details>
<summary><b>Click để xem chi tiết kỹ thuật</b></summary>
<br>

Bản fork này thay đổi hoàn toàn kiến trúc của Server và Addon để đạt hiệu năng tối ưu và bảo mật tốt hơn.

### 1. VMK Server (Backend)

Server được viết lại theo phong cách **System Programming** hiện đại:

- **Kiến trúc Event-Driven (Sử dụng `poll`):** Thay thế cơ chế polling liên tục (gây tốn CPU) bằng `poll()` với timeout hợp lý. Server sẽ "ngủ đông" khi không có sự kiện, giúp mức tiêu thụ CPU khi nhàn rỗi gần như 0%.
- **Single-Threaded:** Loại bỏ đa luồng phức tạp, gộp chung việc lắng nghe Socket và sự kiện đầu vào vào một vòng lặp sự kiện duy nhất, giảm overhead và dung lượng binary.
- **Real-time I/O:** Sử dụng socket để giao tiếp trực tiếp giữa server và addon thay vì ghi file log, giúp phản hồi tức thì và bảo vệ ổ cứng.
- **Bảo mật Socket:**
- Sử dụng **Abstract Socket** (không tạo file trên đĩa) kết hợp với xác thực `getsockopt` để đảm bảo chỉ tiến trình hợp lệ mới có thể gửi tín hiệu.
- Khắc phục các rủi ro bảo mật liên quan đến quyền truy cập file socket công khai ở phiên bản cũ.

### 2. VMK Addon (Frontend)

Cải thiện trải nghiệm người dùng với các tính năng tiện ích:

- **Per-App Configuration:** Tự động ghi nhớ chế độ gõ (Mode) riêng biệt cho từng ứng dụng (Ví dụ: Tắt bộ gõ ở Terminal, bật ở Trình duyệt).
- **Menu Phím Tắt Thông Minh (`):** Menu ngữ cảnh hiển thị ngay tại con trỏ văn bản, cho phép chuyển đổi chế độ nhanh chóng.
- **Tính năng mở rộng:** Hỗ trợ sửa dấu từ cũ (Surrounding Text), chế độ nhập Emoji và nhiều cải tiến khác.

</details>

---

<a id="đóng-góp"></a>

## 🤝 Đóng góp

Đóng góp là điều làm cho cộng đồng mã nguồn mở trở thành một nơi tuyệt vời để học hỏi, truyền cảm hứng và sáng tạo. Mọi đóng góp của bạn đều được **đánh giá cao**.

Vui lòng xem hướng dẫn chi tiết tại [đây](CONTRIBUTING.md) để biết cách tham gia phát triển dự án, quy trình Pull Request và quy tắc code style.
Vui lòng xem hướng dẫn chi tiết [tại đây](CONTRIBUTING.md) để biết cách tham gia phát triển dự án, quy trình Pull Request và quy tắc code style.

Đừng quên tặng dự án một ⭐! Cảm ơn bạn rất nhiều!

Expand Down
41 changes: 41 additions & 0 deletions data/icons/scalable/apps/fcitx-vmk-logo.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions po/vi.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,8 @@ msgid " (Default)"
msgstr " (Mặc định)"

#: src/vmk.cpp:1871
msgid "App name detected by fcitx5: "
msgstr "Tên ứng dụng nhận dạng bởi fcitx5: "
msgid "App: "
msgstr "Ứng dụng: "

#: src/vmk.cpp:1872
msgid "1. Fake backspace by Uinput (smooth)"
Expand All @@ -148,7 +148,7 @@ msgstr "2. Phím xóa giả bởi uinput"

#: src/vmk.cpp:1874
msgid "3. Fake backspace by Uinput for wine apps"
msgstr "3. Phím xóa giả bởi uinput cho các ứng dụng wine"
msgstr "3. Phím xóa giả bởi uinput cho ứng dụng wine"

#: src/vmk.cpp:1875
msgid "4. Surrounding Text"
Expand Down
14 changes: 7 additions & 7 deletions src/vmk.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2061,23 +2061,23 @@ namespace fcitx {
// Build candidate list for app mode menu
// Structure: Header + 8 selectable items (4 VMK modes + 4 special options)
candidateList->append(std::make_unique<DisplayOnlyCandidateWord>(Text(_("App: ") + currentConfigureApp_)));
candidateList->append(std::make_unique<AppModeCandidateWord>(getLabel(VMKMode::VMKSmooth, _("[1] Fake backspace by Uinput (smooth)")), applyMode(VMKMode::VMKSmooth)));
candidateList->append(std::make_unique<AppModeCandidateWord>(getLabel(VMKMode::VMK1, _("[2] Fake backspace by Uinput")), applyMode(VMKMode::VMK1)));
candidateList->append(std::make_unique<AppModeCandidateWord>(getLabel(VMKMode::VMK1HC, _("[3] Fake backspace by Uinput for wine apps")), applyMode(VMKMode::VMK1HC)));
candidateList->append(std::make_unique<AppModeCandidateWord>(getLabel(VMKMode::VMKSmooth, _("[1] Uinput (smooth)")), applyMode(VMKMode::VMKSmooth)));
candidateList->append(std::make_unique<AppModeCandidateWord>(getLabel(VMKMode::VMK1, _("[2] Uinput (Slow)")), applyMode(VMKMode::VMK1)));
candidateList->append(std::make_unique<AppModeCandidateWord>(getLabel(VMKMode::VMK1HC, _("[3] Uinput (Hardcore)")), applyMode(VMKMode::VMK1HC)));
candidateList->append(std::make_unique<AppModeCandidateWord>(getLabel(VMKMode::VMK2, _("[4] Surrounding Text")), applyMode(VMKMode::VMK2)));
candidateList->append(std::make_unique<AppModeCandidateWord>(getLabel(VMKMode::Preedit, _("[q] Preedit")), applyMode(VMKMode::Preedit)));
candidateList->append(std::make_unique<AppModeCandidateWord>(getLabel(VMKMode::Emoji, _("[w] Emoji mode")), applyMode(VMKMode::Emoji)));
candidateList->append(std::make_unique<AppModeCandidateWord>(getLabel(VMKMode::Off, _("[e] OFF - Disable Input Method")), applyMode(VMKMode::Off)));
candidateList->append(std::make_unique<AppModeCandidateWord>(getLabel(VMKMode::Emoji, _("[w] Emoji Picker")), applyMode(VMKMode::Emoji)));
candidateList->append(std::make_unique<AppModeCandidateWord>(getLabel(VMKMode::Off, _("[e] OFF")), applyMode(VMKMode::Off)));

candidateList->append(std::make_unique<AppModeCandidateWord>(Text(_("[r] Remove app settings")), [this, cleanup](InputContext* ic) {
candidateList->append(std::make_unique<AppModeCandidateWord>(Text(_("[r] Remove App Settings")), [this, cleanup](InputContext* ic) {
if (appRules_.count(currentConfigureApp_)) {
appRules_.erase(currentConfigureApp_);
saveAppRules();
}
cleanup(ic);
}));

candidateList->append(std::make_unique<AppModeCandidateWord>(Text(_("[`] Close menu and type `")), [cleanup](InputContext* ic) {
candidateList->append(std::make_unique<AppModeCandidateWord>(Text(_("[`] Type `")), [cleanup](InputContext* ic) {
cleanup(ic);
ic->commitString("`");
}));
Expand Down
Loading