- 
+ 
@@ -47,11 +47,11 @@ Physical Keyboard
│ Stage 1: KEY CAPTURE │
│ │
│ evdev: /dev/input/event* grabs keyboard (primary, reliable) │
-│ X11: XRecord passive monitoring (fallback) │
+│ X11: XRecord passive monitoring (fallback) │
│ │
│ ┌─────────────┐ ┌──────────────┐ ┌──────────────────┐ │
-│ │ evdev grab │ │ X11Capture │ │ FocusIn/FocusOut │ │
-│ │ (libevdev) │ │ (XRecord) │ │ detection │ │
+│ │ evdev grab │ │ X11Capture │ │ Window switch │ │
+│ │ (libevdev) │ │ (XRecord) │ │ detection (250ms)│ │
│ └─────────────┘ └──────────────┘ └──────────────────┘ │
└──────────────────────────────────────────────────────────────┘
│
@@ -63,7 +63,7 @@ Physical Keyboard
│ Ctrl+Space → toggle Vietnamese ON/OFF │
│ Backspace → replay_backspace() │
│ Characters → replay_and_inject(ch) │
-│ VNI/Telex control keys → consume when no match │
+│ VNI control keys → consume when no match │
└──────────────────────────────────────────────────────────────┘
│
▼
@@ -81,13 +81,15 @@ Physical Keyboard
┌──────────────────────────────────────────────────────────────┐
│ Stage 4: KEY INJECTION │
│ │
+│ Primary: uinput injection (evdev keycodes, correct on all │
+│ display servers — routed through libinput on modern X11) │
│ ASCII: direct Linux keycodes via /dev/uinput │
- │ Backspace: Linux keycode 14 via uinput │
- │ Vietnamese Unicode: clipboard paste + trailing ASCII via │
- │ uinput (split only at whitespace/punctuation boundary) │
- │ uinput Ctrl+V via /dev/uinput (no X11 dependency) │
+│ Backspace: Linux keycode 14 via uinput │
+│ Vietnamese Unicode: clipboard paste + trailing ASCII via │
+│ uinput (split only at whitespace/punctuation boundary) │
+│ uinput Ctrl+V via /dev/uinput (no X11 dependency) │
│ │
-│ Fallback: vietc-uinputd Unix socket daemon (privileged) │
+│ Fallback: X11 XTest injection (X11 keycodes = evdev + 8) │
└──────────────────────────────────────────────────────────────┘
│
▼
@@ -133,14 +135,14 @@ vietc/
│ ├── engine.rs # Orchestrator + replay_events(), replay_events_to_commands()
│ ├── event.rs # Event Sourcing: InputEvent, EventStore, Command
│ ├── bamboo.rs # Bamboo engine: transformation model, composition, tone placement
-│ ├── input_method.rs # Telex/VNI rule definitions
+│ ├── input_method.rs # VNI rule definitions
│ └── spelling.rs # Vietnamese syllable validation
│
├── protocol/ # Keyboard capture & injection
│ ├── inject.rs # KeyInjector trait
│ ├── x11_capture.rs # XRecord keyboard capture via C helper
-│ ├── x11_inject.rs # XTest injection + direct clipboard
-│ ├── uinput_monitor.rs # /dev/uinput injection for ASCII + Unicode
+│ ├── x11_inject.rs # XTest injection (fallback)
+│ ├── uinput_monitor.rs # /dev/uinput injection (primary)
│ ├── uinput_client.rs # Unix socket client for vietc-uinputd
│ └── wayland_im.rs # Wayland IM protocol
│
@@ -157,7 +159,7 @@ vietc/
│ └── main.rs # Tray + daemon launcher
│
├── cli/ # Interactive test harness
-├── packaging/ # AppImage + deb build scripts
+├── packaging/ # .deb packaging scripts
└── vietc.toml # Default configuration
```
@@ -166,12 +168,12 @@ vietc/
```
┌─────────────────────────────────────────────────────────────┐
│ vietc-tray │
-│ (System tray icon, daemon launcher, password prompt) │
+│ (System tray icon, daemon launcher) │
└───────────────────────┬─────────────────────────────────────┘
│ starts
▼
┌─────────────────────────────────────────────────────────────┐
-│ vietc (daemon) │
+│ vietc-daemon │
│ │
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────────┐ │
│ │ Config │ │ App State │ │ Display │ │
@@ -183,7 +185,7 @@ vietc/
│ ┌──────▼──────┐ │
│ │ Event Loop │ │
│ │ │ │
-│ │ X11: grab │ │
+│ │ evdev: grab │ │
│ │ keyboard │ │
│ │ │ │
│ │ Process │ │
@@ -198,12 +200,12 @@ vietc/
│ │
│ ┌────────────────────────────────────────────────────────┐ │
│ │ vietc-engine │ │
-│ │ TelexEngine / VniEngine / EnglishDict / Spelling │ │
+│ │ VniEngine / EnglishDict / Spelling │ │
│ └────────────────────────────────────────────────────────┘ │
│ │
│ ┌────────────────────────────────────────────────────────┐ │
│ │ vietc-protocol │ │
-│ │ X11Capture / X11Injector / UinputInjector / Wayland │ │
+│ │ UinputInjector / X11Injector / X11Capture / Wayland │ │
│ └────────────────────────────────────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘
```
@@ -212,24 +214,7 @@ vietc/
## Input Methods
-### Telex
-
-| Key | Result | Example |
-|-----|--------|---------|
-| `aa` | â | `tan` → `tân` |
-| `aw` | ă | `tan` → `tăn` |
-| `ee` | ê | `men` → `mên` |
-| `oo` | ô | `to` → `tô` |
-| `ow` | ơ | `to` → `tơ` |
-| `uw` | ư | `tu` → `tư` |
-| `s` | á (sắc) | `as` → `á` |
-| `f` | à (huyền) | `af` → `à` |
-| `r` | ả (hỏi) | `ar` → `ả` |
-| `x` | ã (ngã) | `ax` → `ã` |
-| `j` | ạ (nặng) | `aj` → `ạ` |
-| `dd` | đ | `dd` → `đ` |
-
-### VNI
+### VNI (default, Telex coming in next version)
| Key | Result | Example |
|-----|--------|---------|
@@ -251,59 +236,51 @@ Flexible typing: type the full syllable, then add marks/tone keys at the end. Ex
| Feature | How It Works |
|---------|-------------|
-| **Direct Input** | No pre-edit buffer. Keystrokes instantly become text via uinput/XTest injection |
+| **Direct Input** | No pre-edit buffer. Keystrokes instantly become text via uinput injection |
| **Bamboo Engine** | Transformation model ported from bamboo-core — composition, marks, tones, flexible backtracking |
-| **Flexible Backtrack** | Type tone/modifier at end of syllable (`tranaf` → `trần`). Scans up to 5 chars backward |
+| **Flexible Backtrack** | Type tone/modifier at end of syllable (`tran5` → `trạn`). Scans up to 5 chars backward |
| **Smart Clusters** | `uo` → `ươ` with backtrack (`chuong7` → `chương`) |
| **Tone Placement** | Correct tone positioning for all Vietnamese diphthongs (io→gió, uâ→xuất, yê→nguyễn) |
| **Macro Expansion** | `ko` → `không`, `dc` → `được`, custom shortcuts |
| **Casing Preservation** | `Tieengs` → `Tiếng`, `TIEENGS` → `TIẾNG` |
| **App Memory** | Per-app Vietnamese/English state, saved to `overrides.toml` |
| **Hot Reload** | Config changes apply without restart (polls mtime every 1.5s) |
-| **Window-Switch Reset** | Alt+Tab clears engine state — no stale composition across apps, even when focus events are missed. Uses `xdotool` or `xprop` fallback to detect window changes |
+| **Window-Switch Reset** | Active window ID verified on every keystroke — Alt+Tab instantly clears engine state. No stale composition across apps |
| **CPU Priority** | Pins daemon to P-cores (0-3) + nice(-10) for low-latency input |
-| **Uinput Daemon** | Privileged `vietc-uinputd` for clean backspace injection (Unix socket, VMK-style) |
+| **Uinput Injection** | Uses `/dev/uinput` for reliable keyboard injection without X11 dependency. Falls back to XTest on systems without uinput access |
---
## Installation
-### Flatpak (recommended)
+### Debian Package (recommended)
-System tray icon + daemon. Find **"Viet+"** in your app menu to launch, or run from terminal.
+System tray icon + daemon + desktop entry. Requires user to be in the `input` group for keyboard capture.
```bash
# Install
-flatpak install --user --bundle VietPlus-x86_64.flatpak
+sudo dpkg -i vietc_0.1.6-1_amd64.deb
-# Launch via app menu, or:
-flatpak run io.github.vietc.VietPlus
-
-# Uninstall
-flatpak uninstall --user io.github.vietc.VietPlus
+# Log out and log back in (for input group membership to take effect)
+# Then launch "Viet+" from your application menu
```
-Includes daemon + CLI + system tray + uinput daemon. Sandboxed — no system libraries are touched.
+The post-install script will:
+- Kill any running tray/daemon processes
+- Remove stale binaries from `/usr/local/bin/`
+- Add your user to the `input` group
+- Prompt you to log out and back in
-### Build from Source (Flatpak)
+### Build from Source
```bash
git clone https://github.com/vndangkhoa/vietc.git
-cd vietc/packaging/flatpak
-bash build-flatpak.sh [version]
+cd vietc
+make deb
+sudo dpkg -i packaging/deb/vietc_0.1.6-1_amd64.deb
```
-Requires Flatpak runtimes: `org.gnome.Platform//50`, `org.gnome.Sdk//50`, `org.freedesktop.Sdk.Extension.rust-stable//25.08`
-
-```bash
-flatpak install --user flathub org.gnome.Platform//50
-flatpak install --user flathub org.gnome.Sdk//50
-flatpak install --user flathub org.freedesktop.Sdk.Extension.rust-stable//25.08
-```
-
-The Flatpak bundle includes the system tray and desktop menu entry. Find **"Viet+"** in your app launcher to start it, or search for it to uninstall. Warning-free build — no `#![allow()]` needed.
-
-See `packaging/flatpak/FLATPAK_BUILD.md` for detailed build instructions.
+Requires Rust toolchain, `pkg-config`, `libx11-dev`, `libxtst-dev`, `libevdev-dev`. See `packaging/deb/build-deb.sh` for details.
---
diff --git a/RELEASE_CHECKLIST.md b/RELEASE_CHECKLIST.md
index 488d892..d05b86a 100644
--- a/RELEASE_CHECKLIST.md
+++ b/RELEASE_CHECKLIST.md
@@ -3,7 +3,7 @@
## When to release
- New feature or bugfix that should be distributed to users
-- Flatpak build changes validated
+- .deb packaging changes validated
- All tests passing (`cargo test`)
---
@@ -38,25 +38,29 @@ Add a new entry under the version heading:
- behavior changes...
```
-### 3. Build the Flatpak
+### 3. Build the .deb
```bash
-cd packaging/flatpak
-bash build-flatpak.sh X.Y.Z
+make deb
```
-Verify the bundle was created:
-```bash
-ls -lh VietPlus-X.Y.Z.flatpak
-```
-
-### 4. Test the Flatpak
+Verify the package was created:
```bash
-flatpak install --user --bundle VietPlus-X.Y.Z.flatpak
-flatpak run io.github.vietc.VietPlus
+ls -lh packaging/deb/vietc_*.deb
```
+### 4. Install & test
+
+```bash
+sudo dpkg -i packaging/deb/vietc_X.Y.Z-1_amd64.deb
+```
+
+Test:
+- Search "Viet+" in the application menu — the tray icon entry should appear
+- Launch from menu — tray icon should show, Vietnamese input should work (VNI, Ctrl+Space to toggle)
+- The tray should autostart on next login (XDG autostart installed)
+
### 5. Commit and push
```bash
@@ -67,12 +71,7 @@ git push origin main
### 6. Create a release on Forgejo/GitHub
-Attach the Flatpak bundle (`VietPlus-X.Y.Z.flatpak`) as a release asset.
-
-```bash
-# Using forgejo-release (if configured)
-# Or manually upload via the web UI
-```
+Attach the .deb package (`vietc_X.Y.Z-1_amd64.deb`) as a release asset.
---
diff --git a/cli/Cargo.toml b/cli/Cargo.toml
index 10698d3..1a784bf 100644
--- a/cli/Cargo.toml
+++ b/cli/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "vietc-cli"
-version = "0.1.0"
+version = "0.1.6"
edition = "2021"
description = "Viet+ CLI Test Harness"
diff --git a/daemon/Cargo.toml b/daemon/Cargo.toml
index e16082a..8dfc33a 100644
--- a/daemon/Cargo.toml
+++ b/daemon/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "vietc-daemon"
-version = "0.1.0"
+version = "0.1.6"
edition = "2021"
description = "Viet+ background daemon"
diff --git a/daemon/src/config.rs b/daemon/src/config.rs
index f8dde81..cbdc5b2 100644
--- a/daemon/src/config.rs
+++ b/daemon/src/config.rs
@@ -196,7 +196,7 @@ impl Default for Config {
auto_restore: AutoRestoreConfig::default(),
app_state: AppStateConfig::default(),
macros,
- grab: false,
+ grab: false, // default false so daemon works without root (needs input group for uinput)
debug: false,
}
}
diff --git a/daemon/src/main.rs b/daemon/src/main.rs
index 80bf682..0dd4291 100644
--- a/daemon/src/main.rs
+++ b/daemon/src/main.rs
@@ -1027,14 +1027,13 @@ fn run_with_evdev(
if active_window_id != last_active_window {
new_window = Some(active_window_id.clone());
- } else if gap > std::time::Duration::from_millis(100) {
- // Background thread hasn't caught up yet — poll xdotool directly
+ } else {
+ // Always verify active window on every keypress — window
+ // switches under 100ms can leak the old engine buffer.
if let Some(id) = app_state::get_active_window_id() {
if id != active_window_id {
new_window = Some(id);
}
- } else {
- log_info(&format!("[vietc] gap poll: window ID query failed (gap={:?}, shared='{}')", gap, active_window_id));
}
}
@@ -1264,22 +1263,15 @@ fn execute_commands(
std::thread::sleep(std::time::Duration::from_millis(20));
}
}
-
fn create_injector(
display: display::DisplayServer,
) -> ResultZero-configuration Vietnamese input method engine supporting Telex and VNI input methods. Works natively on both X11 and Wayland via evdev uinput injection.
-Zero-configuration Vietnamese input method engine supporting Telex and VNI input methods.
-Zero-configuration Vietnamese input method engine supporting Telex and VNI input methods.
\n