Goxkey

<p align="center"> <img src="./icons/icon.png" width="90px"> </p> <img width="1585" height="797" alt="screenshots" src="https://github.com/user-attachments/assets/42930e8a-77fb-4493-aa90-3c0bb9f1ab40" />

Gõkey - A Vietnamese input method editor.

• :zap: Excellent performance (Gen Z translation: Blazing fast!)
• :crab: Written completely in Rust.
• :keyboard: Supported both Telex and VNI input method.
• :sparkles: Focused on typing experience and features that you will use.

Why another Vietnamese IME?

technical curiosity

About

This is my attempt to build an input method editor using only Rust. It's not the first, and definitely not the last.

The goal is to create an input method editor that enable users to type Vietnamese text on the computer using either VNI or TELEX method. Other than that, no other features are planned.

How to install

There are 2 options to download GõKey at this moment: Build from source or Download the Nightly build.

Option 1: Download the Nightly Build

Nightly build is the prebuilt binary that automatically bundled everytime we merged the code to the main branch.

You can download it at the Release page here: https://github.com/huytd/goxkey/releases/tag/nightly-build

Option 2: Build from source

The source code can be compiled easily:

1. Get the latest stable version of the Rust compiler (see here)

2. Install the cargo-bundle extension, this is necessary for bundling macOS apps

3. Checkout the source code of the gõkey project

   git clone https://github.com/huytd/goxkey && cd goxkey
   

4. Run the bundle command:

   cargo bundle
   

After that, you'll find the Gõ Key.app file in the target/debug/bundle folder. Copy it to your /Applications folder.

5. (Important!): Before you run the app, make you you already allowed Accessibility access for the app. Follow the guide in the Wiki to do so.

Without this step, the app will crash and can't be use.

Development

# Run with UI-only mode (skip Accessibility permission check)
cargo r -- --skip-permission

# Force a specific UI language (vi or en), ignoring OS language
cargo r -- --lang vi
cargo r -- --lang en

Dependencies

• core-foundation, core-graphics: for event handling on macOS
• vi-rs: the Vietnamese Input Engine

Fun fact

Do you know how to type gõkey in Telex?

Do this: gox<cmd>key