hellojaccc / kime

Korean IME

kime

Korean IME

View in other languages

English, 한국어

---

Changelog

Why kime

• Well tested input engine
• Very fast
• Low memory footprint
• Write in mostly Rust no segfaults
• Allow custom layouts

Have a question?

Please contact with Discord or post issue

Supported frontend

• XIM
• Wayland
• GTK2
• GTK3
• GTK4
• Qt5
• Qt6

Installation

Arch Linux

you can install from AUR package kime for latest release or kime-git if you want to build from source.

Debian, Ubuntu

you can install from .deb file at releases tab.

Build from source

Docker

It's convenient because you don't need install other dependencies

git clone https://github.com/riey/kime
cd kime

docker build --file build-docker/<distro path>/Dockerfile --tag kime-build:git .
docker run --name kime kime-build:git
docker cp kime:/opt/kime-out/kime.tar.xz .
# if you want deb file try this command instead
# docker cp kime:/opt/kime-out/kime_amd64.deb .

Manually build

make sure cargo and other dependencies listed below are installed before build.

git clone https://github.com/Riey/kime
cd kime

scripts/build.sh -ar

Now all files are in build/out if you want manual install go ahead

you can also use scripts/install.sh <install-prefix> useful script for packaging

and there is scripts/release-deb.sh <deb-out-path> it make deb file.

GTK

you may don't need to do this when you install with package

because most distros doing this themselves.

# If you install gtk2
sudo gtk-query-immodules-2.0 --update-cache
# If you install gtk3
sudo gtk-query-immodules-3.0 --update-cache
# If you install gtk4
sudo gio-querymodules /usr/lib/gtk-4.0/4.0.0/immodules

Configuration

Debian-like

Set input method kime in language setting

Other

Add the following to your init script

export GTK_IM_MODULE=kime
export QT_IM_MODULE=kime
export XMODIFIERS=@im=kime

kime-indicator &
# Note that when X or wayland session is not initialized, below commands would be failed
kime-xim &
# kime-wayland &

if you use X it could be done in .xprofile

read CONFIGURATION.md for detailed options.

Dependencies

Run time

Note that you only need deps what you need for example, if you don't use qt6 it won't required.

• gtk2
• gtk3
• gtk4
• qt5
• qt6
• libappindicator-gtk3 (indicator)
• libxcb (xim)
• cairo (xim)

Build time (you don't need when run compiled binary)

Required

• cmake
• cargo
• libclang
• pkg-config
• libappindicator-gtk3
• libxcb
• cairo

Optional

• gtk2
• gtk3
• gtk4
• qtbase5-private
• qtbase6-private