Download MiKey

The Windows installer is being finished and will be on the releases page in the next few days.

Older versions and source code: the releases page on GitHub.

Requirements

• macOS 13 Ventura or later, Apple Silicon or Intel Mac.
• Windows 10 or 11, x64 or ARM64.
• Any keyboard layout: Swiss German · German · ABC/US · Austrian.

Install on macOS

1. Download MiKey-1.0.1-macOS.dmg, open it and double-click Cài đặt MiKey.pkg. The same file for Apple Silicon (M1–M4) and Intel Macs.
2. macOS says Apple could not check it for malicious software: click Done. This is because the package isn't signed with an Apple certificate.
3. Open System Settings › Privacy & Security, scroll down, click Open Anyway next to MiKey and enter your password.
4. The installer copies MiKey to /Library/Input Methods. Continue, Install.
5. Open System Settings › Keyboard › Input Sources › Edit…, click +, choose Vietnamese › MiKey › Add. If MiKey isn't listed, log out and back in.
6. Pick MiKey in the input menu in the menu bar. Your layout stays active underneath, for example Swiss German.

Update: download the new version and install it over the old one. Remove: take MiKey out of Input Sources, then delete /Library/Input Methods/MiKey.app (Finder › Go › Go to Folder).

Install on Windows

The Windows installer is being finished and will be on the releases page in the next few days.

1. Download MiKey-1.0.1-x64-Setup.exe (or arm64 for ARM devices).
2. Windows SmartScreen says Windows protected your PC: click More info › Run anyway. Same reason as on the Mac: not signed.
3. MiKey is installed for your user account only, no administrator rights needed.
4. MiKey lives in the system tray (bottom right). Alt+Z switches Vietnamese ↔ English/German.

Update: MiKey checks for a new version once a day and only installs ones signed by MiKey. Remove: Settings › Apps › MiKey › Uninstall.

Verify the file

The SHA-256 above must match your download. Mac: shasum -a 256 MiKey-*.pkg. Windows (PowerShell): Get-FileHash MiKey-*.exe.