English | Tiếng Việt

Fcitx5 Lotus

Bộ gõ tiếng Việt đơn giản, hiệu năng cao cho Linux

Cài đặt »

Báo lỗi · Yêu cầu tính năng

Dự án này là bản fork được tối ưu hóa từ bộ gõ VMK. Chân thành cảm ơn tác giả Thành đã đặt nền móng cho bộ gõ này.

Lưu ý: Gỡ và xoá cấu hình fcitx5-vmk trước khi cài đặt fcitx5-lotus để tránh phát sinh lỗi.

Gỡ và xoá cấu hình fcitx5-vmk

Arch / Arch-based - AUR

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

sudo pacman -Rns fcitx5-vmk

yay -Rns fcitx5-vmk

paru -Rns fcitx5-vmk

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

Debian / Ubuntu / Fedora / openSUSE - Open Build Service

• Debian/Ubuntu

sudo apt remove fcitx5-vmk

• Fedora

sudo dnf remove fcitx5-vmk

• openSUSE

sudo zypper remove fcitx5-vmk

NixOS

Xóa (hoặc comment) dòng services.fcitx5-vmk và inputs trong file config, sau đó rebuild lại system. NixOS sẽ tự dọn dẹp.

Biên dịch từ nguồn

Vào lại thư mục source code đã build và chạy:

sudo make uninstall

---

Xóa cấu hình vmk không tương thích:

rm ~/.config/fcitx5/conf/vmk-*.conf

Mục lục

1. Cài đặt
2. Bật bộ gõ
3. Hướng dẫn sử dụng
4. Gỡ cài đặt
5. Đóng góp
6. Giấy phép

---

📦 Cài đặt

Arch / Arch-based - AUR

Hiện tại AUR có 3 gói cài đặt để bạn lựa chọn:

Gói	Mô tả
fcitx5-lotus	Build từ mã nguồn release ổn định
fcitx5-lotus-bin	Dùng binary đã build sẵn
fcitx5-lotus-git	Build từ danh sách commit mới nhất

Cài đặt bằng yay:

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

Hoặc paru:

# Cú pháp: paru -S <tên-gói>
paru -S fcitx5-lotus

Debian / Ubuntu / Fedora / openSUSE - Open Build Service

Truy cập trang Open Build Service để xem hướng dẫn cài đặt chi tiết cho distro của bạn.

Hoặc có thể xem cách cài của từng distro tại đây.

Lưu ý: Arch và Arch-based distro cũng có thể dùng cách cài này.

NixOS

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

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";

    fcitx5-lotus = {
      url = "github:LotusInputMethod/fcitx5-lotus";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs = {
    self,
  ...
}

Bật fcitx5-lotus service trong configuration.nix:

{
  inputs,
  ...
}: {
  imports = [
    inputs.fcitx5-lotus.nixosModules.fcitx5-lotus
  ];

  services.fcitx5-lotus = {
    enable = true;
    user = "your_username"; # Sửa thành tên user của bạn
  };
}

Rebuild lại system để cài đặt.

Biên dịch từ nguồn

KHUYẾN CÁO QUAN TRỌNG:

Vui lòng KHÔNG sử dụng cách này nếu distro của bạn đã được hỗ trợ thông qua Open Build Service.

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 Open Build Service để đảm bảo tính ổn định và tự động cập nhật.

Yêu cầu hệ thống

• Debian/Ubuntu

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

sudo dnf install cmake extra-cmake-modules fcitx5-devel libinput-devel libudev-devel gcc-c++ golang hicolor-icon-theme systemd-devel libX11-devel

• openSUSE

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

# Clone repository
git clone https://github.com/LotusInputMethod/fcitx5-lotus.git
cd fcitx5-lotus

# Biên dịch
cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_INSTALL_LIBDIR=/usr/lib . # Tùy vào distro mà LIBDIR sẽ khác nhau
make

# Cài đặt (cần quyền root)
sudo make install

# Hoặc cài đặt vào thư mục tùy chỉnh
sudo make install PREFIX=/usr/local

---

⚙️ Bật bộ gõ

Sau khi cài đặt xong, bạn cần thực hiện các bước sau để bật bộ gõ fcitx5-lotus:

1. Bật Lotus Server

Server giúp bộ gõ tương tác với hệ thống tốt hơn (đặc biệt là gửi phím xóa và sửa lỗi).

• Bash / Zsh:

# Bật và khởi động service (tự động fix lỗi thiếu user systemd nếu có)
sudo systemctl enable --now fcitx5-lotus-server@$(whoami).service || \
(sudo systemd-sysusers && sudo systemctl enable --now fcitx5-lotus-server@$(whoami).service)

• Fish shell:

# Bật và khởi động service (tự động fix lỗi thiếu user systemd nếu có)
sudo systemctl enable --now fcitx5-lotus-server@(whoami).service; or begin
    sudo systemd-sysusers; and sudo systemctl enable --now fcitx5-lotus-server@(whoami).service
end

# Kiểm tra status (nếu thấy active (running) màu xanh là OK)
systemctl status fcitx5-lotus-server@$(whoami).service

2. Thiết lập biến môi trường

Bộ gõ sẽ không hoạt động nếu thiếu các biến này.

• Bash / Zsh:

# Thêm cấu hình vào ~/.bash_profile (với .zprofile làm tương tự)
cat <<EOF >> ~/.bash_profile
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx
export XMODIFIERS=@im=fcitx
export SDL_IM_MODULE=fcitx
export GLFW_IM_MODULE=ibus
EOF

• Fish shell:

# Thêm cấu hình vào ~/.config/fish/config.fish
cat >> ~/.config/fish/config.fish <<'EOF'

# Input Method Configuration for Fcitx5
set -Ux GTK_IM_MODULE fcitx
set -Ux QT_IM_MODULE fcitx
set -Ux XMODIFIERS "@im=fcitx"
set -gx SDL_IM_MODULE fcitx
set -gx GLFW_IM_MODULE ibus
EOF

Log out và log in để áp dụng thay đổi.

Nếu bạn vẫn chưa gõ được sau khi log out

Nếu cấu hình tại ~/.bash_profile hoặc ~/.zprofile không hoạt động, bạn có thể thử thiết lập tại /etc/environment để áp dụng cho toàn bộ hệ thống:

cat <<EOF | sudo tee -a /etc/environment
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx
XMODIFIERS=@im=fcitx
SDL_IM_MODULE=fcitx
GLFW_IM_MODULE=ibus
EOF

Lưu ý: Cần khởi động lại máy sau khi thiết lập.

3. Tắt bộ gõ cũ (IBus) và thêm Fcitx5 vào Autostart

Nếu máy bạn đang dùng IBus, hãy tắt nó đi trước khi chuyển sang Fcitx5 để tránh xung đột.

# Tắt IBus
killall ibus-daemon || ibus exit

Thêm Fcitx5 vào Autostart cho từng DE / WM (GNOME, Hyprland ...)

DE / WM	Hướng dẫn chi tiết
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
MATE	Control Center → Startup Applications → Add (Name: Fcitx 5, Command: fcitx5)
Pantheon	System Settings → Applications → Startup → Add Startup App... → Fcitx 5
Budgie	Budgie Desktop Settings → Autostart → + → Add application → Fcitx 5
LXQt	LXQt Configuration Center → Session Settings → Autostart → LXQt Autostart → Add (Name: Fcitx 5, Command: fcitx5)
COSMIC	COSMIC Settings → Applications → Startup Applications → Add app → Fcitx 5
i3 / Sway	Thêm exec --no-startup-id fcitx5 -d vào file config (~/.config/i3/config hoặc ~/.config/sway/config)
Hyprland	Thêm exec-once = fcitx5 -d vào ~/.config/hypr/hyprland.conf

Lưu ý: Hãy tắt autostart của IBus (thường là ibus-daemon hoặc ibus) để tránh xung đột. Tốt nhất là gỡ cài đặt IBus nếu không sử dụng.

4. Cấu hình Fcitx5

Sau khi đã log out và log in lại:

1. Mở Fcitx5 Configuration (tìm trong menu ứng dụng hoặc chạy fcitx5-configtool).

2. Tìm Lotus ở 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.

   Cấu hình thêm cho Wayland (KDE, Hyprland)

• KDE Plasma: System Settings → Keyboard → Virtual Keyboard → Chọn Fcitx 5.

• Hyprland: Thêm dòng sau vào ~/.config/hypr/hyprland.conf:

  permission = fcitx5-lotus-server, keyboard, allow

---

📖 Hướng dẫn sử dụng

1. Tùy chỉnh bộ gõ

• Cách truy cập: Nhấp chuột phải vào biểu tượng Lotus trên system tray để mở tuỳ chỉnh.

Tùy chọn	Mô tả	Mặc định
Typing Mode	Chọn chế độ gõ.	Uinput (Smooth)
Input Method	Chọn kiểu gõ.	Telex
Charset	Chọn bảng mã.	Unicode
Spell Check	Bật/tắt kiểm tra lỗi chính tả tiếng Việt.	Bật
Macro	Bật/tắt gõ tắt.	Bật
Capitalize Macro	Bật/tắt gõ tắt chữ hoa.	Bật
Auto non-VN restore	Bât/tắt tự động khôi phục với từ không phải tiếng Việt.	Bật
Modern Style	Bật/tắt kiểu đặt dấu thanh hiện đại (ví dụ: oà, *uý thay vì òa, *úy).	Bật
Free Marking	Bật/tắt bỏ dấu tự do.	Bật
Fix Uinput with ack	Bật/tắt sửa lỗi chế độ uinput với ack Nên bật khi sử dụng các ứng dụng Chromium (Chrome, Brave, Edge, ...).	Tắt

2. Menu chuyển chế độ gõ

Khi đang ở trong bất kỳ ứng dụng nào, nhấn phím ` để mở menu chọn chế độ gõ, có thể dùng chuột hoặc phím tắt để chọn.

Chế độ	Phím tắt	Mô tả
Uinput (Smooth)	1	Chế độ mặc định, phản hồi nhanh. Tối ưu: ứng dụng có tốc độ xử lý input cao.
Uinput (Slow)	2	Tương tự Uinput (Smooth) nhưng tốc độ gửi phím chậm hơn. Tối ưu: ứng dụng có tốc độ xử lý input thấp (ví dụ: Libre Office).
Uinput (Hardcore)	3	Biến thể của Uinput (Smooth). Tối ưu: ứng dụng Windows qua Wine.
Surrounding Text	4	Cho phép sửa dấu trên văn bản đã gõ, hoạt động mượt. Tối ưu: ứng dụng Qt/GTK.
Preedit	Q	Hiển thị gạch chân khi gõ. Tối ưu: hầu hết ứng dụng.
Emoji Picker	W	Tìm kiếm và nhập Emoji (nguồn EmojiOne, hỗ trợ fuzzy search).
OFF	E	Tắt bộ gõ.
Default Typing	R	Chế độ gõ mặc định được cấu hình tại tuỳ chọn Typing mode.
Type `	`	Nhập ký tự `.

Bộ gõ sẽ tự động lưu chế độ gõ đã dùng gần nhất cho từng ứng dụng và khôi phục cấu hình đó khi bạn mở lại chúng.

3. Đặt lại trạng thái đang gõ

Nhấp chuột hoặc chạm touchpad trong khi gõ sẽ tự động đặt lại trạng thái đang gõ, ngăn chặn hiện tượng dính ký tự giữa các từ.

---

🗑️ Gỡ cài đặt

Arch / Arch-based - AUR

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

sudo pacman -Rns fcitx5-lotus

yay -Rns fcitx5-lotus

paru -Rns fcitx5-lotus

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

Debian / Ubuntu / Fedora / openSUSE - Open Build Service

• Debian/Ubuntu

sudo apt remove fcitx5-lotus

• Fedora

sudo dnf remove fcitx5-lotus

• openSUSE

sudo zypper remove fcitx5-lotus

NixOS

Xóa (hoặc comment) dòng services.fcitx5-lotus và inputs trong file config, sau đó rebuild lại system. NixOS sẽ tự dọn dẹp.

Biên dịch từ nguồn

Vào lại thư mục source code đã build và chạy:

sudo make uninstall

---

🤝 Đó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 để biết cách tham gia phát triển dự án, quy trình Pull Request, quy tắc code style và quy tắc ứng xử.

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

Những người đóng góp:

---

📃 Giấy phép

Dự án được phân phối dưới giấy phép GNU General Public License v3. Xem LICENSE để biết thêm chi tiết.

---

✨ Lịch sử sao

---